VCL

Операторы

В VCL доступны следующие операторы:

=

Оператор присваивания.

+, -, *, /, %

Основные математические операции над числовыми значениями.

+=, -=, *=, /=

Оператор присваивания с инкрементом/декрементом/умножением/делением.

Для строк += выполняется конкатенация.

(, )

Вычисление по отдельности.

==, !=, <, >, <=, >=

Сравнения

~, !~

Сопоставление/несопоставление. Может использоваться с регулярными выражениями или списками управления доступом (ACL).

!

Отрицание.

&& / ||

Логическое И/ИЛИ.

Условные операторы

VCL имеет операторы if и else. Вложенную логику можно реализовать с помощью оператора elseif (elsif/elif/else if эквивалентны).

Обратите внимание, что в VCL нет циклов или итераторов любого типа.

Переменные

VCL выполняет большую часть работы, анализируя, set и unset переменные:

if (req.url == "/mistyped_url.html") {
    set req.url = "/correct_url.html";
    unset req.http.cookie;
}

Существуют очевидные ограничения на то, что можно сделать. Например, нет смысла unset req.url; — запрос должен иметь какой-то URL, чтобы быть корректным, и аналогично попытка манипулировать ответом бэкенда, когда его (еще) нет, бессмысленно. Компилятор VCL обнаружит такие ошибки.

Переменные имеют типы. Большинство из них — СТРОКИ, и всё в VCL может быть преобразовано в СТРОКУ, но некоторые переменные имеют типы, такие как DURATION, IP и т. д.

При установке таких переменных правая часть знака равенства должна иметь правильный тип переменной. Нельзя присвоить СТРОКУ переменной типа ЧИСЛО, даже если строка "42".

Функции явного преобразования доступны в VMOD std — стандартный модуль Varnish.

Полный список переменных VCL см.: VCL-Переменные.

Регулярные выражения

Varnish использует Perl-совместимые регулярные выражения (PCRE). Полное описание см. в справке man pcre(3).

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

# If host is NOT example dot com..
if (req.http.host !~ "(?i)example\.com$") {
    ...
}

Инструкция include

Для включения файла VCL в другой файл используйте ключевое слово include:

include "foo.vcl";

Необязательно, ключевое слово include может принимать флаг +glob для включения всех файлов, соответствующих шаблону glob:

include +glob "example.org/*.vcl";

Инструкция import

Инструкция import используется для загрузки модулей Varnish (VMOD).

Пример:

import std;
sub vcl_recv {
    std.log("foo");
}

Комментарии

Одиночные строки VCL можно прокомментировать, используя // или #. Многострочные блоки можно прокомментировать с помощью /*блок*/.

Пример:

sub vcl_recv {
    // Single line of out-commented VCL.
    # Another way of commenting out a single line.
    /*
        Multi-line block of commented-out VCL.
    */
}

Бэкенды и тесты работоспособности

См. VCL-бэкенды и VCL-проверка

Список управления доступом (ACL)

Декларация списка управления доступом (ACL) создаёт и инициализирует именованный список управления доступом, который можно использовать для сопоставления адресов клиентов:

acl localnetwork {
    "localhost";    # myself
    "192.0.2.0"/24; # and everyone on the local network
    ! "192.0.2.23"; # except for the dial-in router
}

Если запись ACL указывает имя хоста, которое Varnish не может разрешить, она будет соответствовать любому адресу, с которым она сравнивается. Следовательно, если ей предшествует знак отрицания, она отклонит любой адрес, с которым она сравнивается, что может быть не тем, что вы имели в виду. Однако, если запись заключена в скобки, она просто будет проигнорирована, если имя хоста не может быть разрешено.

Для сопоставления IP-адреса со списком управления доступом (ACL) просто используйте оператор сопоставления:

if (client.ip ~ localnetwork) {
    return (pipe);
}

ACL имеют флаги функций, которые можно устанавливать или сбрасывать для каждого ACL индивидуально:

• +log — Вывести запись Acl в VSL, чтобы указать, было ли найдено соответствие или нет.
• +table — Реализовать ACL с помощью таблицы вместо скомпилированного кода. Это работает немного медленнее, но компилирует большие ACL намного быстрее.

• -pedantic — Разрешить маски для покрытия не нулевых битов хоста. Это позволяет работать следующему:

  acl foo -pedantic +log {
      "firewall.example.com" / 24;
  }
  

  Однако, если имя резолвется как IPv4 и IPv6, вы по-прежнему получите ошибку.

Объекты VCL

Объект VCL можно создать с помощью ключевого слова new:

sub vcl_init {
    new b = directors.round_robin()
    b.add_backend(node1);
}

Это доступно только в vcl_init.

Подпрограммы

Подпрограмма используется для группирования кода для лучшей читаемости или повторного использования:

sub pipe_if_local {
    if (client.ip ~ localnetwork) {
        return (pipe);
    }
}

Подпрограммы в VCL не принимают аргументы и не возвращают значения. Встроенные подпрограммы имеют имена, начинающиеся с vcl_, что зарезервировано.

Для вызова подпрограммы используйте ключевое слово call за которым следует имя подпрограммы:

sub vcl_recv {
    call pipe_if_local;
}

sub filter_cookies {
    if (!req.http.cookie) {
        return;
    }
    # complex cookie filtering
}

Функции

Доступны следующие встроенные функции: