pfSense

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4: */

/*

    $Id$

    All rights reserved.

    modification, are permitted provided that the following conditions 

       notice, this list of conditions and the following disclaimer in the 

    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 

    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 

    IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 

    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 

    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 

    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 

    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 

    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 

        This version of RADIUS.php has been modified by

        Jonathan De Graeve <jonathan@imelda.be> to integrate with M0n0wall <http://www.m0n0.ch/wall>

        Changes made include:

        * StandardAttributes for M0n0wall use

        * Removed internal Session-Id creation

        * Adding of ReplyMessage to getAttributes()

        * Adding of listAttributes()

        * Adding of VENDOR Bay Networks (Nortel)

        * Adding of VENDOR Nomadix

        * Adding of VENDOR WISPr (Wi-Fi Alliance)

*/

require_once("radius_accounting.inc");

/**

* Client implementation of RADIUS. This are wrapper classes for

*

* @package Auth_RADIUS

* @author  Michael Bretterklieber <michael@bretterklieber.com>

* @access  public

* @version $Revision$

*/

PEAR::loadExtension('radius');

/**

 * class Auth_RADIUS

 *

 * Abstract base class for RADIUS

 *

class Auth_RADIUS extends PEAR {

    /**

     * List of RADIUS servers.

     * @var  array

     * @see  addServer(), putServer()

     */

    var $_servers  = array();

     * Path to the configuration-file.

     * @var  string

     * @see  setConfigFile()

     */

    var $_configfile = null;

     * Resource.

     * @var  resource

     * @see  open(), close()

     */

    var $res = null;

     * Username for authentication and accounting requests.

     * @var  string

     */

    var $username = null;

    /**

     * Password for plaintext-authentication (PAP).

     * @var  string

     */

    var $password = null;

    /**

     * List of known attributes.

     * @var  array

     * @see  dumpAttributes(), getAttributes()

     */

    var $attributes = array();

     * List of raw attributes.

     * @var  array

     * @see  dumpAttributes(), getAttributes()

     */

    var $rawAttributes = array();

    /**

     * List of raw vendor specific attributes.

     * @var  array

     * @see  dumpAttributes(), getAttributes()

     */

     * Constructor

     *

     * Loads the RADIUS PECL/extension

     *

     * @return void

     */

        $this->PEAR();

    }

     * Adds a RADIUS server to the list of servers for requests.

     *

     * are given, they are tried in round-robin fashion until a 

     *

     * @access public

     * @param  string  $servername   Servername or IP-Address

     * @param  integer $port         Portnumber

     * @param  string  $sharedSecret Shared secret

     * @param  integer $timeout      Timeout for each request

     */

     * Returns an error message, if an error occurred.

     *

     * @access public

     * @return string

     */

        return radius_strerror($this->res);

    }

     * Sets the configuration-file.

     *

     * @access public

        $this->_configfile = $file;

    }

    /**

     * Puts an attribute.

     *

     * @access public

     * @param  integer $attrib       Attribute-number

     * @param  mixed   $port         Attribute-value

     * @param  type    $type         Attribute-type

     * @return bool  true on success, false on error

        if ($type == null) {

            $type = gettype($value);

        }

        switch ($type) {

        case 'integer':

            return radius_put_int($this->res, $attrib, (float)$value);

            return radius_put_addr($this->res, $attrib, $value);

        default:

            return radius_put_attr($this->res, $attrib, $value);

        }

    }

     * Puts a vendor-specific attribute.

     *

     * @access public

     * @param  integer $vendor       Vendor (MSoft, Cisco, ...)

     * @param  integer $attrib       Attribute-number

     * @param  mixed   $port         Attribute-value

     * @param  type    $type         Attribute-type

     * @return bool  true on success, false on error

    function putVendorAttribute($vendor, $attrib, $value, $type = null) 

            $type = gettype($value);

        }

        case 'integer':

            return radius_put_vendor_int($this->res, $vendor, $attrib, $value);

            return radius_put_vendor_addr($this->res, $vendor,$attrib, $value);

        default:

            return radius_put_vendor_attr($this->res, $vendor, $attrib, $value);

        }

    }

    /**

     * Prints known attributes received from the server.

     *

     * @access public

    {

        foreach ($this->attributes as $name => $data) {

            echo "$name:$data<br>\n";

        }

    }

    /**

     * Return our know attributes array received from the server.

     *

     * @access public

     */

    function listAttributes()

    {

        return $this->attributes;

    }

    /**

     * @access public

    }

    /**

     * Overwrite this.

     *

     * @access public

    {

    }

     * Puts standard attributes.

     *

     *

    {

        // Add support for sending NAS-IP-Address, set this explicitly as an ip_addr

        $this->putAttribute(RADIUS_NAS_IP_ADDRESS, getNasIP(), "addr");

        // Add support for sending NAS-Identifier

        $this->putAttribute(RADIUS_NAS_IDENTIFIER, getNasID());

     * Puts custom attributes.

     *

     * @access public

    {

        if (isset($this->username)) {

    }

     * Configures the radius library.

     *

     * @access public

     * @param  string  $servername   Servername or IP-Address

     * @param  integer $port         Portnumber

     * @param  string  $sharedSecret Shared secret

     * @param  integer $timeout      Timeout for each request

     * @see addServer()

        if (!radius_add_server($this->res, $servername, $port, $sharedsecret, $timeout, $maxtries)) {

            return false;

        }

        return true;

    }

     * Configures the radius library via external configurationfile

     *

     * @access public

     * @param  string  $servername   Servername or IP-Address

     * @return bool  true on success, false on error

        if (!radius_config($this->res, $file)) {

            return false;

        }

        return true;

     * @access public

     */ 

    {

        if (!$this->open()) {

            return false;

        }

                return false;

            }

        }

            if (!$this->putConfigfile($this->_configfile)) {

                return false;

            }

        }

        return true;

    }

     * Sends a prepared RADIUS request and waits for a response

     *

     * @access public

     * @return mixed  true on success, false on reject, PEAR_Error on error

    {

        $req = radius_send_request($this->res);

        if (!$req) {

            return $this->raiseError('Error sending request: ' . $this->getError());

        }

        switch($req) {

        case RADIUS_ACCESS_ACCEPT:

            if (is_subclass_of($this, 'auth_radius_acct')) {

                return $this->raiseError('RADIUS_ACCESS_ACCEPT is unexpected for accounting');

            }

            return true;

        case RADIUS_ACCESS_REJECT:

            return false;

            if (is_subclass_of($this, 'auth_radius_pap')) {

                return $this->raiseError('RADIUS_ACCOUNTING_RESPONSE is unexpected for authentication');

            }

            return true;

        default:

            return $this->raiseError("Unexpected return value: $req");

    /**

     * Reads all received attributes after sending the request.

     *

     * all attributes (including known attibutes) are stored in rawAttributes

     *

     * @access public

     * @return bool   true on success, false on error

    {

        while ($attrib = radius_get_attr($this->res)) {

            if (!is_array($attrib)) {

                return false;

            $attr = $attrib['attr'];

            $data = $attrib['data'];

            $this->rawAttributes[$attr] = $data;

            switch ($attr) {

            case RADIUS_FRAMED_IP_ADDRESS:

                $this->attributes['framed_ip'] = radius_cvt_addr($data);

                break;

            case RADIUS_FRAMED_IP_NETMASK:

                $this->attributes['framed_mask'] = radius_cvt_addr($data);

                break;

            case RADIUS_FRAMED_MTU:

                $this->attributes['framed_mtu'] = radius_cvt_int($data);

                break;

            case RADIUS_FRAMED_COMPRESSION:

                $this->attributes['framed_compression'] = radius_cvt_int($data);

                break;

            case RADIUS_SESSION_TIMEOUT:

                $this->attributes['session_timeout'] = radius_cvt_int($data);

                break;

            case RADIUS_IDLE_TIMEOUT:

                $this->attributes['idle_timeout'] = radius_cvt_int($data);

                break;

            case RADIUS_SERVICE_TYPE:

                $this->attributes['service_type'] = radius_cvt_int($data);

                break;

            case RADIUS_CLASS:

                $this->attributes['class'] = radius_cvt_int($data);

                break;

            case RADIUS_FRAMED_PROTOCOL:

                $this->attributes['framed_protocol'] = radius_cvt_int($data);

                break;

            case RADIUS_FRAMED_ROUTING:

                $this->attributes['framed_routing'] = radius_cvt_int($data);

                break;

            case RADIUS_FILTER_ID:

                $this->attributes['filter_id'] = radius_cvt_string($data);

                break;

            case RADIUS_REPLY_MESSAGE:

                $this->attributes['reply_message'] = radius_cvt_string($data);

                break;

            case RADIUS_VENDOR_SPECIFIC:

                $attribv = radius_get_vendor_attr($data);

                if (!is_array($attribv)) {

                    return false;

                }

                $attrv = $attribv['attr'];

                $datav = $attribv['data'];

                if ($vendor == RADIUS_VENDOR_MICROSOFT) {

                    switch ($attrv) {

                    case RADIUS_MICROSOFT_MS_CHAP2_SUCCESS:

                        $this->attributes['ms_chap2_success'] = radius_cvt_string($datav);

                        break;

                    case RADIUS_MICROSOFT_MS_CHAP_ERROR:

                        $this->attributes['ms_chap_error'] = radius_cvt_string(substr($datav,1));

                        break;

                    case RADIUS_MICROSOFT_MS_CHAP_DOMAIN:

                        $this->attributes['ms_chap_domain'] = radius_cvt_string($datav);

                        break;

                    case RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY:

                        $this->attributes['ms_mppe_encryption_policy'] = radius_cvt_int($datav);

                        break;

                    case RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES:

                        $this->attributes['ms_mppe_encryption_types'] = radius_cvt_int($datav);

                        break;

                    case RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS:

                        $demangled = radius_demangle($this->res, $datav);

                        $this->attributes['ms_chap_mppe_lm_key'] = substr($demangled, 0, 8);

                        $this->attributes['ms_chap_mppe_nt_key'] = substr($demangled, 8, RADIUS_MPPE_KEY_LEN);

                        break;

                    case RADIUS_MICROSOFT_MS_MPPE_SEND_KEY:

                        $this->attributes['ms_chap_mppe_send_key'] = radius_demangle_mppe_key($this->res, $datav);

                        break;

                    case RADIUS_MICROSOFT_MS_MPPE_RECV_KEY:

                        $this->attributes['ms_chap_mppe_recv_key'] = radius_demangle_mppe_key($this->res, $datav);

                        break;

                    case RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER:

                        $this->attributes['ms_primary_dns_server'] = radius_cvt_string($datav);

                        break;

                    }

                }

                    switch ($attrv) {

                        break;

                    }

                }

                    switch ($attrv) {

                    case 1: /* RADIUS_NOMADIX_BW_UP */

                        $this->attributes['bw_up'] = radius_cvt_int($datav);

                        break;

                    case 2: /* RADIUS_NOMADIX_BW_DOWN */

                        $this->attributes['bw_down'] = radius_cvt_int($datav);

                        break;

                    case 3: /* RADIUS_NOMADIX_URL_REDIRECTION */

                        $this->attributes['url_redirection'] = radius_cvt_string($datav);

                        break;

                    case 5: /* RADIUS_NOMADIX_EXPIRATION */

                        $this->attributes['expiration'] = radius_cvt_string($datav);

                        break;

                    case 7: /* RADIUS_NOMADIX_MAXBYTESUP */

                        $this->attributes['maxbytesup'] = radius_cvt_int($datav);

                        break;

                    case 8: /* RADIUS_NOMADIX_MAXBYTESDOWN */

                        $this->attributes['maxbytesdown'] = radius_cvt_int($datav);

                        break;

                    case 10: /* RADIUS_NOMADIX_LOGOFF_URL */

                        $this->attributes['url_logoff'] = radius_cvt_string($datav);

                        break;

                    }

            switch ($attrv) {

            case 1: /* WISPr-Location-ID */

            $this->attributes['location_id'] = radius_cvt_string($datav);

            break;

            case 2: /* WISPr-Location-Name */

            $this->attributes['location_name'] = radius_cvt_string($datav);

            break;

            case 3: /* WISPr-Logoff-URL */

            $this->attributes['url_logoff'] = radius_cvt_string($datav);

            break;

            case 4: /* WISPr-Redirection-URL */

            $this->attributes['url_redirection'] = radius_cvt_string($datav);

            break;

            case 5: /* WISPr-Bandwidth-Min-Up */

            case 6: /* WISPr-Bandwidth-Min-Down */

            case 7: /* WIPSr-Bandwidth-Max-Up */

            case 8: /* WISPr-Bandwidth-Max-Down */

            case 9: /* WISPr-Session-Terminate-Time */

            $this->attributes['session_terminate_time'] = radius_cvt_string($datav);

            break;

            case 10: /* WISPr-Session-Terminate-End-Of-Day */

            $this->attributes['session_terminate_endofday'] = radius_cvt_int($datav);

            break;

            case 11: /* WISPr-Billing-Class-Of-Service */

            $this->attributes['billing_class_of_service'] = radius_cvt_string($datav);

            break;

           }

        }

                break;

        return true;

    }

     * Frees resources.

     *

     * Calling this method is always a good idea, because all security relevant

     * attributes are filled with Nullbytes to leave nothing in the mem.

     *

     * @access public

    {

        if ($this->res != null) {

            radius_close($this->res);

            $this->res = null;

        }

        $this->username = str_repeat("\0", strlen($this->username));

        $this->password = str_repeat("\0", strlen($this->password));

    }

/**

 * class Auth_RADIUS_PAP

 *

 * Class for authenticating using PAP (Plaintext)

    /**

     * Constructor

     *

     * @param  string  $username   Username

     * @param  string  $password   Password

     * @return void

     */

    function Auth_RADIUS_PAP($username = null, $password = null)

    {

        $this->Auth_RADIUS();

        $this->username = $username;

        $this->password = $password;

    }

     * Creates a RADIUS resource

     *

     * Creates a RADIUS resource for authentication. This should be the first

     * call before you make any other things with the library.

     *

     * @return bool   true on success, false on error

     */

        $this->res = radius_auth_open();

        if (!$this->res) {

            return false;

        }

        return true;

    }

     * Creates an authentication request.

     * You MUST call this method before you can put any attribute

     *

     * @return bool   true on success, false on error

     */

    function createRequest()

    {

        if (!radius_create_request($this->res, RADIUS_ACCESS_REQUEST)) {

            return false;

        }

        return true;

    }

    /**

     * @return void

     */

    function putAuthAttributes()

    {

        if (isset($this->username)) {

        if (isset($this->password)) {

            $this->putAttribute(RADIUS_USER_PASSWORD, $this->password);

        }

    }

}

/**

 * class Auth_RADIUS_CHAP_MD5

 *

 * Class for authenticating using CHAP-MD5 see RFC1994.

class Auth_RADIUS_CHAP_MD5 extends Auth_RADIUS_PAP

{

    /**

     * 8 Bytes binary challenge

     * @var  string

     */

    var $challenge = null;

    /**

     * 16 Bytes MD5 response binary

     * @var  string

     */

    var $response = null;

     * Id of the authentication request. Should incremented after every request.

     * @var  integer

     */

    var $chapid = 1;

     * Constructor

     *

     * @param  string  $username   Username

     * @param  string  $challenge  8 Bytes Challenge (binary)

     * @param  integer $chapid     Requestnumber

     * @return void

     */

    function Auth_RADIUS_CHAP_MD5($username = null, $challenge = null, $chapid = 1)

    {

        $this->Auth_RADIUS_PAP();

        $this->username = $username;

        $this->challenge = $challenge;

        $this->chapid = $chapid;

    }

     * Put CHAP-MD5 specific attributes

     *

     *

     * @return void

     */

    function putAuthAttributes()

    {

        if (isset($this->username)) {

        if (isset($this->response)) {