691d7d706e04826512f4050b8b7ddc073838e163
[exim.git] / src / src / auths / gsasl_exim.h
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim Maintainers 2019 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2012 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-only */
9
10 /* Copyright (c) Twitter Inc 2012 */
11
12 /* Interface to GNU SASL library for generic authentication. */
13
14 /* Authenticator-specific options. */
15
16 typedef struct {
17   uschar *server_service;
18   uschar *server_hostname;
19   uschar *server_realm;
20   uschar *server_mech;
21   uschar *server_password;
22   uschar *server_key;
23   uschar *server_s_key;
24   uschar *server_scram_iter;
25   uschar *server_scram_salt;
26
27   uschar *client_username;
28   uschar *client_password;
29   uschar *client_authz;
30   uschar *client_spassword;
31
32   BOOL    server_channelbinding;
33   BOOL    client_channelbinding;
34 } auth_gsasl_options_block;
35
36 /* Data for reading the authenticator-specific options. */
37
38 extern optionlist auth_gsasl_options[];
39 extern int auth_gsasl_options_count;
40
41 /* Defaults for the authenticator-specific options. */
42
43 extern auth_gsasl_options_block auth_gsasl_option_defaults;
44
45 /* The entry points for the mechanism */
46
47 extern void auth_gsasl_init(auth_instance *);
48 extern int auth_gsasl_server(auth_instance *, uschar *);
49 extern int auth_gsasl_client(auth_instance *, void *,
50                                 int, uschar *, int);
51 extern gstring * auth_gsasl_version_report(gstring *);
52 extern void auth_gsasl_macros(void);
53
54 /* End of gsasl_exim.h */