3 * DooDigestAuth class file.
5 * @author Leng Sheng Hong <darkredz@gmail.com>
6 * @link http://www.doophp.com/
7 * @copyright Copyright © 2009 Leng Sheng Hong
8 * @license http://www.doophp.com/license
12 * Handles HTTP digest authentication
14 * <p>HTTP digest authentication can be used with the URI router.
15 * HTTP digest is much more recommended over the use of HTTP Basic auth which doesn't provide any encryption.
16 * If you are running PHP on Apache in CGI/FastCGI mode, you would need to
17 * add the following line to your .htaccess for digest auth to work correctly.</p>
18 * <code>RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]</code>
20 * <p>This class is tested under Apache 2.2 and Cherokee web server. It should work in both mod_php and cgi mode.</p>
22 * @author Leng Sheng Hong <darkredz@gmail.com>
23 * @version $Id: DooDigestAuth.php 1000 2009-07-7 18:27:22
30 * Authenticate against a list of username and passwords.
32 * <p>HTTP Digest Authentication doesn't work with PHP in CGI mode,
33 * you have to add this into your .htaccess <code>RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]</code></p>
35 * @param string $realm Name of the authentication session
36 * @param array $users An assoc array of username and password: array('uname1'=>'pwd1', 'uname2'=>'pwd2')
37 * @param string $fail_msg Message to be displayed if the User cancel the login
38 * @param string $fail_url URL to be redirect if the User cancel the login
39 * @return string The username if login success.
41 public static function http_auth($realm, $users, $fail_msg=NULL, $fail_url=NULL){
42 $realm = "Restricted area - $realm";
45 //$users = array('admin' => '1234', 'guest' => 'guest');
46 if(!empty($_SERVER['REDIRECT_HTTP_AUTHORIZATION']) && strpos($_SERVER['REDIRECT_HTTP_AUTHORIZATION'], 'Digest')===0){
47 $_SERVER['PHP_AUTH_DIGEST'] = $_SERVER['REDIRECT_HTTP_AUTHORIZATION'];
50 if (empty($_SERVER['PHP_AUTH_DIGEST'])) {
51 header('WWW-Authenticate: Digest realm="'.$realm.
52 '",qop="auth",nonce="'.uniqid().'",opaque="'.md5($realm).'"');
53 header('HTTP/1.1 401 Unauthorized');
57 die("<script>window.location.href = '$fail_url'</script>");
61 // analyze the PHP_AUTH_DIGEST variable
62 if (!($data = self::http_digest_parse($_SERVER['PHP_AUTH_DIGEST'])) || !isset($users[$data['username']])){
63 header('WWW-Authenticate: Digest realm="'.$realm.
64 '",qop="auth",nonce="'.uniqid().'",opaque="'.md5($realm).'"');
65 header('HTTP/1.1 401 Unauthorized');
69 die("<script>window.location.href = '$fail_url'</script>");
73 // generate the valid response
74 $A1 = md5($data['username'] . ':' . $realm . ':' . $users[$data['username']]);
75 $A2 = md5($_SERVER['REQUEST_METHOD'].':'.$data['uri']);
76 $valid_response = md5($A1.':'.$data['nonce'].':'.$data['nc'].':'.$data['cnonce'].':'.$data['qop'].':'.$A2);
78 if ($data['response'] != $valid_response){
79 header('HTTP/1.1 401 Unauthorized');
80 header('WWW-Authenticate: Digest realm="'.$realm.
81 '",qop="auth",nonce="'.uniqid().'",opaque="'.md5($realm).'"');
85 die("<script>window.location.href = '$fail_url'</script>");
89 // ok, valid username & password
90 return $data['username'];
94 * Method to parse the http auth header, works with IE.
96 * Internet Explorer returns a qop="xxxxxxxxxxx" in the header instead of qop=xxxxxxxxxxx as most browsers do.
98 * @param string $txt header string to parse
99 * @return array An assoc array of the digest auth session
101 private static function http_digest_parse($txt)
103 $res = preg_match("/username=\"([^\"]+)\"/i", $txt, $match);
104 $data['username'] = (isset($match[1]))?$match[1]:null;
105 $res = preg_match('/nonce=\"([^\"]+)\"/i', $txt, $match);
106 $data['nonce'] = $match[1];
107 $res = preg_match('/nc=([0-9]+)/i', $txt, $match);
108 $data['nc'] = $match[1];
109 $res = preg_match('/cnonce=\"([^\"]+)\"/i', $txt, $match);
110 $data['cnonce'] = $match[1];
111 $res = preg_match('/qop=([^,]+)/i', $txt, $match);
112 $data['qop'] = str_replace('"','',$match[1]);
113 $res = preg_match('/uri=\"([^\"]+)\"/i', $txt, $match);
114 $data['uri'] = $match[1];
115 $res = preg_match('/response=\"([^\"]+)\"/i', $txt, $match);
116 $data['response'] = $match[1];