View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.jaas.sp.jcr;
35  
36  import info.magnolia.cms.security.MgnlUser;
37  import info.magnolia.cms.security.MgnlUserManager;
38  import info.magnolia.cms.security.SecuritySupport;
39  import info.magnolia.cms.security.User;
40  import info.magnolia.cms.security.UserManager;
41  import info.magnolia.jaas.sp.AbstractLoginModule;
42  import info.magnolia.jaas.sp.UserAwareLoginModule;
43  
44  import java.io.Serializable;
45  import java.security.Principal;
46  import java.util.Collections;
47  import java.util.HashMap;
48  import java.util.Map;
49  
50  import javax.security.auth.login.AccountLockedException;
51  import javax.security.auth.login.AccountNotFoundException;
52  import javax.security.auth.login.FailedLoginException;
53  import javax.security.auth.login.LoginException;
54  
55  import org.apache.commons.codec.binary.Base64;
56  import org.apache.commons.lang.StringUtils;
57  import org.apache.jackrabbit.core.security.UserPrincipal;
58  import org.apache.jackrabbit.core.security.principal.AdminPrincipal;
59  
60  /**
61   * Authentication module implementation using JCR to retrieve the users.
62   * @version $Id: MagnoliaAuthenticationModule.java 45632 2011-05-28 12:46:32Z had $
63   */
64  // JR requires login module to be serializable!
65  public class MagnoliaAuthenticationModule extends AbstractLoginModule implements UserAwareLoginModule, Serializable {
66  
67      private static final boolean logAdmin = false;
68      protected User user;
69  
70      /**
71       * As silly as it seems this class sole purpose of existence is to implement Serializable required by JR itself.
72       * @author had
73       * @version $Id: JCRAuthenticationModule.java 45632 2011-05-28 12:46:32Z had $
74       */
75      public class MagnoliaJRAdminPrincipal extends AdminPrincipal implements Principal, Serializable {
76          public MagnoliaJRAdminPrincipal(String name) {
77              super(name);
78          }
79      }
80  
81      /**
82       * Checks is the credentials exist in the repository.
83       * @throws LoginException or specific subclasses (which will be handled further for user feedback)
84       */
85      @Override
86      public void validateUser() throws LoginException {
87          initUser();
88  
89          if (this.user == null) {
90              throw new AccountNotFoundException("User account " + this.name + " not found.");
91          }
92  
93          matchPassword();
94  
95          if (!this.user.isEnabled()) {
96              throw new AccountLockedException("User account " + this.name + " is locked.");
97          }
98  
99          if (!UserManager.ANONYMOUS_USER.equals(user.getName()) && !isAdmin()) {
100             // update last access date for all non anonymous users
101             getUserManager().updateLastAccessTimestamp(user);
102         }
103     }
104 
105     private UserManager getUserManager() {
106         // can't get the factory upfront and can't use IoC as this class is instantiated by JCR/JAAS before anything else is ready.
107         if (logAdmin || !"admin".equals(name)) {
108             log.debug("getting user manager for realm " + realm.getName());
109         }
110         return SecuritySupport.Factory.getInstance().getUserManager(realm.getName());
111     }
112 
113 
114 
115     protected void initUser() throws LoginException {
116         if (logAdmin || !"admin".equals(name)) {
117             log.debug("initializing user {}", name);
118         }
119         // we do not verify admin user, against our user base (which is in repo we are trying to access with this user), but we still check the password.
120         // This user has assigned no privileges, just dummy near empty user object (with name and pwd only).
121         if (isAdmin()) {
122             Map<String, String> props = new HashMap<String, String>();
123             //TODO: double check if we need to reset pwd here or if getAdminSession() is enough!!!
124             props.put(MgnlUserManager.PROPERTY_PASSWORD, new String(Base64.encodeBase64("admin".getBytes())));
125             MgnlUser user = new MgnlUser(name, null, Collections.EMPTY_LIST, Collections.EMPTY_LIST,props);
126             this.user = user;
127             // admin user is used by system and have no access to regular user stuff
128             return;
129         }
130 
131         long start = System.currentTimeMillis();
132         this.user = getUserManager().getUser(name);
133         if (logAdmin || !"admin".equals(name)) {
134             log.debug("initialized user {} in {}ms", name, (System.currentTimeMillis() - start));
135         }
136     }
137 
138     protected void matchPassword() throws LoginException {
139         String serverPassword = user.getPassword();
140 
141         if (StringUtils.isEmpty(serverPassword)) {
142             throw new FailedLoginException("we do not allow users with no password");
143         }
144 
145         if (!StringUtils.equals(serverPassword, new String(this.pswd))) {
146             throw new FailedLoginException("passwords do not match");
147         }
148     }
149 
150     /**
151      * Set user details.
152      */
153     @Override
154     public void setEntity() {
155         if (isAdmin()) {
156             // JR specific principal for repo only authentication. This part will be probably different per repo.
157             this.subject.getPrincipals().add(new MagnoliaJRAdminPrincipal(name));
158             // admin user is used by system and have no access to regular user stuff
159             return;
160         } else if ("superuser".equals(name)) {
161             // add admin principal also for our superuser to make sure system doesn't deny him any access
162             this.subject.getPrincipals().add(new MagnoliaJRAdminPrincipal(name));
163         } else {
164             // TODO: make JR dependency pluggable!!!
165             // and ordinary JR User principal for everybody else
166             this.subject.getPrincipals().add(new UserPrincipal(name));
167 
168         }
169 
170         // our user has our principal!!!!
171         this.subject.getPrincipals().add(this.user);
172         this.subject.getPrincipals().add(this.realm);
173 
174 
175         collectGroupNames();
176         collectRoleNames();
177     }
178 
179     private boolean isAdmin() {
180         // TODO: make admin user name configurable (read from properties)
181         return this.name != null && this.name.equals("admin");
182     }
183 
184     /**
185      * Set access control list from the user, roles and groups.
186      */
187     @Override
188     public void setACL() {
189     }
190 
191     /**
192      * Extract all the configured roles from the given node. (which can be the user node or a group node)
193      */
194     public void collectRoleNames() {
195         for (String role : this.user.getAllRoles()) {
196             addRoleName(role);
197         }
198     }
199 
200     /**
201      * Extract all the configured groups from the given node. (which can be the user node or a group node)
202      */
203     public void collectGroupNames() {
204         for (String group : this.user.getAllGroups()) {
205             addGroupName(group);
206         }
207     }
208 
209     @Override
210     public User getUser() {
211         return user;
212     }
213 }