NeoMutt  2018-07-16 +2225-8687db
Teaching an old dog new tricks
DOXYGEN
smtp.c File Reference

Send email to an SMTP server. More...

#include "config.h"
#include <netdb.h>
#include <netinet/in.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "mutt/mutt.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "conn/conn.h"
#include "mutt.h"
#include "globals.h"
#include "mutt_account.h"
#include "mutt_socket.h"
#include "options.h"
#include "progress.h"
#include "sendlib.h"
#include <sasl/sasl.h>
#include <sasl/saslutil.h>

Go to the source code of this file.

Macros

#define smtp_success(x)   ((x) / 100 == 2)
 
#define SMTP_READY   334
 
#define SMTP_CONTINUE   354
 
#define SMTP_ERR_READ   -2
 
#define SMTP_ERR_WRITE   -3
 
#define SMTP_ERR_CODE   -4
 
#define SMTP_PORT   25
 
#define SMTPS_PORT   465
 
#define SMTP_AUTH_SUCCESS   0
 
#define SMTP_AUTH_UNAVAIL   1
 
#define SMTP_AUTH_FAIL   -1
 
#define SMTP_CAP_NO_FLAGS   0
 No flags are set. More...
 
#define SMTP_CAP_STARTTLS   (1 << 0)
 Server supports STARTTLS command. More...
 
#define SMTP_CAP_AUTH   (1 << 1)
 Server supports AUTH command. More...
 
#define SMTP_CAP_DSN   (1 << 2)
 Server supports Delivery Status Notification. More...
 
#define SMTP_CAP_EIGHTBITMIME   (1 << 3)
 Server supports 8-bit MIME content. More...
 
#define SMTP_CAP_SMTPUTF8   (1 << 4)
 Server accepts UTF-8 strings. More...
 
#define SMTP_CAP_ALL   ((1 << 5) - 1)
 

Typedefs

typedef uint8_t SmtpCapFlags
 typedef SmtpCapFlags - SMTP server capabilities More...
 

Functions

static bool valid_smtp_code (char *buf, size_t buflen, int *n)
 Is the is a valid SMTP return code? More...
 
static int smtp_get_resp (struct Connection *conn)
 Read a command response from the SMTP server. More...
 
static int smtp_rcpt_to (struct Connection *conn, const struct AddressList *al)
 Set the recipient to an Address. More...
 
static int smtp_data (struct Connection *conn, const char *msgfile)
 Send data to an SMTP server. More...
 
static bool address_uses_unicode (const char *a)
 Do any addresses use Unicode. More...
 
static bool addresses_use_unicode (const struct AddressList *al)
 Do any of a list of addresses use Unicode. More...
 
static int smtp_fill_account (struct ConnAccount *account)
 Create ConnAccount object from SMTP Url. More...
 
static int smtp_helo (struct Connection *conn, bool esmtp)
 Say hello to an SMTP Server. More...
 
static int smtp_auth_sasl (struct Connection *conn, const char *mechlist)
 Authenticate using SASL. More...
 
static int smtp_auth_oauth (struct Connection *conn)
 Authenticate an SMTP connection using OAUTHBEARER. More...
 
static int smtp_auth_plain (struct Connection *conn)
 Authenticate using plain text. More...
 
static int smtp_auth (struct Connection *conn)
 Authenticate to an SMTP server. More...
 
static int smtp_open (struct Connection *conn, bool esmtp)
 Open an SMTP Connection. More...
 
int mutt_smtp_send (const struct AddressList *from, const struct AddressList *to, const struct AddressList *cc, const struct AddressList *bcc, const char *msgfile, bool eightbit)
 Send a message using SMTP. More...
 

Variables

struct SlistC_SmtpAuthenticators
 Config: (smtp) List of allowed authentication methods. More...
 
static char * AuthMechs = NULL
 
static SmtpCapFlags Capabilities
 

Detailed Description

Send email to an SMTP server.

Authors
  • Michael R. Elkins
  • Brendan Cully
  • Pietro Cerutti

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

Macro Definition Documentation

#define smtp_success (   x)    ((x) / 100 == 2)

Definition at line 61 of file smtp.c.

#define SMTP_READY   334

Definition at line 62 of file smtp.c.

#define SMTP_CONTINUE   354

Definition at line 63 of file smtp.c.

#define SMTP_ERR_READ   -2

Definition at line 65 of file smtp.c.

#define SMTP_ERR_WRITE   -3

Definition at line 66 of file smtp.c.

#define SMTP_ERR_CODE   -4

Definition at line 67 of file smtp.c.

#define SMTP_PORT   25

Definition at line 69 of file smtp.c.

#define SMTPS_PORT   465

Definition at line 70 of file smtp.c.

#define SMTP_AUTH_SUCCESS   0

Definition at line 72 of file smtp.c.

#define SMTP_AUTH_UNAVAIL   1

Definition at line 73 of file smtp.c.

#define SMTP_AUTH_FAIL   -1

Definition at line 74 of file smtp.c.

#define SMTP_CAP_NO_FLAGS   0

No flags are set.

Definition at line 81 of file smtp.c.

#define SMTP_CAP_STARTTLS   (1 << 0)

Server supports STARTTLS command.

Definition at line 82 of file smtp.c.

#define SMTP_CAP_AUTH   (1 << 1)

Server supports AUTH command.

Definition at line 83 of file smtp.c.

#define SMTP_CAP_DSN   (1 << 2)

Server supports Delivery Status Notification.

Definition at line 84 of file smtp.c.

#define SMTP_CAP_EIGHTBITMIME   (1 << 3)

Server supports 8-bit MIME content.

Definition at line 85 of file smtp.c.

