mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
radius : fix XML by converting para to simpara tags via script
This commit is contained in:
@@ -1,41 +1,39 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<book xml:id="book.radius" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.radius">
|
||||
<?phpdoc extension-membership="pecl" ?>
|
||||
<title>Radius</title>
|
||||
|
||||
|
||||
<!-- {{{ preface -->
|
||||
<preface xml:id="intro.radius">
|
||||
&reftitle.intro;
|
||||
<para>
|
||||
<simpara>
|
||||
This package is based on the libradius (Remote Authentication Dial In User
|
||||
Service) of FreeBSD. It allows clients to perform authentication and
|
||||
accounting by means of network requests to remote servers.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This PECL extension adds full support for Radius Authentication
|
||||
(<link xlink:href="&url.rfc;2865">RFC 2865</link>) and Radius Accounting
|
||||
(<link xlink:href="&url.rfc;2865">RFC 2865</link>) and Radius Accounting
|
||||
(<link xlink:href="&url.rfc;2866">RFC 2866</link>). This package is available
|
||||
for Unix (tested on FreeBSD and Linux) and for Windows.
|
||||
</para>
|
||||
</simpara>
|
||||
<note>
|
||||
<para>
|
||||
<simpara>
|
||||
An exact description for libradius can be found
|
||||
<link xlink:href="&url.libradius;">here</link>. A detailed description of the
|
||||
configuration file can be found <link xlink:href="&url.libradius.conf;">here</link>.
|
||||
</para>
|
||||
</simpara>
|
||||
</note>
|
||||
</preface>
|
||||
<!-- }}} -->
|
||||
|
||||
|
||||
&reference.radius.setup;
|
||||
&reference.radius.constants;
|
||||
&reference.radius.examples;
|
||||
&reference.radius.reference;
|
||||
|
||||
</book>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
@@ -56,4 +54,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<section xml:id="radius.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="radius.installation">
|
||||
&reftitle.install;
|
||||
<para>
|
||||
<simpara>
|
||||
&pecl.moved;
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
&pecl.info;
|
||||
<link xlink:href="&url.pecl.package;radius">&url.pecl.package;radius</link>.
|
||||
</para>
|
||||
</simpara>
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
||||
@@ -21,10 +21,10 @@
|
||||
<section xml:id="radius.constants.options">
|
||||
<title>RADIUS Options</title>
|
||||
|
||||
<para>
|
||||
<simpara>
|
||||
Several RADIUS functions accept option flags as bitmasks. The constants
|
||||
representing those flags are listed below.
|
||||
</para>
|
||||
</simpara>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry xml:id="constant.radius-option-salt">
|
||||
@@ -33,10 +33,10 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
When set, this option will result in the attribute value being
|
||||
salt-encrypted.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-option-tagged">
|
||||
@@ -45,10 +45,10 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
When set, this option will result in the attribute value being tagged
|
||||
with the value of the tag parameter.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -57,12 +57,12 @@
|
||||
<section xml:id="radius.constants.packets">
|
||||
<title>RADIUS Packet Types</title>
|
||||
|
||||
<para>
|
||||
<simpara>
|
||||
RADIUS packets, whether requests or responses, always include a type. These
|
||||
constants are provided to make it easier to specify types when using
|
||||
<function>radius_create_request</function> and when comparing the result of
|
||||
<function>radius_send_request</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry xml:id="constant.radius-access-request">
|
||||
@@ -71,7 +71,7 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Access-Request, used to authenticate a user against a RADIUS server.
|
||||
Access request packets must include a
|
||||
<link linkend="constant.radius-nas-ip-address"><constant>RADIUS_NAS_IP_ADDRESS</constant></link>
|
||||
@@ -85,7 +85,7 @@
|
||||
attribute, and should include a
|
||||
<link linkend="constant.radius-user-name"><constant>RADIUS_USER_NAME</constant></link>
|
||||
attribute.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-access-accept">
|
||||
@@ -94,10 +94,10 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Access-Accept response to an Access-Request indicating that the
|
||||
RADIUS server authenticated the user successfully.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-access-reject">
|
||||
@@ -106,10 +106,10 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Access-Reject response to an Access-Request indicating that the
|
||||
RADIUS server could not authenticate the user.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-access-challenge">
|
||||
@@ -118,11 +118,11 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Access-Challenge response to an Access-Request indicating that the
|
||||
RADIUS server requires further information in another Access-Request
|
||||
before authenticating the user.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-accounting-request">
|
||||
@@ -131,10 +131,10 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Accounting-Request, used to convey accounting information for a
|
||||
service to the RADIUS server.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-accounting-response">
|
||||
@@ -143,9 +143,9 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An Accounting-Response response to an Accounting-Request.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-coa-request">
|
||||
@@ -154,14 +154,14 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A CoA-Request, sent from the RADIUS server to indicate that the
|
||||
authorisations within the user session have changed. A response must be
|
||||
sent in the form of a CoA-ACK or a CoA-NAK.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-coa-ack">
|
||||
@@ -170,13 +170,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A CoA-ACK, sent to the RADIUS server to indicate that the user
|
||||
authorisations have been updated.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-coa-nak">
|
||||
@@ -185,13 +185,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A CoA-NAK, sent to the RADIUS server to indicate that the user
|
||||
authorisations could not be updated.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-disconnect-request">
|
||||
@@ -200,13 +200,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A Disconnect-Request, sent from the RADIUS server to indicate that the
|
||||
user session must be terminated.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-disconnect-ack">
|
||||
@@ -215,13 +215,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A Disconnect-ACK, sent to the RADIUS server to indicate that the user
|
||||
session has been terminated.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-disconnect-nak">
|
||||
@@ -230,13 +230,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
A Disconnect-NAK, sent to the RADIUS server to indicate that the user
|
||||
session could not be terminated.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is available in PECL radius 1.3.0 and later.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -245,12 +245,12 @@
|
||||
<section xml:id="radius.constants.attributes">
|
||||
<title>RADIUS Attribute Types</title>
|
||||
|
||||
<para>
|
||||
<simpara>
|
||||
These constants define RADIUS attribute types that can be used with
|
||||
<function>radius_put_addr</function>, <function>radius_put_attr</function>,
|
||||
<function>radius_put_int</function> and
|
||||
<function>radius_put_string</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry xml:id="constant.radius-user-name">
|
||||
@@ -259,11 +259,11 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The User-Name attribute. The attribute value is expected to be a
|
||||
<type>string</type> containing the name of the user being authenticated,
|
||||
and can be set using <function>radius_put_attr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-user-password">
|
||||
@@ -272,13 +272,13 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The User-Password attribute. The attribute value is expected to be a
|
||||
<type>string</type> containing the user's password, and can be set using
|
||||
<function>radius_put_attr</function>. This value will be obfuscated on
|
||||
transmission as described in
|
||||
<link xlink:href="&url.rfc;2865">section 5.2 of RFC 2865</link>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-chap-password">
|
||||
@@ -287,7 +287,7 @@
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Chap-Password attribute. The attribute value is expected to be a
|
||||
<type>string</type> with the first byte containing the CHAP identifier,
|
||||
and the subsequent 16 bytes containing the MD5 hash of the CHAP
|
||||
@@ -296,7 +296,7 @@
|
||||
sent separately in a
|
||||
<link linkend="constant.radius-chap-challenge"><constant>RADIUS_CHAP_CHALLENGE</constant></link>
|
||||
attribute.
|
||||
</para>
|
||||
</simpara>
|
||||
<example>
|
||||
<title>Using CHAP passwords</title>
|
||||
<programlisting role="php">
|
||||
@@ -336,11 +336,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The NAS-IP-Address attribute. The attribute value is expected to the IP
|
||||
address of the RADIUS client encoded as an <type>int</type>, which
|
||||
can be set using <function>radius_put_addr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-nas-port">
|
||||
@@ -349,12 +349,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The NAS-Port attribute. The attribute value is expected to be the
|
||||
physical port of the user on the RADIUS client encoded as an
|
||||
<type>int</type>, which can be set using
|
||||
<function>radius_put_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-service-type">
|
||||
@@ -363,12 +363,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Service-Type attribute. The attribute value indicates the service
|
||||
type the user is requesting, and is expected to be an
|
||||
<type>int</type>, which can be set using
|
||||
<function>radius_put_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
<para>
|
||||
A number of constants are provided to represent the possible values of
|
||||
this attribute. They include:
|
||||
@@ -413,12 +413,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-IP-Address attribute. The attribute value is expected to be
|
||||
the address of the user's network encoded as an <type>int</type>,
|
||||
which can be set using <function>radius_put_addr</function> and
|
||||
retrieved using <function>radius_cvt_addr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-ip-netmask">
|
||||
@@ -427,12 +427,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-IP-Netmask attribute. The attribute value is expected to be
|
||||
the netmask of the user's network encoded as an <type>int</type>,
|
||||
which can be set using <function>radius_put_addr</function> and
|
||||
retrieved using <function>radius_cvt_addr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-routing">
|
||||
@@ -441,11 +441,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-Routing attribute. The attribute value is expected to be an
|
||||
<type>int</type> indicating the routing method for the user, which
|
||||
can be set using <function>radius_put_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
<para>
|
||||
Possible values include:
|
||||
<simplelist>
|
||||
@@ -463,11 +463,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Filter-ID attribute. The attribute value is expected to be an
|
||||
implementation-specific, human-readable <type>string</type> of filters,
|
||||
which can be set using <function>radius_put_attr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-mtu">
|
||||
@@ -476,11 +476,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-MTU attribute. The attribute value is expected to be an
|
||||
<type>int</type> indicating the MTU to be configured for the user,
|
||||
and can be set using <function>radius_put_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-compression">
|
||||
@@ -512,11 +512,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Login-IP-Host attribute. The attribute value is expected to the IP
|
||||
address to connect the user to, encoded as an <type>int</type>,
|
||||
which can be set using <function>radius_put_addr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-service">
|
||||
@@ -525,12 +525,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Login-Service attribute. The attribute value is an
|
||||
<type>int</type> indicating the service to connect the user to on
|
||||
the login host. The value can be converted to a PHP integer via
|
||||
<function>radius_cvt_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-tcp-port">
|
||||
@@ -539,12 +539,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Login-TCP-Port attribute. The attribute value is an
|
||||
<type>int</type> indicating the port to connect the user to on the
|
||||
login host. The value can be converted to a PHP integer via
|
||||
<function>radius_cvt_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-reply-message">
|
||||
@@ -553,11 +553,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Reply-Message attribute. The attribute value is a
|
||||
<type>string</type> containing text that may be displayed to the user in
|
||||
response to an access request.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-callback-number">
|
||||
@@ -566,10 +566,10 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Callback-Number attribute. The attribute value is a
|
||||
<type>string</type> containing the dialing string to use for callback.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-callback-id">
|
||||
@@ -578,10 +578,10 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Callback-Id attribute. The attribute value is a <type>string</type>
|
||||
containing an implementation-specific name of the place to be called.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-route">
|
||||
@@ -590,11 +590,11 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-Route attribute. The attribute value is a <type>string</type>
|
||||
containing an implementation-specific set of routes to be configured for
|
||||
the user.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-ipx-network">
|
||||
@@ -603,13 +603,13 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Framed-IPX-Network attribute. The attribute value is an
|
||||
<type>int</type> containing the IPX network to be configured for the
|
||||
user, or <literal>0xFFFFFFFE</literal> to indicate that the RADIUS
|
||||
client should select the network, and can be accessed via
|
||||
<function>radius_cvt_int</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-state">
|
||||
@@ -618,12 +618,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The State attribute. The attribute value is an implementation-defined
|
||||
<type>string</type> included in an Access-Challenge from a server that
|
||||
must be included in the subsequent Access-Request, and can be set using
|
||||
<function>radius_put_attr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-class">
|
||||
@@ -632,12 +632,12 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Class attribute. The attribute value is an arbitrary
|
||||
<type>string</type> included in an Access-Accept message that should
|
||||
then be sent to the accounting server in Accounting-Request messages,
|
||||
and can be set using <function>radius_put_attr</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-vendor-specific">
|
||||
@@ -646,20 +646,20 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The Vendor-Specific attribute. In general, vendor attribute values
|
||||
should be set using <function>radius_put_vendor_addr</function>,
|
||||
<function>radius_put_vendor_attr</function>,
|
||||
<function>radius_put_vendor_int</function> and
|
||||
<function>radius_put_vendor_string</function>, rather than directly.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
This constant is mostly useful when interpreting vendor specific
|
||||
attributes in responses from a RADIUS server; when a vendor specific
|
||||
attribute is received, the <function>radius_get_vendor_attr</function>
|
||||
function should be used to access the vendor ID, attribute type and
|
||||
attribute value.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-session-timeout">
|
||||
@@ -668,9 +668,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Session timeout
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-idle-timeout">
|
||||
@@ -679,9 +679,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Idle timeout
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-termination-action">
|
||||
@@ -690,9 +690,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Termination action
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-called-station-id">
|
||||
@@ -701,9 +701,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Called Station Id
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-calling-station-id">
|
||||
@@ -712,9 +712,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Calling Station Id
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-nas-identifier">
|
||||
@@ -723,9 +723,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
NAS ID
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-proxy-state">
|
||||
@@ -734,9 +734,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Proxy State
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-lat-service">
|
||||
@@ -745,9 +745,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Login LAT Service
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-lat-node">
|
||||
@@ -756,9 +756,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Login LAT Node
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-lat-group">
|
||||
@@ -767,9 +767,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Login LAT Group
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-appletalk-link">
|
||||
@@ -778,9 +778,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Framed Appletalk Link
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-appletalk-network">
|
||||
@@ -789,9 +789,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Framed Appletalk Network
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-framed-appletalk-zone">
|
||||
@@ -800,9 +800,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Framed Appletalk Zone
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-chap-challenge">
|
||||
@@ -811,9 +811,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Challenge
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-nas-port-type">
|
||||
@@ -855,9 +855,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Port Limit
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-login-lat-port">
|
||||
@@ -866,9 +866,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Login LAT Port
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-connect-info">
|
||||
@@ -877,9 +877,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Connect info
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-status-type">
|
||||
@@ -905,9 +905,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting delay time
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-input-octets">
|
||||
@@ -916,9 +916,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting input bytes
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-output-octets">
|
||||
@@ -927,9 +927,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting output bytes
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-session-id">
|
||||
@@ -938,9 +938,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting session ID
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-authentic">
|
||||
@@ -965,9 +965,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting session time
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-input-packets">
|
||||
@@ -976,9 +976,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting input packets
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-output-packets">
|
||||
@@ -987,9 +987,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting output packets
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-terminate-cause">
|
||||
@@ -1029,9 +1029,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting multi session ID
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="constant.radius-acct-link-count">
|
||||
@@ -1040,9 +1040,9 @@ radius_put_attr($radh, RADIUS_CHAP_CHALLENGE, $challenge);
|
||||
(<type>int</type>)
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Accounting link count
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
|
||||
<chapter xml:id="radius.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="radius.examples">
|
||||
&reftitle.examples;
|
||||
<!-- FIXME: Copy&paste the examples from this "package" -->
|
||||
<para>
|
||||
@@ -9,17 +8,17 @@
|
||||
<itemizedlist>
|
||||
<listitem><simpara>get a radius resource</simpara></listitem>
|
||||
<listitem><simpara>configure the library</simpara></listitem>
|
||||
<listitem><simpara>create the request</simpara></listitem>
|
||||
<listitem><simpara>create the request</simpara></listitem>
|
||||
<listitem><simpara>put attributes</simpara></listitem>
|
||||
<listitem><simpara>send the request</simpara></listitem>
|
||||
<listitem><simpara>receive attributes</simpara></listitem>
|
||||
<listitem><simpara>receive attributes</simpara></listitem>
|
||||
<listitem><simpara>close the radius resource (optional)</simpara></listitem>
|
||||
</itemizedlist>
|
||||
Take also a look at the examples in this package.
|
||||
</para>
|
||||
<para>
|
||||
<simpara>
|
||||
The package contains an example php script. This script demonstrates howto
|
||||
authenticate with radius using PAP or CHAP (md5). If you authenticate with
|
||||
authenticate with radius using PAP or CHAP (md5). If you authenticate with
|
||||
Microsoft Radius servers then its not possible to use CHAP (md5). If you
|
||||
would like to authenticate with Microsoft Servers you have to use
|
||||
MS-CHAPv1 or MS-CHAPv2, but its more complicated, because you need md4,
|
||||
@@ -28,9 +27,8 @@
|
||||
MS-CHAP to work you need the <link linkend="ref.mcrypt">mcrypt</link> and
|
||||
the <link linkend="ref.mhash">mhash</link> extension, starting with
|
||||
version 1.2 of the package, the mcrypt extension is no longer needed.
|
||||
</para>
|
||||
</simpara>
|
||||
</chapter>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
@@ -50,4 +48,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
|
||||
vim: et tw=78 syn=sgml
|
||||
vi: ts=1 sw=1
|
||||
-->
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@
|
||||
<type>resource</type><methodname>radius_acct_open</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -24,10 +24,10 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns a handle on success, &false; on error. This function only fails if
|
||||
insufficient memory is available.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -18,13 +18,13 @@
|
||||
<methodparam><type>int</type><parameter>timeout</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>max_tries</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
<function>radius_add_server</function> may be called multiple times, and it
|
||||
may be used together with <function>radius_config</function>. At most 10
|
||||
servers may be specified. When multiple servers are given, they are tried
|
||||
in round-robin fashion until a valid response is received, or until each
|
||||
server's <parameter>max_tries</parameter> limit has been reached.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -33,18 +33,18 @@
|
||||
<varlistentry>
|
||||
<term><parameter>radius_handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>hostname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The <parameter>hostname</parameter> parameter specifies the server host,
|
||||
either as a fully qualified domain name or as a dotted-quad IP address
|
||||
in text form.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@@ -64,29 +64,29 @@
|
||||
<varlistentry>
|
||||
<term><parameter>secret</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The shared secret for the server host is passed to the
|
||||
<parameter>secret</parameter> parameter. The Radius protocol ignores
|
||||
all but the leading 128 bytes of the shared secret.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>timeout</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The timeout for receiving replies from the server is passed to the
|
||||
<parameter>timeout</parameter> parameter, in units of seconds.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>max_tries</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The maximum number of repeated requests to make before giving up is
|
||||
passed into the <parameter>max_tries</parameter>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -94,9 +94,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,8 +13,8 @@
|
||||
<type>resource</type><methodname>radius_auth_open</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
</para>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -24,10 +24,10 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns a handle on success, &false; on error. This function only fails if
|
||||
insufficient memory is available.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,10 +13,10 @@
|
||||
<type>bool</type><methodname>radius_close</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
It is not needed to call this function because php frees all resources at
|
||||
the end of each request.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -28,9 +28,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
||||
@@ -14,13 +14,13 @@
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>file</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Before issuing any Radius requests, the library must be made aware of the
|
||||
servers it can contact. The easiest way to configure the library is to
|
||||
call <function>radius_config</function>. <function>radius_config</function>
|
||||
causes the library to read a configuration file whose format is described
|
||||
in <link xlink:href="&url.libradius.conf;">radius.conf</link>.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -29,20 +29,20 @@
|
||||
<varlistentry>
|
||||
<term><parameter>radius_handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>file</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The pathname of the configuration file is passed as the file argument
|
||||
to <function>radius_config</function>. The library can also be
|
||||
configured programmatically by calls to
|
||||
<function>radius_add_server</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -50,9 +50,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
|
||||
@@ -14,11 +14,11 @@
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>type</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
A Radius request consists of a code specifying the kind of request, and
|
||||
zero or more attributes which provide additional information. To begin
|
||||
constructing a new request, call <function>radius_create_request</function>.
|
||||
</para>
|
||||
</simpara>
|
||||
<note>
|
||||
<simpara>
|
||||
Attention: You must call this function, before you can put any attribute!
|
||||
@@ -32,17 +32,17 @@
|
||||
<varlistentry>
|
||||
<term><parameter>radius_handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
</para>
|
||||
<simpara>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>type</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Type is <constant>RADIUS_ACCESS_REQUEST</constant> or
|
||||
<constant>RADIUS_ACCOUNTING_REQUEST</constant>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -50,9 +50,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,9 +13,9 @@
|
||||
<type>string</type><methodname>radius_cvt_addr</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Converts raw data to IP-Address
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -24,9 +24,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Input data
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -34,9 +34,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the IP-Address.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,9 +13,9 @@
|
||||
<type>int</type><methodname>radius_cvt_int</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Converts raw data to integer
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -24,9 +24,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Input data
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -34,9 +34,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the integer, retrieved from data.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,9 +13,9 @@
|
||||
<type>string</type><methodname>radius_cvt_string</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Converts raw data to string
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -24,9 +24,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Input data
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -34,9 +34,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the string, retrieved from data.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>mangled</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
When using MPPE with MS-CHAPv2, the send- and recv-keys are mangled
|
||||
(see <link xlink:href="&url.rfc;2548">RFC 2548</link>), however this function is
|
||||
useless, because I don't think that there is or will be a PPTP-MPPE
|
||||
implementation in PHP.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -29,9 +29,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>mangled</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The mangled data to demangle
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -39,9 +39,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the demangled string, or &false; on error.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
||||
@@ -14,10 +14,10 @@
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>mangled</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Some data (Passwords, MS-CHAPv1 MPPE-Keys) is mangled for security reasons,
|
||||
and must be demangled before you can use them.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -27,9 +27,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>mangled</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The mangled data to demangle
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -37,9 +37,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the demangled string, or &false; on error.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
||||
@@ -13,14 +13,14 @@
|
||||
<type>mixed</type><methodname>radius_get_attr</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Like Radius requests, each response may contain zero or more attributes.
|
||||
After a response has been received successfully by
|
||||
<function>radius_send_request</function>, its attributes can be extracted
|
||||
one by one using <function>radius_get_attr</function>. Each time
|
||||
<function>radius_get_attr</function> is called, it gets the next attribute
|
||||
from the current response.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -32,10 +32,10 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns an associative array containing the attribute-type and the data, or
|
||||
error number <= 0.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -12,12 +12,12 @@
|
||||
<type class="union"><type>string</type><type>false</type></type><methodname>radius_get_tagged_attr_data</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
If a tagged attribute has been returned from
|
||||
<function>radius_get_attr</function>,
|
||||
<function>radius_get_tagged_attr_data</function> will return the data from
|
||||
the attribute.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -26,9 +26,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The tagged attribute to be decoded.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -36,9 +36,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the data from the tagged attribute &return.falseforfailure;.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -12,12 +12,12 @@
|
||||
<type class="union"><type>int</type><type>false</type></type><methodname>radius_get_tagged_attr_tag</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
If a tagged attribute has been returned from
|
||||
<function>radius_get_attr</function>,
|
||||
<function>radius_get_tagged_attr_data</function> will return the tag from
|
||||
the attribute.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -26,9 +26,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The tagged attribute to be decoded.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -36,9 +36,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the tag from the tagged attribute &return.falseforfailure;.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -13,12 +13,12 @@
|
||||
<type>array</type><methodname>radius_get_vendor_attr</methodname>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
If <function>radius_get_attr</function> returns
|
||||
<constant>RADIUS_VENDOR_SPECIFIC</constant>,
|
||||
<function>radius_get_vendor_attr</function> may be called to determine the
|
||||
vendor.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -27,9 +27,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
Input data
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -37,10 +37,10 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns an associative array containing the attribute-type, vendor and the
|
||||
data, or &false; on error.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
||||
@@ -17,9 +17,9 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches an IP address attribute to the current RADIUS request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -31,9 +31,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>addr</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An IPv4 address in string form, such as <literal>10.0.0.1</literal>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -43,9 +43,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -17,9 +17,9 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches a binary attribute to the current RADIUS request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -31,9 +31,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value, which will be treated as a raw binary string.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -43,9 +43,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -17,9 +17,9 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches an integer attribute to the current RADIUS request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -31,9 +31,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -43,9 +43,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -17,11 +17,11 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches a string attribute to the current RADIUS request. In general,
|
||||
<function>radius_put_attr</function> is a more useful function for
|
||||
attaching string attributes, as it is binary safe.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -33,10 +33,10 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value. This value is expected by the underlying library
|
||||
to be null terminated, therefore this parameter is not binary safe.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -46,9 +46,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -16,10 +16,10 @@
|
||||
<methodparam><type>int</type><parameter>type</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>addr</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches an IP address vendor specific attribute to the current RADIUS
|
||||
request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -32,9 +32,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>addr</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
An IPv4 address in string form, such as <literal>10.0.0.1</literal>.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -44,9 +44,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -18,9 +18,9 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches a vendor specific binary attribute to the current RADIUS request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -33,9 +33,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value, which will be treated as a raw binary string.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -45,9 +45,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -18,9 +18,9 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches a vendor specific integer attribute to the current RADIUS request.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -33,9 +33,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -45,9 +45,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -18,11 +18,11 @@
|
||||
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>tag</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Attaches a vendor specific string attribute to the current RADIUS request.
|
||||
In general, <function>radius_put_vendor_attr</function> is a more useful
|
||||
function for attaching string attributes, as it is binary safe.
|
||||
</para>
|
||||
</simpara>
|
||||
&radius.request.required;
|
||||
</refsect1>
|
||||
|
||||
@@ -35,10 +35,10 @@
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The attribute value. This value is expected by the underlying library
|
||||
to be null terminated, therefore this parameter is not binary safe.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
&radius.parameter.options;
|
||||
@@ -48,9 +48,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
&return.success;
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
|
||||
@@ -13,10 +13,10 @@
|
||||
<type>string</type><methodname>radius_request_authenticator</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
The request authenticator is needed for demangling mangled data like
|
||||
passwords and encryption-keys.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -28,9 +28,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the request authenticator as string, or &false; on error.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
|
||||
@@ -13,15 +13,15 @@
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>data</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
Applies the RADIUS salt-encryption algorithm to the given value.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
In general, this is achieved automatically by providing the
|
||||
<constant>RADIUS_OPTION_SALT</constant> option to an attribute setter
|
||||
function, but this function can be used if low-level request construction
|
||||
is required.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -30,9 +30,9 @@
|
||||
<varlistentry>
|
||||
<term><parameter>data</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<simpara>
|
||||
The data to be salt-encrypted.
|
||||
</para>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -40,9 +40,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the salt-encrypted data &return.falseforfailure;.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
|
||||
@@ -13,15 +13,15 @@
|
||||
<type>int</type><methodname>radius_send_request</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
After the Radius request has been constructed, it is sent by
|
||||
<function>radius_send_request</function>.
|
||||
</para>
|
||||
<para>
|
||||
</simpara>
|
||||
<simpara>
|
||||
The <function>radius_send_request</function> function sends the request and
|
||||
waits for a valid reply, retrying the defined servers in round-robin
|
||||
fashion as necessary.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -33,14 +33,14 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
If a valid response is received, <function>radius_send_request</function>
|
||||
returns the Radius code which specifies the type of the response. This will
|
||||
typically be <constant>RADIUS_ACCESS_ACCEPT</constant>,
|
||||
<constant>RADIUS_ACCESS_REJECT</constant>, or
|
||||
<constant>RADIUS_ACCESS_CHALLENGE</constant>. If no valid response is
|
||||
received, <function>radius_send_request</function> returns &false;.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
|
||||
@@ -13,10 +13,10 @@
|
||||
<type>string</type><methodname>radius_server_secret</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
The shared secret is needed as salt for demangling mangled data like
|
||||
passwords and encryption-keys.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -28,9 +28,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns the server's shared secret as string, or &false; on error.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
||||
@@ -13,10 +13,10 @@
|
||||
<type>string</type><methodname>radius_strerror</methodname>
|
||||
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<simpara>
|
||||
If Radius-functions fail then they record an error message. This error
|
||||
message can be retrieved with this function.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
@@ -28,9 +28,9 @@
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<simpara>
|
||||
Returns error messages as string from failed radius functions.
|
||||
</para>
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
<!-- Keep this comment at the end of the file
|
||||
|
||||
Reference in New Issue
Block a user