You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules/sanity/doc/params.xml

102 lines
3.1 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
%docentities;
]>
<section id="sanity.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>Parameters</title>
<section id="default_checks">
<title><varname>default_checks</varname> (integer)</title>
<para>
This parameter determines which of the checks from the sanity
module are executed if no parameter was given to the sanity_check
function call. By default all implemented checks are included
in the execution of the sanity_check function. The integer value
is the sum of the check numbers which should be executed by default.
</para>
<para>
Default value is 999. This resolves to the following list of
checks: ruri_sip_version (1), ruri_scheme (2), required_headers (4),
cseq_method (32), cseq_value (64), cotent_length (128),
expires_value (256), proxy_require (512).
</para>
<example>
<title>Set <varname>default_checks</varname> parameter</title>
<programlisting>
...
modparam("sanity", "default_checks", 1)
...
</programlisting>
</example>
</section>
<section id="uri_checks">
<title><varname>uri_checks</varname> (integer)</title>
<para>
This parameter determines which URIs are going to be checked
if the 'parse uri' will be executed.
</para>
<para>
Default value is 7. This resolves to the following list of
parsed URIs: Request RUI (1), From URI (2) and To URI (4).
</para>
<example>
<title>Set <varname>uri_checks</varname> parameter</title>
<programlisting>
...
modparam("sanity", "uri_checks", 3)
...
</programlisting>
</example>
</section>
<section id="proxy_require">
<title><varname>proxy_require</varname> (string)</title>
<para>
This parameter set the list of supported extensions for this SIP-router.
The value is expected as comma separated list of the extensions.
This list is separated into single tokens. Each token from
a proxy require header will be compare to the tokens from this
list.
</para>
<example>
<title>Set <varname>proxy_require</varname> parameter</title>
<programlisting>
...
modparam("sanity", "proxy_require", "foo, bar")
...
</programlisting>
</example>
</section>
<section id="autodrop">
<title><varname>autodrop</varname> (integer)</title>
<para>
This parameter controls whether the module drops automatically
or not the SIP message if the sanity checks fail. Default value
is 1 (auto drop). If set to 0, sanity_check() function will return
-1 (false) to configuration file, allowing to write log messages for
example - be sure you exit execution of config without sending a SIP
reply because it is sent by module itself.
</para>
<example>
<title>Set <varname>autodrop</varname> parameter</title>
<programlisting>
...
modparam("sanity", "autodrop", 1)
...
</programlisting>
</example>
</section>
</section>