class DigestAuthenticationEntryPoint implements AuthenticationEntryPointInterface

DigestAuthenticationEntryPoint starts an HTTP Digest authentication.

Methods

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

No description

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

Returns a response that directs the user to authenticate.

getKey() deprecated

No description

string
getSecret()

No description

string
getRealmName()

No description

Details

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

Parameters

$realmName
$secret
$nonceValiditySeconds
LoggerInterface $logger

at line 43
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:

  • For a form login, you might redirect to the login page

    return new RedirectResponse('/login');

  • 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

at line 70
getKey() deprecated

deprecated Since version 2.8, to be removed in 3.0. Use getSecret() instead.

at line 80
string getSecret()

Return Value

string

at line 88
string getRealmName()

Return Value

string