DEPRECATED
Password field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.
There is no corresponding implementation in the Magnolia 6 UI framework.
PasswordFieldDefinition renders two text boxes for entry and verification of passwords. The input text is masked in the field, but the value is stored as clear text in the JCR.
If you want to store hashed password values, you can:
- Use the password field to collect the value of the password entered by the user and delegate the storage of the password and hashing to an underlying user manager. The user manager may be an internal Magnolia user manager or an external user manager. See the Security app for an example of this approach.
Configure BCryptTransformer on the password field by specifying a
transformerClass
property in the field definition:transformerClass = info.magnolia.ui.form.field.transformer.basic.BCryptTransformer
If you store a hashed value, you can no longer decode it to clear text. This is suitable when you want to authenticate against the password and only compare the stored hash against the hash of the password provided when logging in. If you need passwords in plain text so that they can be used to access other systems requiring authentication, we recommend you use the Magnolia Password Manager module.
class: info.magnolia.ui.form.field.definition.PasswordFieldDefinition
fieldType: password
Password field properties
Simple password field definition:
form: tabs: - name: tabUser label: User fields: - name: password fieldType: password label: Password
Node name | Value |
---|---|
form | |
tabs | |
tabUser | |
fields | |
password | |
fieldType | password |
label | Password |
Field-specific properties:
<field name> | required Name of the field. |
| optional, default is Encodes the password and visually masks the characters. |
| optional, default is Property transformer class. Defines how the values are stored in the repository. |
| optional, default is Verifies that the contents of the two boxes match. When set to |
| optional, default is Text displayed above the field. Appears as "Please verify your entry" retrieved from a message bundle. |
| optional, default is Text displayed when passwords do not match. Appears as "Passwords do not match" retrieved from a message bundle. |
Add validators to define your own password policy such as minimum length and character types.