org.exist.security.SecurityManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation
eXist-db NoSQL Database Core
There is a newer version: 6.3.0
/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.security;

import java.util.List;
import org.exist.Database;
import org.exist.EXistException;
import org.exist.config.Configurable;
import org.exist.config.ConfigurationException;
import org.exist.dom.persistent.DocumentImpl;
import org.exist.storage.BrokerPool;
import org.exist.storage.DBBroker;
import org.exist.storage.txn.Txn;
import org.exist.xmldb.XmldbURI;

/**
 * SecurityManager is responsible for managing users and groups.
 * 
 * There's only one SecurityManager for each database instance, which
 * may be obtained by {@link BrokerPool#getSecurityManager()}.
 * 
 */
public interface SecurityManager extends Configurable {

   XmldbURI SECURITY_COLLECTION_URI = XmldbURI.SYSTEM_COLLECTION_URI.append("security");
   XmldbURI CONFIG_FILE_URI = XmldbURI.create("config.xml");
   
   XmldbURI ACCOUNTS_COLLECTION_URI = XmldbURI.create("accounts");
   XmldbURI GROUPS_COLLECTION_URI = XmldbURI.create("groups");
   XmldbURI REMOVED_COLLECTION_URI = XmldbURI.create("removed");

   String SYSTEM = "SYSTEM";
   String DBA_GROUP = "dba";
   String DBA_USER = "admin";
   String GUEST_GROUP = "guest";
   String GUEST_USER = "guest";
   String UNKNOWN_GROUP = "nogroup";
   String UNKNOWN_USER = "nobody";

   void attach(DBBroker broker, Txn transaction) throws EXistException;
   
   Database getDatabase();
   Database database();

   void registerAccount(Account account);

   void registerGroup(Group group);

   Account getAccount(int id);

   boolean hasAccount(String name);

   Account addAccount(Account user) throws PermissionDeniedException, EXistException;
   
   Account addAccount(DBBroker broker, Account account) throws  PermissionDeniedException, EXistException;

   boolean deleteAccount(String name) throws PermissionDeniedException, EXistException;
   boolean deleteAccount(Account account) throws PermissionDeniedException, EXistException;

   boolean updateAccount(Account account) throws PermissionDeniedException, EXistException;

   boolean updateGroup(Group group) throws PermissionDeniedException, EXistException;

   Account getAccount(String name);

   Group addGroup(DBBroker broker, Group group) throws PermissionDeniedException, EXistException;
   
   @Deprecated
   void addGroup(DBBroker broker, String group) throws PermissionDeniedException, EXistException;

   boolean hasGroup(String name);
   boolean hasGroup(Group group);

   Group getGroup(String name);
   Group getGroup(int gid);

   boolean deleteGroup(String name) throws PermissionDeniedException, EXistException;

   boolean hasAdminPrivileges(Account user);

   Subject authenticate(String username, Object credentials) throws AuthenticationException;

   Subject getSystemSubject();
   Subject getGuestSubject();
   Group getDBAGroup();

   List getGroupMembers(String groupName);

   @Deprecated //use realm's method
   java.util.Collection getUsers();

   @Deprecated //use realm's method
   java.util.Collection getGroups();

   //session manager part
   void registerSession(Session session);
   
   @Deprecated
   Subject getSubjectBySessionId(String sessionid);

   boolean hasGroup(int id);

   boolean hasUser(int id);

   /**
    * Find users by their personal name
    * @param startsWith string the user name begins with
    * @return list of usernames
    */
   List findUsernamesWhereNameStarts(String startsWith);

   /**
    * Find users by their username
    * @param startsWith  the user name
    * @return list of usernames
    */
   List findUsernamesWhereUsernameStarts(String startsWith);

   /**
    * Find all groups visible to the invokingUser
    * @return list of all group names
    */
   List findAllGroupNames();
   
   /**
    * Find all users visible to the invokingUser
    * @return list of all user names
    */
   List findAllUserNames();

   /**
    * Find groups by their group name
    * @param startsWith string the group name starts with
    * @return list of group names that math startsWith
    */
   List findGroupnamesWhereGroupnameStarts(String startsWith);
   
   /**
    * Find all members of a group
    * @param groupName group name to find members of
    * @return list of users belonging to the specified group
    */
   List findAllGroupMembers(String groupName);

   /**
    * Process document, possible new sub-instance.
    * @param broker  eXist-db broker
    * @param document to process
    * @throws ConfigurationException if there is an error
    */
   void processParameter(DBBroker broker, DocumentImpl document) throws ConfigurationException;
   void processParameterBeforeSave(DBBroker broker, DocumentImpl document) throws ConfigurationException;
   
   /**
    * Particular web page for authentication.
    * 
    * @return Authentication form location
    */
   String getAuthenticationEntryPoint();

   List findGroupnamesWhereGroupnameContains(String fragment);

   List findUsernamesWhereNamePartStarts(String startsWith);

   @Deprecated
   Subject getCurrentSubject();

   /**
    * A receiver that is given the id of
    * a security principal
    */
   interface PrincipalIdReceiver {

      /**
       * Callback function which received a Principal id
       *
       * @param id The id of the principal
       */
      void allocate(final int id);
   }

   /**
    * Pre-allocates a new account id
    *
    * @param receiver A receiver that will receive the new account id
    * @throws EXistException in case of an eXist-db error
    * @throws PermissionDeniedException in case user has not sufficient rights
    */
   void preAllocateAccountId(PrincipalIdReceiver receiver) throws PermissionDeniedException, EXistException;

   /**
    * Pre-allocates a new group id
    *
    * @param receiver A receiver that will receive the new group id
    * @throws EXistException in case of an eXist-db error
    * @throws PermissionDeniedException in case user has not sufficient rights
    */
   void preAllocateGroupId(PrincipalIdReceiver receiver) throws PermissionDeniedException, EXistException;
}