The "ssl_mbedtls" Module (v3)

This module is deprecated and has been moved to inspircd-contrib in the next major version of InspIRCd.

You should consider using the ssl_gnutls module instead.

This module depends on a third-party library (mbedTLS) and must be manually enabled at compile time.

Once you have installed the dependency you can enable this module using the following command:

./configure --enable-extras ssl_mbedtls

Description

This module allows TLS (SSL) encrypted connections using the mbedTLS library.

Configuration

To load this module use the following <module> tag:

<module name="ssl_mbedtls">

<bind>

This module extends the core <bind> tags with the following fields:

Name Type Default Value Description
sslprofile (since 3.10.0)
ssl (3.0.0 to 3.9.0) 		Text None This MUST be set to the name of a mbedTLS TLS (SSL) profile to listen for secure connections with mbedTLS.
Example Usage

Listens for mbedTLS encrypted IRC connections on the *:6697 endpoint with an TLS (SSL) profile named "Clients":

<bind address="*"
      port="6697"
      ...
      sslprofile="Clients"
      type="clients">

Listens for mbedTLS encrypted server connections on the *:7000 endpoint with an TLS (SSL) profile named "Servers":

<bind address="*"
      port="7000"
      ...
      sslprofile="Servers"
      type="servers">

<mbedtls>

The <mbedtls> tag defines settings about how the ssl_mbedtls module should behave. This tag can only be defined once.

Name Type Default Value Description
onrehash Boolean No Whether TLS (SSL) profiles (see below) should be reloaded as part of a normal rehash.
Example Usage
<mbedtls onrehash="yes">

<sslprofile>

The <sslprofile> tag defines a TLS (SSL) profile for sockets to use. This tag can be defined as many times as required.

If no <sslprofile> tags are defined, including tags for other TLS (SSL) modules, a default profile named mbedtls will be created. This profile will use the contents of the deprecated <mbedtls> tag if one has been defined. It is strongly recommended that you do not use this as it will be removed in a future release.

Name Type Default Value Description
name Text None Required! The name of this TLS (SSL) profile. This is used in <bind:ssl> for incoming connections and <link:ssl> for outgoing server connections.
provider Text None Required! This MUST be set to "mbedtls" to use the mbedTLS library.
cafile Text None If defined then the path to the CA in PEM format.
certfile Text cert.pem The path to the certificate in PEM format.
ciphersuites Text None If defined then a colon-delimited list of mbedTLS ciphersuites.
crlfile Text None If defined then the path to the CRL in PEM format.
curves Text None If defined then a colon-delimited list of curves for use with ECDHE.
dhfile Text dhparams.pem The path to the DH parameters in PEM format.
hash Text sha256 The hash algorithm used for TLS (SSL) client fingerprints.
keyfile Text key.pem The path to the private key in PEM format.
maxver Number None If defined then the maximum version of TLS (SSL) to use.
mindhbits Number 2048 The minimum number of bits of the DH parameters file to use in an Diffie-Hellman key exchange.
minver Number None If defined then the minimum version of TLS (SSL) to use.
outrecsize Number 2048 The maximum size of an outgoing mbedTLS record.
requestclientcert Boolean Yes Whether to request a TLS (SSL) certificate from clients.

The hash field should be set to one of the values shown in the mbedTLS MD documentation.

Example Usage
<sslprofile name="Clients"
            provider="mbedtls"
            cafile=""
            certfile="cert.pem"
            crlfile=""
            dhfile="dhparams.pem"
            hash="sha256"
            keyfile="key.pem"
            mindhbits="2048"
            outrecsize="2048"
            requestclientcert="yes">

Special Notes

TLS (SSL) profiles are not reloaded as part of a normal rehash. If you wish to reload TLS (SSL) profiles you should enable <mbedtls:onrehash>, use /REHASH -ssl, or load the sslrehashsignal to allow you to reload TLS (SSL) profiles by sending SIGUSR1 to the InspIRCd process.

If you are having trouble getting InspIRCd to read your .pem files then check that it has read access to the full path up to the location of them. If you are using a system that uses AppArmor you may need to edit the AppArmor profile to allow InspIRCd to read them too.

If you are using Let's Encrypt and are having problems with missing intermediate certificates then make sure you are using fullchain.pem from Certbot/Dehydrated/etc in <sslprofile:certfile> instead of cert.pem as the latter does not contain intermediate certificates.