captiveportal.CHAP.inc 12.3 KB
Newer Older
Ad Schellevis's avatar
Ad Schellevis committed
1 2 3 4
<?php
/*
Copyright (c) 2002-2010, Michael Bretterklieber <michael@bretterklieber.com>
All rights reserved.
5 6 7

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
Ad Schellevis's avatar
Ad Schellevis committed
8
are met:
9 10

1. Redistributions of source code must retain the above copyright
Ad Schellevis's avatar
Ad Schellevis committed
11
   notice, this list of conditions and the following disclaimer.
12 13
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
Ad Schellevis's avatar
Ad Schellevis committed
14
   documentation and/or other materials provided with the distribution.
15
3. The names of the authors may not be used to endorse or promote products
Ad Schellevis's avatar
Ad Schellevis committed
16
   derived from this software without specific prior written permission.
17 18 19 20 21 22 23 24 25 26

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
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,
Ad Schellevis's avatar
Ad Schellevis committed
27
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 29

This code cannot simply be copied and put under the GNU Public License or
Ad Schellevis's avatar
Ad Schellevis committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
any other GPL-like (LGPL, GPL2) License.

    $Id: CHAP.php 302857 2010-08-28 21:12:59Z mbretter $
*/

require_once 'PEAR.inc';

/**
* Classes for generating packets for various CHAP Protocols:
* CHAP-MD5: RFC1994
* MS-CHAPv1: RFC2433
* MS-CHAPv2: RFC2759
*
* @package Crypt_CHAP
* @author  Michael Bretterklieber <michael@bretterklieber.com>
* @access  public
* @version $Revision: 302857 $
*/

/**
 * class Crypt_CHAP
 *
 * Abstract base class for CHAP
 *
54
 * @package Crypt_CHAP
Ad Schellevis's avatar
Ad Schellevis committed
55
 */
56
class Crypt_CHAP extends PEAR
Ad Schellevis's avatar
Ad Schellevis committed
57 58 59 60 61 62 63 64 65 66 67
{
    /**
     * Random binary challenge
     * @var  string
     */
    var $challenge = null;

    /**
     * Binary response
     * @var  string
     */
68
    var $response = null;
Ad Schellevis's avatar
Ad Schellevis committed
69 70 71 72 73 74 75 76 77 78 79 80

    /**
     * User password
     * @var  string
     */
    var $password = null;

    /**
     * Id of the authentication request. Should incremented after every request.
     * @var  integer
     */
    var $chapid = 1;
81

Ad Schellevis's avatar
Ad Schellevis committed
82 83 84 85 86 87 88 89 90 91 92
    /**
     * Constructor
     *
     * Generates a random challenge
     * @return void
     */
    function Crypt_CHAP()
    {
        $this->PEAR();
        $this->generateChallenge();
    }
93

Ad Schellevis's avatar
Ad Schellevis committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    /**
     * Generates a random binary challenge
     *
     * @param  string  $varname  Name of the property
     * @param  integer $size     Size of the challenge in Bytes
     * @return void
     */
    function generateChallenge($varname = 'challenge', $size = 8)
    {
        $this->$varname = '';
        for ($i = 0; $i < $size; $i++) {
            $this->$varname .= pack('C', 1 + mt_rand() % 255);
        }
        return $this->$varname;
    }

    /**
     * Generates the response. Overwrite this.
     *
     * @return void
114
     */
Ad Schellevis's avatar
Ad Schellevis committed
115 116 117
    function challengeResponse()
    {
    }
118

Ad Schellevis's avatar
Ad Schellevis committed
119 120 121 122 123 124 125
}

/**
 * class Crypt_CHAP_MD5
 *
 * Generate CHAP-MD5 Packets
 *
126
 * @package Crypt_CHAP
Ad Schellevis's avatar
Ad Schellevis committed
127
 */
