1 package org
.argeo
.cms
.auth
;
3 import static org
.argeo
.util
.naming
.LdapAttrs
.cn
;
5 import java
.io
.IOException
;
6 import java
.security
.PrivilegedAction
;
7 import java
.util
.Arrays
;
8 import java
.util
.HashSet
;
10 import java
.util
.Locale
;
14 import javax
.naming
.ldap
.LdapName
;
15 import javax
.security
.auth
.Subject
;
16 import javax
.security
.auth
.callback
.Callback
;
17 import javax
.security
.auth
.callback
.CallbackHandler
;
18 import javax
.security
.auth
.callback
.LanguageCallback
;
19 import javax
.security
.auth
.callback
.NameCallback
;
20 import javax
.security
.auth
.callback
.PasswordCallback
;
21 import javax
.security
.auth
.callback
.UnsupportedCallbackException
;
22 import javax
.security
.auth
.kerberos
.KerberosPrincipal
;
23 import javax
.security
.auth
.login
.CredentialNotFoundException
;
24 import javax
.security
.auth
.login
.LoginException
;
25 import javax
.security
.auth
.spi
.LoginModule
;
27 import org
.argeo
.api
.cms
.CmsConstants
;
28 import org
.argeo
.api
.cms
.CmsLog
;
29 import org
.argeo
.cms
.internal
.runtime
.CmsContextImpl
;
30 import org
.argeo
.cms
.security
.CryptoKeyring
;
31 import org
.argeo
.osgi
.useradmin
.AuthenticatingUser
;
32 import org
.argeo
.osgi
.useradmin
.TokenUtils
;
33 import org
.argeo
.util
.directory
.ldap
.IpaUtils
;
34 import org
.argeo
.util
.naming
.LdapAttrs
;
35 import org
.osgi
.framework
.BundleContext
;
36 import org
.osgi
.framework
.FrameworkUtil
;
37 import org
.osgi
.framework
.ServiceReference
;
38 import org
.osgi
.service
.useradmin
.Authorization
;
39 import org
.osgi
.service
.useradmin
.Group
;
40 import org
.osgi
.service
.useradmin
.User
;
41 import org
.osgi
.service
.useradmin
.UserAdmin
;
44 * Use the {@link UserAdmin} in the OSGi registry as the basis for
47 public class UserAdminLoginModule
implements LoginModule
{
48 private final static CmsLog log
= CmsLog
.getLog(UserAdminLoginModule
.class);
50 private Subject subject
;
51 private CallbackHandler callbackHandler
;
52 private Map
<String
, Object
> sharedState
= null;
54 private List
<String
> indexedUserProperties
= Arrays
.asList(new String
[] { LdapAttrs
.mail
.name(),
55 LdapAttrs
.uid
.name(), LdapAttrs
.employeeNumber
.name(), LdapAttrs
.authPassword
.name() });
58 private BundleContext bc
;
59 private User authenticatedUser
= null;
60 private Locale locale
;
62 private Authorization bindAuthorization
= null;
64 // private boolean singleUser = Activator.isSingleUser();
66 @SuppressWarnings("unchecked")
68 public void initialize(Subject subject
, CallbackHandler callbackHandler
, Map
<String
, ?
> sharedState
,
69 Map
<String
, ?
> options
) {
70 this.subject
= subject
;
72 bc
= FrameworkUtil
.getBundle(UserAdminLoginModule
.class).getBundleContext();
73 this.callbackHandler
= callbackHandler
;
74 this.sharedState
= (Map
<String
, Object
>) sharedState
;
75 } catch (Exception e
) {
76 throw new IllegalStateException("Cannot initialize login module", e
);
81 public boolean login() throws LoginException
{
82 UserAdmin userAdmin
= CmsContextImpl
.getCmsContext().getUserAdmin();
83 final String username
;
84 final char[] password
;
85 Object certificateChain
= null;
86 boolean preauth
= false;
87 if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
88 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_PWD
)) {
89 // NB: required by Basic http auth
90 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
91 password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
93 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
94 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_SPNEGO_TOKEN
)) {
95 // SPNEGO login has succeeded, that's enough for us at this stage
97 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
98 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
)) {
99 String certDn
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
101 certificateChain
= sharedState
.get(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
);
103 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
104 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_ADDR
)
105 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_PORT
)) {// ident
106 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
111 // ask for username and password
112 NameCallback nameCallback
= new NameCallback("User");
113 PasswordCallback passwordCallback
= new PasswordCallback("Password", false);
114 LanguageCallback langCallback
= new LanguageCallback();
116 callbackHandler
.handle(new Callback
[] { nameCallback
, passwordCallback
, langCallback
});
117 } catch (IOException e
) {
118 throw new LoginException("Cannot handle callback: " + e
.getMessage());
119 } catch (UnsupportedCallbackException e
) {
124 locale
= langCallback
.getLocale();
126 locale
= Locale
.getDefault();
127 // FIXME add it to Subject
128 // Locale.setDefault(locale);
130 username
= nameCallback
.getName();
131 if (username
== null || username
.trim().equals("")) {
132 // authorization = userAdmin.getAuthorization(null);
133 throw new CredentialNotFoundException("No credentials provided");
135 if (passwordCallback
.getPassword() != null)
136 password
= passwordCallback
.getPassword();
138 throw new CredentialNotFoundException("No credentials provided");
139 sharedState
.put(CmsAuthUtils
.SHARED_STATE_NAME
, username
);
140 sharedState
.put(CmsAuthUtils
.SHARED_STATE_PWD
, password
);
142 User user
= searchForUser(userAdmin
, username
);
146 String token
= username
;
147 Group tokenGroup
= searchForToken(userAdmin
, token
);
148 if (tokenGroup
!= null) {
149 Authorization tokenAuthorization
= getAuthorizationFromToken(userAdmin
, tokenGroup
);
150 if (tokenAuthorization
!= null) {
151 bindAuthorization
= tokenAuthorization
;
152 authenticatedUser
= (User
) userAdmin
.getRole(bindAuthorization
.getName());
159 return true;// expect Kerberos
161 if (password
!= null) {
164 AuthenticatingUser authenticatingUser
= new AuthenticatingUser(user
.getName(), password
);
165 bindAuthorization
= userAdmin
.getAuthorization(authenticatingUser
);
166 // TODO check tokens as well
167 if (bindAuthorization
!= null) {
168 authenticatedUser
= user
;
171 } catch (Exception e
) {
173 if (log
.isTraceEnabled())
174 log
.trace("Bind failed", e
);
177 // works only if a connection password is provided
178 if (!user
.hasCredential(null, password
)) {
181 } else if (certificateChain
!= null) {
182 // TODO check CRLs/OSCP validity?
183 // NB: authorization in commit() will work only if an LDAP connection password
185 // } else if (singleUser) {
186 // // TODO verify IP address?
187 } else if (preauth
) {
190 throw new CredentialNotFoundException("No credentials provided");
193 authenticatedUser
= user
;
198 public boolean commit() throws LoginException
{
200 subject
.getPublicCredentials().add(locale
);
203 // OsUserUtils.loginAsSystemUser(subject);
205 UserAdmin userAdmin
= CmsContextImpl
.getCmsContext().getUserAdmin();
206 Authorization authorization
;
207 if (callbackHandler
== null) {// anonymous
208 authorization
= userAdmin
.getAuthorization(null);
209 } else if (bindAuthorization
!= null) {// bind
210 authorization
= bindAuthorization
;
212 User authenticatingUser
;
213 Set
<KerberosPrincipal
> kerberosPrincipals
= subject
.getPrincipals(KerberosPrincipal
.class);
214 if (kerberosPrincipals
.isEmpty()) {
215 if (authenticatedUser
== null) {
216 if (log
.isTraceEnabled())
217 log
.trace("Neither kerberos nor user admin login succeeded. Login failed.");
218 throw new CredentialNotFoundException("Bad credentials.");
220 authenticatingUser
= authenticatedUser
;
223 KerberosPrincipal kerberosPrincipal
= kerberosPrincipals
.iterator().next();
224 LdapName dn
= IpaUtils
.kerberosToDn(kerberosPrincipal
.getName());
225 authenticatingUser
= new AuthenticatingUser(dn
);
226 if (authenticatedUser
!= null && !authenticatingUser
.getName().equals(authenticatedUser
.getName()))
227 throw new LoginException("Kerberos login " + authenticatingUser
.getName()
228 + " is inconsistent with user admin login " + authenticatedUser
.getName());
230 if (log
.isTraceEnabled())
231 log
.trace("Retrieve authorization for " + authenticatingUser
+ "... ");
232 authorization
= Subject
.doAs(subject
, new PrivilegedAction
<Authorization
>() {
235 public Authorization
run() {
236 Authorization authorization
= userAdmin
.getAuthorization(authenticatingUser
);
237 return authorization
;
241 if (authorization
== null)
242 throw new LoginException(
243 "User admin found no authorization for authenticated user " + authenticatingUser
.getName());
246 // Log and monitor new login
247 RemoteAuthRequest request
= (RemoteAuthRequest
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_HTTP_REQUEST
);
248 CmsAuthUtils
.addAuthorization(subject
, authorization
);
250 // Unlock keyring (underlying login to the JCR repository)
251 char[] password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
252 if (password
!= null) {
253 ServiceReference
<CryptoKeyring
> keyringSr
= bc
.getServiceReference(CryptoKeyring
.class);
254 if (keyringSr
!= null) {
255 CryptoKeyring keyring
= bc
.getService(keyringSr
);
256 Subject
.doAs(subject
, new PrivilegedAction
<Void
>() {
261 keyring
.unlock(password
);
262 } catch (Exception e
) {
264 log
.warn("Could not unlock keyring with the password provided by " + authorization
.getName()
265 + ": " + e
.getMessage());
274 // Register CmsSession with initial subject
275 CmsAuthUtils
.registerSessionAuthorization(request
, subject
, authorization
, locale
);
277 if (log
.isDebugEnabled())
278 log
.debug("Logged in to CMS: " + subject
);
283 public boolean abort() throws LoginException
{
288 public boolean logout() throws LoginException
{
289 if (log
.isTraceEnabled())
290 log
.trace("Logging out from CMS... " + subject
);
291 CmsAuthUtils
.cleanUp(subject
);
295 protected User
searchForUser(UserAdmin userAdmin
, String providedUsername
) {
297 // TODO check value null or empty
298 Set
<User
> collectedUsers
= new HashSet
<>();
303 for (String attr
: indexedUserProperties
) {
304 user
= userAdmin
.getUser(attr
, providedUsername
);
306 collectedUsers
.add(user
);
308 if (collectedUsers
.size() == 1) {
309 user
= collectedUsers
.iterator().next();
311 } else if (collectedUsers
.size() > 1) {
312 log
.warn(collectedUsers
.size() + " users for provided username" + providedUsername
);
314 // try DN as a last resort
316 user
= (User
) userAdmin
.getRole(providedUsername
);
319 } catch (Exception e
) {
323 } catch (Exception e
) {
324 if (log
.isTraceEnabled())
325 log
.warn("Cannot search for user " + providedUsername
, e
);
331 protected Group
searchForToken(UserAdmin userAdmin
, String token
) {
332 String dn
= cn
+ "=" + token
+ "," + CmsConstants
.TOKENS_BASEDN
;
333 Group tokenGroup
= (Group
) userAdmin
.getRole(dn
);
337 protected Authorization
getAuthorizationFromToken(UserAdmin userAdmin
, Group tokenGroup
) {
338 if (TokenUtils
.isExpired(tokenGroup
))
340 // String expiryDateStr = (String) tokenGroup.getProperties().get(description.name());
341 // if (expiryDateStr != null) {
342 // Instant expiryDate = NamingUtils.ldapDateToInstant(expiryDateStr);
343 // if (expiryDate.isBefore(Instant.now())) {
344 // if (log.isDebugEnabled())
345 // log.debug("Token " + tokenGroup.getName() + " has expired.");
349 String userDn
= TokenUtils
.userDn(tokenGroup
);
350 User user
= (User
) userAdmin
.getRole(userDn
);
351 Authorization auth
= userAdmin
.getAuthorization(user
);