#define SMTP_CAP_SMTPUTF8   (1 << 4)

Server accepts UTF-8 strings.

Definition at line 86 of file smtp.c.

#define SMTP_CAP_ALL   ((1 << 5) - 1)

Definition at line 88 of file smtp.c.

Typedef Documentation

typedef uint8_t SmtpCapFlags

typedef SmtpCapFlags - SMTP server capabilities

Flags, e.g. SMTP_CAP_STARTTLS

Definition at line 80 of file smtp.c.

Function Documentation

static bool valid_smtp_code ( char *  buf,
size_t  buflen,
int *  n 
)
static

Is the is a valid SMTP return code?

Parameters
[in]bufString to check
[in]buflenLength of string
[out]nNumeric value of code
Return values
trueValid number

Definition at line 101 of file smtp.c.

102 {
103  char code[4];
104 
105  if (buflen < 4)
106  return false;
107  code[0] = buf[0];
108  code[1] = buf[1];
109  code[2] = buf[2];
110  code[3] = '\0';
111  if (mutt_str_atoi(code, n) < 0)
112  return false;
113  return true;
114 }
int mutt_str_atoi(const char *str, int *dst)
Convert ASCII string to an integer.
Definition: string.c:262
static int smtp_get_resp ( struct Connection conn)
static

Read a command response from the SMTP server.

Parameters
connSMTP connection
Return values
0Success (2xx code) or continue (354 code)
-1Write error, or any other response code

Definition at line 122 of file smtp.c.

123 {
124  int n;
125  char buf[1024];
126 
127  do
128  {
129  n = mutt_socket_readln(buf, sizeof(buf), conn);
130  if (n < 4)
131  {
132  /* read error, or no response code */
133  return SMTP_ERR_READ;
134  }
135  const char *s = buf + 4; /* Skip the response code and the space/dash */
136  size_t plen;
137 
138  if (mutt_str_startswith(s, "8BITMIME", CASE_IGNORE))
140  else if ((plen = mutt_str_startswith(s, "AUTH ", CASE_IGNORE)))
141  {
143  FREE(&AuthMechs);
144  AuthMechs = mutt_str_strdup(s + plen);
145  }
146  else if (mutt_str_startswith(s, "DSN", CASE_IGNORE))
148  else if (mutt_str_startswith(s, "STARTTLS", CASE_IGNORE))
150  else if (mutt_str_startswith(s, "SMTPUTF8", CASE_IGNORE))
152 
153  if (!valid_smtp_code(buf, n, &n))
154  return SMTP_ERR_CODE;
155 
156  } while (buf[3] == '-');
157 
158  if (smtp_success(n) || (n == SMTP_CONTINUE))
159  return 0;
160 
161  mutt_error(_("SMTP session failed: %s"), buf);
162  return -1;
163 }
#define SMTP_CAP_STARTTLS
Server supports STARTTLS command.
Definition: smtp.c:82
static size_t plen
Length of cached packet.
Definition: pgppacket.c:38
#define SMTP_CAP_SMTPUTF8
Server accepts UTF-8 strings.
Definition: smtp.c:86
#define _(a)
Definition: message.h:28
static SmtpCapFlags Capabilities
Definition: smtp.c:92
Ignore case when comparing strings.
Definition: string2.h:68
#define SMTP_ERR_READ
Definition: smtp.c:65
#define smtp_success(x)
Definition: smtp.c:61
size_t mutt_str_startswith(const char *str, const char *prefix, enum CaseSensitivity cs)
Check whether a string starts with a prefix.
Definition: string.c:168
#define mutt_socket_readln(buf, buflen, conn)
Definition: mutt_socket.h:37
#define SMTP_ERR_CODE
Definition: smtp.c:67
static bool valid_smtp_code(char *buf, size_t buflen, int *n)
Is the is a valid SMTP return code?
Definition: smtp.c:101
char * mutt_str_strdup(const char *str)
Copy a string, safely.
Definition: string.c:380
#define mutt_error(...)
Definition: logging.h:84
#define SMTP_CONTINUE
Definition: smtp.c:63
#define SMTP_CAP_EIGHTBITMIME
Server supports 8-bit MIME content.
Definition: smtp.c:85
#define FREE(x)
Definition: memory.h:40
#define SMTP_CAP_AUTH
Server supports AUTH command.
Definition: smtp.c:83
static char * AuthMechs
Definition: smtp.c:91
#define SMTP_CAP_DSN
Server supports Delivery Status Notification.
Definition: smtp.c:84
static int smtp_rcpt_to ( struct Connection conn,
const struct AddressList *  al 
)
static

Set the recipient to an Address.

Parameters
connServer Connection
alAddressList to use
Return values
0Success
<0Error, e.g. SMTP_ERR_WRITE

Definition at line 172 of file smtp.c.

173 {
174  if (!al)
175  return 0;
176 
177  struct Address *a = NULL;
178  TAILQ_FOREACH(a, al, entries)
179  {
180  /* weed out group mailboxes, since those are for display only */
181  if (!a->mailbox || a->group)
182  {
183  continue;
184  }
185  char buf[1024];
187  snprintf(buf, sizeof(buf), "RCPT TO:<%s> NOTIFY=%s\r\n", a->mailbox, C_DsnNotify);
188  else
189  snprintf(buf, sizeof(buf), "RCPT TO:<%s>\r\n", a->mailbox);
190  if (mutt_socket_send(conn, buf) == -1)
191  return SMTP_ERR_WRITE;
192  int rc = smtp_get_resp(conn);
193  if (rc != 0)
194  return rc;
195  }
196 
197  return 0;
198 }
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:719
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
An email address.
Definition: address.h:34
char * mailbox
Mailbox and host address.
Definition: address.h:37
static SmtpCapFlags Capabilities
Definition: smtp.c:92
#define SMTP_ERR_WRITE
Definition: smtp.c:66
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
bool group
Group mailbox?
Definition: address.h:38
WHERE char * C_DsnNotify
Config: Request notification for message delivery or delay.
Definition: globals.h:102
#define SMTP_CAP_DSN
Server supports Delivery Status Notification.
Definition: smtp.c:84
static int smtp_data ( struct Connection conn,
const char *  msgfile 
)
static

