Skip to content

wip: Sasl client settings auto - #1609

Open
stephanbosch wants to merge 2 commits into
dovecot:mainfrom
stephanbosch:sasl-client-settings-auto
Open

wip: Sasl client settings auto#1609
stephanbosch wants to merge 2 commits into
dovecot:mainfrom
stephanbosch:sasl-client-settings-auto

Conversation

@stephanbosch

Copy link
Copy Markdown
Contributor

JIRA: DOV-9242

@github-actions

Copy link
Copy Markdown

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (8)

authid
authzid
Bhb
frop
GEu
HRhdmlzd
Nvb
Rlck

These words are not needed and should be removed FROP tohdr

To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the git@github.com:stephanbosch/documentation.git repository
on the sasl-client-settings-auto branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.26/apply.pl' |
perl - 'https://github.com/dovecot/documentation/actions/runs/33138522316/attempts/1' &&
git commit -m 'Update check-spelling metadata'
If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Comment thread data/settings.js

imapc_sasl_mechanisms: {
deprecated: {
settings_auth_debug_deprecated: `

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

definitely not settings_auth_debug_deprecated

Comment thread data/settings.js
Mechanisms are attempted in the order of configuration, so preferred mechanisms
should be configured first. If [[setting,client_auth_mechanism]] is set
outside the scope of this filter, the indicated mechanism is used with settings
in that context (a client_auth filter block for that mechanism is not used).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`client_auth`. But .. I don't understand what this sentence is trying to say. I suppose it should be its own paragraph with an example. If that is even something that should be done at all? Maybe this text belongs to client_auth_mechanism setting anyway?

Comment thread data/settings.js
client_auth_password = frop

client_auth SCRAM-SHA-256 { }
client_auth SCRAM-SHA-1 { }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{ } will give error

Comment thread data/settings.js

client_auth_mechanism = PLAIN
client_auth_authzid = mail-out
client_auth_password = frop

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this shows the configuration works like this, but is it something we actually want to encourage? I'm guessing not -> remove it.

Comment thread data/settings.js
values: setting_types.STRING,
text: `
The authorization identity to be used after authenticating as a client to a
remote service.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this default to %{user}?

Comment thread data/settings.js
values: setting_types.STRING,
text: `
The password to be used for authenticating as a client to a remote service. This
is the password belonging to the authentication identity \`client_auth_authid\`.`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we now reusing this client_auth_password for too many things? Should we for example have instead client_auth_oauth2_token setting?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants