01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.servicemix.jbi.security.keystore;
18:
19: import java.security.GeneralSecurityException;
20:
21: import javax.net.ssl.SSLServerSocketFactory;
22: import javax.net.ssl.SSLSocketFactory;
23:
24: /**
25: * Based on http://svn.apache.org/repos/asf/geronimo/trunk/modules/management/
26: * src/java/org/apache/geronimo/management/geronimo/KeystoreManager.java
27: *
28: */
29: public interface KeystoreManager {
30:
31: KeystoreInstance getKeystore(String name);
32:
33: /**
34: * Gets a ServerSocketFactory using one Keystore to access the private key
35: * and another to provide the list of trusted certificate authorities.
36: * @param provider
37: * @param protocol The SSL protocol to use
38: * @param algorithm The SSL algorithm to use
39: * @param keyStore The key keystore name as provided by listKeystores. The
40: * KeystoreInstance for this keystore must be unlocked.
41: * @param keyAlias The name of the private key in the keystore. The
42: * KeystoreInstance for this keystore must have unlocked
43: * this key.
44: * @param trustStore The trust keystore name as provided by listKeystores.
45: * The KeystoreInstance for this keystore must have
46: * unlocked this key.
47: * @param loader The class loader used to resolve factory classes.
48: *
49: * @throws KeystoreIsLocked Occurs when the requested key keystore cannot
50: * be used because it has not been unlocked.
51: * @throws KeyIsLocked Occurs when the requested private key in the key
52: * keystore cannot be used because it has not been
53: * unlocked.
54: */
55: SSLServerSocketFactory createSSLServerFactory(String provider,
56: String protocol, String algorithm, String keyStore,
57: String keyAlias, String trustStore)
58: throws GeneralSecurityException;
59:
60: /**
61: * Gets a SocketFactory using one Keystore to access the private key
62: * and another to provide the list of trusted certificate authorities.
63: * @param provider The SSL provider to use, or null for the default
64: * @param protocol The SSL protocol to use
65: * @param algorithm The SSL algorithm to use
66: * @param keyStore The key keystore name as provided by listKeystores. The
67: * KeystoreInstance for this keystore must be unlocked.
68: * @param keyAlias The name of the private key in the keystore. The
69: * KeystoreInstance for this keystore must have unlocked
70: * this key.
71: * @param trustStore The trust keystore name as provided by listKeystores.
72: * The KeystoreInstance for this keystore must have
73: * unlocked this key.
74: * @param loader The class loader used to resolve factory classes.
75: *
76: * @throws KeystoreIsLocked Occurs when the requested key keystore cannot
77: * be used because it has not been unlocked.
78: * @throws KeyIsLocked Occurs when the requested private key in the key
79: * keystore cannot be used because it has not been
80: * unlocked.
81: * @throws GeneralSecurityException
82: */
83: SSLSocketFactory createSSLFactory(String provider, String protocol,
84: String algorithm, String keyStore, String keyAlias,
85: String trustStore) throws GeneralSecurityException;
86:
87: }
|