kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-24 05:38:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add base XML documentation for res_sip

Browse Source 
Thanks to Brad Latus, this patch adds a significant amount much-needed
documentation to res_sip. It should cover all existing configuration
options currently in Asterisk trunk.

Patch-by: Brad Latus (snuffy)
Review: https://reviewboard.asterisk.org/r/2471/


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@389148 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Kinsey Moore
2013-05-19 17:45:42 +00:00
parent b46840ae3e
commit 1b5a3069f9
4 changed files with 638 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
res/res_sip_acl.c
View File

@@ -32,6 +32,58 @@
#include "asterisk/sorcery.h"
#include "asterisk/acl.h"
/*** DOCUMENTATION
<configInfo name="res_sip_acl" language="en_US">
<synopsis>SIP ACL module</synopsis>
<description><para>
<emphasis>ACL</emphasis>
</para>
<para>The ACL module used by <literal>res_sip</literal>. This module is
independent of <literal>endpoints</literal> and operates on all inbound
SIP communication using res_sip.
</para><para>
It should be noted that this module can also reference ACLs from
<filename>acl.conf</filename>.
</para><para>
There are two main ways of creating an access list: <literal>IP-Domain</literal>
and <literal>Contact Header</literal>. It is possible to create a combined ACL using
both IP and Contact.
</para></description>
<configFile name="res_sip.conf">
<configObject name="acl">
<synopsis>Access Control List</synopsis>
<configOption name="acl">
<synopsis>Name of IP ACL</synopsis>
<description><para>
This matches sections configured in <literal>acl.conf</literal>
</para></description>
</configOption>
<configOption name="contactacl">
<synopsis>Name of Contact ACL</synopsis>
<description><para>
This matches sections configured in <literal>acl.conf</literal>
</para></description>
</configOption>
<configOption name="contactdeny">
<synopsis>List of Contact Header addresses to Deny</synopsis>
</configOption>
<configOption name="contactpermit">
<synopsis>List of Contact Header addresses to Permit</synopsis>
</configOption>
<configOption name="deny">
<synopsis>List of IP-domains to deny access from</synopsis>
</configOption>
<configOption name="permit">
<synopsis>List of IP-domains to allow access from</synopsis>
</configOption>
<configOption name="type">
<synopsis>Must be of type 'acl'.</synopsis>
</configOption>
</configObject>
</configFile>
</configInfo>
***/
struct sip_acl {
SORCERY_OBJECT(details);
struct ast_acl_list *acl;