Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.22 KB

File metadata and controls

61 lines (42 loc) · 2.22 KB

CommonPHP Auth Documentation

CommonPHP Auth is the authentication package for CommonPHP applications and plain PHP projects. It provides credential and identity value objects, result-oriented authentication flow, login state helpers, and driver contracts for database, LDAP, API token, or custom authentication sources.

Auth proves identity. It intentionally does not own authorization policies, password hashing, sessions, HTTP requests, routing, or persistence. Those concerns stay in comphp/security, comphp/session, HTTP/web packages, and driver packages.

Start Here

Authentication Concepts

Examples

Development

Public API Map

Entry points:

  • CommonPHP\Authentication\Authenticator
  • CommonPHP\Authentication\AuthenticationState

Value and result objects:

  • CommonPHP\Authentication\Credentials
  • CommonPHP\Authentication\Identity
  • CommonPHP\Authentication\AuthenticationResult
  • CommonPHP\Authentication\Enums\AuthenticationStatus

Contracts:

  • CommonPHP\Authentication\Contracts\AuthenticatorInterface
  • CommonPHP\Authentication\Contracts\AuthenticationDriverInterface
  • CommonPHP\Authentication\Contracts\AbstractAuthenticationDriver
  • CommonPHP\Authentication\Contracts\CredentialInterface
  • CommonPHP\Authentication\Contracts\IdentityInterface
  • CommonPHP\Authentication\Contracts\IdentityProviderInterface

Exceptions:

  • CommonPHP\Authentication\Exceptions\AuthenticationException
  • CommonPHP\Authentication\Exceptions\AuthenticationDriverException
  • CommonPHP\Authentication\Exceptions\AuthenticationStateException
  • CommonPHP\Authentication\Exceptions\IdentityNotFoundException
  • CommonPHP\Authentication\Exceptions\InvalidCredentialsException