<!-- review: finished -->

<a id="adc-mail-ssl"></a>

# SSL

Модуль обеспечивает поддержку шифрования SSL/TLS для почтовых прокси-протоколов
(POP3, IMAP, SMTP), позволяя устанавливать защищённые соединения между клиентами
и сервером. Он обеспечивает шифрование SSL/TLS для входящих подключений,
поддерживает обновление соединений через STARTTLS, управляет сертификатами и
ключами, а также контролирует настройки SSL, такие как выбор шифров и версий
протоколов.

При [сборке из исходного кода](https://angie.software//angie/docs/installation/sourcebuild.md#sourcebuild) модуль не собирается по умолчанию; его необходимо
включить с помощью [параметра сборки](https://angie.software//angie/docs/installation/sourcebuild.md#configure)
`‑‑with‑mail_ssl_module`.
В пакетах и образах из
[наших репозиториев](https://angie.software//angie/docs/installation/index.md#install-packages)
модуль включен в сборку.

#### NOTE
Для этого модуля нужна библиотека OpenSSL.

<a id="adc-configuration-example-54"></a>

## Пример конфигурации

Для уменьшения загрузки процессора рекомендуется

* установить число [рабочих процессов](https://angie.software//angie/docs/configuration/modules/core.md#worker-processes) равным числу процессоров,
* включить [разделяемый кэш](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-session-cache) сессий,
* выключить [встроенный кэш](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-session-cache) сессий
* и, возможно, увеличить [время жизни](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-session-timeout) сессии (по умолчанию 5 минут):

```nginx
worker_processes auto;

mail {

    ...

    server {
        listen              993 ssl;

        ssl_protocols       TLSv1.2 TLSv1.3;
        ssl_ciphers         AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5;
        ssl_certificate     /usr/local/angie/conf/cert.pem;
        ssl_certificate_key /usr/local/angie/conf/cert.key;
        ssl_session_cache   shared:SSL:10m;
        ssl_session_timeout 10m;

    #    ...
    }
```

<a id="adc-directives-63"></a>

## Директивы

<a id="adc-m-ssl-certificate"></a>

### ssl_certificate

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_certificate` файл;   |
|------------------------------------------------------------------------------------------|---------------------------|
| По умолчанию                                                                             | —                         |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server              |

Указывает файл с сертификатом в формате PEM для данного сервера. Если вместе с основным сертификатом нужно указать промежуточные, то они должны находиться в этом же файле в следующем порядке — сначала основной сертификат, а затем промежуточные. В этом же файле может находиться секретный ключ в формате PEM.

Директива может быть указана несколько раз для загрузки сертификатов разных типов, например RSA и ECDSA:

```nginx
server {
    listen              993 ssl;

    ssl_certificate     example.com.rsa.crt;
    ssl_certificate_key example.com.rsa.key;

    ssl_certificate     example.com.ecdsa.crt;
    ssl_certificate_key example.com.ecdsa.key;

#    ...
}
```

Возможность задавать отдельные цепочки сертификатов для разных сертификатов есть только в OpenSSL 1.0.2 и выше. Для более старых версий следует указывать только одну цепочку сертификатов.

Вместо `файла` можно указать значение "data:сертификат", при котором
сертификат загружается без использования промежуточных файлов.

Ненадлежащее использование подобного синтаксиса может быть небезопасно, например данные секретного ключа могут попасть в [лог ошибок](https://angie.software//angie/docs/configuration/modules/core.md#error-log).

<a id="adc-m-ssl-certificate-compression"></a>

### ssl_certificate_compression

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_certificate_compression` `on` | `off`;   |
|------------------------------------------------------------------------------------------|-----------------------------------------------|
| По умолчанию                                                                             | `ssl_certificate_compression off;`            |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                                  |

Разрешает сжатие TLS 1.3 [сертификатов сервера](https://datatracker.ietf.org/doc/html/rfc8879).

#### NOTE
Директива поддерживается при использовании OpenSSL версии 3.2 и выше; список поддерживаемых алгоритмов сжатия предоставляется библиотекой.

#### NOTE
Директива поддерживается при использовании [BoringSSL](https://boringssl.googlesource.com/boringssl/); список поддерживаемых алгоритмов сжатия включает `zlib`.

<a id="adc-m-ssl-certificate-key"></a>

### ssl_certificate_key

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_certificate_key` файл;   |
|------------------------------------------------------------------------------------------|-------------------------------|
| По умолчанию                                                                             | —                             |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                  |

Указывает файл с секретным ключом в формате PEM для данного виртуального сервера.

Вместо `файла` можно указать значение "engine:имя:id", которое загружает
ключ с указанным id из OpenSSL engine с заданным именем.

Вместо `файла` можно указать значение "store:scheme:id", которое
используется для загрузки ключа с указанным id и URI-схемой scheme,
зарегистрированной в OpenSSL provider, например [pkcs11](https://datatracker.ietf.org/doc/html/rfc7512).

Вместо `файла` также можно указать значение "data:ключ", при котором
секретный ключ загружается без использования промежуточных файлов. При этом
следует учитывать, что ненадлежащее использование подобного синтаксиса может
быть небезопасно, например данные секретного ключа могут попасть в [лог
ошибок](https://angie.software//angie/docs/configuration/modules/core.md#error-log).

<a id="adc-m-ssl-ciphers"></a>

### ssl_ciphers

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_ciphers` шифры;            |
|------------------------------------------------------------------------------------------|---------------------------------|
| По умолчанию                                                                             | `ssl_ciphers HIGH:!aNULL:!MD5;` |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                    |

Описывает разрешенные шифры. Шифры задаются в формате, поддерживаемом библиотекой OpenSSL, например:

```nginx
ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
```

Список шифров зависит от установленной версии OpenSSL.
Полный список можно посмотреть с помощью команды `openssl ciphers`.

#### WARNING
Директива `ssl_ciphers`  *не* настраивает шифры для TLS 1.3 при
использовании OpenSSL. Для настройки шифров TLS 1.3 в OpenSSL используйте
директиву [ssl_conf_command](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-conf-command), добавленную для расширенной
конфигурации SSL.

- В LibreSSL шифры TLS 1.3  *можно* настраивать с помощью
  `ssl_ciphers`.
- В BoringSSL шифры TLS 1.3 настроить невозможно.

<a id="adc-m-ssl-client-certificate"></a>

### ssl_client_certificate

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_client_certificate` файл;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| По умолчанию                                                                             | —                                |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                     |

Указывает файл с доверенными сертификатами CA в формате PEM, которые используются для [проверки](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-verify-client) клиентских сертификатов.

Список сертификатов будет отправляться клиентам. Если это нежелательно, можно воспользоваться директивой [ssl_trusted_certificate](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-trusted-certificate).

<a id="adc-m-ssl-conf-command"></a>

### ssl_conf_command

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_conf_command` имя значение;   |
|------------------------------------------------------------------------------------------|------------------------------------|
| По умолчанию                                                                             | —                                  |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                       |

Задает произвольные [конфигурационные команды](https://docs.openssl.org/master/man3/SSL_CONF_cmd/) OpenSSL.

#### NOTE
Директива поддерживается при использовании OpenSSL 1.0.2 и выше.
Чтобы настроить шифры TLS 1.3 в OpenSSL, используйте команду `ciphersuites`.

На одном уровне может быть указано несколько директив ssl_conf_command:

```nginx
ssl_conf_command Options PrioritizeChaCha;
ssl_conf_command Ciphersuites TLS_CHACHA20_POLY1305_SHA256;
```

Директивы наследуются с предыдущего уровня конфигурации при условии, что на данном уровне не описаны свои директивы ssl_conf_command.

#### WARNING
Изменение настроек OpenSSL напрямую может привести к неожиданному поведению.

<a id="adc-m-ssl-crl"></a>

### ssl_crl

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_crl` файл;   |
|------------------------------------------------------------------------------------------|-------------------|
| По умолчанию                                                                             | —                 |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server      |

Указывает файл с отозванными сертификатами (CRL) в формате PEM, используемыми для [проверки](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-verify-client) клиентских сертификатов.

<a id="adc-m-ssl-dhparam"></a>

### ssl_dhparam

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_dhparam` файл;   |
|------------------------------------------------------------------------------------------|-----------------------|
| По умолчанию                                                                             | —                     |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server          |

Указывает файл с параметрами для DHE-шифров.

#### WARNING
По умолчанию параметры не заданы, и соответственно DHE-шифры не будут использоваться.

<a id="adc-m-ssl-ecdh-curve"></a>

### ssl_ecdh_curve

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_ecdh_curve` кривая;   |
|------------------------------------------------------------------------------------------|----------------------------|
| По умолчанию                                                                             | `ssl_ecdh_curve auto;`     |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server               |

Задает кривую для ECDHE-шифров.

#### NOTE
При использовании OpenSSL 1.0.2 и выше можно указывать несколько кривых, например:

```nginx
ssl_ecdh_curve prime256v1:secp384r1;
```

Специальное значение `auto` соответствует встроенному в библиотеку OpenSSL списку кривых для OpenSSL 1.0.2 и выше, или prime256v1 для более старых версий.

#### NOTE
При использовании OpenSSL 1.0.2 и выше директива задает список кривых, поддерживаемых сервером. Поэтому для работы ECDSA-сертификатов важно, чтобы список включал кривые, используемые в сертификатах.

<a id="adc-m-ssl-password-file"></a>

### ssl_password_file

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_password_file` файл;   |
|------------------------------------------------------------------------------------------|-----------------------------|
| По умолчанию                                                                             | —                           |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                |

Задает файл с паролями от [секретных ключей](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-certificate-key), где каждый пароль указан на отдельной строке. Пароли применяются по очереди в момент загрузки ключа.

Пример:

```nginx
mail {
    ssl_password_file /etc/keys/global.pass;
    ...

    server {
        server_name mail1.example.com;
        ssl_certificate_key /etc/keys/first.key;
    }

    server {
        server_name mail2.example.com;

        # вместо файла можно указать именованный канал
        ssl_password_file /etc/keys/fifo;
        ssl_certificate_key /etc/keys/second.key;
    }
}
```

<a id="adc-m-ssl-prefer-server-ciphers"></a>

### ssl_prefer_server_ciphers

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_prefer_server_ciphers` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------|
| По умолчанию                                                                             | `ssl_prefer_server_ciphers off;`            |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                                |

При использовании протоколов SSLv3 и TLS устанавливает приоритет серверных шифров над клиентскими.

<a id="adc-m-ssl-protocols"></a>

### ssl_protocols

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_protocols` [`SSLv2`] [`SSLv3`] [`TLSv1`] [`TLSv1.1`] [`TLSv1.2`] [`TLSv1.3`];   |
|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| По умолчанию                                                                             | `ssl_protocols TLSv1.2 TLSv1.3;`                                                     |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                                                                         |

#### Versionchanged
Изменено в версии 1.2.0: Параметр `TLSv1.3` добавлен к используемым по умолчанию.

Разрешает указанные протоколы.

#### NOTE
Параметры TLSv1.1 и TLSv1.2 работают только при использовании OpenSSL 1.0.1 и выше.

Параметр TLSv1.3 работает только при использовании OpenSSL 1.1.1 и выше.

<a id="adc-m-ssl-session-cache"></a>

### ssl_session_cache

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_session_cache` `off` | `none` | [builtin[:размер]] [shared:название:размер];   |
|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
| По умолчанию                                                                             | `ssl_session_cache none;`                                                           |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                                                                        |

Задает тип и размеры кэшей для хранения параметров сессий. Тип кэша может быть следующим:

| `off`     | жесткое запрещение использования кэша сессий: Angie явно сообщает клиенту, что сессии не могут использоваться повторно.                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `none`    | мягкое запрещение использования кэша сессий: Angie сообщает клиенту, что сессии могут использоваться повторно, но на самом деле не хранит параметры сессии в кэше.                                                                                                                                                                                                                                                                                                                                                                                                       |
| `builtin` | встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса. Размер кэша задается в сессиях. Если размер не задан, то он равен 20480 сессиям. Использование встроенного кэша может вести к фрагментации памяти.                                                                                                                                                                                                                                                                                                                                      |
| `shared`  | кэш, разделяемый между всеми рабочими процессами. Размер кэша задается в байтах, в 1 мегабайт может поместиться около 4000 сессий. У каждого разделяемого кэша должно быть произвольное название. Кэш с одинаковым названием может использоваться в нескольких серверах. Также он используется для автоматического создания, хранения и периодического обновления ключей TLS session tickets, если они не указаны явно с помощью директивы [ssl_session_ticket_key](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-session-ticket-key). |

Можно использовать одновременно оба типа кэша, например:

```nginx
ssl_session_cache builtin:1000 shared:SSL:10m;
```

однако использование только разделяемого кэша без встроенного должно быть более эффективным.

<a id="adc-m-ssl-session-ticket-key"></a>

### ssl_session_ticket_key

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_session_ticket_key` файл;   |
|------------------------------------------------------------------------------------------|----------------------------------|
| По умолчанию                                                                             | —                                |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                     |

Задает файл с секретным ключом, применяемым при шифровании и расшифровании TLS session tickets. Директива необходима, если один и тот же ключ нужно использовать на нескольких серверах. По умолчанию используется случайно сгенерированный ключ.

Если указано несколько ключей, то только первый ключ используется для шифрования TLS session tickets. Это позволяет настроить ротацию ключей, например:

```nginx
ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;
```

Файл должен содержать 80 или 48 байт случайных данных и может быть создан следующей командой:

```console
openssl rand 80 > ticket.key
```

В зависимости от размера файла для шифрования будет использоваться либо AES256 (для 80-байтных ключей), либо AES128 (для 48-байтных ключей).

<a id="adc-m-ssl-session-tickets"></a>

### ssl_session_tickets

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_session_tickets` `on` | `off`;   |
|------------------------------------------------------------------------------------------|---------------------------------------|
| По умолчанию                                                                             | `ssl_session_tickets on;`             |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                          |

Разрешает или запрещает возобновление сессий при помощи [TLS session tickets](https://datatracker.ietf.org/doc/html/rfc5077).

<a id="adc-m-ssl-session-timeout"></a>

### ssl_session_timeout

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_session_timeout` время;   |
|------------------------------------------------------------------------------------------|--------------------------------|
| По умолчанию                                                                             | `ssl_session_timeout 5m;`      |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                   |

Задает время, в течение которого клиент может повторно использовать параметры сессии.

<a id="adc-m-ssl-trusted-certificate"></a>

### ssl_trusted_certificate

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_trusted_certificate` файл;   |
|------------------------------------------------------------------------------------------|-----------------------------------|
| По умолчанию                                                                             | —                                 |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                      |

Задает файл с доверенными сертификатами CA в формате PEM, которые используются для [проверки](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-verify-client) клиентских сертификатов.

В отличие от [ssl_client_certificate](https://angie.software//angie/docs/configuration/modules/mail/mail_ssl.md#m-ssl-client-certificate), список этих сертификатов не будет отправляться клиентам.

<a id="adc-m-ssl-verify-client"></a>

### ssl_verify_client

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_verify_client` `on` | `off` | `optional` | `optional_no_ca`;   |
|------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| По умолчанию                                                                             | `ssl_verify_client off;`                                            |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                                                        |

Разрешает проверку клиентских сертификатов. Результат проверки передается в заголовке `Auth-SSL-Verify` в запросе [аутентификации](https://angie.software//angie/docs/configuration/modules/mail/mail_auth_http.md#m-auth-http). Если при проверке клиентского сертификата произошла ошибка или клиент не предоставил требуемый сертификат, соединение закрывается.

| `optional`       | запрашивает клиентский сертификат, и если сертификат был предоставлен, проверяет его                                                                                                                                                                                                                                                                                                                                          |
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `optional_no_ca` | запрашивает сертификат клиента, но не требует, чтобы он был подписан доверенным сертификатом CA. Это предназначено для случаев, когда фактическая проверка сертификата осуществляется внешним по отношению к Angie сервисом. Содержимое сертификата доступно в запросах, [посылаемых](https://angie.software//angie/docs/configuration/modules/mail/mail_auth_http.md#m-auth-http-pass-client-cert) на сервер аутентификации. |

<a id="adc-m-ssl-verify-depth"></a>

### ssl_verify_depth

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `ssl_verify_depth` число;   |
|------------------------------------------------------------------------------------------|-----------------------------|
| По умолчанию                                                                             | `ssl_verify_depth 1;`       |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                |

Устанавливает глубину проверки в цепочке клиентских сертификатов.

<a id="adc-m-starttls"></a>

### starttls

| [Синтаксис](https://angie.software//angie/docs/configuration/configfile.md#configfile)   | `starttls` `on` | `off` | `only`;   |
|------------------------------------------------------------------------------------------|-------------------------------------|
| По умолчанию                                                                             | `starttls off;`                     |
| [Контекст](https://angie.software//angie/docs/configuration/configfile.md#configfile)    | mail, server                        |

| `on`   | разрешить использование команд STLS для POP3 и STARTTLS для IMAP и SMTP;   |
|--------|----------------------------------------------------------------------------|
| `off`  | запретить использование команд STLS и STARTTLS;                            |
| `only` | требовать предварительного перехода на TLS.                                |