aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJulian Pidancet <julian.pidancet@oracle.com>2022-09-28 19:49:11 +0200
committerRobin Jarry <robin@jarry.cc>2022-10-01 15:47:33 +0200
commit9217dbeea45830c1d1d3d8453b495b6792bc38ca (patch)
tree813f70196d1e34daa39e2261e598b0914d4dd880 /doc
parent45bff8851509432f6b5a21360ce67a7b2ca55eb5 (diff)
downloadaerc-9217dbeea45830c1d1d3d8453b495b6792bc38ca.tar.gz
imap,smtp: add XOAUTH2 support
Add XOAUTH2 authentication support for IMAP and SMTP. Although XOAUTH2 is now deprecated in favor of OAuthBearer, it is the only way to connect to Office365 since Basic Auth is now completely removed. Since XOAUTH2 is very similar to OAuthBearer and uses the same configuration parameters, this is basically a copy-paste of the existing OAuthBearer code. However, XOAUTH2 support was removed from go-sasl library, so this change reimports the code that was removed from go-sasl and offers it a new home in lib/xoauth2.go. Hopefully it shouldn't be too hard to maintain, being less than 50 SLOC. Link: https://github.com/emersion/go-sasl/commit/7bfe0ed36a21 Implements: https://todo.sr.ht/~rjarry/aerc/78 Signed-off-by: Julian Pidancet <julian.pidancet@oracle.com> Tested-by: Inwit <inwit@sindominio.net> Acked-by: Tim Culverhouse <tim@timculverhouse.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-imap.5.scd6
-rw-r--r--doc/aerc-smtp.5.scd6
2 files changed, 10 insertions, 2 deletions
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index 39ac3371..2a5f6c8b 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -19,7 +19,7 @@ In accounts.conf (see *aerc-config*(5)), the following IMAP-specific options are
available:
*source*
- imap[s][+insecure|+oauthbearer]://username[:password]@hostname[:port]?[:oauth2_params]
+ imap[s][+insecure|+oauthbearer|+xoauth2]://username[:password]@hostname[:port]?[:oauth2_params]
Remember that all fields must be URL encoded. The "@" symbol, when URL
encoded, is *%40*.
@@ -53,6 +53,10 @@ available:
Example:
imaps+oauthbearer://...?token_endpoint=https://...&client_id=
+ *imaps+xoauth2://*
+ IMAP with TLS/SSL using XOAUTH2 Authentication. Parameters are
+ the same as OAUTHBEARER.
+
*source-cred-cmd*
Specifies the command to run to get the password for the IMAP
account. This command will be run using `sh -c [command]`. If a
diff --git a/doc/aerc-smtp.5.scd b/doc/aerc-smtp.5.scd
index 16ff6052..ee2aa176 100644
--- a/doc/aerc-smtp.5.scd
+++ b/doc/aerc-smtp.5.scd
@@ -16,7 +16,7 @@ In accounts.conf (see *aerc-config*(5)), the following SMTP-specific options are
available:
*outgoing*
- smtp[s][+plain|+login|+none|+oauthbearer]://username[:password]@hostname[:port]?[:oauth2_params]
+ smtp[s][+plain|+login|+none|+oauthbearer|+xoauth2]://username[:password]@hostname[:port]?[:oauth2_params]
Remember that all fields must be URL encoded. The "@" symbol, when URL
encoded, is *%40*.
@@ -47,6 +47,10 @@ available:
SMTP with TLS/SSL using OAUTHBEARER Authentication. See documentation in
*aerc-imap*(5) for usage.
+ *+xoauth2*:
+ SMTP with TLS/SSL using XOAUTH2 Authentication. See documentation in
+ *aerc-imap*(5) for usage.
+
*outgoing-cred-cmd*
Specifies the command to run to get the password for the SMTP
account. This command will be run using `sh -c [command]`. If a