/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.oak.security.user;
import java.io.UnsupportedEncodingException;
import java.security.NoSuchAlgorithmException;
import java.security.Principal;
import java.util.Iterator;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.jcr.RepositoryException;
import javax.jcr.UnsupportedRepositoryOperationException;
import org.apache.jackrabbit.api.security.principal.PrincipalManager;
import org.apache.jackrabbit.api.security.user.Authorizable;
import org.apache.jackrabbit.api.security.user.AuthorizableExistsException;
import org.apache.jackrabbit.api.security.user.Group;
import org.apache.jackrabbit.api.security.user.Query;
import org.apache.jackrabbit.api.security.user.User;
import org.apache.jackrabbit.api.security.user.UserManager;
import org.apache.jackrabbit.oak.api.Root;
import org.apache.jackrabbit.oak.api.Tree;
import org.apache.jackrabbit.oak.namepath.NamePathMapper;
import org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager;
import org.apache.jackrabbit.oak.security.user.query.UserQueryManager;
import org.apache.jackrabbit.oak.spi.security.ConfigurationParameters;
import org.apache.jackrabbit.oak.spi.security.SecurityProvider;
import org.apache.jackrabbit.oak.spi.security.principal.EveryonePrincipal;
import org.apache.jackrabbit.oak.spi.security.principal.PrincipalConfiguration;
import org.apache.jackrabbit.oak.spi.security.principal.PrincipalImpl;
import org.apache.jackrabbit.oak.spi.security.user.AuthorizableType;
import org.apache.jackrabbit.oak.spi.security.user.UserConfiguration;
import org.apache.jackrabbit.oak.spi.security.user.UserConstants;
import org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableAction;
import org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableActionProvider;
import org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider;
import org.apache.jackrabbit.oak.spi.security.user.util.PasswordUtil;
import org.apache.jackrabbit.oak.spi.security.user.util.UserUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* UserManagerImpl...
*/
public class UserManagerImpl implements UserManager {
private static final Logger log = LoggerFactory.getLogger(UserManagerImpl.class);
private final Root root;
private final NamePathMapper namePathMapper;
private final SecurityProvider securityProvider;
private final UserProvider userProvider;
private final MembershipProvider membershipProvider;
private final ConfigurationParameters config;
private final AuthorizableActionProvider actionProvider;
private UserQueryManager queryManager;
private ReadOnlyNodeTypeManager ntMgr;
public UserManagerImpl(Root root, NamePathMapper namePathMapper, SecurityProvider securityProvider) {
this.root = root;
this.namePathMapper = namePathMapper;
this.securityProvider = securityProvider;
UserConfiguration uc = securityProvider.getConfiguration(UserConfiguration.class);
this.config = uc.getParameters();
this.userProvider = new UserProvider(root, config);
this.membershipProvider = new MembershipProvider(root, config);
this.actionProvider = getActionProvider(config);
}
@Nonnull
private static AuthorizableActionProvider getActionProvider(ConfigurationParameters config) {
AuthorizableActionProvider actionProvider = config.getConfigValue(UserConstants.PARAM_AUTHORIZABLE_ACTION_PROVIDER, null, AuthorizableActionProvider.class);
if (actionProvider == null) {
actionProvider = new DefaultAuthorizableActionProvider(config);
}
return actionProvider;
}
//--------------------------------------------------------< UserManager >---
@Override
public Authorizable getAuthorizable(String id) throws RepositoryException {
Authorizable authorizable = null;
Tree tree = userProvider.getAuthorizable(id);
if (tree != null) {
authorizable = getAuthorizable(id, tree);
}
return authorizable;
}
@Override
public Authorizable getAuthorizable(Principal principal) throws RepositoryException {
return getAuthorizable(userProvider.getAuthorizableByPrincipal(principal));
}
@Override
public Authorizable getAuthorizableByPath(String path) throws RepositoryException {
String oakPath = namePathMapper.getOakPathKeepIndex(path);
if (oakPath == null) {
throw new RepositoryException("Invalid path " + path);
}
return getAuthorizable(userProvider.getAuthorizableByPath(oakPath));
}
@Override
public Iterator<Authorizable> findAuthorizables(String relPath, String value) throws RepositoryException {
return findAuthorizables(relPath, value, SEARCH_TYPE_AUTHORIZABLE);
}
@Override
public Iterator<Authorizable> findAuthorizables(String relPath, String value, int searchType) throws RepositoryException {
return getQueryManager().findAuthorizables(relPath, value, AuthorizableType.getType(searchType));
}
@Override
public Iterator<Authorizable> findAuthorizables(Query query) throws RepositoryException {
return getQueryManager().findAuthorizables(query);
}
@Override
public User createUser(final String userId, String password) throws RepositoryException {
Principal principal = new PrincipalImpl(userId);
return createUser(userId, password, principal, null);
}
@Override
public User createUser(String userID, String password, Principal principal,
@Nullable String intermediatePath) throws RepositoryException {
checkValidID(userID);
checkValidPrincipal(principal, false);
if (intermediatePath != null) {
intermediatePath = namePathMapper.getOakPathKeepIndex(intermediatePath);
}
Tree userTree = userProvider.createUser(userID, intermediatePath);
setPrincipal(userTree, principal);
if (password != null) {
setPassword(userTree, password, true);
}
User user = new UserImpl(userID, userTree, this);
onCreate(user, password);
log.debug("User created: " + userID);
return user;
}
@Override
public Group createGroup(String groupId) throws RepositoryException {
Principal principal = new PrincipalImpl(groupId);
return createGroup(groupId, principal, null);
}
@Override
public Group createGroup(Principal principal) throws RepositoryException {
return createGroup(principal, null);
}
@Override
public Group createGroup(Principal principal, @Nullable String intermediatePath) throws RepositoryException {
return createGroup(principal.getName(), principal, intermediatePath);
}
@Override
public Group createGroup(String groupID, Principal principal, @Nullable String intermediatePath) throws RepositoryException {
checkValidID(groupID);
checkValidPrincipal(principal, true);
if (intermediatePath != null) {
intermediatePath = namePathMapper.getOakPathKeepIndex(intermediatePath);
}
Tree groupTree = userProvider.createGroup(groupID, intermediatePath);
setPrincipal(groupTree, principal);
Group group = new GroupImpl(groupID, groupTree, this);
onCreate(group);
log.debug("Group created: " + groupID);
return group;
}
/**
* Always returns {@code false}. Any modifications made to this user
* manager instance require a subsequent call to {@link javax.jcr.Session#save()}
* in order to have the changes persisted.
*
* @see org.apache.jackrabbit.api.security.user.UserManager#isAutoSave()
*/
@Override
public boolean isAutoSave() {
return false;
}
/**
* Changing the auto-save behavior is not supported by this implementation
* and this method always throws {@code UnsupportedRepositoryOperationException}
*
* @see UserManager#autoSave(boolean)
*/
@Override
public void autoSave(boolean enable) throws RepositoryException {
throw new UnsupportedRepositoryOperationException("Session#save() is always required.");
}
//--------------------------------------------------------------------------
/**
* Let the configured {@code AuthorizableAction}s perform additional
* tasks associated with the creation of the new user before the
* corresponding new node is persisted.
*
* @param user The new user.
* @param password The password.
* @throws RepositoryException If an exception occurs.
*/
void onCreate(User user, String password) throws RepositoryException {
for (AuthorizableAction action : actionProvider.getAuthorizableActions(securityProvider)) {
action.onCreate(user, password, root, namePathMapper);
}
}
/**
* Let the configured {@code AuthorizableAction}s perform additional
* tasks associated with the creation of the new group before the
* corresponding new node is persisted.
*
* @param group The new group.
* @throws RepositoryException If an exception occurs.
*/
void onCreate(Group group) throws RepositoryException {
for (AuthorizableAction action : actionProvider.getAuthorizableActions(securityProvider)) {
action.onCreate(group, root, namePathMapper);
}
}
/**
* Let the configured {@code AuthorizableAction}s perform any clean
* up tasks related to the authorizable removal (before the corresponding
* node gets removed).
*
* @param authorizable The authorizable to be removed.
* @throws RepositoryException If an exception occurs.
*/
void onRemove(Authorizable authorizable) throws RepositoryException {
for (AuthorizableAction action : actionProvider.getAuthorizableActions(securityProvider)) {
action.onRemove(authorizable, root, namePathMapper);
}
}
/**
* Let the configured {@code AuthorizableAction}s perform additional
* tasks associated with password changing of a given user before the
* corresponding property is being changed.
*
* @param user The target user.
* @param password The new password.
* @throws RepositoryException If an exception occurs.
*/
void onPasswordChange(User user, String password) throws RepositoryException {
for (AuthorizableAction action : actionProvider.getAuthorizableActions(securityProvider)) {
action.onPasswordChange(user, password, root, namePathMapper);
}
}
//--------------------------------------------------------------------------
@CheckForNull
Authorizable getAuthorizable(Tree tree) throws RepositoryException {
if (tree == null || !tree.exists()) {
return null;
}
return getAuthorizable(userProvider.getAuthorizableId(tree), tree);
}
@Nonnull
NamePathMapper getNamePathMapper() {
return namePathMapper;
}
@Nonnull
ReadOnlyNodeTypeManager getNodeTypeManager() {
if (ntMgr == null) {
ntMgr = ReadOnlyNodeTypeManager.getInstance(root, NamePathMapper.DEFAULT);
}
return ntMgr;
}
@Nonnull
MembershipProvider getMembershipProvider() {
return membershipProvider;
}
@Nonnull
PrincipalManager getPrincipalManager() throws RepositoryException {
return securityProvider.getConfiguration(PrincipalConfiguration.class).getPrincipalManager(root, namePathMapper);
}
@Nonnull
ConfigurationParameters getConfig() {
return config;
}
@CheckForNull
private Authorizable getAuthorizable(String id, Tree tree) throws RepositoryException {
if (id == null || tree == null) {
return null;
}
if (UserUtil.isType(tree, AuthorizableType.USER)) {
return new UserImpl(userProvider.getAuthorizableId(tree), tree, this);
} else if (UserUtil.isType(tree, AuthorizableType.GROUP)) {
return new GroupImpl(userProvider.getAuthorizableId(tree), tree, this);
} else {
throw new RepositoryException("Not a user or group tree " + tree.getPath() + '.');
}
}
private void checkValidID(String id) throws RepositoryException {
if (id == null || id.length() == 0) {
throw new IllegalArgumentException("Invalid ID " + id);
} else if (getAuthorizable(id) != null) {
throw new AuthorizableExistsException("Authorizable with ID " + id + " already exists");
}
}
void checkValidPrincipal(Principal principal, boolean isGroup) throws RepositoryException {
if (principal == null || principal.getName() == null || "".equals(principal.getName())) {
throw new IllegalArgumentException("Principal may not be null and must have a valid name.");
}
if (!isGroup && EveryonePrincipal.NAME.equals(principal.getName())) {
throw new IllegalArgumentException("'everyone' is a reserved group principal name.");
}
if (getAuthorizable(principal) != null) {
throw new AuthorizableExistsException("Authorizable with principal " + principal.getName() + " already exists.");
}
}
void setPrincipal(Tree authorizableTree, Principal principal) {
checkNotNull(principal);
authorizableTree.setProperty(UserConstants.REP_PRINCIPAL_NAME, principal.getName());
}
void setPassword(Tree userTree, String password, boolean forceHash) throws RepositoryException {
String pwHash;
if (forceHash || PasswordUtil.isPlainTextPassword(password)) {
try {
pwHash = PasswordUtil.buildPasswordHash(password, config);
} catch (NoSuchAlgorithmException e) {
throw new RepositoryException(e);
} catch (UnsupportedEncodingException e) {
throw new RepositoryException(e);
}
} else {
pwHash = password;
}
userTree.setProperty(UserConstants.REP_PASSWORD, pwHash);
}
private UserQueryManager getQueryManager() {
if (queryManager == null) {
queryManager = new UserQueryManager(this, namePathMapper, config, root);
}
return queryManager;
}
}