summaryrefslogtreecommitdiff
path: root/configuration/radius.html
blob: 0aaacb6e2a51ca47ac80b811d45f7f8f1b556360 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>[radius] &mdash; Accel-ppp 1.12 documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />

  
    <link rel="shortcut icon" href="../_static/favicon.ico"/>
      <script src="../_static/jquery.js?v=5d32c60e"></script>
      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="../_static/documentation_options.js?v=2d52a127"></script>
      <script src="../_static/doctools.js?v=9bcbadda"></script>
      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="[chap-secrets]" href="chap_secrets.html" />
    <link rel="prev" title="[common]" href="common.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html" class="icon icon-home">
            Accel-ppp
              <img src="../_static/logo.png" class="logo" alt="Logo"/>
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Installation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="configuration.html">Configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="modules.html">[modules]</a></li>
<li class="toctree-l2"><a class="reference internal" href="core.html">[core]</a></li>
<li class="toctree-l2"><a class="reference internal" href="common.html">[common]</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">[radius]</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#dm-coa">DM/CoA</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="chap_secrets.html">[chap-secrets]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ppp.html">[ppp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pppoe.html">[pppoe]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pptp.html">[pptp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="l2tp.html">[l2tp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipoe.html">[ipoe]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ip-pool.html">[ip-pool]</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstp.html">[sstp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="dns.html">[dns]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-dns.html">[ipv6-dns]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-pool.html">[ipv6-pool]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-nd.html">[ipv6-nd]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-dhcp.html">[ipv6-dhcp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="shaper.html">[shaper]</a></li>
<li class="toctree-l2"><a class="reference internal" href="log.html">[log]</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.html">[cli]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pppd_compat.html">[pppd-compat]</a></li>
<li class="toctree-l2"><a class="reference internal" href="snmp.html">SNMP</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/radius_features.html">RADIUS and DM/CoA features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Accel-ppp</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="configuration.html">Configuration</a></li>
      <li class="breadcrumb-item active">[radius]</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/configuration/radius.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="radius">
<h1>[radius]<a class="headerlink" href="#radius" title="Link to this heading"></a></h1>
<dl>
<dt><strong>verbose=0|1</strong></dt><dd><p>By default is not defined.</p>
<p>If this option enabled, the radius module should add detailed info to log</p>
</dd>
<dt><strong>interim-verbose=0|1</strong></dt><dd><p>By default is not defined.</p>
<p>Specified, should radius module produce verbose logging of interim radius packets.</p>
</dd>
<dt><strong>dictionary=/path/to/dictionary</strong></dt><dd><p>By default is <cite>&lt; -DCMAKE_INSTALL_PREFIX &gt;/share/accel-ppp/radius/dictionary</cite></p>
<p>Specifies path to RADIUS dictionaries. It is possible to define multiple dictionaries</p>
</dd>
<dt><strong>server=address,secret[,auth-port=1812][,acct-port=1813][,req-limit=0][,fail-timeout=0,max-fail=0,][,weight=1][,backup]</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies IP address, secret, ports of RADIUS server.</p>
</dd>
<dt><strong>nas-ip-address=x.x.x.x</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies value to send to RADIUS server in <em>NAS-IP-Address</em> attribute and to be matched in DM/CoA requests. Also DM/CoA server will bind to that address.</p>
</dd>
<dt><strong>nas-identifier=identifier</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies value to send to RADIUS server in NAS-Identifier attribute and to be matched in DM/CoA requests.</p>
</dd>
<dt><strong>gw-ip-address=x.x.x.x</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies address to use as local address of ppp interfaces if <em>Framed-IP-Address</em> received from RADIUS server.</p>
</dd>
<dt><strong>acct-interim-interval=n</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies interval in seconds to send accounting information (may be overridden by radius <em>Acct-Interim-Interval</em> attribute)</p>
</dd>
<dt><strong>acct-interim-jitter=n</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies absolute maximum jitter value in seconds to be applied to accounting information interval. Calculate interim-interval+-acct-interim-jitter.</p>
</dd>
<dt><strong>max-try=n</strong></dt><dd><p>By default is <code class="docutils literal notranslate"><span class="pre">max-try=3</span></code></p>
<p>Specifies number of tries to send Access-Request/Accounting-Request queries.</p>
</dd>
<dt><strong>timeout=n</strong></dt><dd><p>By default is <code class="docutils literal notranslate"><span class="pre">timeout=3</span></code></p>
<p>Timeout in seconds to wait response from RADIUS server.</p>
</dd>
<dt><strong>acct-timeout=n</strong></dt><dd><p>By default is <code class="docutils literal notranslate"><span class="pre">acct-timeout=3</span></code></p>
<p>Specifies timeout in seconds of accounting interim update, if request not received after this time , session will terminated. If <code class="docutils literal notranslate"><span class="pre">acct-timeout=0</span></code> then session keeps active.</p>
</dd>
<dt><strong>sid-in-auth=0|1</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies should <em>accel-ppp</em> generate and send <code class="docutils literal notranslate"><span class="pre">Acct-Session-Id</span></code> on Access-Request packet. By default <code class="docutils literal notranslate"><span class="pre">Acct-Session-Id</span></code> sent on Accounting-Request packet.</p>
</dd>
<dt><strong>acct-delay-time=0|1</strong></dt><dd><p>By default is <cite>acct-delay-time=0</cite></p>
<p>Specifies whether radius client should include Acct-Delay-Time attribute to accounting requests</p>
</dd>
<dt><strong>attr-tunnel-type=name</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies custom attribute name to be used to send tunnel type (as string).</p>
</dd>
<dt><strong>default-realm=realm</strong></dt><dd><p>By default is disabled.</p>
<p>Append specified realm to username. For example <code class="docutils literal notranslate"><span class="pre">default-realm=example.com</span></code> accel-ppp send to RADIUS server <code class="docutils literal notranslate"><span class="pre">username&#64;example.com</span></code></p>
</dd>
</dl>
<section id="dm-coa">
<h2>DM/CoA<a class="headerlink" href="#dm-coa" title="Link to this heading"></a></h2>
<dl>
<dt><strong>dae-server=x.x.x.x:port,secret</strong></dt><dd><p>By default is not defined.</p>
<p>Specifies IP address, port to bind and secret for Dynamic Authorization Extension server (DM/CoA).This <em>ip address</em> must exist on any server interface.</p>
</dd>
<dt><strong>require-nas-identification=0|1</strong></dt><dd><p>By default is not defined.</p>
<p>Allow processing (DM/CoA) packets that contain valid “NAS-Identifier” and “NAS-IP-Address” attributes.</p>
</dd>
</dl>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="common.html" class="btn btn-neutral float-left" title="[common]" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="chap_secrets.html" class="btn btn-neutral float-right" title="[chap-secrets]" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2023, Accel-ppp Dev.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>