aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Holme <steve_holme@hotmail.com>2013-09-20 21:56:34 +0100
committerSteve Holme <steve_holme@hotmail.com>2013-09-20 21:56:30 +0100
commit18db7438512de1d6f63c616af5755ea2859597b8 (patch)
tree72c5678f29d94dd175dc78c9a46b04e8a2f83da4 /docs
parent0e188e2dc339c6667eb954682a2bf768c6419aa9 (diff)
pop3: Added basic SASL XOAUTH2 support
Added the ability to use an XOAUTH2 bearer token [RFC6750] with POP3 for authentication using RFC6749 "OAuth 2.0 Authorization Framework". The bearer token is expected to be valid for the user specified in conn->user. If CURLOPT_XOAUTH2_BEARER is defined and the connection has an advertised auth mechanism of "XOAUTH2", the user and access token are formatted as a base64 encoded string and sent to the server as "AUTH XOAUTH2 <bearer token>".
Diffstat (limited to 'docs')
-rw-r--r--docs/curl.16
-rw-r--r--docs/libcurl/curl_easy_setopt.34
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/curl.1 b/docs/curl.1
index 3ce2bfab0..6061f93ac 100644
--- a/docs/curl.1
+++ b/docs/curl.1
@@ -174,9 +174,9 @@ since it may require data to be sent twice and then the client must be able to
rewind. If the need should arise when uploading from stdin, the upload
operation will fail.
.IP "--bearer"
-(IMAP/SMTP) Specify the Bearer Token for OAUTH 2.0 server authentication. The
-Bearer Token is used in conjuction with the user name which can be specified
-as part of the \fI--url\fP option or the \fI-u, --user\fP option.
+(IMAP/POP3/SMTP) Specify the Bearer Token for OAUTH 2.0 server authentication.
+The Bearer Token is used in conjuction with the user name which can be
+specified as part of the \fI--url\fP or \fI-u, --user\fP options.
The Bearer Token and user name are formatted according to RFC 6750.
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index a2b40e0c3..a8d764f07 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -1304,8 +1304,8 @@ as libcurl can determine the feature itself when the server supports the
SASL-IR CAPABILITY.
.IP CURLOPT_BEARER
Pass a char * as parameter, which should point to the zero terminated OAUTH
-2.0 Bearer Access Token for use with IMAP and SMTP servers that support the
-OAUTH 2.0 Authorization Framework. (Added in 7.33.0)
+2.0 Bearer Access Token for use with IMAP. POP3 and SMTP servers that support
+the OAUTH 2.0 Authorization Framework. (Added in 7.33.0)
Note: The user name used to generate the Bearer Token should be supplied via
the \fICURLOPT_USERNAME\fP option.