NeoMutt  2022-04-29-215-gc12b98
Teaching an old dog new tricks
DOXYGEN
auth.c
Go to the documentation of this file.
1
31#include "config.h"
32#include <string.h>
33#include "private.h"
34#include "mutt/lib.h"
35#include "config/lib.h"
36#include "core/lib.h"
37#include "auth.h"
38
43{
50 enum ImapAuthRes (*authenticate)(struct ImapAccountData *adata, const char *method);
51
52 const char *method;
54};
55
59static const struct ImapAuth ImapAuthenticators[] = {
60 // clang-format off
61 { imap_auth_oauth, "oauthbearer" },
62 { imap_auth_xoauth2, "xoauth2" },
63 { imap_auth_plain, "plain" },
64#ifdef USE_SASL_CYRUS
65 { imap_auth_sasl, NULL },
66#else
67 { imap_auth_anon, "anonymous" },
68#endif
69#ifdef USE_GSS
70 { imap_auth_gss, "gssapi" },
71#endif
72/* SASL includes CRAM-MD5 (and GSSAPI, but that's not enabled by default) */
73#ifndef HAVE_SASL
74 { imap_auth_cram_md5, "cram-md5" },
75#endif
76 { imap_auth_login, "login" },
77 // clang-format on
78};
79
88bool imap_auth_is_valid(const char *authenticator)
89{
90 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
91 {
92 const struct ImapAuth *auth = &ImapAuthenticators[i];
93 if (auth->method && mutt_istr_equal(auth->method, authenticator))
94 return true;
95 }
96
97 return false;
98}
99
109{
110 int rc = IMAP_AUTH_FAILURE;
111
112 const struct Slist *c_imap_authenticators = cs_subset_slist(NeoMutt->sub, "imap_authenticators");
113 if (c_imap_authenticators && (c_imap_authenticators->count > 0))
114 {
115 mutt_debug(LL_DEBUG2, "Trying user-defined imap_authenticators\n");
116
117 /* Try user-specified list of authentication methods */
118 struct ListNode *np = NULL;
119 STAILQ_FOREACH(np, &c_imap_authenticators->head, entries)
120 {
121 mutt_debug(LL_DEBUG2, "Trying method %s\n", np->data);
122
123 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
124 {
125 const struct ImapAuth *auth = &ImapAuthenticators[i];
126 if (!auth->method || mutt_istr_equal(auth->method, np->data))
127 {
128 rc = auth->authenticate(adata, np->data);
129 if (rc == IMAP_AUTH_SUCCESS)
130 {
131 return rc;
132 }
133 }
134 }
135 }
136 }
137 else
138 {
139 /* Fall back to default: any authenticator */
140 mutt_debug(LL_DEBUG2, "Trying pre-defined imap_authenticators\n");
141
142 for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
143 {
144 rc = ImapAuthenticators[i].authenticate(adata, NULL);
145 if (rc == IMAP_AUTH_SUCCESS)
146 return rc;
147 }
148 }
149
150 mutt_error(_("No authenticators available or wrong credentials"));
151 return rc;
152}
IMAP authenticator multiplexor.
enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method)
GSS Authentication support - Implements ImapAuth::authenticate()
Definition: auth_gss.c:104
enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method)
Plain LOGIN support - Implements ImapAuth::authenticate()
Definition: auth_login.c:44
enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method)
Authenticate using CRAM-MD5 - Implements ImapAuth::authenticate()
Definition: auth_cram.c:94
enum ImapAuthRes imap_auth_xoauth2(struct ImapAccountData *adata, const char *method)
Authenticate an IMAP connection using XOAUTH2 - Implements ImapAuth::authenticate()
Definition: auth_oauth.c:120
enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method)
SASL PLAIN support - Implements ImapAuth::authenticate()
Definition: auth_plain.c:41
ImapAuthRes
Results of IMAP Authentication.
Definition: auth.h:38
@ IMAP_AUTH_FAILURE
Authentication failed.
Definition: auth.h:40
@ IMAP_AUTH_SUCCESS
Authentication successful.
Definition: auth.h:39
enum ImapAuthRes imap_auth_anon(struct ImapAccountData *adata, const char *method)
Authenticate anonymously - Implements ImapAuth::authenticate()
Definition: auth_anon.c:41
enum ImapAuthRes imap_auth_oauth(struct ImapAccountData *adata, const char *method)
Authenticate an IMAP connection using OAUTHBEARER - Implements ImapAuth::authenticate()
Definition: auth_oauth.c:112
enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method)
Default authenticator if available - Implements ImapAuth::authenticate()
Definition: auth_sasl.c:45
const struct Slist * cs_subset_slist(const struct ConfigSubset *sub, const char *name)
Get a string-list config item by name.
Definition: helpers.c:268
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
#define mutt_error(...)
Definition: logging.h:87
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
static const struct ImapAuth ImapAuthenticators[]
Accepted authentication methods.
Definition: auth.c:59
int imap_authenticate(struct ImapAccountData *adata)
Authenticate to an IMAP server.
Definition: auth.c:108
bool imap_auth_is_valid(const char *authenticator)
Check if string is a valid imap authentication method.
Definition: auth.c:88
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.h:41
#define mutt_array_size(x)
Definition: memory.h:36
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:819
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
GUI display the mailboxes in a side panel.
void * adata
Private data (for Mailbox backends)
Definition: account.h:43
IMAP-specific Account data -.
Definition: adata.h:40
IMAP authentication multiplexor.
Definition: auth.c:43
enum ImapAuthRes(* authenticate)(struct ImapAccountData *adata, const char *method)
Authenticate an IMAP connection.
Definition: auth.c:50
const char * method
Name of authentication method supported, NULL means variable.
Definition: auth.c:52
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
String list.
Definition: slist.h:47
struct ListHead head
List containing values.
Definition: slist.h:48
size_t count
Number of values in list.
Definition: slist.h:49