auth.c File Reference

POP authentication. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include "private.h"
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "conn/lib.h"
#include "adata.h"

Include dependency graph for auth.c:

Go to the source code of this file.

Functions
void	pop_apop_timestamp (struct PopAccountData *adata, char *buf)
	Get the server timestamp for APOP authentication.
static enum PopAuthRes	pop_auth_apop (struct PopAccountData *adata, const char *method)
	APOP authenticator - Implements PopAuth::authenticate() -.
static enum PopAuthRes	pop_auth_user (struct PopAccountData *adata, const char *method)
	USER authenticator - Implements PopAuth::authenticate() -.
static enum PopAuthRes	pop_auth_oauth (struct PopAccountData *adata, const char *method)
	Authenticate a POP connection using OAUTHBEARER - Implements PopAuth::authenticate() -.
bool	pop_auth_is_valid (const char *authenticator)
	Check if string is a valid pop authentication method.
int	pop_authenticate (struct PopAccountData *adata)
	Authenticate with a POP server.

Variables
static const struct PopAuth	PopAuthenticators []
	Accepted authentication methods.

Detailed Description

POP authentication.

Authors

• Vsevolod Volkov
• Richard Russon
• Pietro Cerutti
• Yousef Akbar
• Alejandro Colomar

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.c.

Function Documentation

pop_apop_timestamp()

void pop_apop_timestamp	(	struct PopAccountData *	adata,
		char *	buf )

Get the server timestamp for APOP authentication.

Parameters

adata	POP Account data
buf	Timestamp string

Definition at line 326 of file auth.c.

{
  char *p1 = NULL, *p2 = NULL;
 
  FREE(&adata->timestamp);
 
  if ((p1 = strchr(buf, '<')) && (p2 = strchr(p1, '>')))
  {
    p2[1] = '\0';
    adata->timestamp = mutt_str_dup(p1);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

pop_auth_is_valid()

bool pop_auth_is_valid

(

const char *

authenticator

)

Check if string is a valid pop 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 pop authentication method as defined by PopAuthenticators.

Definition at line 527 of file auth.c.

{
  for (size_t i = 0; i < countof(PopAuthenticators); i++)
  {
    const struct PopAuth *auth = &PopAuthenticators[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:

pop_authenticate()

int pop_authenticate

(

struct PopAccountData *

adata

)

Authenticate with a POP server.

Parameters

adata

POP Account data

Return values

num	Result, e.g. POP_A_SUCCESS
0	Successful
-1	Connection lost
-2	Login failed
-3	Authentication cancelled

Definition at line 548 of file auth.c.

{
  struct ConnAccount *cac = &adata->conn->account;
  const struct PopAuth *authenticator = NULL;
  int attempts = 0;
  int rc = POP_A_UNAVAIL;
 
  if ((mutt_account_getuser(cac) < 0) || (cac->user[0] == '\0'))
  {
    return -3;
  }
 
  const struct Slist *c_pop_authenticators = cs_subset_slist(NeoMutt->sub, "pop_authenticators");
  const bool c_pop_auth_try_all = cs_subset_bool(NeoMutt->sub, "pop_auth_try_all");
  if (c_pop_authenticators && (c_pop_authenticators->count > 0))
  {
    /* Try user-specified list of authentication methods */
    struct ListNode *np = NULL;
    STAILQ_FOREACH(np, &c_pop_authenticators->head, entries)
    {
      mutt_debug(LL_DEBUG2, "Trying method %s\n", np->data);
      authenticator = PopAuthenticators;
 
      /* Walk the built-in authenticator table looking for a match */
      while (authenticator->authenticate)
      {
        if (!authenticator->method || mutt_istr_equal(authenticator->method, np->data))
        {
          rc = authenticator->authenticate(adata, np->data);
          if (rc == POP_A_SOCKET)
          {
            /* Connection dropped; try reconnecting and retrying once */
            switch (pop_connect(adata))
            {
              case 0:
              {
                rc = authenticator->authenticate(adata, np->data);
                break;
              }
              case -2:
                rc = POP_A_FAILURE;
            }
          }
 
          if (rc != POP_A_UNAVAIL)
            attempts++;
          if ((rc == POP_A_SUCCESS) || (rc == POP_A_SOCKET) ||
              ((rc == POP_A_FAILURE) && !c_pop_auth_try_all))
          {
            break;
          }
        }
        authenticator++;
      }
    }
  }
  else
  {
    /* Fall back to default: try every authenticator in order */
    mutt_debug(LL_DEBUG2, "Using any available method\n");
    authenticator = PopAuthenticators;
 
    while (authenticator->authenticate)
    {
      rc = authenticator->authenticate(adata, NULL);
      if (rc == POP_A_SOCKET)
      {
        switch (pop_connect(adata))
        {
          case 0:
          {
            rc = authenticator->authenticate(adata, NULL);
            break;
          }
          case -2:
            rc = POP_A_FAILURE;
        }
      }
 
      if (rc != POP_A_UNAVAIL)
        attempts++;
      if ((rc == POP_A_SUCCESS) || (rc == POP_A_SOCKET) ||
          ((rc == POP_A_FAILURE) && !c_pop_auth_try_all))
      {
        break;
      }
 
      authenticator++;
    }
  }
 
  /* Map internal result code to the caller's return values */
  switch (rc)
  {
    case POP_A_SUCCESS:
      return 0;
    case POP_A_SOCKET:
      return -1;
    case POP_A_UNAVAIL:
      if (attempts == 0)
        mutt_error(_("No authenticators available"));
  }
 
  return -2;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

PopAuthenticators

const struct PopAuth PopAuthenticators[]

static

Initial value:

= {
  
  { pop_auth_oauth, "oauthbearer" },
 
 
 
 
 
 
  { pop_auth_apop, "apop" },
  { pop_auth_user, "user" },
  { NULL, NULL },
  
}

Accepted authentication methods.

Definition at line 504 of file auth.c.

                                                  {
  // clang-format off
  { pop_auth_oauth, "oauthbearer" },
#ifdef USE_SASL_CYRUS
  { pop_auth_sasl, NULL },
#endif
#ifdef USE_SASL_GNU
  { pop_auth_gsasl, NULL },
#endif
  { pop_auth_apop, "apop" },
  { pop_auth_user, "user" },
  { NULL, NULL },
  // clang-format on
};