Глава 3. Конфигурация.

Уровень подробности отладочной информации задаётся целым числом от 1 (минимальный) до 5 (максимальный) - глобально значением узла logging/level. Для отдельных модулей уровень подробности может быть изменён на значения узлов log-level в соответствующих местах конфигурации. Это полезно при поиске проблем в конкретной подсистеме сервера, для этого достаточно указать уровень подробности отладочной информации для соответствующего модуля выше глобального.

Все разделы конфигурации предполагающие описание приёма сетевых запросов на подключение от клиентов имеют узлы host. Допускается указание нескольких узлов host для каждой подсистемы Структура XML деревьев host одинакова для всех серверных подсистем. Скажем, клиент SMTP - не серверная подсистема, а клиентская, поэтому у неё XML дерево host имеет более простую структуру.

В полном виде XML дерево host выглядит так:

<host>
  <timeout>time</timeout>
  <clients-limit>N</clients-limit>
  <clients-per-ip-limit>N</clients-per-ip-limit>

  <SSL-certificate-file>filename</SSL-certificate-file>
  <SSL-key-file>filename</SSL-key-file>
  <SSL-key-password>secret</SSL-key-password>
  <SSL-min-version>none|SSLv3|TLSv1|TLSv1.1|TLSv1.2|TLSv1.3</SSL-min-version>
  <SSL-cipher>cipher list</SSL-cipher>
  <SSL-cipher-TLSv1.3>cipher list</SSL-cipher-TLSv1.3>

  <SSL-ca-file>filename</SSL-ca-file>
  <SSL-verify-peer>none|optional|require</SSL-verify-peer>
  <SSL-verify-depth>N</SSL-verify-depth>
  <cert-username>
    <dn>field list</dn>
    <san-email>Yes|No</san-email>
    <san-othername>field list</san-othername>
  </cert-username>

  <bind SSL="0|1" IPv6only="0|1">hostname:port|IPv4:port|*:port|[IPv6]:port|[::]:port|socket_name</bind>
  ...

  <acl>
    <addr type="permit|deny">ip_address</addr>
    <addr type="permit|deny">ip_address/number_of_bits_mask</addr>
    <addr type="permit|deny">ip_address/dotted_decimal_mask</addr>
    <addr type="permit|deny">ip_address_1-ip_address_2</addr>
    <addr type="permit|deny">all|any|0/0</addr>
    ...
  </acl>
</host>

Значения узлов SSL-... и дерево cert-username могут быть указаны для всего набора узлов host находящихся на одном уровне. Для этого достаточно указать узлы SSL-... и дерево cert-username не в XML-дереве host, а на один уровень выше - в узле который содержит множество узлов host. При этом, если какие-то из этих узлов заданы в каком-либо XML-дереве host, они будут переопределять значения заданные вне данного узла host.

Также, узлы SSL-... и дерево cert-username могут быть указаны глобально для любых узлов host в любых разделах конфигурации. Для этого эти узлы указываются как непосредственные потомки корневого узла server. Их значение может быть переопределено в других местах конфигурации.

В различных узлах конфигурации используется формат задания временных интервалов в виде последовательности значений вида N[sec|s|min|m|hour|hours|h|day|days|d|week|weeks|w], Где N - целое число; sec или s - секунды; min или m - минуты; hour, hours или h - часы; day, days или d - дни (одни день - 24 часа); week, weeks или w - недели. Одиночное целое значение без указания размерности задаёт количество секунд.

Примеры:

1h 30min

Один час и тридцать минут.

2 Hours 5 Min 10 Sec

Два часа, пять минут и десять секунд.

50 или 50 sec

Пятьдесят секунд.

Некоторые узлы, например, такие как host/acl, определяют принадлежность адреса IP клиента к заданному множеству. XML деревья данного типа имеют дочерние узлы addr значения которых являются адресом IP или диапазоном адресов. Диапазоны могут задаваться в следующих видах:

Атрибуты type узлов addr принимают одно из двух значений: permit - адрес разрешён и deny - адрес запрещён. При проверке адреса на принадлежность списку, узлы addr просматриваются в том порядке как они записаны в конфигурации, если адрес попадает в указанный диапазон, он считается принятым если type имеет значение permit, либо запрещённым если type имеет значение deny.

Узлы и атрибуты являющиеся переключателями, т.е. те, которые могут принимать одно из двух значений - ИСТИНА или ЛОЖЬ, например, logging/screen, могут задаваться разными ключевыми словами являющимися синонимами:

Для "ИСТИНА": 1, enable, yes, on, true

Для "ЛОЖЬ": 0, disable, no, off, false

Значения узлов указывающих количество байт или объём данных могут представлять собой целое число с указанием размерности: N[byte|bytes|b|kb|k|mb|m|gb|g|tb|t].

Примеры:

1 Kb

1 килобайт (1024 байта)

1 mb

1 мегабайт (1024 килобайта)

128 bytes

128 байт

В некоторых параметрах конфигурации для сопоставления имён хостов, доменов и других строковых данных используются шаблоны. В шаблонах могут встречаться метасимволы: * (звездочка) для любой последовательности символов (включая пустую), ? (вопросительный знак) для одного любого символа и квадратные скобки [...] для перечисления допустимых символов (например, [abc] или [0-9]), позволяя задавать наборы или диапазоны. Если после [ (открывающая квадратная скобка) указан символ ^, то набору или диапазону будет соответствовать любой символ не входящий в указанный набор или диапазон. Если в набор необходимо включить символ ']', он должен идти первым после [ или ^.

Символ \ используется для экранирования: если в шаблоне необходимо указать один из символов '*', '?', '\' как часть текста, перед ним указывается \.

Также, задать символы '*' и '?' как часть текста можно заключив их в квадратные скобки: шаблон "abc[*]xyz" соответствует только строке "abc*xyz".

Сравнение не-метасимволов регистронезависимое.