Skip to content

Commit 22d77c6

Browse files
sirainencmouse
authored andcommitted
settings, auth/policy: Change auth_policy_request_attributes to be strlist
Also just link to the supported variables rather than duplicating them. The duplication was also missing fail_type.
1 parent d0a54ea commit 22d77c6

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

data/settings.js

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4340,23 +4340,13 @@ If \`no\`, there will be no report for the authentication result.`
43404340
Default has changed.`
43414341
},
43424342
tags: [ 'auth_policy' ],
4343-
values: setting_types.STRING,
4343+
values: setting_types.STRLIST,
43444344
seealso: [ 'auth_policy_server_url' ],
43454345
text: `
43464346
Request attributes specification.
43474347
4348-
Variables that can be used for this setting:
4349-
4350-
- [[variable,auth]]
4351-
4352-
- \`%{hashed_password}\`
4353-
4354-
- Truncated auth policy hash of username and password
4355-
4356-
- \`%{requested_username}\`
4357-
4358-
- Logged in user. Same as \`%{user}\`, except for master user logins the
4359-
same as \`%{login_user}\`.`
4348+
See [[link,auth_policy_variables]] for variables that can be used for this
4349+
setting.`
43604350
},
43614351

43624352
auth_policy_server_api_header: {

docs/core/config/auth/policy.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ dovecotlinks:
66
auth_policy_configuration:
77
hash: configuration
88
text: Auth Policy Configuration
9+
auth_policy_variables:
10+
hash: list-of-fields
11+
text: Auth Policy Variables
912
---
1013

1114
# Authentication Policy
@@ -44,7 +47,13 @@ auth_policy_hash_nonce = localized_random_string
4447
# OPTIONAL settings
4548
#auth_policy_server_api_header = Authorization: Basic <base64-encoded value>
4649
#auth_policy_hash_mech = sha256
47-
#auth_policy_request_attributes = login=%{requested_username} pwhash=%{hashed_password} remote=%{rip} device_id=%{client_id} protocol=%{protocol}
50+
#auth_policy_request_attributes {
51+
# login = %{requested_username}
52+
# pwhash = %{hashed_password}
53+
# remote = %{rip}
54+
# device_id = %{client_id}
55+
# protocol = %{protocol}
56+
#}
4857
#auth_policy_reject_on_fail = no
4958
#auth_policy_hash_truncate = 12
5059
#auth_policy_check_before_auth = yes

0 commit comments

Comments
 (0)