1sasl-xoauth2.conf(5)          File Formats Manual         sasl-xoauth2.conf(5)
2
3
4

NAME

6       /etc/sasl-xoauth2.conf - configuration file for sasl-xoauth2
7

DESCRIPTION

9       This file contains static, administrator-defined information needed for
10       XOAUTH2 SASL authentication.
11
12       It uses a JSON format to define variables needed  to  complete  XOAUTH2
13       configuration.
14
15       A minimal configuration file looks like:
16
17              {
18                "client_id": "CLIENT_ID_GOES_HERE",
19                "client_secret": "CLIENT_SECRET_GOES_HERE"
20              }
21
22       See   the   full   README   for   guidance  on  initial  configuration:
23       https://github.com/tarickb/sasl-xoauth2
24

OPTIONS

26       The top-level JSON object can contain the following keys:
27
28       client_id
29              identifies this client for OAuth 2 token requests
30
31       client_secret
32              authenticates this client for OAuth  2  token  requests;  world-
33              readable  by default (but see below to place this in token files
34              instead)
35
36       always_log_to_syslog
37              always write plugin log messages to syslog, even for  successful
38              runs; may contain tokens/secrets (defaults to “no”)
39
40       log_to_syslog_on_failure
41              log to syslog if XOAUTH2 flow fails (defaults to “yes”)
42
43       log_full_trace_on_failure
44              log  a  full  trace to syslog if XOAUTH2 flow fails; may contain
45              tokens/secrets (defaults to “no”)
46
47       token_endpoint
48              URL to use when requesting tokens; defaults to Google,  must  be
49              overridden for use with Microsoft/Outlook.
50
51       proxy  if set, HTTP requests will be proxied through this server
52
53       ca_bundle_file
54              if  set,  overrides  CURL’s default certificate-authority bundle
55              file
56
57       ca_certs_dir
58              if set, overrides CURL’s default certificate-authority directory
59

TOKEN FILE

61       In addition to this file, sasl-xoauth2 relies on a “token  file”  which
62       it  updates independently.  The token file is also JSON-formatted.  The
63       contents of this token file MAY contain values for the  keys  described
64       above  (except for the logging-related keys).  If they do, the value in
65       the token file overrides the value in the main configuration file.
66
67       This makes it possible to use the same installation of sasl-xoauth2  to
68       connect  to  two different providers simultaneously.  This also has the
69       benefit of providing storage for client secrets that is not world-read‐
70       able.
71

BUGS

73       Please   report   improvements   in   this  documentation  upstream  at
74       https://github.com/tarickb/sasl-xoauth2/issues
75

SEE ALSO

77       sasl-xoauth2-tool(1)
78
79
80
81                                                          sasl-xoauth2.conf(5)
Impressum