module.c File Reference

Definition of the Conn Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	conn_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	conn_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	conn_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	ConnVars []
	Config definitions for the connection library.
struct ConfigDef	ConnVarsGetaddr []
	GetAddrInfo Config definitions for the connection library.
struct ConfigDef	ConnVarsGnutls []
	GnuTLS Config definitions for the connection library.
struct ConfigDef	ConnVarsOpenssl []
	OpenSSL Config definitions for the connection library.
struct ConfigDef	ConnVarsPartial []
	SSL partial chains Config definitions for the connection library.
struct ConfigDef	ConnVarsSsl []
	General SSL Config definitions for the conn library.
const struct Module	ModuleConn
	Module for the Conn library.

Detailed Description

Definition of the Conn Module.

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

Function Documentation

conn_init()

static bool conn_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 53 of file module.c.

{
  struct ConnModuleData *mod_data = MUTT_MEM_CALLOC(1, struct ConnModuleData);
  neomutt_set_module_data(n, MODULE_ID_CONN, mod_data);
 
#ifdef USE_SSL_OPENSSL
  mod_data->host_ex_data_index = -1;
  mod_data->skip_mode_ex_data_index = -1;
#endif
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

conn_config_define_variables()

static bool conn_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 72 of file module.c.

{
  bool rc = true;
 
  rc &= cs_register_variables(cs, ConnVars);
 
#if defined(USE_SSL)
  rc &= cs_register_variables(cs, ConnVarsSsl);
#endif
 
#if defined(USE_SSL_GNUTLS)
  rc &= cs_register_variables(cs, ConnVarsGnutls);
#endif
 
#if defined(USE_SSL_OPENSSL)
  rc &= cs_register_variables(cs, ConnVarsOpenssl);
#endif
 
#if defined(HAVE_SSL_PARTIAL_CHAIN)
  rc &= cs_register_variables(cs, ConnVarsPartial);
#endif
 
#if defined(HAVE_GETADDRINFO)
  rc &= cs_register_variables(cs, ConnVarsGetaddr);
#endif
 
  return rc;
}

Here is the call graph for this function:

conn_cleanup()

static bool conn_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 104 of file module.c.

{
  struct ConnModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
#ifdef USE_SASL_CYRUS
  mutt_sasl_cleanup();
#endif
#ifdef USE_SASL_GNU
  mutt_gsasl_cleanup(&mod_data->mutt_gsasl_ctx);
#endif
 
#ifdef USE_SASL_CYRUS
  FREE(&mod_data->mutt_sasl_callbacks);
  FREE(&mod_data->secret_ptr);
#endif
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

ConnVars

struct ConfigDef ConnVars[]

extern

Config definitions for the connection library.

Definition at line 39 of file config.c.

                              {
  // clang-format off
  { "account_command", DT_STRING|D_STRING_COMMAND, 0, 0, NULL,
    "Shell command to retrieve account credentials"
  },
  { "preconnect", DT_STRING, 0, 0, NULL,
    "(socket) External command to run prior to opening a socket"
  },
  { "socket_timeout", DT_NUMBER, 30, 0, NULL,
    "Timeout for socket connect/read/write operations (-1 to wait indefinitely)"
  },
  { "tunnel", DT_STRING|D_STRING_COMMAND, 0, 0, NULL,
    "Shell command to establish a tunnel"
  },
  { "tunnel_is_secure", DT_BOOL, true, 0, NULL,
    "Assume a tunneled connection is secure"
  },
 
  { "connect_timeout", DT_SYNONYM, IP "socket_timeout", IP "2023-02-15" },
  { NULL },
  // clang-format on
};

ConnVarsGetaddr

struct ConfigDef ConnVarsGetaddr[]

extern

GetAddrInfo Config definitions for the connection library.

Definition at line 159 of file config.c.

                                     {
  // clang-format off
  { "use_ipv6", DT_BOOL, true, 0, NULL,
    "Lookup IPv6 addresses when making connections"
  },
  { NULL },
  // clang-format on
};

ConnVarsGnutls

struct ConfigDef ConnVarsGnutls[]

extern

GnuTLS Config definitions for the connection library.

Definition at line 108 of file config.c.

                                    {
  // clang-format off
  { "ssl_ca_certificates_file", DT_PATH|D_PATH_FILE, 0, 0, NULL,
    "File containing trusted CA certificates"
  },
  { "ssl_min_dh_prime_bits", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 0, 0, NULL,
    "Minimum keysize for Diffie-Hellman key exchange"
  },
  { NULL },
  // clang-format on
};

ConnVarsOpenssl

struct ConfigDef ConnVarsOpenssl[]

extern

OpenSSL Config definitions for the connection library.

Definition at line 125 of file config.c.

                                     {
  // clang-format off
  { "entropy_file", DT_PATH|D_PATH_FILE, 0, 0, NULL,
    "(ssl) File/device containing random data to initialise SSL"
  },
  { "ssl_use_system_certs", DT_BOOL, true, 0, NULL,
    "(ssl) Use CA certificates in the system-wide store"
  },
  { "ssl_usesystemcerts", DT_SYNONYM, IP "ssl_use_system_certs", IP "2021-02-11" },
 
  { "ssl_use_sslv2", D_INTERNAL_DEPRECATED|DT_BOOL, 0, IP "2025-12-07" },
  { NULL },
  // clang-format on
};

ConnVarsPartial

struct ConfigDef ConnVarsPartial[]

extern

SSL partial chains Config definitions for the connection library.

Definition at line 145 of file config.c.

                                     {
  // clang-format off
  { "ssl_verify_partial_chains", DT_BOOL, false, 0, NULL,
    "(ssl) Allow verification using partial certificate chains"
  },
  { NULL },
  // clang-format on
};

ConnVarsSsl

struct ConfigDef ConnVarsSsl[]

extern

General SSL Config definitions for the conn library.

Definition at line 66 of file config.c.

                                 {
  // clang-format off
  { "certificate_file", DT_PATH|D_PATH_FILE, IP "~/.mutt_certificates", 0, NULL,
    "File containing trusted certificates"
  },
  { "ssl_ciphers", DT_STRING, 0, 0, NULL,
    "Ciphers to use when using SSL"
  },
  { "ssl_client_cert", DT_PATH|D_PATH_FILE, 0, 0, NULL,
    "File containing client certificates"
  },
  { "ssl_force_tls", DT_BOOL, true, 0, NULL,
    "(ssl) Require TLS encryption for all connections"
  },
  { "ssl_starttls", DT_QUAD, MUTT_YES, 0, NULL,
    "(ssl) Use STARTTLS on servers advertising the capability"
  },
  { "ssl_use_tlsv1_2", DT_BOOL, true, 0, NULL,
    "(ssl) Use TLSv1.2 for authentication"
  },
  { "ssl_use_tlsv1_3", DT_BOOL, true, 0, NULL,
    "(ssl) Use TLSv1.3 for authentication"
  },
  { "ssl_verify_dates", DT_BOOL, true, 0, NULL,
    "(ssl) Verify the dates on the server certificate"
  },
  { "ssl_verify_host", DT_BOOL, true, 0, NULL,
    "(ssl) Verify the server's hostname against the certificate"
  },
 
  { "ssl_use_sslv3",   D_INTERNAL_DEPRECATED|DT_BOOL, 0, IP "2025-12-07" },
  { "ssl_use_tlsv1",   D_INTERNAL_DEPRECATED|DT_BOOL, 0, IP "2025-12-07" },
  { "ssl_use_tlsv1_1", D_INTERNAL_DEPRECATED|DT_BOOL, 0, IP "2025-12-07" },
  { NULL },
  // clang-format on
};

ModuleConn

const struct Module ModuleConn

Initial value:

= {
  MODULE_ID_CONN,
  "conn",
  conn_init,
  NULL, 
  conn_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  conn_cleanup,
}

Module for the Conn library.

Definition at line 128 of file module.c.

                                 {
  MODULE_ID_CONN,
  "conn",
  conn_init,
  NULL, // config_define_types
  conn_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  conn_cleanup,
};