cvs: peardoc /peardoc2/en/pecl radius.xml
| From: | Michael Bretterklieber | Date: | Fri, 27 Dec 2002 15:28:52 +0000 |
| Subject: | cvs: peardoc /peardoc2/en/pecl radius.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-167@lists.php.net to get a copy of this message | ||
mbretter Fri Dec 27 10:28:52 2002 EDT
Modified files:
/peardoc/peardoc2/en/pecl radius.xml
Log:
#some minor corrections
Index: peardoc/peardoc2/en/pecl/radius.xml
diff -u peardoc/peardoc2/en/pecl/radius.xml:1.2 peardoc/peardoc2/en/pecl/radius.xml:1.3
--- peardoc/peardoc2/en/pecl/radius.xml:1.2 Wed Dec 18 10:36:15 2002
+++ peardoc/peardoc2/en/pecl/radius.xml Fri Dec 27 10:28:52 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<reference id="pecl.radius">
<title>Radius</title>
<titleabbrev>radius</titleabbrev>
@@ -31,18 +31,41 @@
Binaries for Windows and Unix can be downloaded from <ulink url="http://www.bretterklieber.com/php">here</ulink>.
</para>
</sect2>
+ <sect2 id="pecl.radius.install">
+ <title>Install</title>
+ <para>
+ Howto install the package?
+ <itemizedlist>
+ <listitem><simpara>untar the package (usualy into
php4/ext)</simpara></listitem>
+ <listitem><simpara>rename radius-x.x to radius</simpara></listitem>
+ <listitem><simpara>run ./buildconf in php4</simpara></listitem>
+ <listitem><simpara>run ./configure
--enable-radius</simpara></listitem>
+ <listitem><simpara>make; make install</simpara></listitem>
+ </itemizedlist>
+ or if you would like to have it as .so:
+ <itemizedlist>
+ <listitem><simpara>untar the package </simpara></listitem>
+ <listitem><simpara>run phpize in the radius-x.x
directory</simpara></listitem>
+ <listitem><simpara>run ./configure in the radius-x.x
directory</simpara></listitem>
+ <listitem><simpara>make; make install</simpara></listitem>
+ </itemizedlist>
+ for windows I recommend to use the php_radius.dll from <ulink url="http://www.bretterklieber.com/php/radius-builds/win32/">here</ulink>
+ </para>
+ </sect2>
<sect2 id="pecl.radius.howtostart">
<title>Quickstart</title>
<para>
Howto start?
<itemizedlist>
- <listitem><simpara>get a radius handle</simpara></listitem>
+ <listitem><simpara>get a radius ressource</simpara></listitem>
<listitem><simpara>configure the library</simpara></listitem>
+ <listitem><simpara>create the request</simpara></listitem>
<listitem><simpara>put attributes</simpara></listitem>
- <listitem><simpara>send request</simpara></listitem>
+ <listitem><simpara>send the request</simpara></listitem>
<listitem><simpara>receive attributes</simpara></listitem>
- <listitem><simpara>close the radius handle</simpara></listitem>
+ <listitem><simpara>close the radius ressource
(optional)</simpara></listitem>
</itemizedlist>
+ Take also a look at the examples in this package.
</para>
<para>
The package contains an example php script. This script demonstrates howto
@@ -50,6 +73,8 @@
MSoft Radius servers then its not possible to use CHAP (md5). If you would like to
authenticate with MSoft Servers you have to use MS-CHAPv1 or MS-CHAPv2, but its
more complicated, because you need md4, sha1 and des to generate the right data.
+ The enclosed examples demonstrate all authentication-methods, including MS-CHAPv1 and
+ MS-CHAPv2. To get the MS-CHAP to work you need the mcrypt and the mhash extension.
</para>
</sect2>
</sect1>
@@ -515,7 +540,7 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns: &true; on success, &false; on error.
+ Returns: Access code, &false; on error.
</para>
<para>
After the Radius request has been constructed, it is sent by
<function>radius_send_request</function>
@@ -841,7 +866,7 @@
Returns: &true;
</para>
<para>
- Its not needed to call this function because php frees all ressources at the end of each
request.
+ Its not needed to call this function because php frees all resources at the end of each
request.
</para>
</refsect1>
</refentry>
@@ -867,7 +892,7 @@
<row><entry>RADIUS_ACCESS_CHALLENGE</entry><entry>-</entry><entry>Accsess
challenge</entry></row>
<row><entry>RADIUS_USER_NAME</entry><entry>string</entry><entry>Username</entry></row>
<row><entry>RADIUS_USER_PASSWORD</entry><entry>string</entry><entry>Password</entry></row>
-
<row><entry>RADIUS_CHAP_PASSWORD</entry><entry>string</entry><entry>Chap
Password. (FYI: chappass = md5(ident + plaintextpass + challenge)</entry></row>
+
<row><entry>RADIUS_CHAP_PASSWORD</entry><entry>string</entry><entry>Chap
Password. FYI: chappass = md5(ident + plaintextpass + challenge)</entry></row>
<row><entry>RADIUS_NAS_IP_ADDRESS</entry><entry>string</entry><entry>NAS
IP-Adress</entry></row>
<row><entry>RADIUS_NAS_PORT</entry><entry>int</entry><entry>NAS
Port</entry></row>
<row><entry>RADIUS_SERVICE_TYPE</entry><entry>int</entry><entry>Type
of Service, one of: RADIUS_LOGIN, RADIUS_FRAMED, RADIUS_CALLBACK_LOGIN,