X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fauth.php;h=53b96d9f717e27ee90ef326bc99bb62dfe9fa452;hp=ac604b51debee372fc1429f2caed5b848a31dba3;hb=b00dce9befb0755283ff90d262b4f89db0b2b6e8;hpb=a83c9f3f4b45786716be599c6c6e8694e2fdba8b

diff --git a/functions/auth.php b/functions/auth.php
index ac604b51..53b96d9f 100644
--- a/functions/auth.php
+++ b/functions/auth.php
@@ -3,64 +3,96 @@
 /**
  * auth.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Contains functions used to do authentication.
+ * 
+ * Dependencies:
+ *  functions/global.php
+ *  functions/strings.php.
  *
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  */
 
-/** Put in a safety net here, in case a naughty admin didn't run conf.pl when they upgraded */
 
-if (! isset($smtp_auth_mech)) {
-  $smtp_auth_mech = 'none';
-}
+/**
+ * Detect whether user is logged in
+ *
+ * Function is similar to is_logged_in() function. If user is logged in, function
+ * returns true. If user is not logged in or session is expired, function saves $_POST
+ * and PAGE_NAME in session and returns false. POST information is saved in
+ * 'session_expired_post' variable, PAGE_NAME is saved in 'session_expired_location'.
+ *
+ * Script that uses this function instead of is_logged_in() function, must handle user
+ * level messages.
+ * @return boolean
+ * @since 1.5.1
+ */
+function sqauth_is_logged_in() {
+    if ( sqsession_is_registered('user_is_logged_in') ) {
+        return true;
+    }
 
-if (! isset($imap_auth_mech)) {
-  $imap_auth_mech = 'login';
-}
+    //  First we store some information in the new session to prevent
+    //  information-loss.
+    $session_expired_post = $_POST;
+    if (defined('PAGE_NAME'))
+        $session_expired_location = PAGE_NAME;
+    else
+        $session_expired_location = '';
+
+    if (!sqsession_is_registered('session_expired_post')) {
+        sqsession_register($session_expired_post,'session_expired_post');
+    }
+    if (!sqsession_is_registered('session_expired_location')) {
+        sqsession_register($session_expired_location,'session_expired_location');
+    }
+
+    session_write_close();
 
-if (! isset($use_imap_tls)) {
-  $use_imap_tls = false;
+    return false;
 }
 
-if (! isset($use_smtp_tls)) {
-  $use_smtp_tls = false;
+/**
+ * Reads and decodes stored user password information
+ *
+ * Direct access to password information is deprecated.
+ * @return string password in plain text
+ * @since 1.5.1
+ */
+function sqauth_read_password() {
+    sqgetGlobalVar('key',         $key,       SQ_COOKIE);
+    sqgetGlobalVar('onetimepad',  $onetimepad,SQ_SESSION);
+
+    return OneTimePadDecrypt($key, $onetimepad);
 }
 
 /**
- * Check if user has previously logged in to the Squirrelmail session.  If user
- * has not logged in, execution will stop inside this function.
+ * Saves or updates user password information
  *
- * @return int A positive value is returned if user has previously logged in
- * successfully.
+ * This function is used to update password information that SquirrelMail
+ * stores during existing web session. It does not modify password stored
+ * in authentication system used by IMAP server.
+ *
+ * Function must be called before any html output started. Direct access
+ * to password information is deprecated. Saved password information is
+ * available only to next executed SquirrelMail script. If your script needs
+ * access to saved password after sqauth_save_password() call, use returned
+ * OTP encrypted key.
+ * @param string $pass password
+ * @return string password encrypted with OTP. In case script wants to access
+ *  password information before reloading page.
+ * @since 1.5.1
  */
-function is_logged_in() {
+function sqauth_save_password($pass) {
+    sqgetGlobalVar('base_uri',    $base_uri,   SQ_SESSION);
 
-    if ( sqsession_is_registered('user_is_logged_in') ) {
-        return;
-    } else {
-        global $PHP_SELF, $session_expired_post, 
-	       $session_expired_location;
-
-        /*  First we store some information in the new session to prevent
-         *  information-loss.
-         */
-	 
-	$session_expired_post = $_POST;
-        $session_expired_location = $PHP_SELF;
-        if (!sqsession_is_registered('session_expired_post')) {    
-           sqsession_register($session_expired_post,'session_expired_post');
-        }
-        if (!sqsession_is_registered('session_expired_location')) {
-           sqsession_register($session_expired_location,'session_expired_location');
-        }
-        include_once( SM_PATH . 'functions/display_messages.php' );
-        logout_error( _("You must be logged in to access this page.") );
-        exit;
-    }
+    $onetimepad = OneTimePadCreate(strlen($pass));
+    sqsession_register($onetimepad,'onetimepad');
+    $key = OneTimePadEncrypt($pass, $onetimepad);
+    sqsetcookie('key', $key, false, $base_uri);
+    return $key;
 }
 
 /**
@@ -71,7 +103,7 @@ function is_logged_in() {
  * @param string $password User password supplied by User
  * @param string $challenge The challenge supplied by the server
  * @return string The response to be sent to the IMAP server
- *
+ * @since 1.4.0
  */
 function cram_md5_response ($username,$password,$challenge) {
     $challenge=base64_decode($challenge);
@@ -93,52 +125,60 @@ function cram_md5_response ($username,$password,$challenge) {
  *   define the digest-uri.
  * @param string $host The host name, usually the server's FQDN; it is used to
  *   define the digest-uri.
+ * @param string $authz Authorization ID (since 1.5.2)
  * @return string The response to be sent to the IMAP server
+ * @since 1.4.0
  */
-function digest_md5_response ($username,$password,$challenge,$service,$host) {
-  $result=digest_md5_parse_challenge($challenge);
-  
-// verify server supports qop=auth
-  // $qop = explode(",",$result['qop']);
-  //if (!in_array("auth",$qop)) {
+function digest_md5_response ($username,$password,$challenge,$service,$host,$authz='') {
+    $result=digest_md5_parse_challenge($challenge);
+
+    // verify server supports qop=auth
+    // $qop = explode(",",$result['qop']);
+    //if (!in_array("auth",$qop)) {
     // rfc2831: client MUST fail if no qop methods supported
-   // return false;
-  //}
-  $cnonce = base64_encode(bin2hex(hmac_md5(microtime())));
-  $ncount = "00000001";
-
-  /* This can be auth (authentication only), auth-int (integrity protection), or
-     auth-conf (confidentiality protection).  Right now only auth is supported.
-	 DO NOT CHANGE THIS VALUE */
-  $qop_value = "auth";
-
-  $digest_uri_value = $service . '/' . $host;
-
-  // build the $response_value
-  //FIXME This will probably break badly if a server sends more than one realm
-  $string_a1 = utf8_encode($username).":";
-  $string_a1 .= utf8_encode($result['realm']).":";
-  $string_a1 .= utf8_encode($password);
-  $string_a1 = hmac_md5($string_a1);
-  $A1 = $string_a1 . ":" . $result['nonce'] . ":" . $cnonce;
-  $A1 = bin2hex(hmac_md5($A1));
-  $A2 = "AUTHENTICATE:$digest_uri_value";
-  // If qop is auth-int or auth-conf, A2 gets a little extra
-  if ($qop_value != 'auth') {
-    $A2 .= ':00000000000000000000000000000000';
-  }
-  $A2 = bin2hex(hmac_md5($A2));
-
-  $string_response = $result['nonce'] . ':' . $ncount . ':' . $cnonce . ':' . $qop_value;
-  $response_value = bin2hex(hmac_md5($A1.":".$string_response.":".$A2));
-
-  $reply = 'charset=utf-8,username="' . $username . '",realm="' . $result["realm"] . '",';
-  $reply .= 'nonce="' . $result['nonce'] . '",nc=' . $ncount . ',cnonce="' . $cnonce . '",';
-  $reply .= "digest-uri=\"$digest_uri_value\",response=$response_value";
-  $reply .= ',qop=' . $qop_value;
-  $reply = base64_encode($reply);
-  return $reply . "\r\n";
- 
+    // return false;
+    //}
+    $cnonce = base64_encode(bin2hex(hmac_md5(microtime())));
+    $ncount = "00000001";
+
+    /* This can be auth (authentication only), auth-int (integrity protection), or
+       auth-conf (confidentiality protection).  Right now only auth is supported.
+       DO NOT CHANGE THIS VALUE */
+    $qop_value = "auth";
+
+    $digest_uri_value = $service . '/' . $host;
+
+    // build the $response_value
+    //FIXME This will probably break badly if a server sends more than one realm
+    $string_a1 = utf8_encode($username).":";
+    $string_a1 .= utf8_encode($result['realm']).":";
+    $string_a1 .= utf8_encode($password);
+    $string_a1 = hmac_md5($string_a1);
+    $A1 = $string_a1 . ":" . $result['nonce'] . ":" . $cnonce;
+    if(!empty($authz)) {
+        $A1 .= ":" . utf8_encode($authz);
+    }
+    $A1 = bin2hex(hmac_md5($A1));
+    $A2 = "AUTHENTICATE:$digest_uri_value";
+    // If qop is auth-int or auth-conf, A2 gets a little extra
+    if ($qop_value != 'auth') {
+        $A2 .= ':00000000000000000000000000000000';
+    }
+    $A2 = bin2hex(hmac_md5($A2));
+
+    $string_response = $result['nonce'] . ':' . $ncount . ':' . $cnonce . ':' . $qop_value;
+    $response_value = bin2hex(hmac_md5($A1.":".$string_response.":".$A2));
+
+    $reply = 'charset=utf-8,username="' . $username . '",realm="' . $result["realm"] . '",';
+    $reply .= 'nonce="' . $result['nonce'] . '",nc=' . $ncount . ',cnonce="' . $cnonce . '",';
+    $reply .= "digest-uri=\"$digest_uri_value\",response=$response_value";
+    $reply .= ',qop=' . $qop_value;
+    if(!empty($authz)) {
+        $reply .= ',authzid=' . $authz;
+    }
+    $reply = base64_encode($reply);
+    return $reply . "\r\n";
+
 }
 
 /**
@@ -148,41 +188,42 @@ function digest_md5_response ($username,$password,$challenge,$service,$host) {
  *
  * @param string $challenge Digest-MD5 Challenge
  * @return array Digest-MD5 challenge decoded data
+ * @since 1.4.0
  */
 function digest_md5_parse_challenge($challenge) {
-  $challenge=base64_decode($challenge);
-  while (isset($challenge)) {
-    if ($challenge{0} == ',') { // First char is a comma, must not be 1st time through loop
-      $challenge=substr($challenge,1);
-    }
-    $key=explode('=',$challenge,2);
-    $challenge=$key[1];
-    $key=$key[0];
-    if ($challenge{0} == '"') {
-      // We're in a quoted value
-      // Drop the first quote, since we don't care about it
-      $challenge=substr($challenge,1);
-      // Now explode() to the next quote, which is the end of our value
-      $val=explode('"',$challenge,2);
-      $challenge=$val[1]; // The rest of the challenge, work on it in next iteration of loop
-      $value=explode(',',$val[0]);
-      // Now, for those quoted values that are only 1 piece..
-      if (sizeof($value) == 1) {
-        $value=$value[0];  // Convert to non-array
-      }
-    } else {
-      // We're in a "simple" value - explode to next comma
-      $val=explode(',',$challenge,2);
-      if (isset($val[1])) {
-	  	$challenge=$val[1];
-	  } else {
-	    unset($challenge);
-	  }
-      $value=$val[0];
-    }
-    $parsed["$key"]=$value;
-  } // End of while loop
-  return $parsed;
+    $challenge=base64_decode($challenge);
+    while (isset($challenge)) {
+        if ($challenge{0} == ',') { // First char is a comma, must not be 1st time through loop
+            $challenge=substr($challenge,1);
+        }
+        $key=explode('=',$challenge,2);
+        $challenge=$key[1];
+        $key=$key[0];
+        if ($challenge{0} == '"') {
+            // We're in a quoted value
+            // Drop the first quote, since we don't care about it
+            $challenge=substr($challenge,1);
+            // Now explode() to the next quote, which is the end of our value
+            $val=explode('"',$challenge,2);
+            $challenge=$val[1]; // The rest of the challenge, work on it in next iteration of loop
+            $value=explode(',',$val[0]);
+            // Now, for those quoted values that are only 1 piece..
+            if (sizeof($value) == 1) {
+                $value=$value[0];  // Convert to non-array
+            }
+        } else {
+            // We're in a "simple" value - explode to next comma
+            $val=explode(',',$challenge,2);
+            if (isset($val[1])) {
+                $challenge=$val[1];
+            } else {
+                unset($challenge);
+            }
+            $value=$val[0];
+        }
+        $parsed["$key"]=$value;
+    } // End of while loop
+    return $parsed;
 }
 
 /**
@@ -194,18 +235,19 @@ function digest_md5_parse_challenge($challenge) {
  * @param string $key Optional key, which, if supplied, will be used to
  * calculate data's HMAC.
  * @return string HMAC Digest string
+ * @since 1.4.0
  */
 function hmac_md5($data, $key='') {
     if (extension_loaded('mhash')) {
-      if ($key== '') {
-        $mhash=mhash(MHASH_MD5,$data);
-      } else {
-        $mhash=mhash(MHASH_MD5,$data,$key);
-      }
-      return $mhash;
+        if ($key== '') {
+            $mhash=mhash(MHASH_MD5,$data);
+        } else {
+            $mhash=mhash(MHASH_MD5,$data,$key);
+        }
+        return $mhash;
     }
     if (!$key) {
-         return pack('H*',md5($data));
+        return pack('H*',md5($data));
     }
     $key = str_pad($key,64,chr(0x00));
     if (strlen($key) > 64) {
@@ -218,27 +260,33 @@ function hmac_md5($data, $key='') {
     return $hmac;
 }
 
-/** 
+/**
  * Fillin user and password based on SMTP auth settings.
  *
  * @param string $user Reference to SMTP username
  * @param string $pass Reference to SMTP password (unencrypted)
+ * @since 1.4.11
  */
 function get_smtp_user(&$user, &$pass) {
-    global $username, $smtp_auth_mech, 
+    global $username, $smtp_auth_mech,
            $smtp_sitewide_user, $smtp_sitewide_pass;
 
     if ($smtp_auth_mech == 'none') {
         $user = '';
         $pass = '';
-    } elseif ( isset($smtp_sitewide_user) && isset($smtp_sitewide_pass) ) {
+    } elseif ( isset($smtp_sitewide_user) && isset($smtp_sitewide_pass) &&
+               !empty($smtp_sitewide_user)) {
         $user = $smtp_sitewide_user;
         $pass = $smtp_sitewide_pass;
     } else {
-        global $key, $onetimepad;
         $user = $username;
-        $pass = OneTimePadDecrypt($key, $onetimepad);
+        $pass = sqauth_read_password();
     }
-}
 
-?>
+    // plugin authors note: override $user or $pass by
+    // directly changing the arguments array contents 
+    // in your plugin e.g., $args[0] = 'new_username';
+    //
+    $temp = array(&$user, &$pass);
+    do_hook('smtp_auth', $temp);
+}