<?xml version="1.0"?>

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Модуль ngx_http_secure_link_module"
        link="/ru/docs/http/ngx_http_secure_link_module.html"
        lang="ru">

<section id="summary">

<para>
Модуль <literal>ngx_http_secure_link_module</literal> проверяет
правильность запрашиваемой ссылки (0.7.18+).
</para>

<para>
По умолчанию этот модуль не собирается, его сборку необходимо
разрешить с помощью конфигурационного параметра
<literal>--with-http_secure_link_module</literal>.
</para>

</section>


<section id="example" name="Пример конфигурации">

<para>
<example>
location /p/ {
    secure_link_secret some_secret_word;

    if ($secure_link = "") {
        return 403;
    }
}
</example>
</para>

</section>


<section id="directives" name="Директивы">

<directive name="secure_link_secret">
<syntax><value>слово</value></syntax>
<default/>
<context>location</context>

<para>
Задаёт секретное <value>слово</value> для проверки правильности ссылки.
Полный URL защищённой ссылки выглядит так:
<example>
/prefix/<value>hash</value>/<value>ссылка</value>
</example>
где <value>hash</value> считается как
<example>
md5(ссылка, секретное_слово);
</example>
</para>

<para>
Префикс — произвольная строка, не включающая слэш.
</para>

</directive>

</section>


<section id="variables" name="Встроенные переменные">

<para>
<list type="tag">

<tag-name><var>$secure_link</var></tag-name>
<tag-desc>
равна ссылке, выделенной из полного URL’а.
Если хэш неверный, то переменная равна пустой строке.
</tag-desc>

</list>
</para>

</section>

</module>