KnpGuard
Add simple and beautiful authentication to Symfony's security component in Silex
and anywhere else., (*1)
, (*2)
This library is deprecated since Symfony 2.8 and won't work with Symfony 3., (*3)
The original purpose was to get feedback and use-cases from people so that we can merge this feature into Symfony itself
(see symfony/symfony#14673)., (*4)
Now it's good (see news from Symfony)., (*5)
Upgrade to Symfony 3
On Symfony 2.8, use the official Guard component., (*6)
Step 1 - Remove the library from your composer.json
Be sure to be on Symfony 2.8, open composer.json file and remove the library:, (*7)
Before:, (*8)
{
"require": {
"php": ">=5.5",
"symfony/symfony": "~2.8",
"...": "...",
"knpuniversity/guard-bundle": "~0.1@dev"
},
}
Now:, (*9)
{
"require": {
"php": ">=5.5",
"symfony/symfony": "~2.8",
"...": "..."
},
}
Step 2 - Remove it from your AppKernel
If you're using the Symfony framework, remove the KnpUGuardBundle from AppKernel.php., (*10)
Step 3 - Modify firewall(s)
Open and modify security.yml file, replace in your firewall(s) key(s) knpu_guard by guard:, (*11)
Before:, (*12)
# app/config/security.yml
security:
# ...
firewalls:
# ...
main:
anonymous: ~
logout: ~
knpu_guard:
authenticators:
- app.form_login_authenticator
# maybe other things, like form_login, remember_me, etc
# ...
Now:, (*13)
# app/config/security.yml
security:
# ...
firewalls:
# ...
main:
anonymous: ~
logout: ~
guard:
authenticators:
- app.form_login_authenticator
# maybe other things, like form_login, remember_me, etc
# ...
Step 4 - Update Authenticator(s)
Update uses in Authenticator(s) class(es)., (*14)
Warning: checkCredentials() NOW must return true in order for authentication to be successful.
In KnpUGuard, if you did NOT throw an AuthenticationException, it would pass., (*15)
Before:, (*16)
use KnpU\Guard\Authenticator\AbstractFormLoginAuthenticator;
use KnpU\Guard\...;
// ...
class FormLoginAuthenticator extends AbstractFormLoginAuthenticator
{
// ...
public function checkCredentials($credentials, UserInterface $user)
{
// ...
if ($password !== 'correctPassword') {
throw new AuthenticationException();
}
// do nothing, allow authentication to pass
}
// ...
}
Now:, (*17)
use Symfony\Component\Security\Guard\AbstractFormLoginAuthenticator;
use Symfony\Component\Security\Guard\...;
// ...
class FormLoginAuthenticator extends AbstractFormLoginAuthenticator
{
// ...
public function checkCredentials($credentials, UserInterface $user)
{
// ...
if ($password !== 'correctPassword') {
// returning anything NOT true will cause an authentication failure
return;
// or, you can still throw an AuthenticationException if you want to
// throw new AuthenticationException();
}
// return true to make authentication successful
return true;
}
// ...
}
Step 5 - Yes we can test it
That's it! Try it out, and then upgrade to Symfony 3 :)., (*18)
Documentation
Find a full tutorial here: https://knpuniversity.com/screencast/guard, (*19)
Basic Usage
Check out the Tutorial for real documentation.
But here's the basic idea., (*20)
Guard works by creating a single class - an authenticator - that handles everything
about how you want to authenticate your users. And authenticator implements
KnpU\Guard\GuardAuthenticatorInterface), (*21)
Here are some real-world examples from the tutorial:, (*22)
Contributing
Find a bug or a use-case that this doesn't support? Open an Issue
so we can make things better., (*23)
License
This library is under the MIT license. See the complete license in the LICENSE file., (*24)
Wallogit.com
