pop_auth.c 11.9 KB
Newer Older
1
/*
2
 * Copyright (C) 2000-2001 Vsevolod Volkov <vvv@mutt.org.ua>
3 4 5 6 7 8 9 10 11 12 13 14 15
 * 
 *     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, write to the Free Software
16
 *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 18
 */

19 20 21 22
#if HAVE_CONFIG_H
# include "config.h"
#endif

23 24 25 26 27 28 29 30 31
#include "mutt.h"
#include "mx.h"
#include "md5.h"
#include "pop.h"

#include <string.h>
#include <unistd.h>

#ifdef USE_SASL
32 33
#include <sasl/sasl.h>
#include <sasl/saslutil.h>
34 35 36 37 38 39

#include "mutt_sasl.h"
#endif

#ifdef USE_SASL
/* SASL authenticator */
40
static pop_auth_res_t pop_auth_sasl (POP_DATA *pop_data, const char *method)
41 42 43 44
{
  sasl_conn_t *saslconn;
  sasl_interact_t *interaction = NULL;
  int rc;
45 46
  char *buf = NULL;
  size_t bufsize = 0;
47 48
  char inbuf[LONG_STRING];
  const char* mech;
49
  const char *pc = NULL;
50
  unsigned int len, olen, client_start;
51

52 53 54 55
  if (mutt_account_getpass (&pop_data->conn->account) ||
      !pop_data->conn->account.pass[0])
    return POP_A_FAILURE;

56
  if (mutt_sasl_client_new (pop_data->conn, &saslconn) < 0)
57 58 59 60 61
  {
    dprint (1, (debugfile, "pop_auth_sasl: Error allocating SASL connection.\n"));
    return POP_A_FAILURE;
  }

62 63 64
  if (!method)
    method = pop_data->auth_list;

65 66
  FOREVER
  {
67
    rc = sasl_client_start(saslconn, method, &interaction, &pc, &olen, &mech);
68 69 70 71 72 73 74 75 76 77
    if (rc != SASL_INTERACT)
      break;
    mutt_sasl_interact (interaction);
  }

  if (rc != SASL_OK && rc != SASL_CONTINUE)
  {
    dprint (1, (debugfile, "pop_auth_sasl: Failure starting authentication exchange. No shared mechanisms?\n"));

    /* SASL doesn't support suggested mechanisms, so fall back */
78
    sasl_dispose (&saslconn);
79 80 81
    return POP_A_UNAVAIL;
  }

82 83 84 85
  /* About client_start:  If sasl_client_start() returns data via pc/olen,
   * the client is expected to send this first (after the AUTH string is sent).
   * sasl_client_start() may in fact return SASL_OK in this case.
   */
86
  client_start = olen;
87 88 89

  mutt_message _("Authenticating (SASL)...");

90 91 92 93
  bufsize = ((olen * 2) > LONG_STRING) ? (olen * 2) : LONG_STRING;
  buf = safe_malloc (bufsize);

  snprintf (buf, bufsize, "AUTH %s", mech);
94 95 96 97 98
  olen = strlen (buf);

  /* looping protocol */
  FOREVER
  {
99
    strfcpy (buf + olen, "\r\n", bufsize - olen);
100 101 102 103 104
    mutt_socket_write (pop_data->conn, buf);
    if (mutt_socket_readln (inbuf, sizeof (inbuf), pop_data->conn) < 0)
    {
      sasl_dispose (&saslconn);
      pop_data->status = POP_DISCONNECTED;
105
      FREE (&buf);
106 107 108
      return POP_A_SOCKET;
    }

109 110 111 112 113
    /* Note we don't exit if rc==SASL_OK when client_start is true.
     * This is because the first loop has only sent the AUTH string, we
     * need to loop at least once more to send the pc/olen returned
     * by sasl_client_start().
     */
114
    if (!client_start && rc != SASL_CONTINUE)
115 116
      break;

117
    if (!mutt_strncmp (inbuf, "+ ", 2)
118
        && sasl_decode64 (inbuf+2, strlen (inbuf+2), buf, bufsize - 1, &len) != SASL_OK)
119 120 121 122 123 124 125 126 127 128 129 130 131 132
    {
      dprint (1, (debugfile, "pop_auth_sasl: error base64-decoding server response.\n"));
      goto bail;
    }

    if (!client_start)
      FOREVER
      {
	rc = sasl_client_step (saslconn, buf, len, &interaction, &pc, &olen);
	if (rc != SASL_INTERACT)
	  break;
	mutt_sasl_interact (interaction);
      }
    else
133 134
    {
      olen = client_start;
135
      client_start = 0;
136
    }
137

138 139 140
    /* Even if sasl_client_step() returns SASL_OK, we should send at
     * least one more line to the server.  See #3862.
     */
141
    if (rc != SASL_CONTINUE && rc != SASL_OK)
142 143 144 145 146
      break;

    /* send out response, or line break if none needed */
    if (pc)
    {
147 148 149 150 151 152
      if ((olen * 2) > bufsize)
      {
        bufsize = olen * 2;
        safe_realloc (&buf, bufsize);
      }
      if (sasl_encode64 (pc, olen, buf, bufsize, &olen) != SASL_OK)
153 154 155 156 157 158 159 160 161 162 163 164 165
      {
	dprint (1, (debugfile, "pop_auth_sasl: error base64-encoding client response.\n"));
	goto bail;
      }
    }
  }

  if (rc != SASL_OK)
    goto bail;

  if (!mutt_strncmp (inbuf, "+OK", 3))
  {
    mutt_sasl_setup_conn (pop_data->conn, saslconn);
166
    FREE (&buf);
167 168 169 170 171 172
    return POP_A_SUCCESS;
  }

bail:
  sasl_dispose (&saslconn);

Michael Elkins's avatar
Michael Elkins committed
173
  /* terminate SASL session if the last response is not +OK nor -ERR */
174 175
  if (!mutt_strncmp (inbuf, "+ ", 2))
  {
176
    snprintf (buf, bufsize, "*\r\n");
177
    if (pop_query (pop_data, buf, sizeof (buf)) == -1)
178 179
    {
      FREE (&buf);
180
      return POP_A_SOCKET;
181
    }
182 183
  }

184
  FREE (&buf);
185
  mutt_error _("SASL authentication failed.");
186
  mutt_sleep (2);
187

188
  return POP_A_FAILURE;
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
}
#endif

