class CsrfTokenService (View source)

Generates, stores and validates the per-session CSRF token carried by the _token form field.

Constants

TOKEN_LENGTH

Methods

__construct(SessionInterface $session)

No description

string
generateToken()

No description

string
getToken(string $session_var = SessionKeys::CSRF_TOKEN)

No description

bool
validateToken(string $token, string $session_var = SessionKeys::CSRF_TOKEN)

No description

void
ensureTokenExists(string $session_var = SessionKeys::CSRF_TOKEN)

No description

void
regenerateToken(string $session_var = SessionKeys::CSRF_TOKEN)

Replace the session token. Called on login so a token planted before authentication cannot be used after it.

Details

__construct(SessionInterface $session)

No description

Parameters

SessionInterface $session

string generateToken()

No description

Return Value

string

string getToken(string $session_var = SessionKeys::CSRF_TOKEN)

No description

Parameters

string $session_var

Return Value

string

bool validateToken(string $token, string $session_var = SessionKeys::CSRF_TOKEN)

No description

Parameters

string $token
string $session_var

Return Value

bool

void ensureTokenExists(string $session_var = SessionKeys::CSRF_TOKEN)

No description

Parameters

string $session_var

Return Value

void

void regenerateToken(string $session_var = SessionKeys::CSRF_TOKEN)

Replace the session token. Called on login so a token planted before authentication cannot be used after it.

Parameters

string $session_var

Return Value

void