128
class Crypt_CHAP_MD5 extends Crypt_CHAP
Ad Schellevis's avatar
Ad Schellevis committed
129 130 131 132 133 134 135 136 137
{

    /**
     * Generates the response.
     *
     * CHAP-MD5 uses MD5-Hash for generating the response. The Hash consists
     * of the chapid, the plaintext password and the challenge.
     *
     * @return string
138
     */
Ad Schellevis's avatar
Ad Schellevis committed
139 140 141 142 143 144 145 146 147 148 149
    function challengeResponse()
    {
        return pack('H*', md5(pack('C', $this->chapid) . $this->password . $this->challenge));
    }
}

/**
 * class Crypt_CHAP_MSv1
 *
 * Generate MS-CHAPv1 Packets. MS-CHAP doesen't use the plaintext password, it uses the
 * NT-HASH wich is stored in the SAM-Database or in the smbpasswd, if you are using samba.
150
 * The NT-HASH is MD4(str2unicode(plaintextpass)).
Ad Schellevis's avatar
Ad Schellevis committed
151
 * You need the hash extension for this class.
152 153
 *
 * @package Crypt_CHAP
Ad Schellevis's avatar
Ad Schellevis committed
154 155 156 157 158 159 160 161 162
 */
class Crypt_CHAP_MSv1 extends Crypt_CHAP
{
    /**
     * Wether using deprecated LM-Responses or not.
     * 0 = use LM-Response, 1 = use NT-Response
     * @var  bool
     */
    var $flags = 1;
163

Ad Schellevis's avatar
Ad Schellevis committed
164 165 166 167 168 169 170 171 172
    /**
     * Constructor
     *
     * Loads the hash extension
     * @return void
     */
    function Crypt_CHAP_MSv1()
    {
        $this->Crypt_CHAP();
173
        self::loadExtension('hash');
Ad Schellevis's avatar
Ad Schellevis committed
174
    }
175

Ad Schellevis's avatar
Ad Schellevis committed
176 177 178 179 180 181
    /**
     * Generates the NT-HASH from the given plaintext password.
     *
     * @access public
     * @return string
     */
182
    function ntPasswordHash($password = null)
Ad Schellevis's avatar
Ad Schellevis committed
183 184 185 186 187 188 189
    {
        if (isset($password)) {
            return pack('H*',hash('md4', $this->str2unicode($password)));
        } else {
            return pack('H*',hash('md4', $this->str2unicode($this->password)));
        }
    }
190

Ad Schellevis's avatar
Ad Schellevis committed
191 192 193 194 195 196
    /**
     * Converts ascii to unicode.
     *
     * @access public
     * @return string
     */
197
    function str2unicode($str)
Ad Schellevis's avatar
Ad Schellevis committed
198 199 200 201 202 203 204 205
    {
        $uni = '';
        $str = (string) $str;
        for ($i = 0; $i < strlen($str); $i++) {
            $a = ord($str{$i}) << 8;
            $uni .= sprintf("%X", $a);
        }
        return pack('H*', $uni);
206 207
    }

Ad Schellevis's avatar
Ad Schellevis committed
208
    /**
209
     * Generates the NT-Response.
Ad Schellevis's avatar
Ad Schellevis committed
210 211 212
     *
     * @access public
     * @return string
213 214
     */
    function challengeResponse()
Ad Schellevis's avatar
Ad Schellevis committed
215 216 217
    {
        return $this->_challengeResponse();
    }
218

Ad Schellevis's avatar
Ad Schellevis committed
219
    /**
220
     * Generates the NT-Response.
Ad Schellevis's avatar
Ad Schellevis committed
221 222 223
     *
     * @access public
     * @return string
224 225
     */
    function ntChallengeResponse()
Ad Schellevis's avatar
Ad Schellevis committed
226 227
    {
        return $this->_challengeResponse(false);
228 229
    }

Ad Schellevis's avatar
Ad Schellevis committed
230
    /**
231
     * Generates the LAN-Manager-Response.
Ad Schellevis's avatar
Ad Schellevis committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
     *
     * @access public
     * @return string
     */
    function lmChallengeResponse()
    {
        return $this->_challengeResponse(true);
    }

