]> git.argeo.org Git - lgpl/argeo-commons.git/blob - org.argeo.cms/src/org/argeo/cms/auth/CmsAuthUtils.java
Improve documentation
[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / auth / CmsAuthUtils.java
1 package org.argeo.cms.auth;
2
3 import java.security.Principal;
4 import java.util.Locale;
5 import java.util.Set;
6 import java.util.UUID;
7
8 import javax.naming.InvalidNameException;
9 import javax.naming.ldap.LdapName;
10 import javax.security.auth.Subject;
11 import javax.security.auth.x500.X500Principal;
12 import javax.servlet.http.HttpServletRequest;
13 import javax.servlet.http.HttpSession;
14
15 //import org.apache.jackrabbit.core.security.AnonymousPrincipal;
16 //import org.apache.jackrabbit.core.security.SecurityConstants;
17 //import org.apache.jackrabbit.core.security.principal.AdminPrincipal;
18 import org.argeo.cms.CmsException;
19 import org.argeo.cms.internal.auth.CmsSessionImpl;
20 import org.argeo.cms.internal.auth.ImpliedByPrincipal;
21 import org.argeo.cms.internal.http.WebCmsSessionImpl;
22 import org.argeo.node.NodeConstants;
23 import org.argeo.node.security.AnonymousPrincipal;
24 import org.argeo.node.security.DataAdminPrincipal;
25 import org.argeo.node.security.NodeSecurityUtils;
26 import org.osgi.service.http.HttpContext;
27 import org.osgi.service.useradmin.Authorization;
28
29 class CmsAuthUtils {
30 /** Shared HTTP request */
31 final static String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
32 /** From org.osgi.service.http.HttpContext */
33 // final static String SHARED_STATE_AUTHORIZATION =
34 // "org.osgi.service.useradmin.authorization";
35 /** From com.sun.security.auth.module.*LoginModule */
36 final static String SHARED_STATE_NAME = "javax.security.auth.login.name";
37 /** From com.sun.security.auth.module.*LoginModule */
38 final static String SHARED_STATE_PWD = "javax.security.auth.login.password";
39
40 final static String SHARED_STATE_SPNEGO_TOKEN = "org.argeo.cms.auth.spnegoToken";
41 final static String SHARED_STATE_SPNEGO_OUT_TOKEN = "org.argeo.cms.auth.spnegoOutToken";
42
43 final static String HEADER_AUTHORIZATION = "Authorization";
44 final static String HEADER_WWW_AUTHENTICATE = "WWW-Authenticate";
45
46 static void addAuthorization(Subject subject, Authorization authorization, Locale locale,
47 HttpServletRequest request) {
48 assert subject != null;
49 checkSubjectEmpty(subject);
50 assert authorization != null;
51
52 // required for display name:
53 subject.getPrivateCredentials().add(authorization);
54
55 Set<Principal> principals = subject.getPrincipals();
56 try {
57 String authName = authorization.getName();
58
59 // determine user's principal
60 final LdapName name;
61 final Principal userPrincipal;
62 if (authName == null) {
63 name = NodeSecurityUtils.ROLE_ANONYMOUS_NAME;
64 userPrincipal = new AnonymousPrincipal();
65 principals.add(userPrincipal);
66 // principals.add(new AnonymousPrincipal());
67 } else {
68 name = new LdapName(authName);
69 NodeSecurityUtils.checkUserName(name);
70 userPrincipal = new X500Principal(name.toString());
71 principals.add(userPrincipal);
72 principals.add(new ImpliedByPrincipal(NodeSecurityUtils.ROLE_USER_NAME, userPrincipal));
73 }
74
75 // Add roles provided by authorization
76 for (String role : authorization.getRoles()) {
77 LdapName roleName = new LdapName(role);
78 if (roleName.equals(name)) {
79 // skip
80 } else {
81 NodeSecurityUtils.checkImpliedPrincipalName(roleName);
82 principals.add(new ImpliedByPrincipal(roleName.toString(), userPrincipal));
83 if (roleName.equals(NodeSecurityUtils.ROLE_ADMIN_NAME))
84 principals.add(new DataAdminPrincipal());
85 }
86 }
87
88 } catch (InvalidNameException e) {
89 throw new CmsException("Cannot commit", e);
90 }
91
92 registerSessionAuthorization(request, subject, authorization, locale);
93 }
94
95 private static void checkSubjectEmpty(Subject subject) {
96 if (!subject.getPrincipals(AnonymousPrincipal.class).isEmpty())
97 throw new IllegalStateException("Already logged in as anonymous: " + subject);
98 if (!subject.getPrincipals(X500Principal.class).isEmpty())
99 throw new IllegalStateException("Already logged in as user: " + subject);
100 if (!subject.getPrincipals(DataAdminPrincipal.class).isEmpty())
101 throw new IllegalStateException("Already logged in as data admin: " + subject);
102 if (!subject.getPrincipals(ImpliedByPrincipal.class).isEmpty())
103 throw new IllegalStateException("Already authorized: " + subject);
104 }
105
106 static void cleanUp(Subject subject) {
107 // Argeo
108 subject.getPrincipals().removeAll(subject.getPrincipals(X500Principal.class));
109 subject.getPrincipals().removeAll(subject.getPrincipals(ImpliedByPrincipal.class));
110 subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
111 subject.getPrincipals().removeAll(subject.getPrincipals(DataAdminPrincipal.class));
112
113 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(CmsSessionId.class));
114 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(Authorization.class));
115 // Jackrabbit
116 // subject.getPrincipals().removeAll(subject.getPrincipals(AdminPrincipal.class));
117 // subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
118 }
119
120 private synchronized static void registerSessionAuthorization(HttpServletRequest request, Subject subject,
121 Authorization authorization, Locale locale) {
122 // synchronized in order to avoid multiple registrations
123 // TODO move it to a service in order to avoid static synchronization
124 if (request != null) {
125 HttpSession httpSession = request.getSession(false);
126 assert httpSession != null;
127 String httpSessId = httpSession.getId();
128 String remoteUser = authorization.getName() != null ? authorization.getName()
129 : NodeConstants.ROLE_ANONYMOUS;
130 request.setAttribute(HttpContext.REMOTE_USER, remoteUser);
131 request.setAttribute(HttpContext.AUTHORIZATION, authorization);
132
133 CmsSessionImpl cmsSession = CmsSessionImpl.getByLocalId(httpSessId);
134 if (cmsSession != null) {
135 if (authorization.getName() != null) {
136 if (cmsSession.getAuthorization().getName() == null) {
137 cmsSession.close();
138 cmsSession = null;
139 } else if (!authorization.getName().equals(cmsSession.getAuthorization().getName())) {
140 throw new CmsException("Inconsistent user " + authorization.getName()
141 + " for existing CMS session " + cmsSession);
142 }
143 } else {// anonymous
144 if (cmsSession.getAuthorization().getName() != null) {
145 cmsSession.close();
146 // TODO rather throw an exception ? log a warning ?
147 cmsSession = null;
148 }
149 }
150 }
151
152 if (cmsSession == null)
153 cmsSession = new WebCmsSessionImpl(subject, authorization, locale, request);
154 // request.setAttribute(CmsSession.class.getName(), cmsSession);
155 CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
156 if (subject.getPrivateCredentials(CmsSessionId.class).size() == 0)
157 subject.getPrivateCredentials().add(nodeSessionId);
158 else {
159 UUID storedSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next().getUuid();
160 // if (storedSessionId.equals(httpSessionId.getValue()))
161 throw new CmsException(
162 "Subject already logged with session " + storedSessionId + " (not " + nodeSessionId + ")");
163 }
164 } else {
165 // TODO desktop, CLI
166 }
167 }
168
169 public static <T extends Principal> T getSinglePrincipal(Subject subject, Class<T> clss) {
170 Set<T> principals = subject.getPrincipals(clss);
171 if (principals.isEmpty())
172 return null;
173 if (principals.size() > 1)
174 throw new IllegalStateException("Only one " + clss + " principal expected in " + subject);
175 return principals.iterator().next();
176 }
177
178 private CmsAuthUtils() {
179
180 }
181
182 }