Skip to content

Commit b7da890

Browse files
committed
vault: update ldap secrets racf usage docs
1 parent 8345b64 commit b7da890

File tree

4 files changed

+148
-60
lines changed
  • content/vault

4 files changed

+148
-60
lines changed

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

Lines changed: 37 additions & 15 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,46 @@ 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 IBM's Resource Access Control Facility (RACF), you
77+
must configure the LDAP secrets engine with the `racf` schema. This enables
78+
specific 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+
#### Credential Type: Password vs. Password Phrase
8181

82-
```bash
83-
$ 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
82+
The engine can manage both traditional 8-character passwords and modern, longer
83+
password phrases. This is controlled by the [`credential_type`](/vault/api-docs/secret/ldap#credential_type)
84+
parameter:
85+
86+
- `password` (Default): The engine will generate and manage standard RACF passwords.
87+
88+
- `phrase`: The engine will generate and manage case-sensitive password phrases (14-100 characters).
89+
90+
#### Configuring Password Rules
91+
92+
The complexity rules for generated credentials, such as length, are not
93+
controlled by the RACF schema itself. Instead, you must define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies).
95+
This allows you to enforce site-specific complexity requirements.
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+
vault write ldap/config \
105+
binddn="$USERNAME" \
106+
bindpass="$PASSWORD" \
107+
url="ldaps://138.91.247.105" \
108+
schema="racf" \
109+
credential_type="phrase" \
110+
password_policy="racf_password_policy"
89111
```
90112

91-
#### Active directory (AD)
113+
### Active directory (AD)
92114

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

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

Lines changed: 37 additions & 15 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,46 @@ 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 IBM's Resource Access Control Facility (RACF), you
77+
must configure the LDAP secrets engine with the `racf` schema. This enables
78+
specific 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+
#### Credential Type: Password vs. Password Phrase
8181

82-
```bash
83-
$ 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
82+
The engine can manage both traditional 8-character passwords and modern, longer
83+
password phrases. This is controlled by the [`credential_type`](/vault/api-docs/secret/ldap#credential_type)
84+
parameter:
85+
86+
- `password` (Default): The engine will generate and manage standard RACF passwords.
87+
88+
- `phrase`: The engine will generate and manage case-sensitive password phrases (14-100 characters).
89+
90+
#### Configuring Password Rules
91+
92+
The complexity rules for generated credentials, such as length, are not
93+
controlled by the RACF schema itself. Instead, you must define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies).
95+
This allows you to enforce site-specific complexity requirements.
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+
vault write ldap/config \
105+
binddn="$USERNAME" \
106+
bindpass="$PASSWORD" \
107+
url="ldaps://138.91.247.105" \
108+
schema="racf" \
109+
credential_type="phrase" \
110+
password_policy="racf_password_policy"
89111
```
90112

91-
#### Active directory (AD)
113+
### Active directory (AD)
92114

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

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

Lines changed: 37 additions & 15 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,46 @@ 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 IBM's Resource Access Control Facility (RACF), you
77+
must configure the LDAP secrets engine with the `racf` schema. This enables
78+
specific 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+
#### Credential Type: Password vs. Password Phrase
8181

82-
```bash
83-
$ 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
82+
The engine can manage both traditional 8-character passwords and modern, longer
83+
password phrases. This is controlled by the [`credential_type`](/vault/api-docs/secret/ldap#credential_type)
84+
parameter:
85+
86+
- `password` (Default): The engine will generate and manage standard RACF passwords.
87+
88+
- `phrase`: The engine will generate and manage case-sensitive password phrases (14-100 characters).
89+
90+
#### Configuring Password Rules
91+
92+
The complexity rules for generated credentials, such as length, are not
93+
controlled by the RACF schema itself. Instead, you must define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies).
95+
This allows you to enforce site-specific complexity requirements.
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+
vault write ldap/config \
105+
binddn="$USERNAME" \
106+
bindpass="$PASSWORD" \
107+
url="ldaps://138.91.247.105" \
108+
schema="racf" \
109+
credential_type="phrase" \
110+
password_policy="racf_password_policy"
89111
```
90112

91-
#### Active directory (AD)
113+
### Active directory (AD)
92114

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

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

Lines changed: 37 additions & 15 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,46 @@ 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 IBM's Resource Access Control Facility (RACF), you
77+
must configure the LDAP secrets engine with the `racf` schema. This enables
78+
specific 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+
#### Credential Type: Password vs. Password Phrase
8181

82-
```bash
83-
$ 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
82+
The engine can manage both traditional 8-character passwords and modern, longer
83+
password phrases. This is controlled by the [`credential_type`](/vault/api-docs/secret/ldap#credential_type)
84+
parameter:
85+
86+
- `password` (Default): The engine will generate and manage standard RACF passwords.
87+
88+
- `phrase`: The engine will generate and manage case-sensitive password phrases (14-100 characters).
89+
90+
#### Configuring Password Rules
91+
92+
The complexity rules for generated credentials, such as length, are not
93+
controlled by the RACF schema itself. Instead, you must define and link a
94+
standard Vault [password policy](/vault/docs/concepts/password-policies).
95+
This allows you to enforce site-specific complexity requirements.
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+
vault write ldap/config \
105+
binddn="$USERNAME" \
106+
bindpass="$PASSWORD" \
107+
url="ldaps://138.91.247.105" \
108+
schema="racf" \
109+
credential_type="phrase" \
110+
password_policy="racf_password_policy"
89111
```
90112

91-
#### Active directory (AD)
113+
### Active directory (AD)
92114

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

0 commit comments

Comments
 (0)