Classes List

Symfony\Component\Security\Guard\GuardAuthenticatorInterface

 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 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
<?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\Guard;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Guard\Token\GuardTokenInterface;
use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;

/** * The interface for all "guard" authenticators. * * The methods on this interface are called throughout the guard authentication * process to give you the power to control most parts of the process from * one location. * * @author Ryan Weaver <ryan@knpuniversity.com> * * @deprecated since version 3.4, to be removed in 4.0. Use AuthenticatorInterface instead */
interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
{
    /** * Get the authentication credentials from the request and return them * as any type (e.g. an associate array). If you return null, authentication * will be skipped. * * Whatever value you return here will be passed to getUser() and checkCredentials() * * For example, for a form login, you might: * * if ($request->request->has('_username')) { * return array( * 'username' => $request->request->get('_username'), * 'password' => $request->request->get('_password'), * ); * } else { * return; * } * * Or for an API token that's on a header, you might use: * * return array('api_key' => $request->headers->get('X-API-TOKEN')); * * @param Request $request * * @return mixed|null */
    public function getCredentials(Request $request);

    /** * Return a UserInterface object based on the credentials. * * The *credentials* are the return value from getCredentials() * * You may throw an AuthenticationException if you wish. If you return * null, then a UsernameNotFoundException is thrown for you. * * @param mixed $credentials * @param UserProviderInterface $userProvider * * @throws AuthenticationException * * @return UserInterface|null */
    public function getUser($credentialsUserProviderInterface $userProvider);

    /** * Returns true if the credentials are valid. * * If any value other than true is returned, authentication will * fail. You may also throw an AuthenticationException if you wish * to cause authentication to fail. * * The *credentials* are the return value from getCredentials() * * @param mixed $credentials * @param UserInterface $user * * @return bool * * @throws AuthenticationException */
    public function checkCredentials($credentialsUserInterface $user);

    /** * Create an authenticated token for the given user. * * If you don't care about which token class is used or don't really * understand what a "token" is, you can skip this method by extending * the AbstractGuardAuthenticator class from your authenticator. * * @see AbstractGuardAuthenticator * * @param UserInterface $user * @param string $providerKey The provider (i.e. firewall) key * * @return GuardTokenInterface */
    public function createAuthenticatedToken(UserInterface $user$providerKey);

    /** * Called when authentication executed, but failed (e.g. wrong username password). * * This should return the Response sent back to the user, like a * RedirectResponse to the login page or a 403 response. * * If you return null, the request will continue, but the user will * not be authenticated. This is probably not what you want to do. * * @param Request $request * @param AuthenticationException $exception * * @return Response|null */
    public function onAuthenticationFailure(Request $requestAuthenticationException $exception);

    /** * Called when authentication executed and was successful! * * This should return the Response sent back to the user, like a * RedirectResponse to the last page they visited. * * If you return null, the current request will continue, and the user * will be authenticated. This makes sense, for example, with an API. * * @param Request $request * @param TokenInterface $token * @param string $providerKey The provider (i.e. firewall) key * * @return Response|null */
    public function onAuthenticationSuccess(Request $requestTokenInterface $token$providerKey);

    /** * Does this method support remember me cookies? * * Remember me cookie will be set if *all* of the following are met: * A) This method returns true * B) The remember_me key under your firewall is configured * C) The "remember me" functionality is activated. This is usually * done by having a _remember_me checkbox in your form, but * can be configured by the "always_remember_me" and "remember_me_parameter" * parameters under the "remember_me" firewall key * D) The onAuthenticationSuccess method returns a Response object * * @return bool */
    public function supportsRememberMe();
}