Package org.opencms.security

Access control and security classes for the OpenCms ACL permission system.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsAuthorizationHandler	Defines general authorization methods.
I_CmsAuthorizationHandler.I_PrivilegedLoginAction	Class providing the privileged login action.
I_CmsCredentialsResolver	This interface can be used to override or replace user names or passwords which occur in the OpenCms configuration, for example to hide passwords from users who can read the configuration files.
I_CmsLoginAction	Interface used to provide a protected login method.
I_CmsPasswordGenerator
I_CmsPasswordHandler	Defines methods for OpenCms password validation.
I_CmsPasswordSecurityEvaluator	Password handler implementing this interface allow the password security to be evaluated.
I_CmsPermissionHandler	Permission handler interface.
I_CmsPrincipal	Representation of an identity in the cms (currently user or group), used to define permissions on a resource.
I_CmsValidationHandler	Defines general validation methods.

Class Summary

Class	Description
CmsAccessControlEntry	An access control entry defines the permissions of a user or group for a distinct resource.
CmsAccessControlList	An access control list contains the permission sets of all principals for a distinct resource that are calculated on the permissions defined by various access control entries.
CmsAdvancedPasswordHandler	Validates the user passwords in with advanced password requirements.
CmsDefaultAuthorizationHandler	Defines default authorization methods.
CmsDefaultCredentialsResolver	Default implementation of a I_CmsCredentialResolver, which does nothing but return the credential which was passed in.
CmsDefaultPasswordGenerator	Default Password Generator class.
CmsDefaultPasswordHandler	Default implementation for OpenCms password validation, just checks if a password is at last 4 characters long.
CmsDefaultPermissionHandler	Generic base driver interface.
CmsDefaultValidationHandler	Default implementation for the validation handler.
CmsOrganizationalUnit	An organizational unit in OpenCms.
CmsOrgUnitManager	This manager provide access to the organizational unit related operations.
CmsPasswordInfo	Validating bean for changing the password.
CmsPermissionSet	An immutable permission set that contains both allowed and denied permissions as bitsets.
CmsPermissionSetCustom	A custom permission set that can be modified during runtime and contains both allowed and denied permissions as bitsets.
CmsPersistentLoginAuthorizationHandler	Authorization handler which uses a special cookie sent by the user's browser for authorization.
CmsPersistentLoginTokenHandler	Creates and validates persisten login tokens for users.
CmsPersistentLoginTokenHandler.Token	Bean representing the data encoded in a login token (user name and key).
CmsPrincipal	Common methods shared among user and group principals, also contains several utility functions to deal with principal instances.
CmsRole	A role is used in the OpenCms security system to check if a user has access to a certain system function.
CmsRoleAsPrincipal	Wrapper around CmsRole objects so they can be used as principals.
CmsRoleManager	This manager provide access to the role related operations.
CmsUserLog	Class with static methods for logging user-related operations in a centralized manner.
I_CmsPermissionHandler.CmsPermissionCheckResult	Enumeration class for the results of I_CmsPermissionHandler.hasPermissions(CmsDbContext, CmsResource, CmsPermissionSet, LockCheck, CmsResourceFilter).
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
I_CmsPasswordSecurityEvaluator.SecurityLevel	Password security levels.
I_CmsPermissionHandler.LockCheck	Enum for the lock check mode.

Exception Summary

Exception	Description
CmsAuthentificationException	Signals that an attempt to authenticate (login) has a user has failed.
CmsCustomLoginException	Custom login exception whose message will be displayed to the user if the login fails.
CmsPasswordEncryptionException	Signals that an attempt to encrypt a password was not successful.
CmsPermissionViolationException	A permission violation occurs if a user without tries to access or maipulate a VFS resource without the required permissions.
CmsRoleViolationException	A role violation occurs if a user without permissions tries to access a protected OpenCms system feature that can only be accessed by users in certain roles.
CmsSecurityException	Used to signal security related issues, for example example during file access and login.
CmsUserDisabledException	Signals that an attempt to authenticate (login) a user has failed because the user had to many invalid logins.