Настройка имен и TLS
Сервер Excubius отвечает на основное имя и любое количество псевдонимов и предоставляет HTTPS в одном из шести режимов: от сертификата Let's Encrypt до шлюза, который завершает TLS перед сервером. Первые значения задаются ответами программы установки. После этого вы меняете их в консоли, и изменение вступает в силу в течение минуты без перезапуска. В этом руководстве показано, как выбрать и изменить эти параметры.
Перед началом работы
- Чтобы менять имена и TLS в консоли, вам нужна роль Super admin (суперадминистратор).
- Чтобы работать непосредственно на сервере, вам нужен доступ по SSH и права
sudo, чтобы действовать от имени учетной записи службы (по умолчаниюexcubius). - Сначала создайте записи DNS. Каждое имя должно разрешаться в адрес сервера или шлюза перед ним из тех мест, откуда пользователи будут работать с Excubius.
Три вида имен
| Имя | Что это |
|---|---|
| Primary name (основное имя) | Имя узла в публичном адресе, например monitoring.ciguapa.example. Его используют ссылки, которые Excubius отправляет в сообщениях Slack и задачах Jira. Вход всегда выполняется на этом имени: пользователь, открывший псевдоним, перенаправляется для входа на основное имя |
| Aliases (псевдонимы) | Другие имена, которые могут открывать пользователи, например monitoring.areito.example в домене, которым вы управляете, если зона DNS клиента вам недоступна. Сервер отвечает на все эти имена |
| Names in the certificate (имена в сертификате) | Имена, для которых запрашивается сертификат. По умолчанию это все имена, и новые псевдонимы добавляются автоматически. Снимите флажок с имени, которое сертификат не может охватить, например с имени, DNS которого вы не управляете |
Всего у сервера может быть не более 100 имен.
Адреса перенаправления, зарегистрированные для входа через Microsoft Entra ID и Google, начинаются с основного имени. Перед изменением основного имени сначала обновите их; см. статью Настройка поставщиков входа.
Выбор режима
| Режим в консоли | Ответ программы установки | Когда использовать |
|---|---|---|
| Let's Encrypt over HTTP | letsencrypt | Каждое имя в сертификате зарегистрировано в публичной системе DNS и указывает на этот сервер, а порт 80 доступен из Интернета напрямую или через NAT или шлюз |
| Let's Encrypt over DNS | letsencrypt-dns | У вас есть учетные данные API для зоны DNS этих имен. Сервер не обязательно должен быть доступен из Интернета, поэтому это обычный выбор для сервера, к которому подключаются через VPN |
| Self-signed | selfsigned | В любой среде. Браузеры выводят предупреждение, пока пользователи не установят сертификат как доверенный на своих компьютерах и телефонах |
| Your own certificate | custom | Ваша организация выпускает сертификаты. Вы вставляете цепочку и ключ и заменяете их до истечения срока действия |
| Gateway in front | gateway | Подсистема балансировки нагрузки или обратный прокси-сервер, например Шлюз приложений Azure (Application Gateway) или Front Door, завершает TLS и пересылает обычный HTTP. Заголовок X-Forwarded-Proto учитывается |
| Plain HTTP | later | Первый тест или сеть, которой вы полностью доверяете. Ничего не шифруется |
Изменение имен или режима в консоли
- Откройте Settings и выберите Server and certificates. Также можно перейти туда из Settings › Instance с помощью Server names and HTTPS.
- В разделе Names проверьте Primary name. Чтобы добавить псевдоним, введите его и выберите Add; чтобы удалить псевдоним, выберите Remove рядом с ним.
- В разделе HTTPS выберите режим и заполните запрашиваемые поля. Каждый режим описан в разделах ниже.
- В разделе Names in the certificate снимите флажки с имен, которые сертификат не может охватить.
- Выберите Apply. На странице появится сообщение Saved. The certificate service is applying it.
В разделе Current certificate показан используемый сертификат: издатель, имена, Valid until, Last attempt с результатом и Next check. Если попытка завершится ошибкой, причина будет описана в поле What went wrong.
Каждое изменение проверяется перед сохранением и записывается в журнал аудита.
Let's Encrypt по HTTP
Введите E-mail for the Let's Encrypt account. Перед применением убедитесь, что каждое имя в сертификате публично разрешается в адрес сервера и что порт 80 открыт из Интернета. Имя, которое не может быть публичным, например IP-адрес или имя, оканчивающееся на .local, .internal или .corp, отклоняется: снимите с него флажок или используйте самозаверяющий сертификат.
Let's Encrypt по DNS
-
Введите E-mail for the Let's Encrypt account.
-
Выберите DNS provider для зоны этих имен. Если поставщика нет в списке, выберите Other (acme.sh dnsapi id) и введите его идентификатор
dnsapiв acme.sh. -
В разделе API credentials введите значения, которые считывает поставщик. Консоль показывает их для каждого поставщика:
Поставщик Идентификатор dnsapiПеременные Cloudflare dns_cfCF_Token,CF_Account_IDDreamHost dns_dreamhostDH_API_KEYAzure DNS dns_azureAZUREDNS_SUBSCRIPTIONID,AZUREDNS_TENANTID,AZUREDNS_APPID,AZUREDNS_CLIENTSECRETAmazon Route 53 dns_awsAWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEYGoDaddy dns_gdGD_Key,GD_SecretDigitalOcean dns_dgonDO_API_KEYGandi dns_gandi_livednsGANDI_LIVEDNS_TOKENHetzner dns_hetznercloudHETZNER_TOKENIONOS dns_ionosIONOS_PREFIX,IONOS_SECRETLinode (Akamai) dns_linode_v4LINODE_V4_API_KEYNamecheap dns_namecheapNAMECHEAP_USERNAME,NAMECHEAP_API_KEY,NAMECHEAP_SOURCEIPOVHcloud dns_ovhOVH_END_POINT,OVH_AK,OVH_AS,OVH_CKPorkbun dns_porkbunPORKBUN_API_KEY,PORKBUN_SECRET_API_KEY -
При необходимости задайте для Let's Encrypt server значение Staging, чтобы отработать настройку, не затрагивая ограничения частоты запросов Let's Encrypt. Браузеры не доверяют промежуточным сертификатам; когда все заработает, вернитесь к значению Production.
Значения учетных данных доступны только для записи: они хранятся в зашифрованном виде и больше никогда не отображаются. Чтобы сохранить уже записанное значение при изменении параметров, оставьте его поле пустым.
Самозаверяющий сертификат
Ничего вводить не нужно. Сертификат действителен 825 дней и продлевается так же, как остальные. Чтобы браузеры перестали выводить предупреждения, выберите Download the certificate и установите его как доверенный на компьютерах и телефонах, с которых используется сервер.
Собственный сертификат
Вставьте Certificate chain в формате PEM, начиная с сертификата сервера, и Private key в формате PEM без парольной фразы. Ключ должен быть ключом RSA длиной 2048 бит или больше либо ключом ECDSA. Консоль отклоняет сертификат с истекшим сроком действия, сертификат, который не охватывает имена сервера, и сертификат, ключ которого не совпадает. Замените их до истечения срока действия сертификата; Excubius не продлевает его за вас.
Шлюз перед сервером
Ничего вводить не нужно. Настройте шлюз так, чтобы он пересылал обычный HTTP на порт 80 сервера и отправлял заголовок X-Forwarded-Proto.
Продление
Сертификаты Let's Encrypt и самозаверяющие сертификаты продлеваются автоматически. Служба сертификатов ежедневно проверяет активный сертификат и продлевает его, когда до окончания срока действия остается 30 дней или меньше. Настраивать таймер на сервере не нужно.
- Неудачная попытка никогда не удаляет то, что работает. Продолжает использоваться предыдущий сертификат или обычный HTTP; ошибка отображается на странице вместе со временем следующей попытки: через 15 минут, а затем с удвоением интервала, вплоть до одного дня.
- Изменение параметров применяется сразу.
- Renew now немедленно запрашивает новый сертификат.
- Use self-signed now переключает сервер на самозаверяющий сертификат. Это быстрый способ получить HTTPS, пока Let's Encrypt еще не может работать.
Файлы cookie сеанса помечаются как Secure всякий раз, когда запрос поступает по HTTPS, поэтому смена режима не требует перезапуска. Оставьте COOKIE_SECURE пустым в файле конфигурации; этот параметр лишь принудительно задает поведение в ту или иную сторону.
Адреса /healthz и /heartbeat отвечают по обычному HTTP в любом режиме, поэтому внешняя система наблюдения продолжает работать, пока вы меняете TLS.
Изменение TLS на сервере
Если консоль недоступна, например потому что сертификат поврежден и браузер отказывается открывать страницу, измените те же параметры на сервере. Сценарий выполняет те же проверки и пишет в тот же журнал аудита, что и консоль.
-
Подключитесь по SSH и перейдите в учетную запись службы:
sudo -iu excubius -
Выведите текущие параметры и сертификат:
/opt/excubius/current/scripts/enable-tls.sh --status -
Измените нужные параметры. Например, переключитесь на самозаверяющий сертификат:
/opt/excubius/current/scripts/enable-tls.sh --mode selfsignedИли используйте Let's Encrypt по DNS с Cloudflare, с двумя именами и сертификатом только для второго. Учетные данные считываются из стандартного ввода в виде строк
KEY=VALUE:/opt/excubius/current/scripts/enable-tls.sh --mode letsencrypt-dns \--email ops@areito.example --dns-provider dns_cf \--names "monitoring.ciguapa.example monitoring.areito.example" \--cert-names monitoring.areito.example < credentials.txt -
Чтобы продлить сертификат немедленно, выполните
enable-tls.sh --renew.
Замените /opt/excubius, если вы выбрали другой каталог установки. Выполните enable-tls.sh --help, чтобы увидеть все параметры, включая --staging и --production. Собственный сертификат можно загрузить только из консоли.
Изменение ответов с помощью программы установки
sudo ./install.sh --reconfigure повторно задает все вопросы. Ответы, касающиеся TLS, применяются к работающей платформе так же, как если бы вы изменили их в консоли.