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
.CmsException
;
33 import org
.argeo
.cms
.internal
.kernel
.Activator
;
34 import org
.argeo
.naming
.LdapAttrs
;
35 import org
.argeo
.osgi
.useradmin
.AuthenticatingUser
;
36 import org
.argeo
.osgi
.useradmin
.IpaUtils
;
37 import org
.argeo
.osgi
.useradmin
.OsUserUtils
;
38 import org
.argeo
.osgi
.useradmin
.TokenUtils
;
39 import org
.osgi
.framework
.BundleContext
;
40 import org
.osgi
.framework
.FrameworkUtil
;
41 import org
.osgi
.framework
.ServiceReference
;
42 import org
.osgi
.service
.useradmin
.Authorization
;
43 import org
.osgi
.service
.useradmin
.Group
;
44 import org
.osgi
.service
.useradmin
.User
;
45 import org
.osgi
.service
.useradmin
.UserAdmin
;
47 /** Use the {@link UserAdmin} in the OSGi registry as the basis for authentication.*/
48 public class UserAdminLoginModule
implements LoginModule
{
49 private final static Log log
= LogFactory
.getLog(UserAdminLoginModule
.class);
51 private Subject subject
;
52 private CallbackHandler callbackHandler
;
53 private Map
<String
, Object
> sharedState
= null;
55 private List
<String
> indexedUserProperties
= Arrays
56 .asList(new String
[] { LdapAttrs
.mail
.name(), LdapAttrs
.uid
.name(), LdapAttrs
.authPassword
.name() });
59 private BundleContext bc
;
60 private User authenticatedUser
= null;
61 private Locale locale
;
63 private Authorization bindAuthorization
= null;
65 private boolean singleUser
= Activator
.isSingleUser();
67 @SuppressWarnings("unchecked")
69 public void initialize(Subject subject
, CallbackHandler callbackHandler
, Map
<String
, ?
> sharedState
,
70 Map
<String
, ?
> options
) {
71 this.subject
= subject
;
73 bc
= FrameworkUtil
.getBundle(UserAdminLoginModule
.class).getBundleContext();
74 this.callbackHandler
= callbackHandler
;
75 this.sharedState
= (Map
<String
, Object
>) sharedState
;
76 } catch (Exception e
) {
77 throw new CmsException("Cannot initialize login module", e
);
82 public boolean login() throws LoginException
{
83 UserAdmin userAdmin
= Activator
.getUserAdmin();
84 final String username
;
85 final char[] password
;
86 Object certificateChain
= null;
87 boolean preauth
= false;
88 if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
89 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_PWD
)) {
90 // NB: required by Basic http auth
91 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
92 password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
94 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
95 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
)) {
96 String certDn
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
99 // ldapName = new LdapName(certificateName);
100 // } catch (InvalidNameException e) {
101 // e.printStackTrace();
104 // username = ldapName.getRdn(ldapName.size() - 1).getValue().toString();
106 certificateChain
= sharedState
.get(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
);
108 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
109 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_ADDR
)
110 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_PORT
)) {// ident
111 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
114 } else if (singleUser
) {
115 username
= OsUserUtils
.getOsUsername();
119 // ask for username and password
120 NameCallback nameCallback
= new NameCallback("User");
121 PasswordCallback passwordCallback
= new PasswordCallback("Password", false);
122 LanguageCallback langCallback
= new LanguageCallback();
124 callbackHandler
.handle(new Callback
[] { nameCallback
, passwordCallback
, langCallback
});
125 } catch (IOException e
) {
126 throw new LoginException("Cannot handle callback: " + e
.getMessage());
127 } catch (UnsupportedCallbackException e
) {
132 locale
= langCallback
.getLocale();
134 locale
= Locale
.getDefault();
135 // FIXME add it to Subject
136 // Locale.setDefault(locale);
138 username
= nameCallback
.getName();
139 if (username
== null || username
.trim().equals("")) {
140 // authorization = userAdmin.getAuthorization(null);
141 throw new CredentialNotFoundException("No credentials provided");
143 if (passwordCallback
.getPassword() != null)
144 password
= passwordCallback
.getPassword();
146 throw new CredentialNotFoundException("No credentials provided");
147 sharedState
.put(CmsAuthUtils
.SHARED_STATE_NAME
, username
);
148 sharedState
.put(CmsAuthUtils
.SHARED_STATE_PWD
, password
);
150 User user
= searchForUser(userAdmin
, username
);
154 String token
= username
;
155 Group tokenGroup
= searchForToken(userAdmin
, token
);
156 if (tokenGroup
!= null) {
157 Authorization tokenAuthorization
= getAuthorizationFromToken(userAdmin
, tokenGroup
);
158 if (tokenAuthorization
!= null) {
159 bindAuthorization
= tokenAuthorization
;
160 authenticatedUser
= (User
) userAdmin
.getRole(bindAuthorization
.getName());
167 return true;// expect Kerberos
169 if (password
!= null) {
172 AuthenticatingUser authenticatingUser
= new AuthenticatingUser(user
.getName(), password
);
173 bindAuthorization
= userAdmin
.getAuthorization(authenticatingUser
);
174 // TODO check tokens as well
175 if (bindAuthorization
!= null) {
176 authenticatedUser
= user
;
179 } catch (Exception e
) {
181 if (log
.isTraceEnabled())
182 log
.trace("Bind failed", e
);
185 // works only if a connection password is provided
186 if (!user
.hasCredential(null, password
)) {
189 } else if (certificateChain
!= null) {
190 // TODO check CRLs/OSCP validity?
191 // NB: authorization in commit() will work only if an LDAP connection password
193 } else if (singleUser
) {
194 // TODO verify IP address?
195 } else if (preauth
) {
198 throw new CredentialNotFoundException("No credentials provided");
201 authenticatedUser
= user
;
206 public boolean commit() throws LoginException
{
208 subject
.getPublicCredentials().add(Locale
.getDefault());
210 subject
.getPublicCredentials().add(locale
);
213 OsUserUtils
.loginAsSystemUser(subject
);
215 UserAdmin userAdmin
= Activator
.getUserAdmin();
216 Authorization authorization
;
217 if (callbackHandler
== null) {// anonymous
218 authorization
= userAdmin
.getAuthorization(null);
219 } else if (bindAuthorization
!= null) {// bind
220 authorization
= bindAuthorization
;
222 User authenticatingUser
;
223 Set
<KerberosPrincipal
> kerberosPrincipals
= subject
.getPrincipals(KerberosPrincipal
.class);
224 if (kerberosPrincipals
.isEmpty()) {
225 if (authenticatedUser
== null) {
226 if (log
.isTraceEnabled())
227 log
.trace("Neither kerberos nor user admin login succeeded. Login failed.");
230 authenticatingUser
= authenticatedUser
;
233 KerberosPrincipal kerberosPrincipal
= kerberosPrincipals
.iterator().next();
234 LdapName dn
= IpaUtils
.kerberosToDn(kerberosPrincipal
.getName());
235 authenticatingUser
= new AuthenticatingUser(dn
);
236 if (authenticatedUser
!= null && !authenticatingUser
.getName().equals(authenticatedUser
.getName()))
237 throw new LoginException("Kerberos login " + authenticatingUser
.getName()
238 + " is inconsistent with user admin login " + authenticatedUser
.getName());
240 authorization
= Subject
.doAs(subject
, new PrivilegedAction
<Authorization
>() {
243 public Authorization
run() {
244 Authorization authorization
= userAdmin
.getAuthorization(authenticatingUser
);
245 return authorization
;
249 if (authorization
== null)
250 throw new LoginException(
251 "User admin found no authorization for authenticated user " + authenticatingUser
.getName());
254 // Log and monitor new login
255 HttpServletRequest request
= (HttpServletRequest
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_HTTP_REQUEST
);
256 CmsAuthUtils
.addAuthorization(subject
, authorization
);
258 // Unlock keyring (underlying login to the JCR repository)
259 char[] password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
260 if (password
!= null) {
261 ServiceReference
<CryptoKeyring
> keyringSr
= bc
.getServiceReference(CryptoKeyring
.class);
262 if (keyringSr
!= null) {
263 CryptoKeyring keyring
= bc
.getService(keyringSr
);
264 Subject
.doAs(subject
, new PrivilegedAction
<Void
>() {
269 keyring
.unlock(password
);
270 } catch (Exception e
) {
272 log
.warn("Could not unlock keyring with the password provided by " + authorization
.getName()
273 + ": " + e
.getMessage());
282 // Register CmsSession with initial subject
283 CmsAuthUtils
.registerSessionAuthorization(request
, subject
, authorization
, locale
);
285 if (log
.isDebugEnabled())
286 log
.debug("Logged in to CMS: " + subject
);
291 public boolean abort() throws LoginException
{
296 public boolean logout() throws LoginException
{
297 if (log
.isTraceEnabled())
298 log
.trace("Logging out from CMS... " + subject
);
299 // boolean httpSessionLogoutOk = CmsAuthUtils.logoutSession(bc,
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
);