code/auth_8h_source.html

/* common defs for authenticators. A good place to set up a generic callback

 * system */


#ifndef MUTT_IMAP_AUTH_H

#define MUTT_IMAP_AUTH_H


#include "config.h"

#include <stdbool.h>


struct ImapAccountData;


enum ImapAuthRes

{

  IMAP_AUTH_SUCCESS = 0,

  IMAP_AUTH_FAILURE,

  IMAP_AUTH_UNAVAIL,

};


bool imap_auth_is_valid(const char *authenticator);


/* external authenticator prototypes */

enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method);

#ifndef USE_SASL_CYRUS

enum ImapAuthRes imap_auth_anon(struct ImapAccountData *adata, const char *method);

enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method);

#endif

enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method);

#ifdef USE_GSS

enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method);

#endif

#ifdef USE_SASL_CYRUS

enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method);

#endif

#ifdef USE_SASL_GNU

enum ImapAuthRes imap_auth_gsasl(struct ImapAccountData *adata, const char *method);

#endif

enum ImapAuthRes imap_auth_oauth(struct ImapAccountData *adata, const char *method);

enum ImapAuthRes imap_auth_xoauth2(struct ImapAccountData *adata, const char *method);


#endif /* MUTT_IMAP_AUTH_H */

ImapAuthRes
ImapAuthRes
Results of IMAP Authentication.
Definition: auth.h:39

IMAP_AUTH_FAILURE
@ IMAP_AUTH_FAILURE
Authentication failed.
Definition: auth.h:41

IMAP_AUTH_SUCCESS
@ IMAP_AUTH_SUCCESS
Authentication successful.
Definition: auth.h:40

IMAP_AUTH_UNAVAIL
@ IMAP_AUTH_UNAVAIL
Authentication method not permitted.
Definition: auth.h:42

imap_auth_is_valid
bool imap_auth_is_valid(const char *authenticator)
Check if string is a valid imap authentication method.
Definition: auth.c:95

imap_auth_gss
enum ImapAuthRes imap_auth_gss(struct ImapAccountData *adata, const char *method)
GSS Authentication support - Implements ImapAuth::authenticate() -.
Definition: auth_gss.c:106

imap_auth_login
enum ImapAuthRes imap_auth_login(struct ImapAccountData *adata, const char *method)
Plain LOGIN support - Implements ImapAuth::authenticate() -.
Definition: auth_login.c:45

imap_auth_gsasl
enum ImapAuthRes imap_auth_gsasl(struct ImapAccountData *adata, const char *method)
GNU SASL authenticator - Implements ImapAuth::authenticate() -.
Definition: auth_gsasl.c:41

imap_auth_cram_md5
enum ImapAuthRes imap_auth_cram_md5(struct ImapAccountData *adata, const char *method)
Authenticate using CRAM-MD5 - Implements ImapAuth::authenticate() -.
Definition: auth_cram.c:97

imap_auth_xoauth2
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

imap_auth_plain
enum ImapAuthRes imap_auth_plain(struct ImapAccountData *adata, const char *method)
SASL PLAIN support - Implements ImapAuth::authenticate() -.
Definition: auth_plain.c:42

imap_auth_anon
enum ImapAuthRes imap_auth_anon(struct ImapAccountData *adata, const char *method)
Authenticate anonymously - Implements ImapAuth::authenticate() -.
Definition: auth_anon.c:42

imap_auth_oauth
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

imap_auth_sasl
enum ImapAuthRes imap_auth_sasl(struct ImapAccountData *adata, const char *method)
SASL authenticator - Implements ImapAuth::authenticate() -.
Definition: auth_sasl.c:47

Account::adata
void * adata
Private data (for Mailbox backends)
Definition: account.h:42

ImapAccountData
IMAP-specific Account data -.
Definition: adata.h:40