/* Get the server timestamp for APOP authentication */
void pop_apop_timestamp (POP_DATA *pop_data, char *buf)
{
  char *p1, *p2;

  FREE (&pop_data->timestamp);

  if ((p1 = strchr (buf, '<')) && (p2 = strchr (p1, '>')))
  {
    p2[1] = '\0';
    pop_data->timestamp = safe_strdup (p1);
  }
}

/* APOP authenticator */
207
static pop_auth_res_t pop_auth_apop (POP_DATA *pop_data, const char *method)
208
{
209
  struct md5_ctx ctx;
210 211 212
  unsigned char digest[16];
  char hash[33];
  char buf[LONG_STRING];
213
  size_t i;
214

215 216 217 218
  if (mutt_account_getpass (&pop_data->conn->account) ||
      !pop_data->conn->account.pass[0])
    return POP_A_FAILURE;

219 220 221
  if (!pop_data->timestamp)
    return POP_A_UNAVAIL;

222 223 224 225 226 227 228
  if (rfc822_valid_msgid (pop_data->timestamp) < 0)
  {
    mutt_error _("POP timestamp is invalid!");
    mutt_sleep (2);
    return POP_A_UNAVAIL;
  }

229 230 231
  mutt_message _("Authenticating (APOP)...");

  /* Compute the authentication hash to send to the server */
232 233 234 235 236
  md5_init_ctx (&ctx);
  md5_process_bytes (pop_data->timestamp, strlen (pop_data->timestamp), &ctx);
  md5_process_bytes (pop_data->conn->account.pass,
		     strlen (pop_data->conn->account.pass), &ctx);
  md5_finish_ctx (&ctx, digest);
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

  for (i = 0; i < sizeof (digest); i++)
    sprintf (hash + 2 * i, "%02x", digest[i]);

  /* Send APOP command to server */
  snprintf (buf, sizeof (buf), "APOP %s %s\r\n", pop_data->conn->account.user, hash);

  switch (pop_query (pop_data, buf, sizeof (buf)))
  {
    case 0:
      return POP_A_SUCCESS;
    case -1:
      return POP_A_SOCKET;
  }

  mutt_error _("APOP authentication failed.");
253
  mutt_sleep (2);
254

255
  return POP_A_FAILURE;
256 257 258
}

