NeoMutt  2024-03-23-147-g885fbc
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
auth.h
Go to the documentation of this file.
1
24/* common defs for authenticators. A good place to set up a generic callback
25 * system */
26
27#ifndef MUTT_IMAP_AUTH_H
28#define MUTT_IMAP_AUTH_H
29
30#include "config.h"
31#include <stdbool.h>
32
33struct ImapAccountData;
34
39{
43};
44
45bool imap_auth_is_valid(const char *authenticator);
46
47/* external authenticator prototypes */
48enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method);
49#ifndef USE_SASL_CYRUS
50enum ImapAuthRes imap_auth_anon(struct ImapAccountData *adata, const char *method);
51enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method);
52#endif
53enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method);
54#ifdef USE_GSS
55enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method);
56#endif
57#ifdef USE_SASL_CYRUS
58enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method);
59#endif
60#ifdef USE_SASL_GNU
61enum ImapAuthRes imap_auth_gsasl(struct ImapAccountData *adata, const char *method);
62#endif
63enum ImapAuthRes imap_auth_oauth(struct ImapAccountData *adata, const char *method);
64enum ImapAuthRes imap_auth_xoauth2(struct ImapAccountData *adata, const char *method);
65
66#endif /* MUTT_IMAP_AUTH_H */
ImapAuthRes
Results of IMAP Authentication.
Definition: auth.h:39
@ IMAP_AUTH_FAILURE
Authentication failed.
Definition: auth.h:41
@ IMAP_AUTH_SUCCESS
Authentication successful.
Definition: auth.h:40
@ IMAP_AUTH_UNAVAIL
Authentication method not permitted.
Definition: auth.h:42
bool imap_auth_is_valid(const char *authenticator)
Check if string is a valid imap authentication method.
Definition: auth.c:95
enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method)
GSS Authentication support - Implements ImapAuth::authenticate() -.
Definition: auth_gss.c:106
enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method)
Plain LOGIN support - Implements ImapAuth::authenticate() -.
Definition: auth_login.c:45
enum ImapAuthRes imap_auth_gsasl(struct ImapAccountData *adata, const char *method)
GNU SASL authenticator - Implements ImapAuth::authenticate() -.
Definition: auth_gsasl.c:41
enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method)
Authenticate using CRAM-MD5 - Implements ImapAuth::authenticate() -.
Definition: auth_cram.c:97
enum ImapAuthRes imap_auth_xoauth2(struct ImapAccountData *adata, const char *method)
Authenticate an IMAP connection using XOAUTH2 - Implements ImapAuth::authenticate() -.
Definition: auth_oauth.c:119
enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method)
SASL PLAIN support - Implements ImapAuth::authenticate() -.
Definition: auth_plain.c:41
enum ImapAuthRes imap_auth_anon(struct ImapAccountData *adata, const char *method)
Authenticate anonymously - Implements ImapAuth::authenticate() -.
Definition: auth_anon.c:42
enum ImapAuthRes imap_auth_oauth(struct ImapAccountData *adata, const char *method)
Authenticate an IMAP connection using OAUTHBEARER - Implements ImapAuth::authenticate() -.
Definition: auth_oauth.c:111
enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method)
SASL authenticator - Implements ImapAuth::authenticate() -.
Definition: auth_sasl.c:47
void * adata
Private data (for Mailbox backends)
Definition: account.h:42
IMAP-specific Account data -.
Definition: adata.h:40