Send data to an SMTP server.

Parameters
connSMTP Connection
msgfileFilename containing data
Return values
0Success
<0Error, e.g. SMTP_ERR_WRITE

Definition at line 207 of file smtp.c.

208 {
209  char buf[1024];
210  struct Progress progress;
211  struct stat st;
212  int rc, term = 0;
213  size_t buflen = 0;
214 
215  FILE *fp = fopen(msgfile, "r");
216  if (!fp)
217  {
218  mutt_error(_("SMTP session failed: unable to open %s"), msgfile);
219  return -1;
220  }
221  stat(msgfile, &st);
222  unlink(msgfile);
223  mutt_progress_init(&progress, _("Sending message..."), MUTT_PROGRESS_SIZE,
224  C_NetInc, st.st_size);
225 
226  snprintf(buf, sizeof(buf), "DATA\r\n");
227  if (mutt_socket_send(conn, buf) == -1)
228  {
229  mutt_file_fclose(&fp);
230  return SMTP_ERR_WRITE;
231  }
232  rc = smtp_get_resp(conn);
233  if (rc != 0)
234  {
235  mutt_file_fclose(&fp);
236  return rc;
237  }
238 
239  while (fgets(buf, sizeof(buf) - 1, fp))
240  {
241  buflen = mutt_str_strlen(buf);
242  term = buflen && buf[buflen - 1] == '\n';
243  if (term && ((buflen == 1) || (buf[buflen - 2] != '\r')))
244  snprintf(buf + buflen - 1, sizeof(buf) - buflen + 1, "\r\n");
245  if (buf[0] == '.')
246  {
247  if (mutt_socket_send_d(conn, ".", MUTT_SOCK_LOG_FULL) == -1)
248  {
249  mutt_file_fclose(&fp);
250  return SMTP_ERR_WRITE;
251  }
252  }
253  if (mutt_socket_send_d(conn, buf, MUTT_SOCK_LOG_FULL) == -1)
254  {
255  mutt_file_fclose(&fp);
256  return SMTP_ERR_WRITE;
257  }
258  mutt_progress_update(&progress, ftell(fp), -1);
259  }
260  if (!term && buflen && (mutt_socket_send_d(conn, "\r\n", MUTT_SOCK_LOG_FULL) == -1))
261  {
262  mutt_file_fclose(&fp);
263  return SMTP_ERR_WRITE;
264  }
265  mutt_file_fclose(&fp);
266 
267  /* terminate the message body */
268  if (mutt_socket_send(conn, ".\r\n") == -1)
269  return SMTP_ERR_WRITE;
270 
271  rc = smtp_get_resp(conn);
272  if (rc != 0)
273  return rc;
274 
275  return 0;
276 }
#define MUTT_PROGRESS_SIZE
traffic-based progress
Definition: progress.h:32
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
void mutt_progress_update(struct Progress *progress, long pos, int percent)
Update the state of the progress bar.
Definition: progress.c:171
void mutt_progress_init(struct Progress *progress, const char *msg, unsigned short flags, unsigned short inc, size_t size)
Set up a progress bar.
Definition: progress.c:114
#define _(a)
Definition: message.h:28
size_t mutt_str_strlen(const char *a)
Calculate the length of a string, safely.
Definition: string.c:666
#define MUTT_SOCK_LOG_FULL
Definition: mutt_socket.h:32
A progress bar.
Definition: progress.h:38
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:149
#define mutt_socket_send_d(conn, buf, dbg)
Definition: mutt_socket.h:39
#define SMTP_ERR_WRITE
Definition: smtp.c:66
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
#define mutt_error(...)
Definition: logging.h:84
WHERE short C_NetInc
Config: (socket) Update the progress bar after this many KB sent/received (0 to disable) ...
Definition: globals.h:123
static bool address_uses_unicode ( const char *  a)
static

Do any addresses use Unicode.

Parameters
aAddress list to check
Return values
trueif any of the string of addresses use 8-bit characters

Definition at line 283 of file smtp.c.

284 {
285  if (!a)
286  return false;
287 
288  while (*a)
289  {
290  if ((unsigned char) *a & (1 << 7))
291  return true;
292  a++;
293  }
294 
295  return false;
296 }
static bool addresses_use_unicode ( const struct AddressList *  al)
static

Do any of a list of addresses use Unicode.

Parameters
alAddress list to check
Return values
trueif any use 8-bit characters

Definition at line 303 of file smtp.c.

304 {
305  struct Address *a = NULL;
306  TAILQ_FOREACH(a, al, entries)
307  {
308  if (a->mailbox && !a->group && address_uses_unicode(a->mailbox))
309  return true;
310  }
311  return false;
312 }
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:719
An email address.
Definition: address.h:34
char * mailbox
Mailbox and host address.
Definition: address.h:37
static bool address_uses_unicode(const char *a)
Do any addresses use Unicode.
Definition: smtp.c:283
bool group
Group mailbox?
Definition: address.h:38
static int smtp_fill_account ( struct ConnAccount account)
static

Create ConnAccount object from SMTP Url.

Parameters
accountConnAccount to populate
Return values
0Success
-1Error

Definition at line 320 of file smtp.c.

