You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2021/05/20 19:26:42 UTC
[sling-org-apache-sling-commons-crypto] 01/02: SLING-10407 Provide
a password provider for environment variables
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-crypto.git
commit 2e106403d8a98643de0981284043de0af58884ea
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Thu May 20 21:23:06 2021 +0200
SLING-10407 Provide a password provider for environment variables
---
pom.xml | 6 ++
.../EnvironmentVariablePasswordProvider.java | 82 ++++++++++++++++++++++
...nmentVariablePasswordProviderConfiguration.java | 46 ++++++++++++
... => EnvironmentVariablePasswordProviderIT.java} | 33 ++++++---
.../crypto/it/tests/FilePasswordProviderIT.java | 3 +
5 files changed, 162 insertions(+), 8 deletions(-)
diff --git a/pom.xml b/pom.xml
index ca3d8b1..2f53462 100644
--- a/pom.xml
+++ b/pom.xml
@@ -222,6 +222,12 @@
<scope>test</scope>
</dependency>
<dependency>
+ <groupId>com.github.stefanbirkner</groupId>
+ <artifactId>system-lambda</artifactId>
+ <version>1.2.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
<groupId>com.google.truth</groupId>
<artifactId>truth</artifactId>
<version>1.1.2</version>
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java
new file mode 100644
index 0000000..66ffcf2
--- /dev/null
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProvider.java
@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.sling.commons.crypto.internal;
+
+import java.util.Objects;
+
+import org.apache.sling.commons.crypto.PasswordProvider;
+import org.jetbrains.annotations.NotNull;
+import org.osgi.framework.Constants;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Modified;
+import org.osgi.service.metatype.annotations.Designate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Component(
+ property = {
+ Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Crypto – Environment Variable Password Provider",
+ Constants.SERVICE_VENDOR + "=The Apache Software Foundation"
+ }
+)
+@Designate(
+ ocd = EnvironmentVariablePasswordProviderConfiguration.class,
+ factory = true
+)
+public class EnvironmentVariablePasswordProvider implements PasswordProvider {
+
+ private EnvironmentVariablePasswordProviderConfiguration configuration;
+
+ private final Logger logger = LoggerFactory.getLogger(EnvironmentVariablePasswordProvider.class);
+
+ public EnvironmentVariablePasswordProvider() { //
+ }
+
+ @Activate
+ private void activate(final EnvironmentVariablePasswordProviderConfiguration configuration) {
+ logger.debug("activating");
+ this.configuration = configuration;
+ }
+
+ @Modified
+ private void modified(final EnvironmentVariablePasswordProviderConfiguration configuration) {
+ logger.debug("modifying");
+ this.configuration = configuration;
+ }
+
+ @Deactivate
+ private void deactivate() {
+ logger.debug("deactivating");
+ this.configuration = null;
+ }
+
+ @Override
+ public char @NotNull [] getPassword() {
+ final String name = configuration.name();
+ if (Objects.isNull(System.getenv(name))) {
+ final String message = String.format("environment variable '%s' not set", name);
+ throw new RuntimeException(message);
+ } else {
+ return System.getenv(name).toCharArray();
+ }
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProviderConfiguration.java b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProviderConfiguration.java
new file mode 100644
index 0000000..4d991e2
--- /dev/null
+++ b/src/main/java/org/apache/sling/commons/crypto/internal/EnvironmentVariablePasswordProviderConfiguration.java
@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.sling.commons.crypto.internal;
+
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+
+@ObjectClassDefinition(
+ name = "Apache Sling Commons Crypto “Environment Variable Password Provider”",
+ description = "Provides passwords from environment variables"
+)
+@SuppressWarnings("java:S100")
+@interface EnvironmentVariablePasswordProviderConfiguration {
+
+ @AttributeDefinition(
+ name = "Names",
+ description = "names of this service",
+ required = false
+ )
+ String[] names() default {};
+
+ @AttributeDefinition(
+ name = "Name",
+ description = "name of the environment variable"
+ )
+ String name();
+
+ String webconsole_configurationFactory_nameHint() default "{names} {name}";
+
+}
diff --git a/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java b/src/test/java/org/apache/sling/commons/crypto/it/tests/EnvironmentVariablePasswordProviderIT.java
similarity index 58%
copy from src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java
copy to src/test/java/org/apache/sling/commons/crypto/it/tests/EnvironmentVariablePasswordProviderIT.java
index cc0a51c..8ebd7de 100644
--- a/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java
+++ b/src/test/java/org/apache/sling/commons/crypto/it/tests/EnvironmentVariablePasswordProviderIT.java
@@ -28,26 +28,35 @@ import org.ops4j.pax.exam.Option;
import org.ops4j.pax.exam.junit.PaxExam;
import org.ops4j.pax.exam.spi.reactors.ExamReactorStrategy;
import org.ops4j.pax.exam.spi.reactors.PerClass;
-import org.ops4j.pax.exam.util.PathUtils;
+import org.ops4j.pax.exam.util.Filter;
+import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;
import static com.google.common.truth.Truth.assertThat;
+import static org.ops4j.pax.exam.CoreOptions.mavenBundle;
import static org.ops4j.pax.exam.CoreOptions.options;
+import static org.ops4j.pax.exam.CoreOptions.wrappedBundle;
import static org.ops4j.pax.exam.cm.ConfigurationAdminOptions.factoryConfiguration;
@RunWith(PaxExam.class)
@ExamReactorStrategy(PerClass.class)
-public class FilePasswordProviderIT extends CryptoTestSupport {
+public class EnvironmentVariablePasswordProviderIT extends CryptoTestSupport {
+
+ private static final String ENVIRONMENT_VARIABLE_NAME = "SLING_CRYPTO_PASSWORD";
+
+ private static final String ENVIRONMENT_VARIABLE_VALUE = " Napøleøn Sølø (DK) \uD83C\uDFC1\uD83C\uDDE9\uD83C\uDDF0";
@Inject
+ @Filter(value = "(names=environment)")
private PasswordProvider passwordProvider;
@Configuration
public Option[] configuration() {
- final String path = String.format("%s/src/test/resources/password.utf8", PathUtils.getBaseDir());
return options(
baseConfiguration(),
- factoryConfiguration("org.apache.sling.commons.crypto.internal.FilePasswordProvider")
- .put("path", path)
+ wrappedBundle(mavenBundle().groupId("com.github.stefanbirkner").artifactId("system-lambda").versionAsInProject()),
+ factoryConfiguration("org.apache.sling.commons.crypto.internal.EnvironmentVariablePasswordProvider")
+ .put("names", new String[]{"environment"})
+ .put("name", ENVIRONMENT_VARIABLE_NAME)
.asOption()
);
}
@@ -58,9 +67,17 @@ public class FilePasswordProviderIT extends CryptoTestSupport {
}
@Test
- public void testPassword() {
- final String password = " Napøleøn Sølø (DK) \uD83C\uDFC1\uD83C\uDDE9\uD83C\uDDF0";
- assertThat(passwordProvider.getPassword()).isEqualTo(password.toCharArray());
+ public void testPassword() throws Exception {
+ final char[] password = withEnvironmentVariable(ENVIRONMENT_VARIABLE_NAME, ENVIRONMENT_VARIABLE_VALUE)
+ .execute(() ->
+ passwordProvider.getPassword()
+ );
+ assertThat(password).isEqualTo(ENVIRONMENT_VARIABLE_VALUE.toCharArray());
+ }
+
+ @Test(expected = RuntimeException.class)
+ public void testEnvironmentVariableNotSet() throws Exception {
+ passwordProvider.getPassword();
}
}
diff --git a/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java b/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java
index cc0a51c..8cf8f7c 100644
--- a/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java
+++ b/src/test/java/org/apache/sling/commons/crypto/it/tests/FilePasswordProviderIT.java
@@ -28,6 +28,7 @@ import org.ops4j.pax.exam.Option;
import org.ops4j.pax.exam.junit.PaxExam;
import org.ops4j.pax.exam.spi.reactors.ExamReactorStrategy;
import org.ops4j.pax.exam.spi.reactors.PerClass;
+import org.ops4j.pax.exam.util.Filter;
import org.ops4j.pax.exam.util.PathUtils;
import static com.google.common.truth.Truth.assertThat;
@@ -39,6 +40,7 @@ import static org.ops4j.pax.exam.cm.ConfigurationAdminOptions.factoryConfigurati
public class FilePasswordProviderIT extends CryptoTestSupport {
@Inject
+ @Filter(value = "(names=file)")
private PasswordProvider passwordProvider;
@Configuration
@@ -47,6 +49,7 @@ public class FilePasswordProviderIT extends CryptoTestSupport {
return options(
baseConfiguration(),
factoryConfiguration("org.apache.sling.commons.crypto.internal.FilePasswordProvider")
+ .put("names", new String[]{"file"})
.put("path", path)
.asOption()
);