1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.authentication;
import java.util.Enumeration;
import java.util.Hashtable;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.ISubsystem;
/**
* An interface that represents an authentication component
* <P>
*
* @version $Revision$, $Date$
*/
public interface IAuthSubsystem extends ISubsystem {
/**
* Constant for auths.
*/
public static final String ID = "auths";
/**
* Constant for class.
*/
public static final String PROP_CLASS = "class";
/**
* Constant for impl
*/
public static final String PROP_IMPL = "impl";
/**
* Constant for pluginName.
*/
public static final String PROP_PLUGIN = "pluginName";
/**
* Constant for instance.
*/
public static final String PROP_INSTANCE = "instance";
/* XXX should not be here */
/**
* Constant for password based authentication plugin ID.
*/
public static final String PASSWDUSERDB_PLUGIN_ID = "passwdUserDBAuthPlugin";
/**
* Constant for certificate based authentication plugin ID.
*/
public static final String CERTUSERDB_PLUGIN_ID = "certUserDBAuthPlugin";
/**
* Constant for challenge based authentication plugin ID.
*/
public static final String CHALLENGE_PLUGIN_ID = "challengeAuthPlugin";
/**
* Constant for null authentication plugin ID.
*/
public static final String NULL_PLUGIN_ID = "nullAuthPlugin";
/**
* Constant for ssl client authentication plugin ID.
*/
public static final String SSLCLIENTCERT_PLUGIN_ID = "sslClientCertAuthPlugin";
/**
* Constant for password based authentication manager ID.
*/
public static final String PASSWDUSERDB_AUTHMGR_ID = "passwdUserDBAuthMgr";
/**
* Constant for certificate based authentication manager ID.
*/
public static final String CERTUSERDB_AUTHMGR_ID = "certUserDBAuthMgr";
/**
* Constant for challenge based authentication manager ID.
*/
public static final String CHALLENGE_AUTHMGR_ID = "challengeAuthMgr";
/**
* Constant for null authentication manager ID.
*/
public static final String NULL_AUTHMGR_ID = "nullAuthMgr";
/**
* Constant for ssl client authentication manager ID.
*/
public static final String SSLCLIENTCERT_AUTHMGR_ID = "sslClientCertAuthMgr";
/**
* Constant for CMC authentication plugin ID.
*/
public static final String CMCAUTH_PLUGIN_ID = "CMCAuth";
/**
* Constant for CMC authentication manager ID.
*/
public static final String CMCAUTH_AUTHMGR_ID = "CMCAuth";
/**
* Authenticate the given credentials using the given manager name.
* @param authCred The authentication credentials
* @param authMgrName The authentication manager name
* @return a authentication token.
* @exception EMissingCredential when missing credential during authentication
* @exception EInvalidCredentials when the credential is invalid
* @exception EBaseException If an error occurs during authentication.
*/
public IAuthToken authenticate(IAuthCredentials authCred, String authMgrName)
throws EMissingCredential, EInvalidCredentials, EBaseException;
/**
* Gets the required credential attributes for the given authentication
* manager.
* @param authMgrName The authentication manager name
* @return a Vector of required credential attribute names.
* @exception EBaseException If the required credential is missing
*/
public String[] getRequiredCreds(String authMgrName) throws EBaseException;
/**
* Adds (registers) the given authentication manager.
* @param name The authentication manager name
* @param authMgr The authentication manager instance.
*/
public void add(String name, IAuthManager authMgr);
/**
* Deletes (deregisters) the given authentication manager.
* @param name The authentication manager name to delete.
*/
public void delete(String name);
/**
* Gets the Authentication manager instance of the specified name.
* @param name The authentication manager's name.
* @exception EBaseException when internal error occurs.
*/
public IAuthManager getAuthManager(String name) throws EBaseException;
/**
* Gets an enumeration of authentication managers registered to the
* authentication subsystem.
* @return a list of authentication managers
*/
public Enumeration<IAuthManager> getAuthManagers();
/**
* Gets an enumeration of authentication manager plugins.
* @return a list of authentication plugins
*/
public Enumeration<AuthMgrPlugin> getAuthManagerPlugins();
/**
* Gets a single authentication manager plugin implementation
* @param name given authentication plugin name
* @return the given authentication plugin
*/
public IAuthManager getAuthManagerPlugin(String name);
/**
* Get configuration parameters for a authentication mgr plugin.
* @param implName The plugin name.
* @return configuration parameters for the given authentication manager plugin
* @exception EAuthMgrPluginNotFound If the authentication manager
* plugin is not found.
* @exception EBaseException If an internal error occurred.
*/
public String[] getConfigParams(String implName)
throws EAuthMgrPluginNotFound, EBaseException;
/**
* Log error message.
* @param level log level
* @param msg error message
*/
public void log(int level, String msg);
/**
* Get a hashtable containing all authentication plugins.
* @return all authentication plugins.
*/
public Hashtable<String, AuthMgrPlugin> getPlugins();
/**
* Get a hashtable containing all authentication instances.
* @return all authentication instances.
*/
public Hashtable<?, ?> getInstances();
/**
* Get an authentication manager interface for the given name.
* @param name given authentication manager name.
* @return an authentication manager for the given manager name.
*/
public IAuthManager get(String name);
/**
* Get an authentication manager plugin impl for the given name.
* @param name given authentication manager name.
* @return an authentication manager plugin
*/
public AuthMgrPlugin getAuthManagerPluginImpl(String name);
}
|
