Download the PHP package dotkernel/dot-authentication without Composer
On this page you can find all versions of the php package dotkernel/dot-authentication. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dotkernel/dot-authentication
More information about dotkernel/dot-authentication
Files in dotkernel/dot-authentication
Package dot-authentication
Short Description Core interfaces for authentication implementations
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dot-authentication
dot-authentication
Authentication base package defining interfaces for authentication services to be used with DotKernel applications.
Installation
Run the following command in you project directory
Please note that usually this package will be installed as a dependency to a concrete implementation, so usually you won't need to add this to you project manually.
AuthenticationInterface
Defines the interface that should be implemented by any authentication service, in order to work with DotKernel applications. This is a result of the fact that the default packages used by DotKernel applications, that need access to the authentication service are type-hinted against this interface.
Also, concrete implementations should be registered in the service manager using this interface's FQN.
Methods
-
method to implement the actual authentication process. It should extract credentials from the
$requestobject(Authorization header, custom request attributes etc.). It should return anAuthenticationResultobject, defined in this package, which carry the authentication status and identity on success. -
this method should return a valid PSR-7
ResponseInterfaceused to notify the client or browser that it needs to authenticate first(usually using theWWW-Authenticateheader - usefull for HTTP basic and digest authentication) - these methods are used to check if authenticated, get the authenticated identity object, force set an identity(maybe useful for auto-login) or clear an identity(logout)
IdentityInterface
You can use any object to represent an authenticated identity(user) as long as it implements this interface. It requires 2 methods, getId() which should return the unique identifier of the identity, and getName(): string which should return a string representation of the identity(for display purposes, usually the email or username)
AuthenticationResult
Returned by the authentication service, on authentication success or failure. It composes one of the predefined authentication codes, which describes the authentication status, an error message in case the authentication has failed, and the identity object on success.
UnauthorizedException
Exception to be thrown when accessing content that need authentication first. This can be used within an application to trigger an error and do a custom action(like redirecting to a login page). There is not a predefined way to handle this, DotKernel packages use this exception paired with a custom error handler to handle unauthorized errors. When using the frontend or admin applications, this is already setup among the authentication/authorization packages, and throwing an UnauthorizedException from anywhere your application, it will redirect to the login page by default.