321 {
322  account->flags = 0;
323  account->port = 0;
324  account->type = MUTT_ACCT_TYPE_SMTP;
325 
326  struct Url *url = url_parse(C_SmtpUrl);
327  if (!url || ((url->scheme != U_SMTP) && (url->scheme != U_SMTPS)) ||
328  !url->host || (mutt_account_fromurl(account, url) < 0))
329  {
330  url_free(&url);
331  mutt_error(_("Invalid SMTP URL: %s"), C_SmtpUrl);
332  return -1;
333  }
334 
335  if (url->scheme == U_SMTPS)
336  account->flags |= MUTT_ACCT_SSL;
337 
338  if (account->port == 0)
339  {
340  if (account->flags & MUTT_ACCT_SSL)
341  account->port = SMTPS_PORT;
342  else
343  {
344  static unsigned short SmtpPort = 0;
345  if (SmtpPort == 0)
346  {
347  struct servent *service = getservbyname("smtp", "tcp");
348  if (service)
349  SmtpPort = ntohs(service->s_port);
350  else
351  SmtpPort = SMTP_PORT;
352  mutt_debug(LL_DEBUG3, "Using default SMTP port %d\n", SmtpPort);
353  }
354  account->port = SmtpPort;
355  }
356  }
357 
358  url_free(&url);
359  return 0;
360 }
WHERE char * C_SmtpUrl
Config: (smtp) Url of the SMTP server.
Definition: globals.h:140
A parsed URL proto://user:password@host:port/path?a=1&b=2
Definition: url.h:66
enum UrlScheme scheme
Scheme, e.g. U_SMTPS.
Definition: url.h:68
#define _(a)
Definition: message.h:28
#define SMTP_PORT
Definition: smtp.c:69
unsigned short port
Definition: connaccount.h:37
Url is smtps://.
Definition: url.h:43
unsigned char type
Connection type, e.g. MUTT_ACCT_TYPE_IMAP.
Definition: connaccount.h:38
char * host
Host.
Definition: url.h:71
#define mutt_error(...)
Definition: logging.h:84
void url_free(struct Url **u)
Free the contents of a URL.
Definition: url.c:288
Url is smtp://.
Definition: url.h:42
#define MUTT_ACCT_SSL
Account uses SSL/TLS.
Definition: mutt_account.h:64
Smtp Account.
Definition: mutt_account.h:54
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
#define SMTPS_PORT
Definition: smtp.c:70
int mutt_account_fromurl(struct ConnAccount *account, const struct Url *url)
Fill ConnAccount with information from url.
Definition: mutt_account.c:108
Log at debug level 3.
Definition: logging.h:58
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:39
struct Url * url_parse(const char *src)
Fill in Url.
Definition: url.c:161
static int smtp_helo ( struct Connection conn,
bool  esmtp 
)
static

Say hello to an SMTP Server.

Parameters
connSMTP Connection
esmtpIf true, use ESMTP
Return values
0Success
<0Error, e.g. SMTP_ERR_WRITE

Definition at line 369 of file smtp.c.

370 {
371  Capabilities = 0;
372 
373  if (!esmtp)
374  {
375  /* if TLS or AUTH are requested, use EHLO */
376  if (conn->account.flags & MUTT_ACCT_USER)
377  esmtp = true;
378 #ifdef USE_SSL
379  if (C_SslForceTls || (C_SslStarttls != MUTT_NO))
380  esmtp = true;
381 #endif
382  }
383 
384  const char *fqdn = mutt_fqdn(false);
385  if (!fqdn)
386  fqdn = NONULL(ShortHostname);
387 
388  char buf[1024];
389  snprintf(buf, sizeof(buf), "%s %s\r\n", esmtp ? "EHLO" : "HELO", fqdn);
390  /* XXX there should probably be a wrapper in mutt_socket.c that
391  * repeatedly calls conn->write until all data is sent. This
392  * currently doesn't check for a short write. */
393  if (mutt_socket_send(conn, buf) == -1)
394  return SMTP_ERR_WRITE;
395  return smtp_get_resp(conn);
396 }
#define NONULL(x)
Definition: string2.h:37
struct ConnAccount account
Definition: connection.h:36
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
WHERE bool C_SslForceTls
Config: (ssl) Require TLS encryption for all connections.
Definition: globals.h:232
static SmtpCapFlags Capabilities
Definition: smtp.c:92
#define SMTP_ERR_WRITE
Definition: smtp.c:66
User answered &#39;No&#39;, or assume &#39;No&#39;.
Definition: quad.h:38
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
const char * mutt_fqdn(bool may_hide_host)
Get the Fully-Qualified Domain Name.
Definition: sendlib.c:2449
WHERE char * ShortHostname
Short version of the hostname.
Definition: globals.h:49
WHERE unsigned char C_SslStarttls
Config: (ssl) Use STARTTLS on servers advertising the capability.
Definition: globals.h:188
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:39
#define MUTT_ACCT_USER
User field has been set.
Definition: mutt_account.h:61
static int smtp_auth_sasl ( struct Connection conn,
const char *  mechlist 
)
static

Authenticate using SASL.

Parameters
connSMTP Connection
mechlistList of mechanisms to use
Return values
0Success
<0Error, e.g. SMTP_AUTH_FAIL

Definition at line 406 of file smtp.c.

