private.h File Reference

#include <stddef.h>
#include <stdbool.h>
#include <time.h>

Include dependency graph for private.h:

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

Go to the source code of this file.

Functions
int	raw_socket_close (struct Connection *conn)
	Close a socket - Implements Connection::close() More...
int	raw_socket_open (struct Connection *conn)
	Open a socket - Implements Connection::open() More...
int	raw_socket_poll (struct Connection *conn, time_t wait_secs)
	Checks whether reads would block - Implements Connection::poll() More...
int	raw_socket_read (struct Connection *conn, char *buf, size_t len)
	Read data from a socket - Implements Connection::read() More...
int	raw_socket_write (struct Connection *conn, const char *buf, size_t count)
	Write data to a socket - Implements Connection::write() More...
void	mutt_tunnel_socket_setup (struct Connection *conn)
	sets up tunnel connection functions More...

Variables
const char *	C_CertificateFile
	Config: (ssl) File containing trusted certificates. More...
short	C_ConnectTimeout
	Config: Timeout for making network connections (-1 to wait indefinitely) More...
const char *	C_EntropyFile
	Config: (ssl) File/device containing random data to initialise SSL. More...
const char *	C_Preconnect
	Config: External command to run prior to opening a socket. More...
const char *	C_SslCaCertificatesFile
	Config: File containing trusted CA certificates. More...
const char *	C_SslCiphers
	Config: (ssl) Ciphers to use when using SSL. More...
const char *	C_SslClientCert
	Config: (ssl) File containing client certificates. More...
short	C_SslMinDhPrimeBits
	Config: Minimum keysize for Diffie-Hellman key exchange. More...
bool	C_SslUseSslv2
bool	C_SslUseSslv3
	Config: (ssl) INSECURE: Use SSLv3 for authentication. More...
bool	C_SslUseTlsv11
	Config: (ssl) Use TLSv1.1 for authentication. More...
bool	C_SslUseTlsv12
	Config: (ssl) Use TLSv1.2 for authentication. More...
bool	C_SslUseTlsv13
	Config: (ssl) Use TLSv1.3 for authentication. More...
bool	C_SslUseTlsv1
	Config: (ssl) Use TLSv1 for authentication. More...
bool	C_SslUseSystemCerts
bool	C_SslVerifyDates
	Config: (ssl) Verify the dates on the server certificate. More...
bool	C_SslVerifyHost
	Config: (ssl) Verify the server's hostname against the certificate. More...
bool	C_SslVerifyPartialChains
	Config: (ssl) Allow verification using partial certificate chains. More...
bool	C_TunnelIsSecure
	Config: Assume a tunneled connection is secure. More...
bool	C_UseIpv6
	Config: Lookup IPv6 addresses when making connections. More...

Detailed Description

Shared functions that are private to Connections

Authors

• 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 private.h.

Function Documentation

raw_socket_close()

int raw_socket_close

(

struct Connection *

conn

)

Close a socket - Implements Connection::close()

Definition at line 360 of file raw.c.

{
  return close(conn->fd);
}

Here is the caller graph for this function:

raw_socket_open()

int raw_socket_open

(

struct Connection *

conn

)

Open a socket - Implements Connection::open()

Definition at line 116 of file raw.c.

