Skip to content

Commit 80a8caa

Browse files
authored
vault: update ldap secrets racf usage docs (#1101)
2 parents 00fef0d + 03be266 commit 80a8caa

File tree

4 files changed

+179
-56
lines changed
  • content/vault

4 files changed

+179
-56
lines changed

content/vault/v1.18.x/content/docs/secrets/ldap.mdx

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ The secrets engine has three primary features:
5151
Note: it's not possible to retrieve the generated password once rotated by Vault.
5252
It's recommended a dedicated entry management account be created specifically for Vault.
5353

54-
### Schemas
54+
## Schemas
5555

5656
The LDAP Secret Engine supports three different schemas:
5757

5858
- `openldap` (default)
5959
- `racf`
6060
- `ad`
6161

62-
#### OpenLDAP
62+
### OpenLDAP
6363

6464
By default, the LDAP Secret Engine assumes the entry password is stored in `userPassword`.
6565
There are many object classes that provide `userPassword` including for example:
@@ -71,24 +71,54 @@ There are many object classes that provide `userPassword` including for example:
7171
- `person`
7272
- `posixAccount`
7373

74-
#### Resource access control facility (RACF)
74+
### Resource access control facility (RACF)
7575

76-
For managing IBM's Resource Access Control Facility (RACF) security system, the secret
77-
engine must be configured to use the schema `racf`.
76+
To manage credentials for an IBM Resource Access Control Facility (RACF),
77+
configure the LDAP secrets engine with the `racf` schema to enable the
78+
behaviors required for RACF compatibility.
7879

79-
Generated passwords must be 8 characters or less to support RACF. The length of the
80-
password can be configured using a [password policy](/vault/docs/concepts/password-policies):
80+
#### Password vs. password phrase credentials
8181

82-
```bash
82+
The LDAP plugin supports traditional 8-character passwords and modern,
83+
longer password phrases through th
84+
[`credential_type`](/vault/api-docs/secret/ldap#credential_type) parameter:
85+
86+
- `password` (Default): Configure the plugin to generate and manage standard RACF passwords.
87+
88+
- `phrase`: Configure the plugin to generate and manage case-sensitive password phrases.
89+
90+
#### Configure password rules
91+
92+
The RACF schema does not control the credential complexity rules directly.
93+
To enforce site-specific complexity requirements, define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies)
95+
to your RACF schema.
96+
97+
#### Example configuration
98+
99+
The following example configures the LDAP engine for RACF, sets it to manage
100+
password phrases, and links a password policy to enforce length and
101+
complexity.
102+
103+
```shell-session
104+
$ cat > /tmp/password_policy.hcl <<-EOF
105+
length = 20
106+
rule "charset" {
107+
charset = "abcdefghijklmnopqrstuvwxyz"
108+
min-chars = 1
109+
}
110+
EOF
111+
$ vault write sys/policies/password/racf_password_policy policy=@/tmp/password_policy.hcl
83112
$ vault write ldap/config \
84-
binddn=$USERNAME \
85-
bindpass=$PASSWORD \
86-
url=ldaps://138.91.247.105 \
87-
schema=racf \
88-
password_policy=racf_password_policy
113+
binddn="$USERNAME" \
114+
bindpass="$PASSWORD" \
115+
url="ldaps://138.91.247.105" \
116+
schema="racf" \
117+
credential_type="phrase" \
118+
password_policy="racf_password_policy"
89119
```
90120

91-
#### Active directory (AD)
121+
### Active directory (AD)
92122

93123
For managing Active Directory instances, the secret engine must be configured to use the
94124
schema `ad`.

content/vault/v1.19.x/content/docs/secrets/ldap.mdx

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ The secrets engine has three primary features:
5151
Note: it's not possible to retrieve the generated password once rotated by Vault.
5252
It's recommended a dedicated entry management account be created specifically for Vault.
5353

54-
### Schemas
54+
## Schemas
5555

5656
The LDAP Secret Engine supports three different schemas:
5757

5858
- `openldap` (default)
5959
- `racf`
6060
- `ad`
6161

62-
#### OpenLDAP
62+
### OpenLDAP
6363

6464
By default, the LDAP Secret Engine assumes the entry password is stored in `userPassword`.
6565
There are many object classes that provide `userPassword` including for example:
@@ -71,24 +71,55 @@ There are many object classes that provide `userPassword` including for example:
7171
- `person`
7272
- `posixAccount`
7373

74-
#### Resource access control facility (RACF)
74+
### Resource access control facility (RACF)
7575

76-
For managing IBM's Resource Access Control Facility (RACF) security system, the secret
77-
engine must be configured to use the schema `racf`.
76+
To manage credentials for an IBM Resource Access Control Facility (RACF),
77+
configure the LDAP secrets engine with the `racf` schema to enable the
78+
behaviors required for RACF compatibility.
7879

79-
Generated passwords must be 8 characters or less to support RACF. The length of the
80-
password can be configured using a [password policy](/vault/docs/concepts/password-policies):
80+
#### Password vs. password phrase credentials
8181

82-
```bash
82+
The LDAP plugin supports traditional 8-character passwords and modern,
83+
longer password phrases through th
84+
[`credential_type`](/vault/api-docs/secret/ldap#credential_type) parameter:
85+
86+
- `password` (Default): Configure the plugin to generate and manage standard RACF passwords.
87+
- `phrase`: Configure the plugin to generate and manage case-sensitive password phrases.
88+
89+
90+
#### Configure password rules
91+
92+
The RACF schema does not control the credential complexity rules directly.
93+
To enforce site-specific complexity requirements, define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies)
95+
to your RACF schema.
96+
97+
98+
#### Example configuration
99+
100+
The following example configures the LDAP engine for RACF, sets it to manage
101+
password phrases, and links a password policy to enforce length and
102+
complexity.
103+
104+
```shell-session
105+
$ cat > /tmp/password_policy.hcl <<-EOF
106+
length = 20
107+
rule "charset" {
108+
charset = "abcdefghijklmnopqrstuvwxyz"
109+
min-chars = 1
110+
}
111+
EOF
112+
$ vault write sys/policies/password/racf_password_policy policy=@/tmp/password_policy.hcl
83113
$ vault write ldap/config \
84-
binddn=$USERNAME \
85-
bindpass=$PASSWORD \
86-
url=ldaps://138.91.247.105 \
87-
schema=racf \
88-
password_policy=racf_password_policy
114+
binddn="$USERNAME" \
115+
bindpass="$PASSWORD" \
116+
url="ldaps://138.91.247.105" \
117+
schema="racf" \
118+
credential_type="phrase" \
119+
password_policy="racf_password_policy"
89120
```
90121

91-
#### Active directory (AD)
122+
### Active directory (AD)
92123

93124
For managing Active Directory instances, the secret engine must be configured to use the
94125
schema `ad`.

content/vault/v1.20.x/content/docs/secrets/ldap.mdx

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ The secrets engine has three primary features:
5151
Note: it's not possible to retrieve the generated password once rotated by Vault.
5252
It's recommended a dedicated entry management account be created specifically for Vault.
5353

54-
### Schemas
54+
## Schemas
5555

5656
The LDAP Secret Engine supports three different schemas:
5757

5858
- `openldap` (default)
5959
- `racf`
6060
- `ad`
6161

62-
#### OpenLDAP
62+
### OpenLDAP
6363

6464
By default, the LDAP Secret Engine assumes the entry password is stored in `userPassword`.
6565
There are many object classes that provide `userPassword` including for example:
@@ -71,24 +71,55 @@ There are many object classes that provide `userPassword` including for example:
7171
- `person`
7272
- `posixAccount`
7373

74-
#### Resource access control facility (RACF)
74+
### Resource access control facility (RACF)
7575

76-
For managing IBM's Resource Access Control Facility (RACF) security system, the secret
77-
engine must be configured to use the schema `racf`.
76+
To manage credentials for an IBM Resource Access Control Facility (RACF),
77+
configure the LDAP secrets engine with the `racf` schema to enable the
78+
behaviors required for RACF compatibility.
7879

79-
Generated passwords must be 8 characters or less to support RACF. The length of the
80-
password can be configured using a [password policy](/vault/docs/concepts/password-policies):
80+
#### Password vs. password phrase credentials
8181

82-
```bash
82+
The LDAP plugin supports traditional 8-character passwords and modern,
83+
longer password phrases through th
84+
[`credential_type`](/vault/api-docs/secret/ldap#credential_type) parameter:
85+
86+
- `password` (Default): Configure the plugin to generate and manage standard RACF passwords.
87+
- `phrase`: Configure the plugin to generate and manage case-sensitive password phrases.
88+
89+
90+
#### Configure password rules
91+
92+
The RACF schema does not control the credential complexity rules directly.
93+
To enforce site-specific complexity requirements, define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies)
95+
to your RACF schema.
96+
97+
98+
#### Example configuration
99+
100+
The following example configures the LDAP engine for RACF, sets it to manage
101+
password phrases, and links a password policy to enforce length and
102+
complexity.
103+
104+
```shell-session
105+
$ cat > /tmp/password_policy.hcl <<-EOF
106+
length = 20
107+
rule "charset" {
108+
charset = "abcdefghijklmnopqrstuvwxyz"
109+
min-chars = 1
110+
}
111+
EOF
112+
$ vault write sys/policies/password/racf_password_policy policy=@/tmp/password_policy.hcl
83113
$ vault write ldap/config \
84-
binddn=$USERNAME \
85-
bindpass=$PASSWORD \
86-
url=ldaps://138.91.247.105 \
87-
schema=racf \
88-
password_policy=racf_password_policy
114+
binddn="$USERNAME" \
115+
bindpass="$PASSWORD" \
116+
url="ldaps://138.91.247.105" \
117+
schema="racf" \
118+
credential_type="phrase" \
119+
password_policy="racf_password_policy"
89120
```
90121

91-
#### Active directory (AD)
122+
### Active directory (AD)
92123

93124
For managing Active Directory instances, the secret engine must be configured to use the
94125
schema `ad`.

content/vault/v1.21.x (rc)/content/docs/secrets/ldap.mdx

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ The secrets engine has three primary features:
5151
Note: it's not possible to retrieve the generated password once rotated by Vault.
5252
It's recommended a dedicated entry management account be created specifically for Vault.
5353

54-
### Schemas
54+
## Schemas
5555

5656
The LDAP Secret Engine supports three different schemas:
5757

5858
- `openldap` (default)
5959
- `racf`
6060
- `ad`
6161

62-
#### OpenLDAP
62+
### OpenLDAP
6363

6464
By default, the LDAP Secret Engine assumes the entry password is stored in `userPassword`.
6565
There are many object classes that provide `userPassword` including for example:
@@ -71,24 +71,55 @@ There are many object classes that provide `userPassword` including for example:
7171
- `person`
7272
- `posixAccount`
7373

74-
#### Resource access control facility (RACF)
74+
### Resource access control facility (RACF)
7575

76-
For managing IBM's Resource Access Control Facility (RACF) security system, the secret
77-
engine must be configured to use the schema `racf`.
76+
To manage credentials for an IBM Resource Access Control Facility (RACF),
77+
configure the LDAP secrets engine with the `racf` schema to enable the
78+
behaviors required for RACF compatibility.
7879

79-
Generated passwords must be 8 characters or less to support RACF. The length of the
80-
password can be configured using a [password policy](/vault/docs/concepts/password-policies):
80+
#### Password vs. password phrase credentials
8181

82-
```bash
82+
The LDAP plugin supports traditional 8-character passwords and modern,
83+
longer password phrases through th
84+
[`credential_type`](/vault/api-docs/secret/ldap#credential_type) parameter:
85+
86+
- `password` (Default): Configure the plugin to generate and manage standard RACF passwords.
87+
- `phrase`: Configure the plugin to generate and manage case-sensitive password phrases.
88+
89+
90+
#### Configure password rules
91+
92+
The RACF schema does not control the credential complexity rules directly.
93+
To enforce site-specific complexity requirements, define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies)
95+
to your RACF schema.
96+
97+
98+
#### Example configuration
99+
100+
The following example configures the LDAP engine for RACF, sets it to manage
101+
password phrases, and links a password policy to enforce length and
102+
complexity.
103+
104+
```shell-session
105+
$ cat > /tmp/password_policy.hcl <<-EOF
106+
length = 20
107+
rule "charset" {
108+
charset = "abcdefghijklmnopqrstuvwxyz"
109+
min-chars = 1
110+
}
111+
EOF
112+
$ vault write sys/policies/password/racf_password_policy policy=@/tmp/password_policy.hcl
83113
$ vault write ldap/config \
84-
binddn=$USERNAME \
85-
bindpass=$PASSWORD \
86-
url=ldaps://138.91.247.105 \
87-
schema=racf \
88-
password_policy=racf_password_policy
114+
binddn="$USERNAME" \
115+
bindpass="$PASSWORD" \
116+
url="ldaps://138.91.247.105" \
117+
schema="racf" \
118+
credential_type="phrase" \
119+
password_policy="racf_password_policy"
89120
```
90121

91-
#### Active directory (AD)
122+
### Active directory (AD)
92123

93124
For managing Active Directory instances, the secret engine must be configured to use the
94125
schema `ad`.

0 commit comments

Comments
 (0)