Password field - 5 UI
Deprecated
|
This password field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework. For the updated implementation, see Password field for Magnolia 6 UI instead. |
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
BCryptTransformerin the password field by specifying atransformerClassproperty 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: PasswordReferencing fields shortcut info - 5 UI
See Referencing fields for further information.
| Property | Description |
|---|---|
|
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 |
|
optional, default is Text displayed when passwords do not match. Appears as ``Passwords do not match'' retrieved from a message bundle. |
Common field properties - 5 UI
| Property | Description | ||
|---|---|---|---|
|
required Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types. To check the correct form of the name, use the Definitions app. |
||
|
optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
||
|
optional Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static field. |
||
|
optional, default is Enables i18n
authoring support which allows editors to write foreign-language or
regionally targeted content. A two-letter language identifier (en, de,
fr etc.) is displayed on controls where |
||
|
optional, default is the message bundle defined in the dialog definition_ Message bundle such
as |
||
|
optional Field label displayed to editors. The value can be literal such as
If you do not provide the property, Magnolia will fall back to a generated i18n key and display the key in the UI. If you do not want a label at all, define the property and set its value
to a blank space such as |
||
|
optional, default is the name of the field’s parent node_ Name of the node where the value is saved. The name |
||
|
|||
|
optional, default is Makes the field uneditable. Adding this property has the same effect as creating a static field. |
||
|
optional, default is Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values. |
||
|
optional, default is Error message displayed when required is true and the user saves an
empty field. The value can be literal or retrieved from the
message bundle with
a key such as |
||
|
optional Adds one or more style names to this component. Multiple styles can be
specified as a space-separated list of style names such as
|
||
|
optional Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don’t need to define a class unless you want to override the default. The value is a fully-qualified class name.
|
||
|
optional, most fields set a default value automatically JCR property type of the stored value such as |
|
Add validators to define your own password policy such as minimum length and character types. |