407 {
408  sasl_conn_t *saslconn = NULL;
409  sasl_interact_t *interaction = NULL;
410  const char *mech = NULL;
411  const char *data = NULL;
412  unsigned int len;
413  char *buf = NULL;
414  size_t bufsize = 0;
415  int rc, saslrc;
416 
417  if (mutt_sasl_client_new(conn, &saslconn) < 0)
418  return SMTP_AUTH_FAIL;
419 
420  do
421  {
422  rc = sasl_client_start(saslconn, mechlist, &interaction, &data, &len, &mech);
423  if (rc == SASL_INTERACT)
424  mutt_sasl_interact(interaction);
425  } while (rc == SASL_INTERACT);
426 
427  if ((rc != SASL_OK) && (rc != SASL_CONTINUE))
428  {
429  mutt_debug(LL_DEBUG2, "%s unavailable\n", mech);
430  sasl_dispose(&saslconn);
431  return SMTP_AUTH_UNAVAIL;
432  }
433 
434  if (!OptNoCurses)
435  mutt_message(_("Authenticating (%s)..."), mech);
436 
437  bufsize = MAX((len * 2), 1024);
438  buf = mutt_mem_malloc(bufsize);
439 
440  snprintf(buf, bufsize, "AUTH %s", mech);
441  if (len)
442  {
443  mutt_str_strcat(buf, bufsize, " ");
444  if (sasl_encode64(data, len, buf + mutt_str_strlen(buf),
445  bufsize - mutt_str_strlen(buf), &len) != SASL_OK)
446  {
447  mutt_debug(LL_DEBUG1, "#1 error base64-encoding client response\n");
448  goto fail;
449  }
450  }
451  mutt_str_strcat(buf, bufsize, "\r\n");
452 
453  do
454  {
455  if (mutt_socket_send(conn, buf) < 0)
456  goto fail;
457  rc = mutt_socket_readln_d(buf, bufsize, conn, MUTT_SOCK_LOG_FULL);
458  if (rc < 0)
459  goto fail;
460  if (!valid_smtp_code(buf, rc, &rc))
461  goto fail;
462 
463  if (rc != SMTP_READY)
464  break;
465 
466  if (sasl_decode64(buf + 4, strlen(buf + 4), buf, bufsize - 1, &len) != SASL_OK)
467  {
468  mutt_debug(LL_DEBUG1, "error base64-decoding server response\n");
469  goto fail;
470  }
471 
472  do
473  {
474  saslrc = sasl_client_step(saslconn, buf, len, &interaction, &data, &len);
475  if (saslrc == SASL_INTERACT)
476  mutt_sasl_interact(interaction);
477  } while (saslrc == SASL_INTERACT);
478 
479  if (len)
480  {
481  if ((len * 2) > bufsize)
482  {
483  bufsize = len * 2;
484  mutt_mem_realloc(&buf, bufsize);
485  }
486  if (sasl_encode64(data, len, buf, bufsize, &len) != SASL_OK)
487  {
488  mutt_debug(LL_DEBUG1, "#2 error base64-encoding client response\n");
489  goto fail;
490  }
491  }
492  mutt_str_strfcpy(buf + len, "\r\n", bufsize - len);
493  } while (rc == SMTP_READY && saslrc != SASL_FAIL);
494 
495  if (smtp_success(rc))
496  {
497  mutt_sasl_setup_conn(conn, saslconn);
498  FREE(&buf);
499  return SMTP_AUTH_SUCCESS;
500  }
501 
502 fail:
503  sasl_dispose(&saslconn);
504  FREE(&buf);
505  return SMTP_AUTH_FAIL;
506 }
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
#define mutt_message(...)
Definition: logging.h:83
#define _(a)
Definition: message.h:28
int mutt_sasl_client_new(struct Connection *conn, sasl_conn_t **saslconn)
wrapper for sasl_client_new
Definition: sasl.c:534
WHERE bool OptNoCurses
(pseudo) when sending in batch mode
Definition: options.h:45
#define SMTP_AUTH_SUCCESS
Definition: smtp.c:72
void mutt_sasl_setup_conn(struct Connection *conn, sasl_conn_t *saslconn)
Set up an SASL connection.
Definition: sasl.c:678
size_t mutt_str_strlen(const char *a)
Calculate the length of a string, safely.
Definition: string.c:666
#define MUTT_SOCK_LOG_FULL
Definition: mutt_socket.h:32
#define MAX(a, b)
Definition: memory.h:30
Log at debug level 2.
Definition: logging.h:57
void mutt_mem_realloc(void *ptr, size_t size)
Resize a block of memory on the heap.
Definition: memory.c:114
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
size_t mutt_str_strfcpy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:750
#define SMTP_READY
Definition: smtp.c:62
#define smtp_success(x)
Definition: smtp.c:61
char * mutt_str_strcat(char *buf, size_t buflen, const char *s)
Concatenate two strings.
Definition: string.c:395
#define SMTP_AUTH_UNAVAIL
Definition: smtp.c:73
Log at debug level 1.
Definition: logging.h:56
static bool valid_smtp_code(char *buf, size_t buflen, int *n)
Is the is a valid SMTP return code?
Definition: smtp.c:101
#define FREE(x)
Definition: memory.h:40
int mutt_socket_readln_d(char *buf, size_t buflen, struct Connection *conn, int dbg)
Read a line from a socket.
Definition: socket.c:242
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
#define SMTP_AUTH_FAIL
Definition: smtp.c:74
int mutt_sasl_interact(sasl_interact_t *interaction)
Perform an SASL interaction with the user.
Definition: sasl.c:645
static int smtp_auth_oauth ( struct Connection conn)
static

Authenticate an SMTP connection using OAUTHBEARER.

Parameters
connConnection info
Return values
numResult, e.g. SMTP_AUTH_SUCCESS

Definition at line 514 of file smtp.c.

