Dar contraseñas a los usuarios
Keep on Learning!
If you liked what you've learned so far, dive in! Subscribe to get access to this tutorial plus video, code and script downloads.
With a Subscription, click any sentence in the script to jump to that part of the video!
Login SubscribeA Symfony realmente no le importa si los usuarios de tu sistema tienen contraseñas o no. Si estás construyendo un sistema de inicio de sesión que lee las claves API de una cabecera, entonces no hay contraseñas. Lo mismo ocurre si tienes algún tipo de sistema SSO. Tus usuarios pueden tener contraseñas... pero las introducen en algún otro sitio.
Pero para nosotros, sí queremos que cada usuario tenga una contraseña. Cuando antes utilizamos el comando make:user, nos preguntó si queríamos que nuestros usuarios tuvieran contraseña. Respondimos que no... para poder hacer todo esto manualmente. Pero en un proyecto real, yo respondería "sí" para ahorrar tiempo.
PasswordAuthenticatedUserInterface
Sabemos que todas las clases de Usuario deben implementar UserInterface:
| // ... lines 1 - 7 | |
| use Symfony\Component\Security\Core\User\UserInterface; | |
| // ... lines 9 - 12 | |
| class User implements UserInterface | |
| { | |
| // ... lines 15 - 130 | |
| } |
Entonces, si necesitas comprobar las contraseñas de los usuarios en tu aplicación, también tienes que implementar una segunda interfaz llamada PasswordAuthenticatedUserInterface:
| // ... lines 1 - 6 | |
| use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface; | |
| // ... lines 8 - 12 | |
| class User implements UserInterface, PasswordAuthenticatedUserInterface | |
| { | |
| // ... lines 15 - 128 | |
| } |
Esto requiere que tengas un nuevo método: getPassword().
Si estás utilizando Symfony 6, aún no tendrás esto, así que añádelo:
| // ... lines 1 - 12 | |
| class User implements UserInterface | |
| { | |
| // ... lines 15 - 90 | |
| /** | |
| * This method can be removed in Symfony 6.0 - is not needed for apps that do not check user passwords. | |
| * | |
| * @see PasswordAuthenticatedUserInterface | |
| */ | |
| public function getPassword(): ?string | |
| { | |
| return null; | |
| } | |
| // ... lines 100 - 130 | |
| } |
Yo lo tengo porque uso Symfony 5 y el método getPassword() es necesario por compatibilidad con versiones anteriores: antes formaba parte de UserInterface.
Ahora que nuestros usuarios tendrán una contraseña, y que estamos implementandoPasswordAuthenticatedUserInterface, voy a eliminar este comentario encima del método:
| // ... lines 1 - 12 | |
| class User implements UserInterface, PasswordAuthenticatedUserInterface | |
| { | |
| // ... lines 15 - 90 | |
| /** | |
| * @see PasswordAuthenticatedUserInterface | |
| */ | |
| public function getPassword(): ?string | |
| { | |
| return null; | |
| } | |
| // ... lines 98 - 128 | |
| } |
Almacenar una contraseña hash para cada usuario
Vale, olvidémonos de la seguridad por un momento. En su lugar, centrémonos en el hecho de que necesitamos poder almacenar una contraseña única para cada usuario en la base de datos. ¡Esto significa que nuestra entidad de usuario necesita un nuevo campo! Busca tu terminal y ejecuta:
symfony console make:entity
Actualicemos la entidad User, para añadir un nuevo campo llámalo password... que es una cadena, 255 de longitud es exagerado pero está bien... y luego di "no" a anulable. Pulsa intro para terminar.
De vuelta en la clase User, es... en su mayor parte no sorprendente. Tenemos una nueva propiedad $password... y al final, un nuevo método setPassword():
| // ... lines 1 - 12 | |
| class User implements UserInterface, PasswordAuthenticatedUserInterface | |
| { | |
| // ... lines 15 - 36 | |
| /** | |
| * @ORM\Column(type="string", length=255) | |
| */ | |
| private $password; | |
| // ... lines 41 - 134 | |
| public function setPassword(string $password): self | |
| { | |
| $this->password = $password; | |
| return $this; | |
| } | |
| } |
Fíjate que no ha generado un método getPassword()... porque ya teníamos uno. Pero tenemos que actualizarlo para que devuelva $this->password:
| // ... lines 1 - 12 | |
| class User implements UserInterface, PasswordAuthenticatedUserInterface | |
| { | |
| // ... lines 15 - 98 | |
| public function getPassword(): ?string | |
| { | |
| return $this->password; | |
| } | |
| // ... lines 103 - 140 | |
| } |
Algo muy importante sobre esta propiedad $password: no va a almacenar la contraseña en texto plano. ¡Nunca jamás almacenes la contraseña en texto plano! Es la forma más rápida de tener una brecha de seguridad... y perder amigos.
En su lugar, vamos a almacenar una versión cifrada de la contraseña... y dentro de un minuto veremos cómo generar esa contraseña cifrada. Pero antes, hagamos la migración para la nueva propiedad:
symfony console make:migration
Echa un vistazo a ese archivo para asegurarte de que todo se ve bien:
| // ... lines 1 - 12 | |
| final class Version20211001185505 extends AbstractMigration | |
| { | |
| public function getDescription(): string | |
| { | |
| return ''; | |
| } | |
| public function up(Schema $schema): void | |
| { | |
| // this up() migration is auto-generated, please modify it to your needs | |
| $this->addSql('ALTER TABLE user ADD password VARCHAR(255) NOT NULL'); | |
| } | |
| public function down(Schema $schema): void | |
| { | |
| // this down() migration is auto-generated, please modify it to your needs | |
| $this->addSql('ALTER TABLE user DROP password'); | |
| } | |
| } |
Tip
Si utilizas PostgreSQL, deberás modificar tu migración. Añade DEFAULT '' al final para que la nueva columna pueda añadirse sin error`terminal
$this->addSql('ALTER TABLE user ADD password VARCHAR(255) NOT NULL DEFAULT \'\'');
Y... ¡lo hace! Ciérralo... y ejecútalo:
symfony console doctrine:migrations:migrate
El password_hashers Config
¡Perfecto! Ahora que nuestros usuarios tienen una nueva columna de contraseña en la base de datos, vamos a rellenarla en nuestras fijaciones. Abre src/Factory/UserFactory.php y busca getDefaults().
De nuevo, lo que no vamos a hacer es poner en password la contraseña en texto plano. No, esa propiedad password tiene que almacenar la versión hash de la contraseña.
Abre config/packages/security.yaml. Esto tiene un poco de configuración en la parte superior llamada password_hashers, que le dice a Symfony qué algoritmo hash debe utilizar para el hash de las contraseñas de usuario:
| security: | |
| // ... lines 2 - 6 | |
| # https://symfony.com/doc/current/security.html#c-hashing-passwords | |
| password_hashers: | |
| Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface: 'auto' | |
| // ... lines 10 - 39 |
Esta configuración dice que cualquier clase User que implementePasswordAuthenticatedUserInterface - lo que nuestra clase, por supuesto, hace - utilizará el algoritmo auto donde Symfony elige el último y mejor algoritmo automáticamente.
El servicio Password Hasher
Gracias a esta configuración, tenemos acceso a un servicio "hasher" que es capaz de convertir una contraseña de texto plano en una versión hash utilizando este algoritmo auto. De vuelta aUserFactory, podemos utilizarlo para establecer la propiedad password:
| // ... lines 1 - 28 | |
| final class UserFactory extends ModelFactory | |
| { | |
| // ... lines 31 - 37 | |
| protected function getDefaults(): array | |
| { | |
| return [ | |
| // ... lines 41 - 42 | |
| 'plainPassword' => 'tada', | |
| ]; | |
| } | |
| // ... lines 46 - 58 | |
| } |
En el constructor, añade un nuevo argumento: UserPasswordHasherInterface $passwordHasher. Pulsaré Alt+Enter e iré a "Inicializar propiedades" para crear esa propiedad y establecerla:
| // ... lines 1 - 6 | |
| use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface; | |
| // ... lines 8 - 29 | |
| final class UserFactory extends ModelFactory | |
| { | |
| private UserPasswordHasherInterface $passwordHasher; | |
| public function __construct(UserPasswordHasherInterface $passwordHasher) | |
| { | |
| parent::__construct(); | |
| $this->passwordHasher = $passwordHasher; | |
| } | |
| // ... lines 40 - 67 | |
| } |
A continuación, podemos establecer password en $this->passwordHasher->hashPassword() y luego pasarle alguna cadena de texto sin formato.
Bueno... para ser sincero... aunque espero que esto tenga sentido a alto nivel... esto no funcionará del todo porque el primer argumento de hashPassword() es el objeto User... que aún no tenemos dentro de getDefaults().
No pasa nada, porque de todas formas me gusta crear una propiedad plainPassword en User para facilitar todo esto. Añadámoslo a continuación, terminemos las fijaciones y actualicemos nuestro autenticador para validar la contraseña. Ah, pero no te preocupes: esa nueva propiedadplainPassword no se almacenará en la base de datos.
18 Comments
Is anyone else confused about the "product" table mentioned in the tip of the migration file for PostgreSQL user?
Hey @JDCrain ,
Ah, I see now :) Yeah, seems someone was testing that query on different DB structure and didn't tweak it to match the tutorial code, I fixed it :)
Thanks for the head ups!
Cheers!
Hey @JDCrain ,
What exactly confuses you in that? :) Could you share more info?
Cheers!
Dear SymfonyCasts,
I created a migration to add
passwordcolumn containing$this->addSql('ALTER TABLE user ADD password VARCHAR(255) NOT NULL');.Since the
usertable already has users in it, I thought the migration would fail because it should not know what value to use for the existing rows in the table, resulting in an error. However, the migration surprisingly executed without any error.I inserted a new user manually using MySQL's console, and it warned me:
Field 'password' doesn't have a default value.I ran
set SQL_MODE='STRICT_ALL_TABLES';referring to this Stack Exchange post.As expected, the MySQL console throws an error when attempting to insert a new user without setting the password field.
However, when using
symfony console doctrine:query:sqlto insert a new user, despite the NOT NULL constraint, the following command completed successfully, introducing a new row with a missing password value:Symfony: 7.0.9
doctrine/doctrine-bundle: "^2.12"
MariaDB: 10.4.32-MariaDB
How to enforce the
NOT NULLconstraint?Thank you in advance.
Best regards,
Easwaran Chinraj
Hey Easwaran,
Hm, that should just work out of the box, not sure what exactly goes wrong in your case. First of all, please double-check the server version specified in your DB connection, either in the DATABASE_URL or in Doctrine config files, see "server_version" in https://symfony.com/doc/current/reference/configuration/doctrine.html . Also, double check your Doctrine config files that you don't have any custom options that may override that behavior.
But in your application, you can easily fix it with the validation constraints, then when you save the form without the required fields the validation will fail and the form will render an error for you avoiding saving the invalid data. That mostly solves your issue. About the "doctrine:query:SQL" - that's more complex, it just should work the same way your SQL console works, not sure. But that sounds like an edge case for admins anyway, it should not affect your users because users' input may be validated with validation constraints as I said above.
I hope that helps!
Cheers!
Hello,
the auth system requires a password field with the name
passwordfor the query in the corresponding table. How do I proceed if the password field should be called e.g.usr_password.thx!
HI @Rufnex,
Eeasy-peasy, you can configure everything in
security.yamlhere the docs https://symfony.com/doc/current/reference/configuration/security.html#reference-security-firewall-form-loginCheers!
Hi sadikoff,
thank you .. thats clear. What I meant I, in the database table the password field is called usr_password and not password. Is it possible to configure that too?
Thank you again.
Of course, you have total control over your Entity. You can use
nameproperty on#[ORM\Column()]attribute, and many overs BTW :-)Cheers
OMG . thats fu*** easy! Thank you ;o)
After changing nullable field to "not null", probably needs to add DEFAULT value in the migrations
$this->addSql('ALTER TABLE users ADD password VARCHAR(255) NOT NULL DEFAULT \'\'');
Hey triemli,
And probably not, did you get any issues with that? If yes, can you please share you DB version so we can find why that's not work for you?
If you create a not null field without default data mysql should just add this field with empty data, but probably that is something depending on configuration or server version.
Cheers
Maybe because I used Postgres.
First migration:
` $this->addSql('CREATE SEQUENCE users_id_seq INCREMENT BY 1 MINVALUE 1 START 1');
Second
$this->addSql("ALTER TABLE users ADD password VARCHAR(255) NOT NULL DEFAULT ''");Yeah that's the key, we are using mysql for tutorial, sounds like we should write a note about it, thanks for tip!
Cheers!
On Postgres I had to add some extra escaped quotes round user to get the migration to complete:
$this->addSql("ALTER TABLE \"user\" ADD password VARCHAR(255) NOT NULL DEFAULT''");Hey gazzatav
I bet that is because you are using "user" as table name, and this word is reserved. but tutorial uses "users" and that can be ok
Cheers
Hi @Vladimir, you are right that 'user' is a reserved word in postgresql and several other sql standards but I have used the class User exactly like the tutorials (there is no use of 'users' in the class). Doctrine is choosing table names not me! It may be that Doctrine chose 'users' for your dbms and version. Maybe Doctrine's knowledge of the dbms is so good it knows how closely it can keep to entity names. Out of interest, the postgresql documentation does say that it's possible to use a reserved word as a bare table name without creating an 'as' alias but anyway Doctrine always seems to create aliases. If I use psql to check my database, when I use the '\d user' command to describe the table, it describes the one Doctrine made. However, if I run 'select * from user;' the result comes from the admin table which postgres made! If I change the query to use 'public.user' I get the results from the fixtures.
Whoops, I missed somehow that tutorial uses 'user'. You can always force doctrine to use any table name you need with
@ORM\Table()annotation =)Cheers
"Houston: no signs of life"
Start the conversation!