Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 214 lines (188 sloc) 7.363 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
<?php
/**
* Slightly modified by Andreas Gohr <andi@aplitbrain.org>
*/

/*
Copyright (c) 2005 Paul James
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the Paul James nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
*/

/** HTTP Digest authentication class */
class HTTPDigest
{

    /** The Digest opaque value (any string will do, never sent in plain text over the wire).
* @var str
*/
    var $opaque = 'opaque';

    /** The authentication realm name.
* @var str
*/
    var $realm = 'Realm';

    /** The base URL of the application, auth data will be used for all resources under this URL.
* @var str
*/
    var $baseURL = '/';

    /** Are passwords stored as an a1 hash (username:realm:password) rather than plain text.
* @var str
*/
    var $passwordsHashed = TRUE;

    /** The private key.
* @var str
*/
    var $privateKey = 'privatekey';

    /** The life of the nonce value in seconds
* @var int
*/
    var $nonceLife = 300;

    /** Send HTTP Auth header */
    function send()
    {
        header('WWW-Authenticate: Digest '.
            'realm="'.$this->realm.'", '.
            'domain="'.$this->baseURL.'", '.
            'qop=auth, '.
            'algorithm=MD5, '.
            'nonce="'.$this->getNonce().'", '.
            'opaque="'.$this->getOpaque().'"'
        );
        header('HTTP/1.0 401 Unauthorized');
    }

    /** Get the HTTP Auth header
* @return str
*/
    function getAuthHeader()
    {

        // try to get the digest headers - taken from PHPMyOpenID ANDI
        if (function_exists('apache_request_headers') && ini_get('safe_mode') == false) {
                $arh = apache_request_headers();
                $hdr = $arh['Authorization'];

        } elseif (isset($_SERVER['PHP_AUTH_DIGEST'])) {
                $hdr = $_SERVER['PHP_AUTH_DIGEST'];

        } elseif (isset($_SERVER['HTTP_AUTHORIZATION'])) {
                $hdr = $_SERVER['HTTP_AUTHORIZATION'];

        } elseif (isset($_ENV['PHP_AUTH_DIGEST'])) {
                $hdr = $_ENV['PHP_AUTH_DIGEST'];

        } elseif (isset($_REQUEST['auth'])) {
                $hdr = stripslashes(urldecode($_REQUEST['auth']));

        } else {
                $hdr = null;
        }

        return $hdr;
    }

    /** Authenticate the user and return username on success.
* @param str[] users Array of username/password pairs
* @return str
*/
    function authenticate($users)
    {
        $authorization = $this->getAuthHeader();
        if ($authorization) {
            if (substr($authorization, 0, 5) == 'Basic') {
                trigger_error('You are trying to use HTTP Basic authentication but I am expecting HTTP Digest');
                exit;
            }
            if (
                preg_match('/username="([^"]+)"/', $authorization, $username) &&
                preg_match('/nonce="([^"]+)"/', $authorization, $nonce) &&
                preg_match('/response="([^"]+)"/', $authorization, $response) &&
                preg_match('/opaque="([^"]+)"/', $authorization, $opaque) &&
                preg_match('/uri="([^"]+)"/', $authorization, $uri)
            ) {
                $username = $username[1];
                $requestURI = $_SERVER['REQUEST_URI'];
                if (strpos($requestURI, '?') !== FALSE) { // hack for IE which does not pass querystring in URI element of Digest string or in response hash
                    $requestURI = substr($requestURI, 0, strlen($uri[1]));
                }
                if (
                    isset($users[$username]) &&
                    $opaque[1] == $this->getOpaque() &&
                    $uri[1] == $requestURI &&
                    $nonce[1] == $this->getNonce()
                ) {
                    $passphrase = $users[$username];
                    if ($this->passwordsHashed) {
                        $a1 = $passphrase;
                    } else {
                        $a1 = md5($username.':'.$this->getRealm().':'.$passphrase);
                    }
                    $a2 = md5($_SERVER['REQUEST_METHOD'].':'.$requestURI);
                    if (
                        preg_match('/qop="?([^,\s"]+)/', $authorization, $qop) &&
                        preg_match('/nc=([^,\s"]+)/', $authorization, $nc) &&
                        preg_match('/cnonce="([^"]+)"/', $authorization, $cnonce)
                    ) {
                        $expectedResponse = md5($a1.':'.$nonce[1].':'.$nc[1].':'.$cnonce[1].':'.$qop[1].':'.$a2);
                    } else {
                        $expectedResponse = md5($a1.':'.$nonce[1].':'.$a2);
                    }
                    if ($response[1] == $expectedResponse) {
                        return $username;
                    }
                }
            }
        } else {
            // this breaks the initial login phase ANDI
            #trigger_error('HTTP Digest headers not being passed to PHP by the server, unable to authenticate user');
            #exit;
        }
        return NULL;
    }

    /** Get nonce value for HTTP Digest.
* @return str
*/
    function getNonce() {
        $time = ceil(time() / $this->nonceLife) * $this->nonceLife;
        return md5(date('Y-m-d H:i', $time).':'.$_SERVER['REMOTE_ADDR'].':'.$this->privateKey);
    }

    /** Get opaque value for HTTP Digest.
* @return str
*/
    function getOpaque()
    {
        return md5($this->opaque);
    }

    /** Get realm for HTTP Digest taking PHP safe mode into account.
* @return str
*/
    function getRealm()
    {
        if (ini_get('safe_mode')) {
            return $this->realm.'-'.getmyuid();
        } else {
            return $this->realm;
        }
    }

}

/* Example usage
$HTTPDigest =& new HTTPDigest();
if ($username = $HTTPDigest->authenticate(array(
'username' => md5('username:'.$HTTPDigest->getRealm().':password')
))) {
echo sprintf('Logged in as "%s"', $username);
} else {
$HTTPDigest->send();
echo 'Not logged in';
}
//*/

?>
Something went wrong with that request. Please try again.