{
  int rc;
 
  char *host_idna = NULL;
 
#ifdef HAVE_GETADDRINFO
  /* --- IPv4/6 --- */
 
  /* "65536\0" */
  char port[6];
  struct addrinfo hints;
  struct addrinfo *res = NULL;
  struct addrinfo *cur = NULL;
 
  /* we accept v4 or v6 STREAM sockets */
  memset(&hints, 0, sizeof(hints));
 
  if (C_UseIpv6)
    hints.ai_family = AF_UNSPEC;
  else
    hints.ai_family = AF_INET;
 
  hints.ai_socktype = SOCK_STREAM;
 
  snprintf(port, sizeof(port), "%d", conn->account.port);
 
#ifdef HAVE_LIBIDN
  if (mutt_idna_to_ascii_lz(conn->account.host, &host_idna, 1) != 0)
  {
    mutt_error(_("Bad IDN: '%s'"), conn->account.host);
    return -1;
  }
#else
  host_idna = conn->account.host;
#endif
 
  if (!OptNoCurses)
    mutt_message(_("Looking up %s..."), conn->account.host);
 
  rc = getaddrinfo(host_idna, port, &hints, &res);
 
#ifdef HAVE_LIBIDN
  FREE(&host_idna);
#endif
 
  if (rc)
  {
    mutt_error(_("Could not find the host \"%s\""), conn->account.host);
    return -1;
  }
 
  if (!OptNoCurses)
    mutt_message(_("Connecting to %s..."), conn->account.host);
 
  rc = -1;
  for (cur = res; cur; cur = cur->ai_next)
  {
    int fd = socket(cur->ai_family, cur->ai_socktype, cur->ai_protocol);
    if (fd >= 0)
    {
      rc = socket_connect(fd, cur->ai_addr);
      if (rc == 0)
      {
        fcntl(fd, F_SETFD, FD_CLOEXEC);
        conn->fd = fd;
        break;
      }
      else
        close(fd);
    }
  }
 
  freeaddrinfo(res);
#else
  /* --- IPv4 only --- */
 
  struct sockaddr_in sin;
  struct hostent *he = NULL;
 
  memset(&sin, 0, sizeof(sin));
  sin.sin_port = htons(conn->account.port);
  sin.sin_family = AF_INET;
 
#ifdef HAVE_LIBIDN
  if (mutt_idna_to_ascii_lz(conn->account.host, &host_idna, 1) != 0)
  {
    mutt_error(_("Bad IDN: '%s'"), conn->account.host);
    return -1;
  }
#else
  host_idna = conn->account.host;
#endif
 
  if (!OptNoCurses)
    mutt_message(_("Looking up %s..."), conn->account.host);
 
  he = gethostbyname(host_idna);
 
#ifdef HAVE_LIBIDN
  FREE(&host_idna);
#endif
 
  if (!he)
  {
    mutt_error(_("Could not find the host \"%s\""), conn->account.host);
 
    return -1;
  }
 
  if (!OptNoCurses)
    mutt_message(_("Connecting to %s..."), conn->account.host);
 
  rc = -1;
  for (int i = 0; he->h_addr_list[i]; i++)
  {
    memcpy(&sin.sin_addr, he->h_addr_list[i], he->h_length);
    int fd = socket(PF_INET, SOCK_STREAM, IPPROTO_IP);
 
    if (fd >= 0)
    {
      rc = socket_connect(fd, (struct sockaddr *) &sin);
      if (rc == 0)
      {
        fcntl(fd, F_SETFD, FD_CLOEXEC);
        conn->fd = fd;
        break;
      }
      else
        close(fd);
    }
  }
#endif
  if (rc)
  {
    mutt_error(_("Could not connect to %s (%s)"), conn->account.host,
               (rc > 0) ? strerror(rc) : _("unknown error"));
    return -1;
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_socket_poll()

int raw_socket_poll	(	struct Connection *	conn,
		time_t	wait_secs
	)

Checks whether reads would block - Implements Connection::poll()

Definition at line 322 of file raw.c.

{
  if (conn->fd < 0)
    return -1;
 
  fd_set rfds;
  struct timeval tv;
 
  uint64_t wait_millis = wait_secs * 1000UL;
 
  while (true)
  {
    tv.tv_sec = wait_millis / 1000;
    tv.tv_usec = (wait_millis % 1000) * 1000;
 
    FD_ZERO(&rfds);
    FD_SET(conn->fd, &rfds);
 
    uint64_t pre_t = mutt_date_epoch_ms();
    const int rc = select(conn->fd + 1, &rfds, NULL, NULL, &tv);
    uint64_t post_t = mutt_date_epoch_ms();
 
    if ((rc > 0) || ((rc < 0) && (errno != EINTR)))
      return rc;
 
    if (SigInt)
      mutt_query_exit();
 
    wait_millis += pre_t;
    if (wait_millis <= post_t)
      return 0;
    wait_millis -= post_t;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_socket_read()

int raw_socket_read	(	struct Connection *	conn,
		char *	buf,
		size_t	len
	)

Read data from a socket - Implements Connection::read()

Definition at line 262 of file raw.c.

{
  int rc;
 
  mutt_sig_allow_interrupt(true);
  do
  {
    rc = read(conn->fd, buf, count);
  } while (rc < 0 && (errno == EINTR));
 
  if (rc < 0)
  {
    mutt_error(_("Error talking to %s (%s)"), conn->account.host, strerror(errno));
    SigInt = 0;
  }
  mutt_sig_allow_interrupt(false);
 
  if (SigInt)
  {
    mutt_error(_("Connection to %s has been aborted"), conn->account.host);
    SigInt = 0;
    rc = -1;
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_socket_write()

int raw_socket_write	(	struct Connection *	conn,
		const char *	buf,
		size_t	count
	)

Write data to a socket - Implements Connection::write()

Definition at line 292 of file raw.c.

{
  int rc;
  size_t sent = 0;
 
  mutt_sig_allow_interrupt(true);
  do
  {
    do
    {
      rc = write(conn->fd, buf + sent, count - sent);
    } while (rc < 0 && (errno == EINTR));
 
    if (rc < 0)
    {
      mutt_error(_("Error talking to %s (%s)"), conn->account.host, strerror(errno));
      mutt_sig_allow_interrupt(false);
      return -1;
    }
 
    sent += rc;
  } while ((sent < count) && (SigInt == 0));
 
  mutt_sig_allow_interrupt(false);
  return sent;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_tunnel_socket_setup()

void mutt_tunnel_socket_setup

(

struct Connection *

conn

)

sets up tunnel connection functions

Parameters

conn	Connection to assign functions to

Assign tunnel socket functions to the Connection conn.

Definition at line 233 of file tunnel.c.

{
  conn->open = tunnel_socket_open;
  conn->close = tunnel_socket_close;
  conn->read = tunnel_socket_read;
  conn->write = tunnel_socket_write;
  conn->poll = tunnel_socket_poll;
  /* Note we are using ssf as a boolean in this case.  See the notes in
   * conn/connection.h */
  if (C_TunnelIsSecure)
    conn->ssf = 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C_CertificateFile

const char* C_CertificateFile

Config: (ssl) File containing trusted certificates.

Definition at line 42 of file config.c.

C_ConnectTimeout

short C_ConnectTimeout

Config: Timeout for making network connections (-1 to wait indefinitely)

Definition at line 37 of file config.c.

C_EntropyFile

const char* C_EntropyFile

Config: (ssl) File/device containing random data to initialise SSL.

Definition at line 43 of file config.c.

C_Preconnect

const char* C_Preconnect

Config: External command to run prior to opening a socket.

Definition at line 38 of file config.c.

C_SslCaCertificatesFile

const char* C_SslCaCertificatesFile

Config: File containing trusted CA certificates.

Definition at line 64 of file config.c.

C_SslCiphers

const char* C_SslCiphers

Config: (ssl) Ciphers to use when using SSL.

Definition at line 44 of file config.c.

C_SslClientCert

const char* C_SslClientCert

Config: (ssl) File containing client certificates.

Definition at line 45 of file config.c.

C_SslMinDhPrimeBits

short C_SslMinDhPrimeBits

Config: Minimum keysize for Diffie-Hellman key exchange.

Definition at line 65 of file config.c.

C_SslUseSslv2

bool C_SslUseSslv2

C_SslUseSslv3

bool C_SslUseSslv3

Config: (ssl) INSECURE: Use SSLv3 for authentication.

Definition at line 52 of file config.c.

C_SslUseTlsv11

bool C_SslUseTlsv11

Config: (ssl) Use TLSv1.1 for authentication.

Definition at line 54 of file config.c.

C_SslUseTlsv12

bool C_SslUseTlsv12

Config: (ssl) Use TLSv1.2 for authentication.

Definition at line 55 of file config.c.

C_SslUseTlsv13

bool C_SslUseTlsv13

Config: (ssl) Use TLSv1.3 for authentication.

Definition at line 56 of file config.c.

C_SslUseTlsv1

bool C_SslUseTlsv1

Config: (ssl) Use TLSv1 for authentication.

Definition at line 53 of file config.c.

C_SslUseSystemCerts

bool C_SslUseSystemCerts

C_SslVerifyDates

bool C_SslVerifyDates

Config: (ssl) Verify the dates on the server certificate.

Definition at line 57 of file config.c.

C_SslVerifyHost

bool C_SslVerifyHost

Config: (ssl) Verify the server's hostname against the certificate.

Definition at line 58 of file config.c.

C_SslVerifyPartialChains

bool C_SslVerifyPartialChains

Config: (ssl) Allow verification using partial certificate chains.

Definition at line 60 of file config.c.

C_TunnelIsSecure

bool C_TunnelIsSecure

Config: Assume a tunneled connection is secure.

Definition at line 40 of file config.c.

C_UseIpv6

bool C_UseIpv6

Config: Lookup IPv6 addresses when making connections.

Definition at line 68 of file config.c.