diff options
| author | Kevin McCarthy <kevin@8t8.us> | 2020-06-11 16:11:36 -0700 |
|---|---|---|
| committer | Kevin McCarthy <kevin@8t8.us> | 2020-06-13 14:44:17 -0700 |
| commit | c7a872d1eeea39df148396869c1cbbc0fa26552f (patch) | |
| tree | 0fa80c6f4e6e0a7f8693ee087f18b3870a16b718 /doc | |
| parent | 5b844328bb7d7fb0357328bed002e7672f9b9e2a (diff) | |
Add basic XOAUTH2 support.
This still relies on an external script to obtain the resource access
token. Since XOAUTH2 should be slowly going away, use the same
refresh_commands as with OAUTHBEARER.
Unlike OAUTHBEARER, XOAUTH2 must be explicitly added to the
$imap/smtp/pop_authenticators list.
To keep the shared functions simpler, convert them to use buffers.
RFC 7628 indicates that upon authentication failure the clients should
be sending an BASE 64 encoded '^a' ("AQ=="), to terminate the SASL
session, so change all the handlers to do that and read the following
response. The RFC doesn't comment about a line terminator being
required, but I assume it is, so add that too.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.xml.head | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/manual.xml.head b/doc/manual.xml.head index e6414c0f..354932a4 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -9026,6 +9026,26 @@ set imap_oauth_refresh_command="/path/to/oauth2.py --quiet --user=[email_address <para> Substitute pop or smtp for imap in the above example to configure for those. </para> + +<sect2 id="xoauth2"> + <title>XOAUTH2 Support</title> + + <para> + Support for the deprecated XOAUTH2 protocol is also available. To + enable this, add <quote>xoauth2</quote> to the + <link linkend="imap-authenticators">$imap_authenticators</link>, + <link linkend="pop-authenticators">$pop_authenticators</link>, or + <link linkend="smtp-authenticators">$smtp_authenticators</link> config + variables. XOAUTH2 uses the same refresh command configuration variables + as OAUTHBEARER: + <link linkend="imap-oauth-refresh-command">$imap_oauth_refresh_command</link>, + <link linkend="pop-oauth-refresh-command">$pop_oauth_refresh_command</link>, and + <link linkend="smtp-oauth-refresh-command">$smtp_oauth_refresh_command</link>. + Those will need to be set to a script to generate the appropriate XOAUTH2 + token. + </para> +</sect2> + </sect1> <sect1 id="account-hook"> |