Package Summary
Support for validating
credentials (such as passwords or X509 certificates) during authentication via the
CredentialsMatcher interface and its supporting implementations.
Support for
PAM, or
Pluggable
Authentication
Modules, which is the capability to authenticate a user against multiple configurable (pluggable)
modules (Shiro calls these
Realms).
Interface Summary
An
Account is a convenience interface that extends both
AuthenticationInfo and
AuthorizationInfo and represents authentication and authorization for a
single account in a
single Realm.
AuthenticationInfo represents a Subject's (aka user's) stored account information relevant to the authentication/log-in process only.
An
AuthenticationListener listens for notifications while
Subjects authenticate with the system.
An
AuthenticationToken is a consolidation of an account's principals and supporting credentials submitted by a user during an authentication attempt.
An Authenticator is responsible for authenticating accounts in an application.
A
HostAuthenticationToken retains the host information from where an authentication attempt originates.
An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.
An
AuthenticationToken that indicates if the user wishes their identity to be remembered across sessions.
Interface representing account information that may use a salt when hashing credentials.
Class Summary
Superclass for almost all
Authenticator implementations that performs the common work around authentication attempts.
Simple implementation of the
Account interface that contains principal and credential and authorization information (roles and permissions) as instance variables and exposes them via getters and setters using standard JavaBean notation.
A simple username/password authentication token to support the most widely-used authentication mechanism.
Exception Summary
Exception thrown due to a problem with the account under which an authentication attempt is being executed.
General exception thrown due to an error during the Authentication process.
Thrown when an authentication attempt has been received for an account that has already been authenticated (i.e.
Exception thrown due to a problem with the credential(s) submitted for an account during the authentication process.
Thrown when attempting to authenticate and the corresponding account has been disabled for some reason.
Thrown when a system is configured to only allow a certain number of authentication attempts over a period of time and the current session has failed to authenticate successfully within that number.
Thrown during the authentication process when the system determines the submitted credential(s) has expired and will not allow login.
Thrown when attempting to authenticate with credential(s) that do not match the actual credentials associated with the account principal.
A special kind of
DisabledAccountException, this exception is thrown when attempting to authenticate and the corresponding account has been disabled explicitly due to being locked.
Thrown when attempting to authenticate with a principal that doesn't exist in the system (e.g.
Package org.apache.shiro.authc Description
Core interfaces and exceptions concerning Authentication (the act of logging-in).
Shiro abbreviates the word 'AuthentiCation' as
authc to distinguish it seperately from 'AuthoriZation', abbreviated as
authz.
The primary item of interest in this package is the
Authenticator interface, which acts as the entry point (facade) to all other other authentication components. Other components, interfaces and exceptions are here to support
Authenticator implementations.