1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: SSLHelper.java,v 1.3 2005/07/22 23:38:04 tanderson Exp $
44 */
45 package org.exolab.jms.net.util;
46
47 import java.util.Properties;
48
49
50 /***
51 * Helper class for configuring the secure socket layer (SSL).
52 *
53 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
54 * @version $Revision: 1.3 $
55 */
56 public class SSLHelper {
57
58 /***
59 * System property to indicate the keystore to use.
60 */
61 public static final String KEY_STORE = "javax.net.ssl.keyStore";
62
63 /***
64 * System property to indicate the keystore type.
65 */
66 public static final String KEY_STORE_TYPE
67 = "javax.net.ssl.keyStoreType";
68
69 /***
70 * System property to indicate the keystore password.
71 */
72 public static final String KEY_STORE_PASSWORD
73 = "javax.net.ssl.keyStorePassword";
74
75 /***
76 * System property to indicate the truststore to use.
77 */
78 public static final String TRUST_STORE = "javax.net.ssl.trustStore";
79
80 /***
81 * System property to indicate the truststore password.
82 */
83 public static final String TRUST_STORE_PASSWORD
84 = "javax.net.ssl.trustStorePassword";
85
86 /***
87 * System property to indicate the truststore type.
88 */
89 public static final String TRUST_STORE_TYPE
90 = "javax.net.ssl.trustStoreType";
91
92 /***
93 * Configure the secure socket layer.
94 * <p/>
95 * This sets system properties corresponding to those specified by
96 * <code>properties</code>
97 *
98 * @param properties the properties to use
99 * @throws SecurityException if the security manager doesn't allow a
100 * property to be updated.
101 */
102 public static void configure(SSLProperties properties)
103 throws SecurityException {
104 update(KEY_STORE, properties.getKeyStore());
105 update(KEY_STORE_PASSWORD, properties.getKeyStorePassword());
106 update(KEY_STORE_TYPE, properties.getKeyStoreType());
107 update(TRUST_STORE, properties.getTrustStore());
108 update(TRUST_STORE_PASSWORD, properties.getTrustStorePassword());
109 update(TRUST_STORE_TYPE, properties.getTrustStoreType());
110 }
111
112 /***
113 * Update a system property, setting it if the corresponding value isn't
114 * null, or removing it if it is.
115 *
116 * @param key the property name
117 * @param value the property value
118 * @throws SecurityException if the security manager doesn't allow a
119 * property to be updated.
120 */
121 private static void update(String key, String value)
122 throws SecurityException {
123 if (value != null) {
124 System.setProperty(key, value);
125 } else if (System.getProperty(key) != null) {
126 Properties properties = System.getProperties();
127 properties.remove(key);
128 }
129 }
130 }