/* USER authenticator */
259
static pop_auth_res_t pop_auth_user (POP_DATA *pop_data, const char *method)
260 261 262 263 264 265 266
{
  char buf[LONG_STRING];
  int ret;

  if (!pop_data->cmd_user)
    return POP_A_UNAVAIL;

267 268 269 270
  if (mutt_account_getpass (&pop_data->conn->account) ||
      !pop_data->conn->account.pass[0])
    return POP_A_FAILURE;

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
  mutt_message _("Logging in...");

  snprintf (buf, sizeof (buf), "USER %s\r\n", pop_data->conn->account.user);
  ret = pop_query (pop_data, buf, sizeof (buf));

  if (pop_data->cmd_user == 2)
  {
    if (ret == 0)
    {
      pop_data->cmd_user = 1;

      dprint (1, (debugfile, "pop_auth_user: set USER capability\n"));
    }

    if (ret == -2)
    {
      pop_data->cmd_user = 0;

      dprint (1, (debugfile, "pop_auth_user: unset USER capability\n"));
290
      snprintf (pop_data->err_msg, sizeof (pop_data->err_msg), "%s",
291 292 293 294 295 296 297 298 299 300
              _("Command USER is not supported by server."));
    }
  }

  if (ret == 0)
  {
    snprintf (buf, sizeof (buf), "PASS %s\r\n", pop_data->conn->account.pass);
    ret = pop_query_d (pop_data, buf, sizeof (buf), 
#ifdef DEBUG
	/* don't print the password unless we're at the ungodly debugging level */
301
	debuglevel < MUTT_SOCK_LOG_FULL ? "PASS *\r\n" :
302 303 304 305 306 307 308 309 310 311 312 313 314
#endif
	NULL);
  }

  switch (ret)
  {
    case 0:
      return POP_A_SUCCESS;
    case -1:
      return POP_A_SOCKET;
  }

  mutt_error ("%s %s", _("Login failed."), pop_data->err_msg);
315
  mutt_sleep (2);
316 317 318 319

  return POP_A_FAILURE;
}

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
/* OAUTHBEARER authenticator */
static pop_auth_res_t pop_auth_oauth (POP_DATA *pop_data, const char *method)
{
  char *oauthbearer = NULL;
  char decoded_err[LONG_STRING];
  char *err = NULL;
  char *auth_cmd = NULL;
  size_t auth_cmd_len;
  int ret, len;

  mutt_message _("Authenticating (OAUTHBEARER)...");

  oauthbearer = mutt_account_getoauthbearer (&pop_data->conn->account);
  if (oauthbearer == NULL)
    return POP_A_FAILURE;

  auth_cmd_len = strlen (oauthbearer) + 30;
  auth_cmd = safe_malloc (auth_cmd_len);
  snprintf (auth_cmd, auth_cmd_len, "AUTH OAUTHBEARER %s\r\n", oauthbearer);
  FREE (&oauthbearer);

  ret = pop_query_d (pop_data, auth_cmd, strlen (auth_cmd), 
#ifdef DEBUG
	/* don't print the bearer token unless we're at the ungodly debugging level */
	debuglevel < MUTT_SOCK_LOG_FULL ? "AUTH OAUTHBEARER *\r\n" :
#endif
	NULL);
  FREE (&auth_cmd);

  switch (ret)
  {
    case 0:
      return POP_A_SUCCESS;
    case -1:
      return POP_A_SOCKET;
  }

  /* The error response was a SASL continuation, so "continue" it.
   * See RFC 7628 3.2.3
   */
  mutt_socket_write (pop_data->conn, "\001");

  err = pop_data->err_msg;
  len = mutt_from_base64 (decoded_err, pop_data->err_msg, sizeof(decoded_err) - 1);
  if (len >= 0)
  {
    decoded_err[len] = '\0';
    err = decoded_err;
  }
  mutt_error ("%s %s", _("Authentication failed."), err);
  mutt_sleep (2);

  return POP_A_FAILURE;
}