    /**
     * Generates the response.
     *
     * Generates the response using DES.
     *
     * @param  bool  $lm  wether generating LAN-Manager-Response
     * @access private
     * @return string
     */
    function _challengeResponse($lm = false)
    {
        if ($lm) {
            $hash = $this->lmPasswordHash();
        } else {
            $hash = $this->ntPasswordHash();
        }

        while (strlen($hash) < 21) {
            $hash .= "\0";
        }

        $td = mcrypt_module_open(MCRYPT_DES, '', MCRYPT_MODE_ECB, '');
        $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND);
        $key = $this->_desAddParity(substr($hash, 0, 7));
        mcrypt_generic_init($td, $key, $iv);
        $resp1 = mcrypt_generic($td, $this->challenge);
        mcrypt_generic_deinit($td);

        $key = $this->_desAddParity(substr($hash, 7, 7));
        mcrypt_generic_init($td, $key, $iv);
        $resp2 = mcrypt_generic($td, $this->challenge);
        mcrypt_generic_deinit($td);

        $key = $this->_desAddParity(substr($hash, 14, 7));
        mcrypt_generic_init($td, $key, $iv);
        $resp3 = mcrypt_generic($td, $this->challenge);
        mcrypt_generic_deinit($td);
        mcrypt_module_close($td);

        return $resp1 . $resp2 . $resp3;
    }

    /**
     * Generates the LAN-Manager-HASH from the given plaintext password.
     *
     * @access public
     * @return string
     */
    function lmPasswordHash($password = null)
    {
        $plain = isset($password) ? $password : $this->password;

        $plain = substr(strtoupper($plain), 0, 14);
        while (strlen($plain) < 14) {
             $plain .= "\0";
        }

        return $this->_desHash(substr($plain, 0, 7)) . $this->_desHash(substr($plain, 7, 7));
    }

    /**
     * Generates an irreversible HASH.
     *
     * @access private
     * @return string
     */
    function _desHash($plain)
    {
        $key = $this->_desAddParity($plain);
        $td = mcrypt_module_open(MCRYPT_DES, '', MCRYPT_MODE_ECB, '');
        $iv = mcrypt_create_iv (mcrypt_enc_get_iv_size($td), MCRYPT_RAND);
        mcrypt_generic_init($td, $key, $iv);
        $hash = mcrypt_generic($td, 'KGS!@#$%');
        mcrypt_generic_deinit($td);
        mcrypt_module_close($td);
        return $hash;
    }

    /**
     * Adds the parity bit to the given DES key.
     *
     * @access private
     * @param  string  $key 7-Bytes Key without parity
     * @return string
     */
    function _desAddParity($key)
    {
        static $odd_parity = array(
                1,  1,  2,  2,  4,  4,  7,  7,  8,  8, 11, 11, 13, 13, 14, 14,
                16, 16, 19, 19, 21, 21, 22, 22, 25, 25, 26, 26, 28, 28, 31, 31,
                32, 32, 35, 35, 37, 37, 38, 38, 41, 41, 42, 42, 44, 44, 47, 47,
                49, 49, 50, 50, 52, 52, 55, 55, 56, 56, 59, 59, 61, 61, 62, 62,
                64, 64, 67, 67, 69, 69, 70, 70, 73, 73, 74, 74, 76, 76, 79, 79,
                81, 81, 82, 82, 84, 84, 87, 87, 88, 88, 91, 91, 93, 93, 94, 94,
                97, 97, 98, 98,100,100,103,103,104,104,107,107,109,109,110,110,
                112,112,115,115,117,117,118,118,121,121,122,122,124,124,127,127,
                128,128,131,131,133,133,134,134,137,137,138,138,140,140,143,143,
                145,145,146,146,148,148,151,151,152,152,155,155,157,157,158,158,
                161,161,162,162,164,164,167,167,168,168,171,171,173,173,174,174,
                176,176,179,179,181,181,182,182,185,185,186,186,188,188,191,191,
                193,193,194,194,196,196,199,199,200,200,203,203,205,205,206,206,
                208,208,211,211,213,213,214,214,217,217,218,218,220,220,223,223,
                224,224,227,227,229,229,230,230,233,233,234,234,236,236,239,239,
                241,241,242,242,244,244,247,247,248,248,251,251,253,253,254,254);

        $bin = '';
        for ($i = 0; $i < strlen($key); $i++) {
            $bin .= sprintf('%08s', decbin(ord($key{$i})));
        }

        $str1 = explode('-', substr(chunk_split($bin, 7, '-'), 0, -1));
        $x = '';
        foreach($str1 as $s) {
            $x .= sprintf('%02s', dechex($odd_parity[bindec($s . '0')]));
        }

        return pack('H*', $x);

    }
