Asterisk-13-Configuration_res_pjsip_acl_29394920.html 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Asterisk Project : Asterisk 13 Configuration_res_pjsip_acl</title>
  5. <link rel="stylesheet" href="styles/site.css" type="text/css" />
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </head>
  8. <body class="theme-default aui-theme-default">
  9. <div id="page">
  10. <div id="main" class="aui-page-panel">
  11. <div id="main-header">
  12. <div id="breadcrumb-section">
  13. <ol id="breadcrumbs">
  14. <li class="first">
  15. <span><a href="index.html">Asterisk Project</a></span>
  16. </li>
  17. <li>
  18. <span><a href="Asterisk-13-Command-Reference_29394274.html">Asterisk 13 Command Reference</a></span>
  19. </li>
  20. <li>
  21. <span><a href="Asterisk-13-Module-Configuration_29394289.html">Asterisk 13 Module Configuration</a></span>
  22. </li>
  23. </ol>
  24. </div>
  25. <h1 id="title-heading" class="pagetitle">
  26. <span id="title-text">
  27. Asterisk Project : Asterisk 13 Configuration_res_pjsip_acl
  28. </span>
  29. </h1>
  30. </div>
  31. <div id="content" class="view">
  32. <div class="page-metadata">
  33. Created by <span class='author'> wikibot</span> on Aug 08, 2014
  34. </div>
  35. <div id="main-content" class="wiki-content group">
  36. <h1 id="Asterisk13Configuration_res_pjsip_acl-SIPACLmodule">SIP ACL module</h1>
  37. <p>This configuration documentation is for functionality provided by <code>res_pjsip_acl</code>.</p>
  38. <h2 id="Asterisk13Configuration_res_pjsip_acl-Overview">Overview</h2>
  39. <p><strong>ACL</strong></p>
  40. <p>The ACL module used by <code>res_pjsip</code>. This module is independent of <code>endpoints</code> and operates on all inbound SIP communication using res_pjsip.</p>
  41. <p>There are two main ways of defining your ACL with the options provided. You can use the <code>permit</code> and <code>deny</code> options which act on <strong>IP</strong> addresses, or the <code>contactpermit</code> and <code>contactdeny</code> options which act on <strong>Contact header</strong> addresses in incoming REGISTER requests. You can combine the various options to create a mixed ACL.</p>
  42. <p>Additionally, instead of defining an ACL with options, you can reference IP or Contact header ACLs from the file <code>acl.conf</code> by using the <code>acl</code> or <code>contactacl</code> options.</p>
  43. <h2 id="Asterisk13Configuration_res_pjsip_acl-pjsip.conf">pjsip.conf</h2>
  44. <h3 id="Asterisk13Configuration_res_pjsip_acl-acl">acl</h3>
  45. <p>Access Control List</p>
  46. <h4 id="Asterisk13Configuration_res_pjsip_acl-ConfigurationOptionReference">Configuration Option Reference</h4>
  47. <div class="table-wrap"><table class="confluenceTable"><tbody>
  48. <tr>
  49. <th class="confluenceTh"><p> Option Name </p></th>
  50. <th class="confluenceTh"><p> Type </p></th>
  51. <th class="confluenceTh"><p> Default Value </p></th>
  52. <th class="confluenceTh"><p> Regular Expression </p></th>
  53. <th class="confluenceTh"><p> Description </p></th>
  54. </tr>
  55. <tr>
  56. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>acl</code></a> </p></td>
  57. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  58. <td class="confluenceTd"><p> </p></td>
  59. <td class="confluenceTd"><p> <code>false</code> </p></td>
  60. <td class="confluenceTd"><p> List of IP ACL section names in acl.conf </p></td>
  61. </tr>
  62. <tr>
  63. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>contact_acl</code></a> </p></td>
  64. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  65. <td class="confluenceTd"><p> </p></td>
  66. <td class="confluenceTd"><p> <code>false</code> </p></td>
  67. <td class="confluenceTd"><p> List of Contact ACL section names in acl.conf </p></td>
  68. </tr>
  69. <tr>
  70. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>contact_deny</code></a> </p></td>
  71. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  72. <td class="confluenceTd"><p> </p></td>
  73. <td class="confluenceTd"><p> <code>false</code> </p></td>
  74. <td class="confluenceTd"><p> List of Contact header addresses to deny </p></td>
  75. </tr>
  76. <tr>
  77. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>contact_permit</code></a> </p></td>
  78. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  79. <td class="confluenceTd"><p> </p></td>
  80. <td class="confluenceTd"><p> <code>false</code> </p></td>
  81. <td class="confluenceTd"><p> List of Contact header addresses to permit </p></td>
  82. </tr>
  83. <tr>
  84. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>deny</code></a> </p></td>
  85. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  86. <td class="confluenceTd"><p> </p></td>
  87. <td class="confluenceTd"><p> <code>false</code> </p></td>
  88. <td class="confluenceTd"><p> List of IP addresses to deny access from </p></td>
  89. </tr>
  90. <tr>
  91. <td class="confluenceTd"><p> <a href="Asterisk-13-Configuration_res_pjsip_acl_29394920.html"><code>permit</code></a> </p></td>
  92. <td class="confluenceTd"><p> <code>Custom</code> </p></td>
  93. <td class="confluenceTd"><p> </p></td>
  94. <td class="confluenceTd"><p> <code>false</code> </p></td>
  95. <td class="confluenceTd"><p> List of IP addresses to permit access from </p></td>
  96. </tr>
  97. <tr>
  98. <td class="confluenceTd"><p> <code>type</code> </p></td>
  99. <td class="confluenceTd"><p> <code>None</code> </p></td>
  100. <td class="confluenceTd"><p> </p></td>
  101. <td class="confluenceTd"><p> <code>false</code> </p></td>
  102. <td class="confluenceTd"><p> Must be of type 'acl'. </p></td>
  103. </tr>
  104. </tbody></table></div>
  105. <h4 id="Asterisk13Configuration_res_pjsip_acl-ConfigurationOptionDescriptions">Configuration Option Descriptions</h4>
  106. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_acl"></span></p>
  107. <h5 id="Asterisk13Configuration_res_pjsip_acl-acl.1">acl</h5>
  108. <p>This matches sections configured in <code>acl.conf</code>. The value is defined as a list of comma-delimited section names.</p>
  109. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_contact_acl"></span></p>
  110. <h5 id="Asterisk13Configuration_res_pjsip_acl-contact_acl">contact_acl</h5>
  111. <p>This matches sections configured in <code>acl.conf</code>. The value is defined as a list of comma-delimited section names.</p>
  112. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_contact_deny"></span></p>
  113. <h5 id="Asterisk13Configuration_res_pjsip_acl-contact_deny">contact_deny</h5>
  114. <p>The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')</p>
  115. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_contact_permit"></span></p>
  116. <h5 id="Asterisk13Configuration_res_pjsip_acl-contact_permit">contact_permit</h5>
  117. <p>The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')</p>
  118. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_deny"></span></p>
  119. <h5 id="Asterisk13Configuration_res_pjsip_acl-deny">deny</h5>
  120. <p>The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')</p>
  121. <p><span class="confluence-anchor-link" id="Asterisk13Configuration_res_pjsip_acl-acl_permit"></span></p>
  122. <h5 id="Asterisk13Configuration_res_pjsip_acl-permit">permit</h5>
  123. <p>The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')</p>
  124. <h3 id="Asterisk13Configuration_res_pjsip_acl-ImportVersion">Import Version</h3>
  125. <p>This documentation was imported from Asterisk Version SVN-branch-13-r420538</p>
  126. </div>
  127. </div> </div>
  128. <div id="footer">
  129. <section class="footer-body">
  130. <p>Document generated by Confluence on Aug 11, 2014 13:49</p>
  131. </section>
  132. </div>
  133. </div> </body>
  134. </html>