Classes List

Symfony\Component\Security\Csrf\CsrfTokenManagerInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Csrf;

/** * Manages CSRF tokens. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface CsrfTokenManagerInterface
{
    /** * Returns a CSRF token for the given ID. * * If previously no token existed for the given ID, a new token is * generated. Otherwise the existing token is returned (with the same value, * not the same instance). * * @param string $tokenId The token ID. You may choose an arbitrary value * for the ID * * @return CsrfToken The CSRF token */
    public function getToken($tokenId);

    /** * Generates a new token value for the given ID. * * This method will generate a new token for the given token ID, independent * of whether a token value previously existed or not. It can be used to * enforce once-only tokens in environments with high security needs. * * @param string $tokenId The token ID. You may choose an arbitrary value * for the ID * * @return CsrfToken The CSRF token */
    public function refreshToken($tokenId);

    /** * Invalidates the CSRF token with the given ID, if one exists. * * @param string $tokenId The token ID * * @return string|null Returns the removed token value if one existed, NULL * otherwise */
    public function removeToken($tokenId);

    /** * Returns whether the given CSRF token is valid. * * @return bool Returns true if the token is valid, false otherwise */
    public function isTokenValid(CsrfToken $token);
}