360

Ad Schellevis's avatar
Ad Schellevis committed
361
    /**
362
     * Generates the response-packet.
Ad Schellevis's avatar
Ad Schellevis committed
363 364 365 366
     *
     * @param  bool  $lm  wether including LAN-Manager-Response
     * @access private
     * @return string
367
     */
Ad Schellevis's avatar
Ad Schellevis committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    function response($lm = false)
    {
        $ntresp = $this->ntChallengeResponse();
        if ($lm) {
            $lmresp = $this->lmChallengeResponse();
        } else {
            $lmresp = str_repeat ("\0", 24);
        }

        // Response: LM Response, NT Response, flags (0 = use LM Response, 1 = use NT Response)
        return $lmresp . $ntresp . pack('C', !$lm);
    }
}

/**
 * class Crypt_CHAP_MSv2
 *
385
 * Generate MS-CHAPv2 Packets. This version of MS-CHAP uses a 16 Bytes authenticator
Ad Schellevis's avatar
Ad Schellevis committed
386
 * challenge and a 16 Bytes peer Challenge. LAN-Manager responses no longer exists
387
 * in this version. The challenge is already a SHA1 challenge hash of both challenges
Ad Schellevis's avatar
Ad Schellevis committed
388
 * and of the username.
389 390
 *
 * @package Crypt_CHAP
Ad Schellevis's avatar
Ad Schellevis committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
 */
class Crypt_CHAP_MSv2 extends Crypt_CHAP_MSv1
{
    /**
     * The username
     * @var  string
     */
    var $username = null;

    /**
     * The 16 Bytes random binary peer challenge
     * @var  string
     */
    var $peerChallenge = null;

    /**
     * The 16 Bytes random binary authenticator challenge
     * @var  string
     */
    var $authChallenge = null;
411

Ad Schellevis's avatar
Ad Schellevis committed
412 413 414 415 416 417 418 419 420 421 422
    /**
     * Constructor
     *
     * Generates the 16 Bytes peer and authentication challenge
     * @return void
     */
    function Crypt_CHAP_MSv2()
    {
        $this->Crypt_CHAP_MSv1();
        $this->generateChallenge('peerChallenge', 16);
        $this->generateChallenge('authChallenge', 16);
423
    }
Ad Schellevis's avatar
Ad Schellevis committed
424 425 426 427 428 429 430

    /**
     * Generates a hash from the NT-HASH.
     *
     * @access public
     * @param  string  $nthash The NT-HASH
     * @return string
431 432
     */
    function ntPasswordHashHash($nthash)
Ad Schellevis's avatar
Ad Schellevis committed
433 434 435
    {
        return pack('H*',hash('md4', $nthash));
    }
436

Ad Schellevis's avatar
Ad Schellevis committed
437 438 439 440 441 442
    /**
     * Generates the challenge hash from the peer and the authenticator challenge and
     * the username. SHA1 is used for this, but only the first 8 Bytes are used.
     *
     * @access public
     * @return string
443 444
     */
    function challengeHash()
Ad Schellevis's avatar
Ad Schellevis committed
445 446
    {
        return substr(pack('H*',hash('sha1', $this->peerChallenge . $this->authChallenge . $this->username)), 0, 8);
447
    }
Ad Schellevis's avatar
Ad Schellevis committed
448 449

    /**
450
     * Generates the response.
Ad Schellevis's avatar
Ad Schellevis committed
451 452 453
     *
     * @access public
     * @return string
454 455
     */
    function challengeResponse()
Ad Schellevis's avatar
Ad Schellevis committed
456 457 458
    {
        $this->challenge = $this->challengeHash();
        return $this->_challengeResponse();
459
    }
Ad Schellevis's avatar
Ad Schellevis committed
460 461 462 463
}


?>