515 {
516  mutt_message(_("Authenticating (OAUTHBEARER)..."));
517 
518  /* We get the access token from the smtp_oauth_refresh_command */
519  char *oauthbearer = mutt_account_getoauthbearer(&conn->account);
520  if (!oauthbearer)
521  return SMTP_AUTH_FAIL;
522 
523  size_t ilen = strlen(oauthbearer) + 30;
524  char *ibuf = mutt_mem_malloc(ilen);
525  snprintf(ibuf, ilen, "AUTH OAUTHBEARER %s\r\n", oauthbearer);
526 
527  int rc = mutt_socket_send(conn, ibuf);
528  FREE(&oauthbearer);
529  FREE(&ibuf);
530 
531  if (rc == -1)
532  return SMTP_AUTH_FAIL;
533  if (smtp_get_resp(conn) != 0)
534  return SMTP_AUTH_FAIL;
535 
536  return SMTP_AUTH_SUCCESS;
537 }
struct ConnAccount account
Definition: connection.h:36
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
#define mutt_message(...)
Definition: logging.h:83
#define _(a)
Definition: message.h:28
#define SMTP_AUTH_SUCCESS
Definition: smtp.c:72
char * mutt_account_getoauthbearer(struct ConnAccount *account)
Get an OAUTHBEARER token.
Definition: mutt_account.c:347
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
#define FREE(x)
Definition: memory.h:40
#define SMTP_AUTH_FAIL
Definition: smtp.c:74
static int smtp_auth_plain ( struct Connection conn)
static

Authenticate using plain text.

Parameters
connSMTP Connection
Return values
0Success
<0Error, e.g. SMTP_AUTH_FAIL

Definition at line 545 of file smtp.c.

546 {
547  char buf[1024];
548 
549  /* Get username and password. Bail out of any can't be retrieved. */
550  if ((mutt_account_getuser(&conn->account) < 0) ||
551  (mutt_account_getpass(&conn->account) < 0))
552  {
553  goto error;
554  }
555 
556  /* Build the initial client response. */
557  size_t len = mutt_sasl_plain_msg(buf, sizeof(buf), "AUTH PLAIN", conn->account.user,
558  conn->account.user, conn->account.pass);
559 
560  /* Terminate as per SMTP protocol. Bail out if there's no room left. */
561  if (snprintf(buf + len, sizeof(buf) - len, "\r\n") != 2)
562  {
563  goto error;
564  }
565 
566  /* Send request, receive response (with a check for OK code). */
567  if ((mutt_socket_send(conn, buf) < 0) || smtp_get_resp(conn))
568  {
569  goto error;
570  }
571 
572  /* If we got here, auth was successful. */
573  return 0;
574 
575 error:
576  mutt_error(_("SASL authentication failed"));
577  return -1;
578 }
struct ConnAccount account
Definition: connection.h:36
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
char user[128]
Definition: connaccount.h:33
#define _(a)
Definition: message.h:28
size_t mutt_sasl_plain_msg(char *buf, size_t buflen, const char *cmd, const char *authz, const char *user, const char *pass)
Construct a base64 encoded SASL PLAIN message.
Definition: sasl_plain.c:54
char pass[256]
Definition: connaccount.h:35
int mutt_account_getpass(struct ConnAccount *account)
Fetch password into ConnAccount, if necessary.
Definition: mutt_account.c:288
int mutt_account_getuser(struct ConnAccount *account)
Retrieve username into ConnAccount, if necessary.
Definition: mutt_account.c:207
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
#define mutt_error(...)
Definition: logging.h:84
static int smtp_auth ( struct Connection conn)
static

Authenticate to an SMTP server.

Parameters
connSMTP Connection
Return values
0Success
<0Error, e.g. SMTP_AUTH_FAIL

Definition at line 586 of file smtp.c.

587 {
588  int r = SMTP_AUTH_UNAVAIL;
589 
591  {
592  struct ListNode *np = NULL;
594  {
595  mutt_debug(LL_DEBUG2, "Trying method %s\n", np->data);
596 
597  if (strcmp(np->data, "oauthbearer") == 0)
598  {
599  r = smtp_auth_oauth(conn);
600  }
601  else if (strcmp(np->data, "plain") == 0)
602  {
603  r = smtp_auth_plain(conn);
604  }
605  else
606  {
607 #ifdef USE_SASL
608  r = smtp_auth_sasl(conn, np->data);
609 #else
610  mutt_error(_("SMTP authentication method %s requires SASL"), np->data);
611  continue;
612 #endif
613  }
614 
615  if ((r == SMTP_AUTH_FAIL) && (C_SmtpAuthenticators->count > 1))
616  {
617  mutt_error(_("%s authentication failed, trying next method"), np->data);
618  }
619  else if (r != SMTP_AUTH_UNAVAIL)
620  break;
621  }
622  }
623  else
624  {
625 #ifdef USE_SASL
626  r = smtp_auth_sasl(conn, AuthMechs);
627 #else
628  mutt_error(_("SMTP authentication requires SASL"));
629  r = SMTP_AUTH_UNAVAIL;
630 #endif
631  }
632 
633  if (r != SMTP_AUTH_SUCCESS)
635 
636  if (r == SMTP_AUTH_FAIL)
637  {
638  mutt_error(_("SASL authentication failed"));
639  }
640  else if (r == SMTP_AUTH_UNAVAIL)
641  {
642  mutt_error(_("No authenticators available"));
643  }
644 
645  return (r == SMTP_AUTH_SUCCESS) ? 0 : -1;
646 }
static int smtp_auth_plain(struct Connection *conn)
Authenticate using plain text.
Definition: smtp.c:545
struct ConnAccount account
Definition: connection.h:36
#define _(a)
Definition: message.h:28
#define SMTP_AUTH_SUCCESS
Definition: smtp.c:72
struct Slist * C_SmtpAuthenticators
Config: (smtp) List of allowed authentication methods.
Definition: smtp.c:59
Log at debug level 2.
Definition: logging.h:57
struct ListHead head
Definition: slist.h:45
size_t count
Definition: slist.h:46
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:350
#define SMTP_AUTH_UNAVAIL
Definition: smtp.c:73
char * data
Definition: list.h:35
static int smtp_auth_sasl(struct Connection *conn, const char *mechlist)
Authenticate using SASL.
Definition: smtp.c:406
#define mutt_error(...)
Definition: logging.h:84
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
A List node for strings.
Definition: list.h:33
static char * AuthMechs
Definition: smtp.c:91
#define SMTP_AUTH_FAIL
Definition: smtp.c:74
static int smtp_auth_oauth(struct Connection *conn)
Authenticate an SMTP connection using OAUTHBEARER.
Definition: smtp.c:514
void mutt_account_unsetpass(struct ConnAccount *account)
Unset ConnAccount&#39;s password.
Definition: mutt_account.c:331
static int smtp_open ( struct Connection conn,
bool  esmtp 
)
static

