DigestAuthenticationEntryPoint

class DigestAuthenticationEntryPoint implements AuthenticationEntryPointInterface

DigestAuthenticationEntryPoint starts an HTTP Digest authentication.

Methods

__construct($realmName, $secret, $nonceValiditySeconds = 300, LoggerInterface $logger = null)
Response start(Request $request, AuthenticationException $authException = null)

Returns a response that directs the user to authenticate.

string getSecret()
string getRealmName()

Details

__construct($realmName, $secret, $nonceValiditySeconds = 300, LoggerInterface $logger = null)

Parameters

$realmName
$secret
$nonceValiditySeconds
LoggerInterface $logger

Response start(Request $request, AuthenticationException $authException = null)

Returns a response that directs the user to authenticate.

This is called when an anonymous request accesses a resource that requires authentication. The job of this method is to return some response that "helps" the user start into the authentication process.

Examples: A) For a form login, you might redirect to the login page return new Response('/login'); B) For an API token authentication system, you return a 401 response return new Response('Auth header required', 401);

Parameters

Request $request The request that resulted in an AuthenticationException
AuthenticationException $authException The exception that started the authentication process

Return Value

Response

string getSecret()

Return Value

string

string getRealmName()

Return Value

string