SMTP Authentication API

Authenticate an SMTP connection. More...

Functions
static int	smtp_auth_oauth (struct SmtpAccountData *adata, const char *method)
	Authenticate an SMTP connection using OAUTHBEARER - Implements SmtpAuth::authenticate() -.
static int	smtp_auth_xoauth2 (struct SmtpAccountData *adata, const char *method)
	Authenticate an SMTP connection using XOAUTH2 - Implements SmtpAuth::authenticate() -.
static int	smtp_auth_plain (struct SmtpAccountData *adata, const char *method)
	Authenticate using plain text - Implements SmtpAuth::authenticate() -.
static int	smtp_auth_login (struct SmtpAccountData *adata, const char *method)
	Authenticate using plain text - Implements SmtpAuth::authenticate() -.

Detailed Description

Authenticate an SMTP connection.

Parameters

adata	Smtp Account data
method	Use this named method, or any available method if NULL

Return values

num	Result, e.g. SMTP_AUTH_SUCCESS

Function Documentation

smtp_auth_oauth()

static int smtp_auth_oauth ( struct SmtpAccountData * adata, const char * method )

static

Authenticate an SMTP connection using OAUTHBEARER - Implements SmtpAuth::authenticate() -.

Parameters

adata	SMTP Account data
method	Authentication method (not used)

Return values

num	Result, e.g. SMTP_AUTH_SUCCESS

Definition at line 803 of file smtp.c.

{
  return smtp_auth_oauth_xoauth2(adata, method, false);
}

Here is the call graph for this function:

smtp_auth_xoauth2()

static int smtp_auth_xoauth2 ( struct SmtpAccountData * adata, const char * method )

static

Authenticate an SMTP connection using XOAUTH2 - Implements SmtpAuth::authenticate() -.

Parameters

adata	SMTP Account data
method	Authentication method (not used)

Return values

num	Result, e.g. SMTP_AUTH_SUCCESS

Definition at line 814 of file smtp.c.

{
  return smtp_auth_oauth_xoauth2(adata, method, true);
}

Here is the call graph for this function:

smtp_auth_plain()

static int smtp_auth_plain ( struct SmtpAccountData * adata, const char * method )

static

Authenticate using plain text - Implements SmtpAuth::authenticate() -.

Parameters

adata	SMTP Account data
method	Authentication method (not used)

Return values

0	Success
<0	Error, e.g. SMTP_AUTH_FAIL

Note

method is "PLAIN"

Definition at line 828 of file smtp.c.

{
  struct Buffer *buf = NULL;
  struct ConnAccount *cac = &adata->conn->account;
  int rc = -1;
 
  /* Get username and password. Bail out of any can't be retrieved. */
  if ((mutt_account_getuser(cac) < 0) || (mutt_account_getpass(cac) < 0))
    goto error;
 
  /* Build the initial client response. */
  buf = buf_pool_get();
  mutt_sasl_plain_msg(buf, "AUTH PLAIN", cac->user, cac->user, cac->pass);
  buf_add_printf(buf, "\r\n");
 
  /* Send request, receive response (with a check for OK code). */
  if ((mutt_socket_send(adata->conn, buf_string(buf)) < 0) || smtp_get_resp(adata))
    goto error;
 
  rc = 0; // Auth was successful
 
error:
  if (rc != 0)
  {
    // L10N: %s is the method name, e.g. Anonymous, CRAM-MD5, GSSAPI, SASL
    mutt_error(_("%s authentication failed"), "SASL");
  }
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

smtp_auth_login()

static int smtp_auth_login ( struct SmtpAccountData * adata, const char * method )

static

Authenticate using plain text - Implements SmtpAuth::authenticate() -.

Parameters

adata	SMTP Account data
method	Authentication method (not used)

Return values

0	Success
<0	Error, e.g. SMTP_AUTH_FAIL

Note

method is "LOGIN"

Definition at line 868 of file smtp.c.

{
  char b64[1024] = { 0 };
  char buf[1026] = { 0 };
 
  /* Get username and password. Bail out of any can't be retrieved. */
  if ((mutt_account_getuser(&adata->conn->account) < 0) ||
      (mutt_account_getpass(&adata->conn->account) < 0))
  {
    goto error;
  }
 
  /* Send the AUTH LOGIN request. */
  if (mutt_socket_send(adata->conn, "AUTH LOGIN\r\n") < 0)
  {
    goto error;
  }
 
  /* Read the 334 VXNlcm5hbWU6 challenge ("Username:" base64-encoded) */
  int rc = mutt_socket_readln_d(buf, sizeof(buf), adata->conn, MUTT_SOCK_LOG_FULL);
  if ((rc < 0) || !mutt_str_equal(buf, "334 VXNlcm5hbWU6"))
  {
    goto error;
  }
 
  /* Send the username */
  size_t len = snprintf(buf, sizeof(buf), "%s", adata->conn->account.user);
  mutt_b64_encode(buf, len, b64, sizeof(b64));
  snprintf(buf, sizeof(buf), "%s\r\n", b64);
  if (mutt_socket_send(adata->conn, buf) < 0)
  {
    goto error;
  }
 
  /* Read the 334 UGFzc3dvcmQ6 challenge ("Password:" base64-encoded) */
  rc = mutt_socket_readln_d(buf, sizeof(buf), adata->conn, MUTT_SOCK_LOG_FULL);
  if ((rc < 0) || !mutt_str_equal(buf, "334 UGFzc3dvcmQ6"))
  {
    goto error;
  }
 
  /* Send the password */
  len = snprintf(buf, sizeof(buf), "%s", adata->conn->account.pass);
  mutt_b64_encode(buf, len, b64, sizeof(b64));
  snprintf(buf, sizeof(buf), "%s\r\n", b64);
  if (mutt_socket_send(adata->conn, buf) < 0)
  {
    goto error;
  }
 
  /* Check the final response */
  if (smtp_get_resp(adata) < 0)
  {
    goto error;
  }
 
  /* If we got here, auth was successful. */
  return 0;
 
error:
  // L10N: %s is the method name, e.g. Anonymous, CRAM-MD5, GSSAPI, SASL
  mutt_error(_("%s authentication failed"), "LOGIN");
  return -1;
}

Here is the call graph for this function: