mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
9e05066097
Add tests and makes the password policy a provider so the configuration can be loaded to memory on startup.
134 lines
2.7 KiB
Markdown
134 lines
2.7 KiB
Markdown
---
|
|
layout: default
|
|
title: Password Policy
|
|
parent: Configuration
|
|
nav_order: 17
|
|
---
|
|
|
|
# Password Policy
|
|
|
|
_Authelia_ allows administrators to configure an enforced password policy.
|
|
|
|
## Configuration
|
|
|
|
```yaml
|
|
password_policy:
|
|
standard:
|
|
enabled: false
|
|
min_length: 8
|
|
max_length: 0
|
|
require_uppercase: false
|
|
require_lowercase: false
|
|
require_number: false
|
|
require_special: false
|
|
zxcvbn:
|
|
enabled: false
|
|
```
|
|
|
|
## Options
|
|
|
|
### standard
|
|
<div markdown="1">
|
|
type: list
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
This section allows you to enable standard security policies.
|
|
|
|
#### enabled
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Enables standard password policy.
|
|
|
|
#### min_length
|
|
<div markdown="1">
|
|
type: integer
|
|
{: .label .label-config .label-purple }
|
|
default: 8
|
|
{: .label .label-config .label-blue }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Determines the minimum allowed password length.
|
|
|
|
#### max_length
|
|
<div markdown="1">
|
|
type: integer
|
|
{: .label .label-config .label-purple }
|
|
default: 0
|
|
{: .label .label-config .label-blue }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Determines the maximum allowed password length.
|
|
|
|
#### require_uppercase
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Indicates that at least one UPPERCASE letter must be provided as part of the password.
|
|
|
|
#### require_lowercase
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Indicates that at least one lowercase letter must be provided as part of the password.
|
|
|
|
#### require_number
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Indicates that at least one number must be provided as part of the password.
|
|
|
|
#### require_special
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
Indicates that at least one special character must be provided as part of the password.
|
|
|
|
### zxcvbn
|
|
|
|
This password policy enables advanced password strength metering, using [zxcvbn](https://github.com/dropbox/zxcvbn).
|
|
|
|
Note that this password policy do not restrict the user's entry it just gives the user feedback as to how strong their
|
|
password is.
|
|
|
|
#### enabled
|
|
<div markdown="1">
|
|
type: bool
|
|
{: .label .label-config .label-purple }
|
|
required: no
|
|
{: .label .label-config .label-green }
|
|
</div>
|
|
|
|
_**Important Note:** only one password policy can be applied at a time._
|
|
|
|
Enables zxcvbn password policy.
|
|
|
|
|