Open an SMTP Connection.

Parameters
connSMTP Connection
esmtpIf true, use ESMTP
Return values
0Success
-1Error

Definition at line 655 of file smtp.c.

656 {
657  int rc;
658 
659  if (mutt_socket_open(conn))
660  return -1;
661 
662  /* get greeting string */
663  rc = smtp_get_resp(conn);
664  if (rc != 0)
665  return rc;
666 
667  rc = smtp_helo(conn, esmtp);
668  if (rc != 0)
669  return rc;
670 
671 #ifdef USE_SSL
672  enum QuadOption ans = MUTT_NO;
673  if (conn->ssf)
674  ans = MUTT_NO;
675  else if (C_SslForceTls)
676  ans = MUTT_YES;
677  else if ((Capabilities & SMTP_CAP_STARTTLS) &&
679  _("Secure connection with TLS?"))) == MUTT_ABORT))
680  {
681  return -1;
682  }
683 
684  if (ans == MUTT_YES)
685  {
686  if (mutt_socket_send(conn, "STARTTLS\r\n") < 0)
687  return SMTP_ERR_WRITE;
688  rc = smtp_get_resp(conn);
689  if (rc != 0)
690  return rc;
691 
692  if (mutt_ssl_starttls(conn))
693  {
694  mutt_error(_("Could not negotiate TLS connection"));
695  return -1;
696  }
697 
698  /* re-EHLO to get authentication mechanisms */
699  rc = smtp_helo(conn, esmtp);
700  if (rc != 0)
701  return rc;
702  }
703 #endif
704 
705  if (conn->account.flags & MUTT_ACCT_USER)
706  {
707  if (!(Capabilities & SMTP_CAP_AUTH))
708  {
709  mutt_error(_("SMTP server does not support authentication"));
710  return -1;
711  }
712 
713  return smtp_auth(conn);
714  }
715 
716  return 0;
717 }
static int smtp_helo(struct Connection *conn, bool esmtp)
Say hello to an SMTP Server.
Definition: smtp.c:369
struct ConnAccount account
Definition: connection.h:36
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
unsigned int ssf
security strength factor, in bits
Definition: connection.h:37
#define SMTP_CAP_STARTTLS
Server supports STARTTLS command.
Definition: smtp.c:82
User aborted the question (with Ctrl-G)
Definition: quad.h:37
enum QuadOption query_quadoption(enum QuadOption opt, const char *prompt)
Ask the user a quad-question.
Definition: init.c:3321
User answered &#39;Yes&#39;, or assume &#39;Yes&#39;.
Definition: quad.h:39
#define _(a)
Definition: message.h:28
WHERE bool C_SslForceTls
Config: (ssl) Require TLS encryption for all connections.
Definition: globals.h:232
int mutt_socket_open(struct Connection *conn)
Simple wrapper.
Definition: socket.c:74
static int smtp_auth(struct Connection *conn)
Authenticate to an SMTP server.
Definition: smtp.c:586
static SmtpCapFlags Capabilities
Definition: smtp.c:92
#define SMTP_ERR_WRITE
Definition: smtp.c:66
int mutt_ssl_starttls(struct Connection *conn)
Negotiate TLS over an already opened connection.
Definition: ssl.c:1412
User answered &#39;No&#39;, or assume &#39;No&#39;.
Definition: quad.h:38
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
#define mutt_error(...)
Definition: logging.h:84
#define SMTP_CAP_AUTH
Server supports AUTH command.
Definition: smtp.c:83
QuadOption
Possible values for a quad-option.
Definition: quad.h:35
WHERE unsigned char C_SslStarttls
Config: (ssl) Use STARTTLS on servers advertising the capability.
Definition: globals.h:188
MuttAccountFlags flags
Which fields are initialised, e.g. MUTT_ACCT_USER.
Definition: connaccount.h:39
#define MUTT_ACCT_USER
User field has been set.
Definition: mutt_account.h:61
int mutt_smtp_send ( const struct AddressList *  from,
const struct AddressList *  to,
const struct AddressList *  cc,
const struct AddressList *  bcc,
const char *  msgfile,
bool  eightbit 
)

Send a message using SMTP.

Parameters
fromFrom Address
toTo Address
ccCc Address
bccBcc Address
msgfileMessage to send to the server
eightbitIf true, try for an 8-bit friendly connection
Return values
0Success
-1Error

Definition at line 730 of file smtp.c.

