auth.h File Reference

IMAP authenticator multiplexor. More...

#include "config.h"
#include <stdbool.h>

Include dependency graph for auth.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	ImapAuthRes { IMAP_AUTH_SUCCESS = 0 , IMAP_AUTH_FAILURE , IMAP_AUTH_UNAVAIL }
	Results of IMAP Authentication. More...

Functions
bool	imap_auth_is_valid (const char *authenticator)
	Check if string is a valid imap authentication method.
enum ImapAuthRes	imap_auth_plain (struct ImapAccountData *adata, const char *method)
	SASL PLAIN support - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_anon (struct ImapAccountData *adata, const char *method)
	Authenticate anonymously - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_cram_md5 (struct ImapAccountData *adata, const char *method)
	Authenticate using CRAM-MD5 - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_login (struct ImapAccountData *adata, const char *method)
	Plain LOGIN support - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_gss (struct ImapAccountData *adata, const char *method)
	GSS Authentication support - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_oauth (struct ImapAccountData *adata, const char *method)
	Authenticate an IMAP connection using OAUTHBEARER - Implements ImapAuth::authenticate() -.
enum ImapAuthRes	imap_auth_xoauth2 (struct ImapAccountData *adata, const char *method)
	Authenticate an IMAP connection using XOAUTH2 - Implements ImapAuth::authenticate() -.

Detailed Description

IMAP authenticator multiplexor.

Authors

• Brendan Cully
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file auth.h.

Enumeration Type Documentation

ImapAuthRes

enum ImapAuthRes

Results of IMAP Authentication.

Enumerator
IMAP_AUTH_SUCCESS	Authentication successful.
IMAP_AUTH_FAILURE	Authentication failed.
IMAP_AUTH_UNAVAIL	Authentication method not permitted.

Definition at line 38 of file auth.h.

{
  IMAP_AUTH_SUCCESS = 0, 
  IMAP_AUTH_FAILURE,     
  IMAP_AUTH_UNAVAIL,     
};

Function Documentation

imap_auth_is_valid()

bool imap_auth_is_valid

(

const char *

authenticator

)

Check if string is a valid imap authentication method.

Parameters

authenticator

Authenticator string to check

Return values

true	Argument is a valid auth method

Validate whether an input string is an accepted imap authentication method as defined by ImapAuthenticators.

Definition at line 95 of file auth.c.

{
  for (size_t i = 0; i < mutt_array_size(ImapAuthenticators); i++)
  {
    const struct ImapAuth *auth = &ImapAuthenticators[i];
    if (auth->method && mutt_istr_equal(auth->method, authenticator))
      return true;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function: