jaas/blueprint/jasypt/src/test/java/org/apache/karaf/jaas/blueprint/jasypt/handler/EncryptableConfigAdminPropertyPlaceholderTest.java - karaf - Git at Google

 /*
  *  Licensed 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.
  *  under the License.
  */
 package org.apache.karaf.jaas.blueprint.jasypt.handler;

 import junit.framework.TestCase;
 import org.apache.felix.connect.PojoServiceRegistryFactoryImpl;
 import org.apache.felix.connect.launch.BundleDescriptor;
 import org.apache.felix.connect.launch.ClasspathScanner;
 import org.apache.felix.connect.launch.PojoServiceRegistry;
 import org.apache.felix.connect.launch.PojoServiceRegistryFactory;
 import org.apache.karaf.util.StreamUtils;
 import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
 import org.jasypt.encryption.pbe.config.EnvironmentStringPBEConfig;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.ops4j.pax.tinybundles.core.TinyBundle;
 import org.osgi.framework.*;
 import org.osgi.service.cm.Configuration;
 import org.osgi.service.cm.ConfigurationAdmin;
 import org.osgi.util.tracker.ServiceTracker;

 import java.io.*;
 import java.util.*;
 import java.util.jar.JarInputStream;

 import static org.ops4j.pax.tinybundles.core.TinyBundles.bundle;

 public class EncryptableConfigAdminPropertyPlaceholderTest extends TestCase {

     public static final long DEFAULT_TIMEOUT = 30000;

     private BundleContext bundleContext;
     private ConfigurationAdmin configAdmin;
     private EnvironmentStringPBEConfig env;
     private StandardPBEStringEncryptor enc;
     private String encryptedValue;

     @Before
     public void setUp() throws Exception {

         // Configure Jasypt
         enc = new StandardPBEStringEncryptor();
         env = new EnvironmentStringPBEConfig();
         env.setAlgorithm("PBEWithMD5AndDES");
         env.setPassword("password");
         enc.setConfig(env);

         System.setProperty("org.osgi.framework.storage", "target/osgi/" + System.currentTimeMillis());
         System.setProperty("karaf.name", "root");

         List<BundleDescriptor> bundles = new ClasspathScanner().scanForBundles("(Bundle-SymbolicName=*)");
         bundles.add(getBundleDescriptor(
                 "target/jasypt2.jar",
                 bundle().add("OSGI-INF/blueprint/karaf-jaas-jasypt.xml", getClass().getResource("/OSGI-INF/blueprint/karaf-jaas-jasypt.xml"))
                         .set("Manifest-Version", "2")
                         .set("Bundle-ManifestVersion", "2")
                         .set("Bundle-SymbolicName", "jasypt")
                         .set("Bundle-Version", "0.0.0")));
         bundles.add(getBundleDescriptor(
                 "target/test2.jar",
                 bundle().add("OSGI-INF/blueprint/configadmin-test.xml", getClass().getResource("configadmin-test.xml"))
                         .set("Manifest-Version", "2")
                         .set("Bundle-ManifestVersion", "2")
                         .set("Bundle-SymbolicName", "configtest")
                         .set("Bundle-Version", "0.0.0")));

         Map config = new HashMap();
         config.put(PojoServiceRegistryFactory.BUNDLE_DESCRIPTORS, bundles);
         PojoServiceRegistry reg = new PojoServiceRegistryFactoryImpl().newPojoServiceRegistry(config);
         bundleContext = reg.getBundleContext();
     }

     private BundleDescriptor getBundleDescriptor(String path, TinyBundle bundle) throws Exception {
         File file = new File(path);
         FileOutputStream fos = new FileOutputStream(file);
         StreamUtils.copy(bundle.build(), fos);
         fos.close();
         JarInputStream jis = new JarInputStream(new FileInputStream(file));
         Map<String, String> headers = new HashMap<>();
         for (Map.Entry entry : jis.getManifest().getMainAttributes().entrySet()) {
             headers.put(entry.getKey().toString(), entry.getValue().toString());
         }
         return new BundleDescriptor(
                 getClass().getClassLoader(),
                 "jar:" + file.toURI().toString() + "!/",
                 headers);
     }

     @After
     public void tearDown() throws Exception {
         bundleContext.getBundle().stop();
     }

     @Test
     public void testEncryptConfigProperty() throws Exception {

         for (Bundle bundle : bundleContext.getBundles()) {
             System.out.println(bundle.getSymbolicName() + " / " + bundle.getVersion());
         }

         configAdmin = getOsgiService(ConfigurationAdmin.class);
         assertNotNull(configAdmin);

         Configuration config = configAdmin.createFactoryConfiguration("encrypt.config", null);
         Dictionary props = new Properties();

         // Encrypt a key/value
         // bar is encrypted and link to foo key
         encryptedValue = enc.encrypt("bar");
         props.put("foo", encryptedValue);
         config.update(props);

         Configuration[] configs = configAdmin.listConfigurations(null);

         for (Configuration conf : configs) {
             String pid = conf.getPid();

             // System.out.println(">> ConfigImpl pid : " + pid);

             Dictionary<String, ?> dict = conf.getProperties();
             for (Enumeration e = dict.keys(); e.hasMoreElements(); ) {
                 String key = (String) e.nextElement();
                 Object value = dict.get(key);

                 // System.out.println(">> Key : " + key + ", value : " + value);

                 if (key.equals("foo")) {
                     String val = (String) value;
                     // Verify encrypted value
                     assertEquals(encryptedValue, val);
                     // Decrypt and check value
                     String decrypt = enc.decrypt(val);
                     assertEquals("bar",decrypt);
                 }
             }

         }

     }


     protected <T> T getOsgiService(Class<T> type, long timeout) {
         return getOsgiService(type, null, timeout);
     }

     protected <T> T getOsgiService(Class<T> type) {
         return getOsgiService(type, null, DEFAULT_TIMEOUT);
     }

     protected <T> T getOsgiService(Class<T> type, String filter) {
         return getOsgiService(type, filter, DEFAULT_TIMEOUT);
     }

     protected <T> T getOsgiService(Class<T> type, String filter, long timeout) {
         ServiceTracker tracker = null;
         try {
             String flt;
             if (filter != null) {
                 if (filter.startsWith("(")) {
                     flt = "(&(" + Constants.OBJECTCLASS + "=" + type.getName() + ")" + filter + ")";
                 } else {
                     flt = "(&(" + Constants.OBJECTCLASS + "=" + type.getName() + ")(" + filter + "))";
                 }
             } else {
                 flt = "(" + Constants.OBJECTCLASS + "=" + type.getName() + ")";
             }
             Filter osgiFilter = FrameworkUtil.createFilter(flt);
             tracker = new ServiceTracker(bundleContext, osgiFilter, null);
             tracker.open(true);
             // Note that the tracker is not closed to keep the reference
             // This is buggy, as the service reference may change i think
             Object svc = type.cast(tracker.waitForService(timeout));
             if (svc == null) {
                 Dictionary dic = bundleContext.getBundle().getHeaders();
                 System.err.println("Test bundle headers: " + explode(dic));

                 for (ServiceReference ref : asCollection(bundleContext.getAllServiceReferences(null, null))) {
                     System.err.println("ServiceReference: " + ref);
                 }

                 for (ServiceReference ref : asCollection(bundleContext.getAllServiceReferences(null, flt))) {
                     System.err.println("Filtered ServiceReference: " + ref);
                 }

                 throw new RuntimeException("Gave up waiting for service " + flt);
             }
             return type.cast(svc);
         } catch (InvalidSyntaxException e) {
             throw new IllegalArgumentException("Invalid filter", e);
         } catch (InterruptedException e) {
             throw new RuntimeException(e);
         }
     }

     /*
      * Explode the dictionary into a ,-delimited list of key=value pairs
      */
     private static String explode(Dictionary dictionary) {
         Enumeration keys = dictionary.keys();
         StringBuffer result = new StringBuffer();
         while (keys.hasMoreElements()) {
             Object key = keys.nextElement();
             result.append(String.format("%s=%s", key, dictionary.get(key)));
             if (keys.hasMoreElements()) {
                 result.append(", ");
             }
         }
         return result.toString();
     }

     /*
      * Provides an iterable collection of references, even if the original array is null
      */
     private static final Collection<ServiceReference> asCollection(ServiceReference[] references) {
         List<ServiceReference> result = new LinkedList<>();
         if (references != null) {
             for (ServiceReference reference : references) {
                 result.add(reference);
             }
         }
         return result;
     }

     /*
     public void setConfigAdmin(ConfigurationAdmin configAdmin) {
         this.configAdmin = configAdmin;
     }*/
 }
	/*
	* Licensed 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.
	* under the License.
	*/
	package org.apache.karaf.jaas.blueprint.jasypt.handler;

	import junit.framework.TestCase;
	import org.apache.felix.connect.PojoServiceRegistryFactoryImpl;
	import org.apache.felix.connect.launch.BundleDescriptor;
	import org.apache.felix.connect.launch.ClasspathScanner;
	import org.apache.felix.connect.launch.PojoServiceRegistry;
	import org.apache.felix.connect.launch.PojoServiceRegistryFactory;
	import org.apache.karaf.util.StreamUtils;
	import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
	import org.jasypt.encryption.pbe.config.EnvironmentStringPBEConfig;
	import org.junit.After;
	import org.junit.Before;
	import org.junit.Test;
	import org.ops4j.pax.tinybundles.core.TinyBundle;
	import org.osgi.framework.*;
	import org.osgi.service.cm.Configuration;
	import org.osgi.service.cm.ConfigurationAdmin;
	import org.osgi.util.tracker.ServiceTracker;

	import java.io.*;
	import java.util.*;
	import java.util.jar.JarInputStream;

	import static org.ops4j.pax.tinybundles.core.TinyBundles.bundle;

	public class EncryptableConfigAdminPropertyPlaceholderTest extends TestCase {

	public static final long DEFAULT_TIMEOUT = 30000;

	private BundleContext bundleContext;
	private ConfigurationAdmin configAdmin;
	private EnvironmentStringPBEConfig env;
	private StandardPBEStringEncryptor enc;
	private String encryptedValue;

	@Before
	public void setUp() throws Exception {

	// Configure Jasypt
	enc = new StandardPBEStringEncryptor();
	env = new EnvironmentStringPBEConfig();
	env.setAlgorithm("PBEWithMD5AndDES");
	env.setPassword("password");
	enc.setConfig(env);

	System.setProperty("org.osgi.framework.storage", "target/osgi/" + System.currentTimeMillis());
	System.setProperty("karaf.name", "root");

	List<BundleDescriptor> bundles = new ClasspathScanner().scanForBundles("(Bundle-SymbolicName=*)");
	bundles.add(getBundleDescriptor(
	"target/jasypt2.jar",
	bundle().add("OSGI-INF/blueprint/karaf-jaas-jasypt.xml", getClass().getResource("/OSGI-INF/blueprint/karaf-jaas-jasypt.xml"))
	.set("Manifest-Version", "2")
	.set("Bundle-ManifestVersion", "2")
	.set("Bundle-SymbolicName", "jasypt")
	.set("Bundle-Version", "0.0.0")));
	bundles.add(getBundleDescriptor(
	"target/test2.jar",
	bundle().add("OSGI-INF/blueprint/configadmin-test.xml", getClass().getResource("configadmin-test.xml"))
	.set("Manifest-Version", "2")
	.set("Bundle-ManifestVersion", "2")
	.set("Bundle-SymbolicName", "configtest")
	.set("Bundle-Version", "0.0.0")));

	Map config = new HashMap();
	config.put(PojoServiceRegistryFactory.BUNDLE_DESCRIPTORS, bundles);
	PojoServiceRegistry reg = new PojoServiceRegistryFactoryImpl().newPojoServiceRegistry(config);
	bundleContext = reg.getBundleContext();
	}

	private BundleDescriptor getBundleDescriptor(String path, TinyBundle bundle) throws Exception {
	File file = new File(path);
	FileOutputStream fos = new FileOutputStream(file);
	StreamUtils.copy(bundle.build(), fos);
	fos.close();
	JarInputStream jis = new JarInputStream(new FileInputStream(file));
	Map<String, String> headers = new HashMap<>();
	for (Map.Entry entry : jis.getManifest().getMainAttributes().entrySet()) {
	headers.put(entry.getKey().toString(), entry.getValue().toString());
	}
	return new BundleDescriptor(
	getClass().getClassLoader(),
	"jar:" + file.toURI().toString() + "!/",
	headers);
	}

	@After
	public void tearDown() throws Exception {
	bundleContext.getBundle().stop();
	}

	@Test
	public void testEncryptConfigProperty() throws Exception {

	for (Bundle bundle : bundleContext.getBundles()) {
	System.out.println(bundle.getSymbolicName() + " / " + bundle.getVersion());
	}

	configAdmin = getOsgiService(ConfigurationAdmin.class);
	assertNotNull(configAdmin);

	Configuration config = configAdmin.createFactoryConfiguration("encrypt.config", null);
	Dictionary props = new Properties();

	// Encrypt a key/value
	// bar is encrypted and link to foo key
	encryptedValue = enc.encrypt("bar");
	props.put("foo", encryptedValue);
	config.update(props);

	Configuration[] configs = configAdmin.listConfigurations(null);

	for (Configuration conf : configs) {
	String pid = conf.getPid();

	// System.out.println(">> ConfigImpl pid : " + pid);

	Dictionary<String, ?> dict = conf.getProperties();
	for (Enumeration e = dict.keys(); e.hasMoreElements(); ) {
	String key = (String) e.nextElement();
	Object value = dict.get(key);

	// System.out.println(">> Key : " + key + ", value : " + value);

	if (key.equals("foo")) {
	String val = (String) value;
	// Verify encrypted value
	assertEquals(encryptedValue, val);
	// Decrypt and check value
	String decrypt = enc.decrypt(val);
	assertEquals("bar",decrypt);
	}
	}

	}

	}


	protected <T> T getOsgiService(Class<T> type, long timeout) {
	return getOsgiService(type, null, timeout);
	}

	protected <T> T getOsgiService(Class<T> type) {
	return getOsgiService(type, null, DEFAULT_TIMEOUT);
	}

	protected <T> T getOsgiService(Class<T> type, String filter) {
	return getOsgiService(type, filter, DEFAULT_TIMEOUT);
	}

	protected <T> T getOsgiService(Class<T> type, String filter, long timeout) {
	ServiceTracker tracker = null;
	try {
	String flt;
	if (filter != null) {
	if (filter.startsWith("(")) {
	flt = "(&(" + Constants.OBJECTCLASS + "=" + type.getName() + ")" + filter + ")";
	} else {
	flt = "(&(" + Constants.OBJECTCLASS + "=" + type.getName() + ")(" + filter + "))";
	}
	} else {
	flt = "(" + Constants.OBJECTCLASS + "=" + type.getName() + ")";
	}
	Filter osgiFilter = FrameworkUtil.createFilter(flt);
	tracker = new ServiceTracker(bundleContext, osgiFilter, null);
	tracker.open(true);
	// Note that the tracker is not closed to keep the reference
	// This is buggy, as the service reference may change i think
	Object svc = type.cast(tracker.waitForService(timeout));
	if (svc == null) {
	Dictionary dic = bundleContext.getBundle().getHeaders();
	System.err.println("Test bundle headers: " + explode(dic));

	for (ServiceReference ref : asCollection(bundleContext.getAllServiceReferences(null, null))) {
	System.err.println("ServiceReference: " + ref);
	}

	for (ServiceReference ref : asCollection(bundleContext.getAllServiceReferences(null, flt))) {
	System.err.println("Filtered ServiceReference: " + ref);
	}

	throw new RuntimeException("Gave up waiting for service " + flt);
	}
	return type.cast(svc);
	} catch (InvalidSyntaxException e) {
	throw new IllegalArgumentException("Invalid filter", e);
	} catch (InterruptedException e) {
	throw new RuntimeException(e);
	}
	}

	/*
	* Explode the dictionary into a ,-delimited list of key=value pairs
	*/
	private static String explode(Dictionary dictionary) {
	Enumeration keys = dictionary.keys();
	StringBuffer result = new StringBuffer();
	while (keys.hasMoreElements()) {
	Object key = keys.nextElement();
	result.append(String.format("%s=%s", key, dictionary.get(key)));
	if (keys.hasMoreElements()) {
	result.append(", ");
	}
	}
	return result.toString();
	}

	/*
	* Provides an iterable collection of references, even if the original array is null
	*/
	private static final Collection<ServiceReference> asCollection(ServiceReference[] references) {
	List<ServiceReference> result = new LinkedList<>();
	if (references != null) {
	for (ServiceReference reference : references) {
	result.add(reference);
	}
	}
	return result;
	}

	/*
	public void setConfigAdmin(ConfigurationAdmin configAdmin) {
	this.configAdmin = configAdmin;
	}*/
	}