733 {
734  struct Connection *conn = NULL;
735  struct ConnAccount account;
736  const char *envfrom = NULL;
737  char buf[1024];
738  int rc = -1;
739 
740  /* it might be better to synthesize an envelope from from user and host
741  * but this condition is most likely arrived at accidentally */
743  envfrom = C_EnvelopeFromAddress->mailbox;
744  else if (from && !TAILQ_EMPTY(from))
745  envfrom = TAILQ_FIRST(from)->mailbox;
746  else
747  {
748  mutt_error(_("No from address given"));
749  return -1;
750  }
751 
752  if (smtp_fill_account(&account) < 0)
753  return rc;
754 
755  conn = mutt_conn_find(NULL, &account);
756  if (!conn)
757  return -1;
758 
759  do
760  {
761  /* send our greeting */
762  rc = smtp_open(conn, eightbit);
763  if (rc != 0)
764  break;
765  FREE(&AuthMechs);
766 
767  /* send the sender's address */
768  int len = snprintf(buf, sizeof(buf), "MAIL FROM:<%s>", envfrom);
769  if (eightbit && (Capabilities & SMTP_CAP_EIGHTBITMIME))
770  {
771  mutt_str_strncat(buf, sizeof(buf), " BODY=8BITMIME", 15);
772  len += 14;
773  }
775  len += snprintf(buf + len, sizeof(buf) - len, " RET=%s", C_DsnReturn);
777  (address_uses_unicode(envfrom) || addresses_use_unicode(to) ||
779  {
780  snprintf(buf + len, sizeof(buf) - len, " SMTPUTF8");
781  }
782  mutt_str_strncat(buf, sizeof(buf), "\r\n", 3);
783  if (mutt_socket_send(conn, buf) == -1)
784  {
785  rc = SMTP_ERR_WRITE;
786  break;
787  }
788  rc = smtp_get_resp(conn);
789  if (rc != 0)
790  break;
791 
792  /* send the recipient list */
793  if ((rc = smtp_rcpt_to(conn, to)) || (rc = smtp_rcpt_to(conn, cc)) ||
794  (rc = smtp_rcpt_to(conn, bcc)))
795  {
796  break;
797  }
798 
799  /* send the message data */
800  rc = smtp_data(conn, msgfile);
801  if (rc != 0)
802  break;
803 
804  mutt_socket_send(conn, "QUIT\r\n");
805 
806  rc = 0;
807  } while (false);
808 
809  mutt_socket_close(conn);
810 
811  if (rc == SMTP_ERR_READ)
812  mutt_error(_("SMTP session failed: read error"));
813  else if (rc == SMTP_ERR_WRITE)
814  mutt_error(_("SMTP session failed: write error"));
815  else if (rc == SMTP_ERR_CODE)
816  mutt_error(_("Invalid server response"));
817 
818  return rc;
819 }
#define TAILQ_FIRST(head)
Definition: queue.h:717
#define mutt_socket_send(conn, buf)
Definition: mutt_socket.h:38
An open network connection (socket)
Definition: connection.h:34
#define SMTP_CAP_SMTPUTF8
Server accepts UTF-8 strings.
Definition: smtp.c:86
#define _(a)
Definition: message.h:28
char * mailbox
Mailbox and host address.
Definition: address.h:37
char * mutt_str_strncat(char *d, size_t l, const char *s, size_t sl)
Concatenate two strings.
Definition: string.c:424
static int smtp_open(struct Connection *conn, bool esmtp)
Open an SMTP Connection.
Definition: smtp.c:655
static SmtpCapFlags Capabilities
Definition: smtp.c:92
#define SMTP_ERR_WRITE
Definition: smtp.c:66
static bool address_uses_unicode(const char *a)
Do any addresses use Unicode.
Definition: smtp.c:283
static int smtp_get_resp(struct Connection *conn)
Read a command response from the SMTP server.
Definition: smtp.c:122
#define SMTP_ERR_READ
Definition: smtp.c:65
Login details for a remote server.
Definition: connaccount.h:31
int mutt_socket_close(struct Connection *conn)
Close a socket.
Definition: socket.c:95
WHERE char * C_DsnReturn
Config: What to send as a notification of message delivery or delay.
Definition: globals.h:103
#define SMTP_ERR_CODE
Definition: smtp.c:67
static int smtp_fill_account(struct ConnAccount *account)
Create ConnAccount object from SMTP Url.
Definition: smtp.c:320
#define mutt_error(...)
Definition: logging.h:84
WHERE struct Address * C_EnvelopeFromAddress
Config: Manually set the sender for outgoing messages.
Definition: globals.h:92
#define SMTP_CAP_EIGHTBITMIME
Server supports 8-bit MIME content.
Definition: smtp.c:85
static bool addresses_use_unicode(const struct AddressList *al)
Do any of a list of addresses use Unicode.
Definition: smtp.c:303
#define FREE(x)
Definition: memory.h:40
static int smtp_rcpt_to(struct Connection *conn, const struct AddressList *al)
Set the recipient to an Address.
Definition: smtp.c:172
#define TAILQ_EMPTY(head)
Definition: queue.h:715
static char * AuthMechs
Definition: smtp.c:91
static int smtp_data(struct Connection *conn, const char *msgfile)
Send data to an SMTP server.
Definition: smtp.c:207
struct Connection * mutt_conn_find(const struct Connection *start, const struct ConnAccount *account)
Find a connection from a list.
Definition: mutt_socket.c:85
#define SMTP_CAP_DSN
Server supports Delivery Status Notification.
Definition: smtp.c:84

Variable Documentation

struct Slist* C_SmtpAuthenticators

Config: (smtp) List of allowed authentication methods.

Definition at line 59 of file smtp.c.

char* AuthMechs = NULL
static

Definition at line 91 of file smtp.c.

SmtpCapFlags Capabilities
static

Definition at line 92 of file smtp.c.