375
static const pop_auth_t pop_authenticators[] = {
376
  { pop_auth_oauth, "oauthbearer" },
377
#ifdef USE_SASL
378
  { pop_auth_sasl, NULL },
379
#endif
380 381
  { pop_auth_apop, "apop" },
  { pop_auth_user, "user" },
382
  { NULL,	   NULL }
383 384 385 386 387
};

/*
 * Authentication
 *  0 - successful,
Ondřej Bílka's avatar
Ondřej Bílka committed
388
 * -1 - connection lost,
389 390 391 392 393 394
 * -2 - login failed,
 * -3 - authentication canceled.
*/
int pop_authenticate (POP_DATA* pop_data)
{
  ACCOUNT *acct = &pop_data->conn->account;
395
  const pop_auth_t* authenticator;
396 397 398 399
  char* methods;
  char* comma;
  char* method;
  int attempts = 0;
400 401
  int ret = POP_A_UNAVAIL;

402
  if (mutt_account_getuser (acct) || !acct->user[0])
403 404
    return -3;

405
  if (PopAuthenticators && *PopAuthenticators)
406
  {
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
    /* Try user-specified list of authentication methods */
    methods = safe_strdup (PopAuthenticators);
    method = methods;

    while (method)
    {
      comma = strchr (method, ':');
      if (comma)
	*comma++ = '\0';
      dprint (2, (debugfile, "pop_authenticate: Trying method %s\n", method));
      authenticator = pop_authenticators;

      while (authenticator->authenticate)
      {
	if (!authenticator->method ||
	    !ascii_strcasecmp (authenticator->method, method))
	{
	  ret = authenticator->authenticate (pop_data, method);
	  if (ret == POP_A_SOCKET)
	    switch (pop_connect (pop_data))
	    {
	      case 0:
	      {
		ret = authenticator->authenticate (pop_data, method);
		break;
	      }
	      case -2:
		ret = POP_A_FAILURE;
	    }

	  if (ret != POP_A_UNAVAIL)
	    attempts++;
	  if (ret == POP_A_SUCCESS || ret == POP_A_SOCKET ||
	      (ret == POP_A_FAILURE && !option (OPTPOPAUTHTRYALL)))
	  {
	    comma = NULL;
	    break;
	  }
	}
	authenticator++;
      }

      method = comma;
    }

    FREE (&methods);
453 454 455
  }
  else
  {
456 457
    /* Fall back to default: any authenticator */
    dprint (2, (debugfile, "pop_authenticate: Using any available method.\n"));
458 459
    authenticator = pop_authenticators;

460
    while (authenticator->authenticate)
461
    {
462
      ret = authenticator->authenticate (pop_data, authenticator->method);
463 464 465 466 467
      if (ret == POP_A_SOCKET)
	switch (pop_connect (pop_data))
	{
	  case 0:
	  {
468
	    ret = authenticator->authenticate (pop_data, authenticator->method);
469 470 471 472 473 474
	    break;
	  }
	  case -2:
	    ret = POP_A_FAILURE;
	}

475 476 477 478
      if (ret != POP_A_UNAVAIL)
	attempts++;
      if (ret == POP_A_SUCCESS || ret == POP_A_SOCKET ||
	  (ret == POP_A_FAILURE && !option (OPTPOPAUTHTRYALL)))
479 480 481 482 483 484 485 486 487 488 489 490 491
	break;

      authenticator++;
    }
  }

  switch (ret)
  {
    case POP_A_SUCCESS:
      return 0;
    case POP_A_SOCKET:
      return -1;
    case POP_A_UNAVAIL:
492 493
      if (!attempts)
	mutt_error (_("No authenticators available"));
494 495 496 497
  }

  return -2;
}