Skip to content

config-rewrite: auth_policy_request_attributes should be strlist #1082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmouse merged 2 commits into from
Nov 26, 2024
Merged

config-rewrite: auth_policy_request_attributes should be strlist #1082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaea018
settings/types: String list can now be cleared out
sirainen Nov 22, 2024
31a2d4e
settings, auth/policy: Change auth_policy_request_attributes to be st…
sirainen Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions data/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4340,23 +4340,13 @@ If \`no\`, there will be no report for the authentication result.`
Default has changed.`
},
tags: [ 'auth_policy' ],
values: setting_types.STRING,
values: setting_types.STRLIST,
seealso: [ 'auth_policy_server_url' ],
text: `
Request attributes specification.

Variables that can be used for this setting:

- [[variable,auth]]

- \`%{hashed_password}\`

- Truncated auth policy hash of username and password

- \`%{requested_username}\`

- Logged in user. Same as \`%{user}\`, except for master user logins the
same as \`%{login_user}\`.`
See [[link,auth_policy_variables]] for variables that can be used for this
setting.`
},

auth_policy_server_api_header: {
Expand Down
11 changes: 10 additions & 1 deletion docs/core/config/auth/policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ dovecotlinks:
auth_policy_configuration:
hash: configuration
text: Auth Policy Configuration
auth_policy_variables:
hash: list-of-fields
text: Auth Policy Variables
---

# Authentication Policy
Expand Down Expand Up @@ -44,7 +47,13 @@ auth_policy_hash_nonce = localized_random_string
# OPTIONAL settings
#auth_policy_server_api_header = Authorization: Basic <base64-encoded value>
#auth_policy_hash_mech = sha256
#auth_policy_request_attributes = login=%{requested_username} pwhash=%{hashed_password} remote=%{rip} device_id=%{client_id} protocol=%{protocol}
#auth_policy_request_attributes {
# login = %{requested_username}
# pwhash = %{hashed_password}
# remote = %{rip}
# device_id = %{client_id}
# protocol = %{protocol}
#}
#auth_policy_reject_on_fail = no
#auth_policy_hash_truncate = 12
#auth_policy_check_before_auth = yes
Expand Down
10 changes: 10 additions & 0 deletions docs/core/settings/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,16 @@ fs_randomfail_ops {
}
```

You can clear out an existing string list by setting it to an empty value.
This is mainly useful to drop default settings. For example:

```
auth_policy_request_attributes =
auth_policy_request_attributes {
login = %{requested_username}
}
```

## Boolean List

The boolean list type is a list of `key=yes/no` pairs. Each key is unique
Expand Down