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
.cms
.CmsException
;
31 import org
.argeo
.cms
.internal
.kernel
.Activator
;
32 import org
.argeo
.naming
.LdapAttrs
;
33 import org
.argeo
.node
.NodeConstants
;
34 import org
.argeo
.node
.security
.CryptoKeyring
;
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 public class UserAdminLoginModule
implements LoginModule
{
48 private final static Log log
= LogFactory
.getLog(UserAdminLoginModule
.class);
50 private Subject subject
;
51 private CallbackHandler callbackHandler
;
52 private Map
<String
, Object
> sharedState
= null;
54 private List
<String
> indexedUserProperties
= Arrays
55 .asList(new String
[] { LdapAttrs
.mail
.name(), LdapAttrs
.uid
.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 CmsException("Cannot initialize login module", e
);
81 public boolean login() throws LoginException
{
82 UserAdmin userAdmin
= Activator
.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_CERTIFICATE_CHAIN
)) {
95 String certDn
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
98 // ldapName = new LdapName(certificateName);
99 // } catch (InvalidNameException e) {
100 // e.printStackTrace();
103 // username = ldapName.getRdn(ldapName.size() - 1).getValue().toString();
105 certificateChain
= sharedState
.get(CmsAuthUtils
.SHARED_STATE_CERTIFICATE_CHAIN
);
107 } else if (sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_NAME
)
108 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_ADDR
)
109 && sharedState
.containsKey(CmsAuthUtils
.SHARED_STATE_REMOTE_PORT
)) {// ident
110 username
= (String
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_NAME
);
113 } else if (singleUser
) {
114 username
= OsUserUtils
.getOsUsername();
118 // ask for username and password
119 NameCallback nameCallback
= new NameCallback("User");
120 PasswordCallback passwordCallback
= new PasswordCallback("Password", false);
121 LanguageCallback langCallback
= new LanguageCallback();
123 callbackHandler
.handle(new Callback
[] { nameCallback
, passwordCallback
, langCallback
});
124 } catch (IOException e
) {
125 throw new LoginException("Cannot handle callback: " + e
.getMessage());
126 } catch (UnsupportedCallbackException e
) {
131 locale
= langCallback
.getLocale();
133 locale
= Locale
.getDefault();
134 // FIXME add it to Subject
135 // Locale.setDefault(locale);
137 username
= nameCallback
.getName();
138 if (username
== null || username
.trim().equals("")) {
139 // authorization = userAdmin.getAuthorization(null);
140 throw new CredentialNotFoundException("No credentials provided");
142 if (passwordCallback
.getPassword() != null)
143 password
= passwordCallback
.getPassword();
145 throw new CredentialNotFoundException("No credentials provided");
146 sharedState
.put(CmsAuthUtils
.SHARED_STATE_NAME
, username
);
147 sharedState
.put(CmsAuthUtils
.SHARED_STATE_PWD
, password
);
149 User user
= searchForUser(userAdmin
, username
);
153 String token
= username
;
154 Group tokenGroup
= searchForToken(userAdmin
, token
);
155 if (tokenGroup
!= null) {
156 Authorization tokenAuthorization
= getAuthorizationFromToken(userAdmin
, tokenGroup
);
157 if (tokenAuthorization
!= null) {
158 bindAuthorization
= tokenAuthorization
;
159 authenticatedUser
= (User
) userAdmin
.getRole(bindAuthorization
.getName());
166 return true;// expect Kerberos
168 if (password
!= null) {
171 AuthenticatingUser authenticatingUser
= new AuthenticatingUser(user
.getName(), password
);
172 bindAuthorization
= userAdmin
.getAuthorization(authenticatingUser
);
173 // TODO check tokens as well
174 if (bindAuthorization
!= null) {
175 authenticatedUser
= user
;
178 } catch (Exception e
) {
180 if (log
.isTraceEnabled())
181 log
.trace("Bind failed", e
);
184 // works only if a connection password is provided
185 if (!user
.hasCredential(null, password
)) {
188 } else if (certificateChain
!= null) {
189 // TODO check CRLs/OSCP validity?
190 // NB: authorization in commit() will work only if an LDAP connection password
192 } else if (singleUser
) {
193 // TODO verify IP address?
194 } else if (preauth
) {
197 throw new CredentialNotFoundException("No credentials provided");
200 authenticatedUser
= user
;
205 public boolean commit() throws LoginException
{
207 subject
.getPublicCredentials().add(Locale
.getDefault());
209 subject
.getPublicCredentials().add(locale
);
212 OsUserUtils
.loginAsSystemUser(subject
);
214 UserAdmin userAdmin
= Activator
.getUserAdmin();
215 Authorization authorization
;
216 if (callbackHandler
== null) {// anonymous
217 authorization
= userAdmin
.getAuthorization(null);
218 } else if (bindAuthorization
!= null) {// bind
219 authorization
= bindAuthorization
;
221 User authenticatingUser
;
222 Set
<KerberosPrincipal
> kerberosPrincipals
= subject
.getPrincipals(KerberosPrincipal
.class);
223 if (kerberosPrincipals
.isEmpty()) {
224 if (authenticatedUser
== null) {
225 if (log
.isTraceEnabled())
226 log
.trace("Neither kerberos nor user admin login succeeded. Login failed.");
229 authenticatingUser
= authenticatedUser
;
232 KerberosPrincipal kerberosPrincipal
= kerberosPrincipals
.iterator().next();
233 LdapName dn
= IpaUtils
.kerberosToDn(kerberosPrincipal
.getName());
234 authenticatingUser
= new AuthenticatingUser(dn
);
235 if (authenticatedUser
!= null && !authenticatingUser
.getName().equals(authenticatedUser
.getName()))
236 throw new LoginException("Kerberos login " + authenticatingUser
.getName()
237 + " is inconsistent with user admin login " + authenticatedUser
.getName());
239 authorization
= Subject
.doAs(subject
, new PrivilegedAction
<Authorization
>() {
242 public Authorization
run() {
243 Authorization authorization
= userAdmin
.getAuthorization(authenticatingUser
);
244 return authorization
;
248 if (authorization
== null)
249 throw new LoginException(
250 "User admin found no authorization for authenticated user " + authenticatingUser
.getName());
253 // Log and monitor new login
254 HttpServletRequest request
= (HttpServletRequest
) sharedState
.get(CmsAuthUtils
.SHARED_STATE_HTTP_REQUEST
);
255 CmsAuthUtils
.addAuthorization(subject
, authorization
);
257 // Unlock keyring (underlying login to the JCR repository)
258 char[] password
= (char[]) sharedState
.get(CmsAuthUtils
.SHARED_STATE_PWD
);
259 if (password
!= null) {
260 ServiceReference
<CryptoKeyring
> keyringSr
= bc
.getServiceReference(CryptoKeyring
.class);
261 if (keyringSr
!= null) {
262 CryptoKeyring keyring
= bc
.getService(keyringSr
);
263 Subject
.doAs(subject
, new PrivilegedAction
<Void
>() {
268 keyring
.unlock(password
);
269 } catch (Exception e
) {
271 log
.warn("Could not unlock keyring with the password provided by " + authorization
.getName()
272 + ": " + e
.getMessage());
281 // Register CmsSession with initial subject
282 CmsAuthUtils
.registerSessionAuthorization(request
, subject
, authorization
, locale
);
284 if (log
.isDebugEnabled())
285 log
.debug("Logged in to CMS: " + subject
);
290 public boolean abort() throws LoginException
{
295 public boolean logout() throws LoginException
{
296 if (log
.isTraceEnabled())
297 log
.trace("Logging out from CMS... " + subject
);
298 // boolean httpSessionLogoutOk = CmsAuthUtils.logoutSession(bc,
300 CmsAuthUtils
.cleanUp(subject
);
304 protected User
searchForUser(UserAdmin userAdmin
, String providedUsername
) {
306 // TODO check value null or empty
307 Set
<User
> collectedUsers
= new HashSet
<>();
311 for (String attr
: indexedUserProperties
) {
312 user
= userAdmin
.getUser(attr
, providedUsername
);
314 collectedUsers
.add(user
);
316 if (collectedUsers
.size() == 1) {
317 user
= collectedUsers
.iterator().next();
319 } else if (collectedUsers
.size() > 1) {
320 log
.warn(collectedUsers
.size() + " users for provided username" + providedUsername
);
322 // try DN as a last resort
324 user
= (User
) userAdmin
.getRole(providedUsername
);
327 } catch (Exception e
) {
331 } catch (Exception e
) {
332 if (log
.isTraceEnabled())
333 log
.warn("Cannot search for user " + providedUsername
, e
);
339 protected Group
searchForToken(UserAdmin userAdmin
, String token
) {
340 String dn
= cn
+ "=" + token
+ "," + NodeConstants
.TOKENS_BASEDN
;
341 Group tokenGroup
= (Group
) userAdmin
.getRole(dn
);
345 protected Authorization
getAuthorizationFromToken(UserAdmin userAdmin
, Group tokenGroup
) {
346 if (TokenUtils
.isExpired(tokenGroup
))
348 // String expiryDateStr = (String) tokenGroup.getProperties().get(description.name());
349 // if (expiryDateStr != null) {
350 // Instant expiryDate = NamingUtils.ldapDateToInstant(expiryDateStr);
351 // if (expiryDate.isBefore(Instant.now())) {
352 // if (log.isDebugEnabled())
353 // log.debug("Token " + tokenGroup.getName() + " has expired.");
357 Authorization auth
= userAdmin
.getAuthorization(tokenGroup
);