| | |
| | | package com.gitblit.models;
|
| | |
|
| | | import java.io.Serializable;
|
| | | import java.security.Principal;
|
| | | import java.util.ArrayList;
|
| | | import java.util.Collections;
|
| | | import java.util.HashSet;
|
| | | import java.util.LinkedHashMap;
|
| | | import java.util.LinkedHashSet;
|
| | | import java.util.List;
|
| | | import java.util.Map;
|
| | | import java.util.Set;
|
| | | import java.util.TreeSet;
|
| | |
|
| | | public class UserModel implements Serializable {
|
| | | import com.gitblit.Constants.AccessPermission;
|
| | | import com.gitblit.Constants.AccessRestrictionType;
|
| | | import com.gitblit.Constants.AuthorizationControl;
|
| | | import com.gitblit.Constants.PermissionType;
|
| | | import com.gitblit.Constants.RegistrantType;
|
| | | import com.gitblit.Constants.Unused;
|
| | | import com.gitblit.utils.ArrayUtils;
|
| | | import com.gitblit.utils.StringUtils;
|
| | |
|
| | | /**
|
| | | * UserModel is a serializable model class that represents a user and the user's
|
| | | * restricted repository memberships. Instances of UserModels are also used as
|
| | | * servlet user principals.
|
| | | * |
| | | * @author James Moger
|
| | | * |
| | | */
|
| | | public class UserModel implements Principal, Serializable, Comparable<UserModel> {
|
| | |
|
| | | private static final long serialVersionUID = 1L;
|
| | |
|
| | | public static final UserModel ANONYMOUS = new UserModel();
|
| | | |
| | | // field names are reflectively mapped in EditUser page
|
| | | public String username;
|
| | | public String password;
|
| | | public String cookie;
|
| | | public String displayName;
|
| | | public String emailAddress;
|
| | | public String organizationalUnit;
|
| | | public String organization;
|
| | | public String locality;
|
| | | public String stateProvince;
|
| | | public String countryCode;
|
| | | public boolean canAdmin;
|
| | | public final List<String> repositories = new ArrayList<String>();
|
| | | public boolean canFork;
|
| | | public boolean canCreate;
|
| | | public boolean excludeFromFederation;
|
| | | // retained for backwards-compatibility with RPC clients
|
| | | @Deprecated
|
| | | public final Set<String> repositories = new HashSet<String>();
|
| | | public final Map<String, AccessPermission> permissions = new LinkedHashMap<String, AccessPermission>();
|
| | | public final Set<TeamModel> teams = new TreeSet<TeamModel>();
|
| | |
|
| | | // non-persisted fields
|
| | | public boolean isAuthenticated;
|
| | | |
| | | public UserModel(String username) {
|
| | | this.username = username;
|
| | | this.isAuthenticated = true;
|
| | | }
|
| | |
|
| | | private UserModel() {
|
| | | this.username = "$anonymous";
|
| | | this.isAuthenticated = false;
|
| | | }
|
| | |
|
| | | /**
|
| | | * This method does not take into consideration Ownership where the
|
| | | * administrator has not explicitly granted access to the owner.
|
| | | * |
| | | * @param repositoryName
|
| | | * @return
|
| | | */
|
| | | @Deprecated
|
| | | public boolean canAccessRepository(String repositoryName) {
|
| | | return canAdmin || repositories.contains(repositoryName);
|
| | | return canAdmin() || repositories.contains(repositoryName.toLowerCase())
|
| | | || hasTeamAccess(repositoryName);
|
| | | }
|
| | |
|
| | | public void setRepositories(List<String> repositories) {
|
| | | this.repositories.clear();
|
| | | this.repositories.addAll(repositories);
|
| | | @Deprecated
|
| | | @Unused
|
| | | public boolean canAccessRepository(RepositoryModel repository) {
|
| | | boolean isOwner = !StringUtils.isEmpty(repository.owner)
|
| | | && repository.owner.equals(username);
|
| | | boolean allowAuthenticated = isAuthenticated && AuthorizationControl.AUTHENTICATED.equals(repository.authorizationControl);
|
| | | return canAdmin() || isOwner || repositories.contains(repository.name.toLowerCase())
|
| | | || hasTeamAccess(repository.name) || allowAuthenticated;
|
| | | }
|
| | |
|
| | | @Deprecated
|
| | | @Unused
|
| | | public boolean hasTeamAccess(String repositoryName) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.hasRepositoryPermission(repositoryName)) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | | |
| | | @Deprecated
|
| | | @Unused
|
| | | public boolean hasRepository(String name) {
|
| | | return hasRepositoryPermission(name);
|
| | | }
|
| | |
|
| | | @Deprecated
|
| | | @Unused
|
| | | public void addRepository(String name) {
|
| | | repositories.add(name.toLowerCase());
|
| | | addRepositoryPermission(name);
|
| | | }
|
| | |
|
| | | @Deprecated
|
| | | @Unused
|
| | | public void removeRepository(String name) {
|
| | | removeRepositoryPermission(name);
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns a list of repository permissions for this user exclusive of
|
| | | * permissions inherited from team memberships.
|
| | | * |
| | | * @return the user's list of permissions
|
| | | */
|
| | | public List<RegistrantAccessPermission> getRepositoryPermissions() {
|
| | | List<RegistrantAccessPermission> list = new ArrayList<RegistrantAccessPermission>();
|
| | | if (canAdmin()) {
|
| | | // user has REWIND access to all repositories
|
| | | return list;
|
| | | }
|
| | | for (Map.Entry<String, AccessPermission> entry : permissions.entrySet()) {
|
| | | String registrant = entry.getKey();
|
| | | AccessPermission ap = entry.getValue();
|
| | | String source = null;
|
| | | boolean mutable = true;
|
| | | PermissionType pType = PermissionType.EXPLICIT;
|
| | | if (isMyPersonalRepository(registrant)) {
|
| | | pType = PermissionType.OWNER;
|
| | | ap = AccessPermission.REWIND;
|
| | | mutable = false;
|
| | | } else if (StringUtils.findInvalidCharacter(registrant) != null) {
|
| | | // a regex will have at least 1 invalid character
|
| | | pType = PermissionType.REGEX;
|
| | | source = registrant;
|
| | | }
|
| | | list.add(new RegistrantAccessPermission(registrant, ap, pType, RegistrantType.REPOSITORY, source, mutable));
|
| | | }
|
| | | Collections.sort(list);
|
| | | |
| | | // include immutable team permissions, being careful to preserve order
|
| | | Set<RegistrantAccessPermission> set = new LinkedHashSet<RegistrantAccessPermission>(list);
|
| | | for (TeamModel team : teams) {
|
| | | for (RegistrantAccessPermission teamPermission : team.getRepositoryPermissions()) {
|
| | | // we can not change an inherited team permission, though we can override
|
| | | teamPermission.registrantType = RegistrantType.REPOSITORY;
|
| | | teamPermission.permissionType = PermissionType.TEAM;
|
| | | teamPermission.source = team.name;
|
| | | teamPermission.mutable = false;
|
| | | set.add(teamPermission);
|
| | | }
|
| | | }
|
| | | return new ArrayList<RegistrantAccessPermission>(set);
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns true if the user has any type of specified access permission for
|
| | | * this repository.
|
| | | * |
| | | * @param name
|
| | | * @return true if user has a specified access permission for the repository
|
| | | */
|
| | | public boolean hasRepositoryPermission(String name) {
|
| | | String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
|
| | | if (permissions.containsKey(repository)) {
|
| | | // exact repository permission specified
|
| | | return true;
|
| | | } else {
|
| | | // search for regex permission match
|
| | | for (String key : permissions.keySet()) {
|
| | | if (name.matches(key)) {
|
| | | AccessPermission p = permissions.get(key);
|
| | | if (p != null) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns true if the user has an explicitly specified access permission for
|
| | | * this repository.
|
| | | * |
| | | * @param name
|
| | | * @return if the user has an explicitly specified access permission
|
| | | */
|
| | | public boolean hasExplicitRepositoryPermission(String name) {
|
| | | String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
|
| | | return permissions.containsKey(repository);
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns true if the user's team memberships specify an access permission for
|
| | | * this repository.
|
| | | * |
| | | * @param name
|
| | | * @return if the user's team memberships specifi an access permission
|
| | | */
|
| | | public boolean hasTeamRepositoryPermission(String name) {
|
| | | if (teams != null) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.hasRepositoryPermission(name)) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | | |
| | | /**
|
| | | * Adds a repository permission to the team.
|
| | | * <p>
|
| | | * Role may be formatted as:
|
| | | * <ul>
|
| | | * <li> myrepo.git <i>(this is implicitly RW+)</i>
|
| | | * <li> RW+:myrepo.git
|
| | | * </ul>
|
| | | * @param role
|
| | | */
|
| | | public void addRepositoryPermission(String role) {
|
| | | AccessPermission permission = AccessPermission.permissionFromRole(role);
|
| | | String repository = AccessPermission.repositoryFromRole(role).toLowerCase();
|
| | | repositories.add(repository);
|
| | | permissions.put(repository, permission);
|
| | | }
|
| | | |
| | | public AccessPermission removeRepositoryPermission(String name) {
|
| | | String repository = AccessPermission.repositoryFromRole(name).toLowerCase();
|
| | | repositories.remove(repository);
|
| | | return permissions.remove(repository);
|
| | | }
|
| | | |
| | | public void setRepositoryPermission(String repository, AccessPermission permission) {
|
| | | permissions.put(repository.toLowerCase(), permission);
|
| | | }
|
| | |
|
| | | public RegistrantAccessPermission getRepositoryPermission(RepositoryModel repository) {
|
| | | RegistrantAccessPermission ap = new RegistrantAccessPermission();
|
| | | ap.registrant = username;
|
| | | ap.registrantType = RegistrantType.USER;
|
| | | ap.permission = AccessPermission.NONE;
|
| | | ap.mutable = false;
|
| | |
|
| | | if (AccessRestrictionType.NONE.equals(repository.accessRestriction)) {
|
| | | // anonymous rewind
|
| | | ap.permissionType = PermissionType.ADMINISTRATOR;
|
| | | ap.permission = AccessPermission.REWIND;
|
| | | return ap;
|
| | | }
|
| | |
|
| | | // administrator
|
| | | if (canAdmin()) {
|
| | | ap.permissionType = PermissionType.ADMINISTRATOR;
|
| | | ap.permission = AccessPermission.REWIND;
|
| | | if (!canAdmin) {
|
| | | // administator permission from team membership
|
| | | for (TeamModel team : teams) {
|
| | | if (team.canAdmin) {
|
| | | ap.source = team.name;
|
| | | break;
|
| | | }
|
| | | }
|
| | | }
|
| | | return ap;
|
| | | }
|
| | | |
| | | // repository owner - either specified owner or personal repository
|
| | | if (repository.isOwner(username) || repository.isUsersPersonalRepository(username)) {
|
| | | ap.permissionType = PermissionType.OWNER;
|
| | | ap.permission = AccessPermission.REWIND;
|
| | | return ap;
|
| | | }
|
| | | |
| | | if (AuthorizationControl.AUTHENTICATED.equals(repository.authorizationControl) && isAuthenticated) {
|
| | | // AUTHENTICATED is a shortcut for authorizing all logged-in users RW+ access
|
| | | ap.permission = AccessPermission.REWIND;
|
| | | return ap;
|
| | | }
|
| | | |
| | | // explicit user permission OR user regex match is used
|
| | | // if that fails, then the best team permission is used
|
| | | if (permissions.containsKey(repository.name.toLowerCase())) {
|
| | | // exact repository permission specified, use it
|
| | | AccessPermission p = permissions.get(repository.name.toLowerCase());
|
| | | if (p != null) {
|
| | | ap.permissionType = PermissionType.EXPLICIT;
|
| | | ap.permission = p;
|
| | | ap.mutable = true;
|
| | | return ap;
|
| | | }
|
| | | } else {
|
| | | // search for case-insensitive regex permission match
|
| | | for (String key : permissions.keySet()) {
|
| | | if (StringUtils.matchesIgnoreCase(repository.name, key)) {
|
| | | AccessPermission p = permissions.get(key);
|
| | | if (p != null) {
|
| | | // take first match
|
| | | ap.permissionType = PermissionType.REGEX;
|
| | | ap.permission = p;
|
| | | ap.source = key;
|
| | | return ap;
|
| | | }
|
| | | }
|
| | | }
|
| | | }
|
| | | |
| | | // try to find a team match
|
| | | for (TeamModel team : teams) {
|
| | | RegistrantAccessPermission p = team.getRepositoryPermission(repository);
|
| | | if (p.permission.exceeds(ap.permission)) {
|
| | | // use highest team permission
|
| | | ap.permission = p.permission;
|
| | | ap.source = team.name;
|
| | | ap.permissionType = PermissionType.TEAM;
|
| | | }
|
| | | } |
| | | |
| | | return ap;
|
| | | }
|
| | | |
| | | protected boolean canAccess(RepositoryModel repository, AccessRestrictionType ifRestriction, AccessPermission requirePermission) {
|
| | | if (repository.accessRestriction.atLeast(ifRestriction)) {
|
| | | RegistrantAccessPermission ap = getRepositoryPermission(repository);
|
| | | return ap.permission.atLeast(requirePermission);
|
| | | }
|
| | | return true;
|
| | | }
|
| | | |
| | | public boolean canView(RepositoryModel repository) {
|
| | | return canAccess(repository, AccessRestrictionType.VIEW, AccessPermission.VIEW);
|
| | | }
|
| | |
|
| | | public boolean canClone(RepositoryModel repository) {
|
| | | return canAccess(repository, AccessRestrictionType.CLONE, AccessPermission.CLONE);
|
| | | }
|
| | |
|
| | | public boolean canPush(RepositoryModel repository) {
|
| | | if (repository.isFrozen) {
|
| | | return false;
|
| | | }
|
| | | return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.PUSH);
|
| | | }
|
| | |
|
| | | public boolean canCreateRef(RepositoryModel repository) {
|
| | | if (repository.isFrozen) {
|
| | | return false;
|
| | | }
|
| | | return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.CREATE);
|
| | | }
|
| | |
|
| | | public boolean canDeleteRef(RepositoryModel repository) {
|
| | | if (repository.isFrozen) {
|
| | | return false;
|
| | | }
|
| | | return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.DELETE);
|
| | | }
|
| | |
|
| | | public boolean canRewindRef(RepositoryModel repository) {
|
| | | if (repository.isFrozen) {
|
| | | return false;
|
| | | }
|
| | | return canAccess(repository, AccessRestrictionType.PUSH, AccessPermission.REWIND);
|
| | | }
|
| | |
|
| | | public boolean canFork(RepositoryModel repository) {
|
| | | if (repository.isUsersPersonalRepository(username)) {
|
| | | // can not fork your own repository
|
| | | return false;
|
| | | }
|
| | | if (canAdmin() || repository.isOwner(username)) {
|
| | | return true;
|
| | | }
|
| | | if (!repository.allowForks) {
|
| | | return false;
|
| | | }
|
| | | if (!isAuthenticated || !canFork()) {
|
| | | return false;
|
| | | }
|
| | | return canClone(repository);
|
| | | }
|
| | | |
| | | public boolean canDelete(RepositoryModel model) {
|
| | | return canAdmin() || model.isUsersPersonalRepository(username);
|
| | | }
|
| | | |
| | | public boolean canEdit(RepositoryModel model) {
|
| | | return canAdmin() || model.isUsersPersonalRepository(username) || model.isOwner(username);
|
| | | }
|
| | | |
| | | /**
|
| | | * This returns true if the user has fork privileges or the user has fork
|
| | | * privileges because of a team membership.
|
| | | * |
| | | * @return true if the user can fork
|
| | | */
|
| | | public boolean canFork() {
|
| | | if (canFork) {
|
| | | return true;
|
| | | }
|
| | | if (!ArrayUtils.isEmpty(teams)) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.canFork) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | |
|
| | | /**
|
| | | * This returns true if the user has admin privileges or the user has admin
|
| | | * privileges because of a team membership.
|
| | | * |
| | | * @return true if the user can admin
|
| | | */
|
| | | public boolean canAdmin() {
|
| | | if (canAdmin) {
|
| | | return true;
|
| | | }
|
| | | if (!ArrayUtils.isEmpty(teams)) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.canAdmin) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | |
|
| | | /**
|
| | | * This returns true if the user has create privileges or the user has create
|
| | | * privileges because of a team membership.
|
| | | * |
| | | * @return true if the user can admin
|
| | | */
|
| | | public boolean canCreate() {
|
| | | if (canCreate) {
|
| | | return true;
|
| | | }
|
| | | if (!ArrayUtils.isEmpty(teams)) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.canCreate) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns true if the user is allowed to create the specified repository.
|
| | | * |
| | | * @param repository
|
| | | * @return true if the user can create the repository
|
| | | */
|
| | | public boolean canCreate(String repository) {
|
| | | if (canAdmin()) {
|
| | | // admins can create any repository
|
| | | return true;
|
| | | }
|
| | | if (canCreate) {
|
| | | String projectPath = StringUtils.getFirstPathElement(repository);
|
| | | if (!StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase("~" + username)) {
|
| | | // personal repository
|
| | | return true;
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | |
|
| | | public boolean isTeamMember(String teamname) {
|
| | | for (TeamModel team : teams) {
|
| | | if (team.name.equalsIgnoreCase(teamname)) {
|
| | | return true;
|
| | | }
|
| | | }
|
| | | return false;
|
| | | }
|
| | |
|
| | | public TeamModel getTeam(String teamname) {
|
| | | if (teams == null) {
|
| | | return null;
|
| | | }
|
| | | for (TeamModel team : teams) {
|
| | | if (team.name.equalsIgnoreCase(teamname)) {
|
| | | return team;
|
| | | }
|
| | | }
|
| | | return null;
|
| | | }
|
| | |
|
| | | @Override
|
| | | public String getName() {
|
| | | return username;
|
| | | }
|
| | | |
| | | public String getDisplayName() {
|
| | | if (StringUtils.isEmpty(displayName)) {
|
| | | return username;
|
| | | }
|
| | | return displayName;
|
| | | }
|
| | | |
| | | public String getPersonalPath() {
|
| | | return "~" + username;
|
| | | }
|
| | | |
| | | @Override
|
| | | public int hashCode() {
|
| | | return username.hashCode();
|
| | | }
|
| | | |
| | | @Override
|
| | | public boolean equals(Object o) {
|
| | | if (o instanceof UserModel) {
|
| | | return username.equals(((UserModel) o).username);
|
| | | }
|
| | | return false;
|
| | | }
|
| | |
|
| | | @Override
|
| | | public String toString() {
|
| | | return username;
|
| | | }
|
| | |
|
| | | @Override
|
| | | public int compareTo(UserModel o) {
|
| | | return username.compareTo(o.username);
|
| | | }
|
| | | |
| | | /**
|
| | | * Returns true if the name/email pair match this user account.
|
| | | * |
| | | * @param name
|
| | | * @param email
|
| | | * @return true, if the name and email address match this account
|
| | | */
|
| | | public boolean is(String name, String email) {
|
| | | // at a minimum a usename or display name must be supplied
|
| | | if (StringUtils.isEmpty(name)) {
|
| | | return false;
|
| | | }
|
| | | boolean nameVerified = name.equalsIgnoreCase(username) || name.equalsIgnoreCase(getDisplayName());
|
| | | boolean emailVerified = false;
|
| | | if (StringUtils.isEmpty(emailAddress)) {
|
| | | // user account has not specified an email address
|
| | | // rely on username/displayname verification
|
| | | emailVerified = true;
|
| | | } else {
|
| | | // user account has specified an email address
|
| | | // require email address verification
|
| | | if (!StringUtils.isEmpty(email)) {
|
| | | emailVerified = email.equalsIgnoreCase(emailAddress);
|
| | | }
|
| | | }
|
| | | return nameVerified && emailVerified;
|
| | | }
|
| | | |
| | | public boolean hasBranchPermission(String repositoryName, String branch) {
|
| | | // Default UserModel doesn't implement branch-level security. Other Realms (i.e. Gerrit) may override this method.
|
| | | return hasRepositoryPermission(repositoryName) || hasTeamRepositoryPermission(repositoryName);
|
| | | }
|
| | | |
| | | public boolean isMyPersonalRepository(String repository) {
|
| | | String projectPath = StringUtils.getFirstPathElement(repository);
|
| | | return !StringUtils.isEmpty(projectPath) && projectPath.equalsIgnoreCase("~" + username);
|
| | | }
|
| | | }
|