Skip to content

settings, global: Replace FILE setting type syntax #1046

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
Oct 30, 2024
Merged

settings, global: Replace FILE setting type syntax #1046

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
7aa8c5e
settings, global: Replace FILE setting type syntax
sirainen Oct 9, 2024
1eb5e54
mail_crypt: Clarify base64-encoded keys
sirainen Oct 9, 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
5 changes: 3 additions & 2 deletions docs/core/plugins/mail_crypt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,8 @@ crypt_global_private_key main {
## Base64-encoded Keys

Mail-crypt plugin can read keys that are base64 encoded. This is intended
mostly for providing PEM keys via userdb.
mostly for providing PEM keys via userdb, because it may be difficult to get
userdb to return multi-line values.

Hence, this is possible:

Expand All @@ -369,7 +370,7 @@ passdb static {
password = pass
fields {
crypt_global_public_key_file = ecpubkey.pem
crypt_global_private_key/main/private_key = <content of ecprivkey.pem>
crypt_global_private_key/main/private_key_file = inline:<base64-encoded content of ecprivkey.pem>
}
}
```
Expand Down
8 changes: 4 additions & 4 deletions docs/core/settings/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,10 +185,10 @@ the process has dropped root privileges.

The file paths do not support [[link,settings_variables,%variables]].

All the `file` type settings end with a `_file` suffix. It's possible to give
inline values (instead of a path to a file) for the setting by removing the
`_file` suffix. For example userdb could be returning
`crypt_global_public_key=<public key content>` without having to use files.
It's possible to give inline values (instead of a path to a file) for the
setting by using `inline:` prefix in the value. For example userdb could be
returning `crypt_global_public_key_file=inline:<public key content>` without
having to use files.

## Named Filter

Expand Down