diff options
Diffstat (limited to 'configuration/chap_secrets.html')
| -rw-r--r-- | configuration/chap_secrets.html | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/configuration/chap_secrets.html b/configuration/chap_secrets.html new file mode 100644 index 0000000..721ab9d --- /dev/null +++ b/configuration/chap_secrets.html @@ -0,0 +1,200 @@ +<!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>[chap-secrets] — 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=19f00094" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <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=9a2dae69"></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="[ppp]" href="ppp.html" /> + <link rel="prev" title="[radius]" href="radius.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"><a class="reference internal" href="radius.html">[radius]</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">[chap-secrets]</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#configuration">Configuration</a></li> +<li class="toctree-l3"><a class="reference internal" href="#chap-secrets-file-example">Chap-secrets file example</a></li> +</ul> +</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">[chap-secrets]</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/configuration/chap_secrets.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="chap-secrets"> +<h1>[chap-secrets]<a class="headerlink" href="#chap-secrets" title="Link to this heading"></a></h1> +<p><em>Chap-secret</em> is the module of authentication which works with user authentication data and other data (username, password, ip address, speed etc.) stored as local file. Currently <em>accel-ppp</em> may works only with one of the authentication method, chap-secrets or RADIUS. RADIUS has more priority if set in <code class="docutils literal notranslate"><span class="pre">[modules]</span></code> section. Remove or <em>#comment</em> <code class="docutils literal notranslate"><span class="pre">radius</span></code> from section <code class="docutils literal notranslate"><span class="pre">[modules]</span></code> if you want use <code class="docutils literal notranslate"><span class="pre">chap-secrets</span></code>. Example:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>modules<span class="o">]</span> +chap-secrets +<span class="c1">#radius</span> +</pre></div> +</div> +<section id="configuration"> +<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h2> +<dl> +<dt><strong>chap-secrets=/path/to/file</strong></dt><dd><p>By default is <code class="docutils literal notranslate"><span class="pre">chap-secrets=/etc/ppp/chap-secrets</span></code></p> +<p>Specifies alternate chap-secrets file location.</p> +</dd> +<dt><strong>username-hash=hash1[,hash2]</strong></dt><dd><p>By default is not defined.</p> +<p>Specifies hash chain to calculate username hash. hash1, hash2 are openssl known digest names (md5, sha1, etc). +For example, <code class="docutils literal notranslate"><span class="pre">username-hash=md5,sha1</span></code> means hash username through md5 and then binary result hash through sha1. +Username have to be specified as hexadecimal dump of digest result.Password field have to be encrypted using smbencrypt (NT Hash part).</p> +</dd> +<dt><strong>encrypted=0|1</strong></dt><dd><p>By default is disabled: <code class="docutils literal notranslate"><span class="pre">encrypted=0</span></code></p> +<p>Specifies either chap-secrets is encrypted.</p> +</dd> +</dl> +<div class="admonition-note admonition"> +<p class="admonition-title">Note:</p> +<p>Encryption is incompatible with auth_chap_md5 module.</p> +<p>To enable chap-secrets encryption ablity accel-ppp must be compiled with -DCRYPTO=OPENSSL (which is default).</p> +</div> +<dl> +<dt><strong>gw-ip-address=x.x.x.x[/mask]</strong></dt><dd><p>By default is not defined.</p> +<p>Specifies address to use as local address of ppp interfaces if chap-secrets is used for IP address assignment. Mask is used for IPoE.</p> +</dd> +</dl> +</section> +<section id="chap-secrets-file-example"> +<h2>Chap-secrets file example<a class="headerlink" href="#chap-secrets-file-example" title="Link to this heading"></a></h2> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1">#client server secret ip-address speed</span> +user001<span class="w"> </span>*<span class="w"> </span>password1<span class="w"> </span><span class="m">100</span>.64.100.1<span class="w"> </span><span class="m">20480</span>/10240 +user002<span class="w"> </span>*<span class="w"> </span>passowrd2<span class="w"> </span>*<span class="w"> </span><span class="m">10240</span>/10240 +user003<span class="w"> </span>*<span class="w"> </span>passowrd3<span class="w"> </span>ip_pool1<span class="w"> </span><span class="m">10240</span> +eth0.101<span class="w"> </span>*<span class="w"> </span>eth0.101<span class="w"> </span>ipoe_pool<span class="w"> </span><span class="m">20480</span> +<span class="m">100</span>.64.0.2<span class="w"> </span>*<span class="w"> </span><span class="m">100</span>.64.0.2<span class="w"> </span>* +</pre></div> +</div> +<ul class="simple"> +<li><p>The first column contain <em>username</em>.</p></li> +<li><p>The second column is only keep for support chap secrets files standard.</p></li> +<li><p>The third column contain secret or password.</p></li> +<li><p>The fourth column may contain allocated ip address or pool name which configured in <code class="docutils literal notranslate"><span class="pre">[ip-pool]</span></code> section.</p></li> +<li><p>The fifth column contain rate-limit.</p></li> +</ul> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="radius.html" class="btn btn-neutral float-left" title="[radius]" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="ppp.html" class="btn btn-neutral float-right" title="[ppp]" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© 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>
\ No newline at end of file |