1 package org
.argeo
.cms
.auth
;
3 import static org
.argeo
.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
;
26 import javax
.servlet
.http
.HttpServletRequest
;
28 import org
.apache
.commons
.logging
.Log
;
29 import org
.apache
.commons
.logging
.LogFactory
;
30 import org
.argeo
.api
.NodeConstants
;
31 import org
.argeo
.api
.security
.CryptoKeyring
;
32 import org
.argeo
.cms
.internal
.kernel
.Activator
;
33 import org
.argeo
.naming
.LdapAttrs
;
34 import org
.argeo
.osgi
.useradmin
.AuthenticatingUser
;
35 import org
.argeo
.osgi
.useradmin
.IpaUtils
;
36 import org
.argeo
.osgi
.useradmin
.OsUserUtils
;
37 import org
.argeo
.osgi
.useradmin
.TokenUtils
;
38 import org
.osgi
.framework
.BundleContext
;
39 import org
.osgi
.framework
.FrameworkUtil
;
40 import org
.osgi
.framework
.ServiceReference
;
41 import org
.osgi
.service
.useradmin
.Authorization
;
42 import org
.osgi
.service
.useradmin
.Group
;
43 import org
.osgi
.service
.useradmin
.User
;
44 import org
.osgi
.service
.useradmin
.UserAdmin
;
47 * Use the {@link UserAdmin} in the OSGi registry as the basis for
50 public class UserAdminLoginModule
implements LoginModule
{
51 private final static Log log
= LogFactory
.getLog(UserAdminLoginModule
.class);
53 private Subject subject
;
54 private CallbackHandler callbackHandler
;
55 private Map
<String
, Object
> sharedState
= null;
57 private List
<String
> indexedUserProperties
= Arrays
58 .asList(new String
[] { LdapAttrs
.mail
.name(), LdapAttrs
.uid
.name(), LdapAttrs
.authPassword
.name() });
61 private BundleContext bc
;
62 private User authenticatedUser
= null;
63 private Locale locale
;
65 private Authorization bindAuthorization
= null;
67 private boolean singleUser
= Activator
.isSingleUser();
69 @SuppressWarnings("unchecked")
71 public void initialize(Subject subject
, CallbackHandler callbackHandler
, Map
<String
, ?
> sharedState
,
72 Map
<String
, ?
> options
) {
73 this.subject
= subject
;
75 bc
= FrameworkUtil
.getBundle(UserAdminLoginModule
.class).getBundleContext();
76 this.callbackHandler
= callbackHandler
;
77 this.sharedState
= (Map
<String
, Object
>) sharedState
;
78 } catch (Exception e
) {
79 throw new IllegalStateException("Cannot initialize login module", e
);
84 public boolean login() throws LoginException
{
85 UserAdmin userAdmin
= Activator
.getUserAdmin();
86 final String username
;
87 final char[] password
;
88 Object certificateChain
= null;
89 boolean preauth
= false;
90 if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
91 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_PWD
)) {
92 // NB: required by Basic http auth
93 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
94 password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
96 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
97 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
)) {
98 String certDn
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
101 // ldapName = new LdapName(certificateName);
102 // } catch (InvalidNameException e) {
103 // e.printStackTrace();
106 // username = ldapName.getRdn(ldapName.size() - 1).getValue().toString();
108 certificateChain
= sharedState
.get(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
);
110 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
111 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_ADDR
)
112 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_PORT
)) {// ident
113 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
116 } else if (singleUser
) {
117 username
= OsUserUtils
.getOsUsername();
119 // TODO retrieve from http session
120 locale
= Locale
.getDefault();
123 // ask for username and password
124 NameCallback nameCallback
= new NameCallback("User");
125 PasswordCallback passwordCallback
= new PasswordCallback("Password", false);
126 LanguageCallback langCallback
= new LanguageCallback();
128 callbackHandler
.handle(new Callback
[] { nameCallback
, passwordCallback
, langCallback
});
129 } catch (IOException e
) {
130 throw new LoginException("Cannot handle callback: " + e
.getMessage());
131 } catch (UnsupportedCallbackException e
) {
136 locale
= langCallback
.getLocale();
138 locale
= Locale
.getDefault();
139 // FIXME add it to Subject
140 // Locale.setDefault(locale);
142 username
= nameCallback
.getName();
143 if (username
== null || username
.trim().equals("")) {
144 // authorization = userAdmin.getAuthorization(null);
145 throw new CredentialNotFoundException("No credentials provided");
147 if (passwordCallback
.getPassword() != null)
148 password
= passwordCallback
.getPassword();
150 throw new CredentialNotFoundException("No credentials provided");
151 sharedState
.put(CmsAuthUtils
.SHARED_STATE_NAME
, username
);
152 sharedState
.put(CmsAuthUtils
.SHARED_STATE_PWD
, password
);
154 User user
= searchForUser(userAdmin
, username
);
158 String token
= username
;
159 Group tokenGroup
= searchForToken(userAdmin
, token
);
160 if (tokenGroup
!= null) {
161 Authorization tokenAuthorization
= getAuthorizationFromToken(userAdmin
, tokenGroup
);
162 if (tokenAuthorization
!= null) {
163 bindAuthorization
= tokenAuthorization
;
164 authenticatedUser
= (User
) userAdmin
.getRole(bindAuthorization
.getName());
171 return true;// expect Kerberos
173 if (password
!= null) {
176 AuthenticatingUser authenticatingUser
= new AuthenticatingUser(user
.getName(), password
);
177 bindAuthorization
= userAdmin
.getAuthorization(authenticatingUser
);
178 // TODO check tokens as well
179 if (bindAuthorization
!= null) {
180 authenticatedUser
= user
;
183 } catch (Exception e
) {
185 if (log
.isTraceEnabled())
186 log
.trace("Bind failed", e
);
189 // works only if a connection password is provided
190 if (!user
.hasCredential(null, password
)) {
193 } else if (certificateChain
!= null) {
194 // TODO check CRLs/OSCP validity?
195 // NB: authorization in commit() will work only if an LDAP connection password
197 } else if (singleUser
) {
198 // TODO verify IP address?
199 } else if (preauth
) {
202 throw new CredentialNotFoundException("No credentials provided");
205 authenticatedUser
= user
;
210 public boolean commit() throws LoginException
{
212 subject
.getPublicCredentials().add(locale
);
215 OsUserUtils
.loginAsSystemUser(subject
);
217 UserAdmin userAdmin
= Activator
.getUserAdmin();
218 Authorization authorization
;
219 if (callbackHandler
== null) {// anonymous
220 authorization
= userAdmin
.getAuthorization(null);
221 } else if (bindAuthorization
!= null) {// bind
222 authorization
= bindAuthorization
;
224 User authenticatingUser
;
225 Set
<KerberosPrincipal
> kerberosPrincipals
= subject
.getPrincipals(KerberosPrincipal
.class);
226 if (kerberosPrincipals
.isEmpty()) {
227 if (authenticatedUser
== null) {
228 if (log
.isTraceEnabled())
229 log
.trace("Neither kerberos nor user admin login succeeded. Login failed.");
230 throw new CredentialNotFoundException("Bad credentials.");
232 authenticatingUser
= authenticatedUser
;
235 KerberosPrincipal kerberosPrincipal
= kerberosPrincipals
.iterator().next();
236 LdapName dn
= IpaUtils
.kerberosToDn(kerberosPrincipal
.getName());
237 authenticatingUser
= new AuthenticatingUser(dn
);
238 if (authenticatedUser
!= null && !authenticatingUser
.getName().equals(authenticatedUser
.getName()))
239 throw new LoginException("Kerberos login " + authenticatingUser
.getName()
240 + " is inconsistent with user admin login " + authenticatedUser
.getName());
242 authorization
= Subject
.doAs(subject
, new PrivilegedAction
<Authorization
>() {
245 public Authorization
run() {
246 Authorization authorization
= userAdmin
.getAuthorization(authenticatingUser
);
247 return authorization
;
251 if (authorization
== null)
252 throw new LoginException(
253 "User admin found no authorization for authenticated user " + authenticatingUser
.getName());
256 // Log and monitor new login
257 HttpServletRequest request
= (HttpServletRequest
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_HTTP_REQUEST
);
258 CmsAuthUtils
.addAuthorization(subject
, authorization
);
260 // Unlock keyring (underlying login to the JCR repository)
261 char[] password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
262 if (password
!= null) {
263 ServiceReference
<CryptoKeyring
> keyringSr
= bc
.getServiceReference(CryptoKeyring
.class);
264 if (keyringSr
!= null) {
265 CryptoKeyring keyring
= bc
.getService(keyringSr
);
266 Subject
.doAs(subject
, new PrivilegedAction
<Void
>() {
271 keyring
.unlock(password
);
272 } catch (Exception e
) {
274 log
.warn("Could not unlock keyring with the password provided by " + authorization
.getName()
275 + ": " + e
.getMessage());
284 // Register CmsSession with initial subject
285 CmsAuthUtils
.registerSessionAuthorization(request
, subject
, authorization
, locale
);
287 if (log
.isDebugEnabled())
288 log
.debug("Logged in to CMS: " + subject
);
293 public boolean abort() throws LoginException
{
298 public boolean logout() throws LoginException
{
299 if (log
.isTraceEnabled())
300 log
.trace("Logging out from CMS... " + subject
);
301 CmsAuthUtils
.cleanUp(subject
);
305 protected User
searchForUser(UserAdmin userAdmin
, String providedUsername
) {
307 // TODO check value null or empty
308 Set
<User
> collectedUsers
= new HashSet
<>();
312 for (String attr
: indexedUserProperties
) {
313 user
= userAdmin
.getUser(attr
, providedUsername
);
315 collectedUsers
.add(user
);
317 if (collectedUsers
.size() == 1) {
318 user
= collectedUsers
.iterator().next();
320 } else if (collectedUsers
.size() > 1) {
321 log
.warn(collectedUsers
.size() + " users for provided username" + providedUsername
);
323 // try DN as a last resort
325 user
= (User
) userAdmin
.getRole(providedUsername
);
328 } catch (Exception e
) {
332 } catch (Exception e
) {
333 if (log
.isTraceEnabled())
334 log
.warn("Cannot search for user " + providedUsername
, e
);
340 protected Group
searchForToken(UserAdmin userAdmin
, String token
) {
341 String dn
= cn
+ "=" + token
+ "," + NodeConstants
.TOKENS_BASEDN
;
342 Group tokenGroup
= (Group
) userAdmin
.getRole(dn
);
346 protected Authorization
getAuthorizationFromToken(UserAdmin userAdmin
, Group tokenGroup
) {
347 if (TokenUtils
.isExpired(tokenGroup
))
349 // String expiryDateStr = (String) tokenGroup.getProperties().get(description.name());
350 // if (expiryDateStr != null) {
351 // Instant expiryDate = NamingUtils.ldapDateToInstant(expiryDateStr);
352 // if (expiryDate.isBefore(Instant.now())) {
353 // if (log.isDebugEnabled())
354 // log.debug("Token " + tokenGroup.getName() + " has expired.");
358 String userDn
= TokenUtils
.userDn(tokenGroup
);
359 User user
= (User
) userAdmin
.getRole(userDn
);
360 Authorization auth
= userAdmin
.getAuthorization(user
);