Adding a comment with an explanation for translators.

[squirrelmail.git] / functions / auth.php

diff --git a/functions/auth.php b/functions/auth.php
index 4fcc53f93f4fffba048f0e2d2db47c12b50aec70..9ee20bbbe0c124325bf3311a3ea0a1fe5a5d9615 100644 (file)
--- a/functions/auth.php
+++ b/functions/auth.php
@@ -9,7 +9,7 @@
  *  functions/global.php
  *  functions/strings.php.
  *
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2009 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -21,8 +21,8 @@
  *
  * 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 $PHP_SELF in session and returns false. POST information is saved in
- * 'session_expired_post' variable, PHP_SELF is saved in 'session_expired_location'.
+ * 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.
@@ -34,21 +34,24 @@ function sqauth_is_logged_in() {
         return true;
     }
 
-       //  First we store some information in the new session to prevent
-       //  information-loss.
-       sqGetGlobalVar('PHP_SELF', $PHP_SELF, SQ_SERVER);
+    //  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 = '';
 
-       $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');
-       }
-       session_write_close();
+    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();
 
-       return false;
+    return false;
 }
 
 /**
@@ -68,19 +71,26 @@ function sqauth_read_password() {
 /**
  * Saves or updates user password information
  *
- * 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.
+ * This function is used to update the password information that
+ * SquirrelMail stores in the existing PHP session. It does NOT 
+ * modify the password stored in the authentication system used
+ * by the IMAP server.
+ *
+ * This function must be called before any html output is started.
+ * Direct access to password information is deprecated. The saved
+ * password information is available only to the SquirrelMail script
+ * that is called/executed AFTER the current one. If your script
+ * needs access to the saved password after a sqauth_save_password()
+ * call, use the returned OTP encrypted key.
  *
- * 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.
+ *
+ * @return string Password encrypted with OTP. In case the script
+ *                wants to access the password information before
+ *                the end of its execution.
+ *
  * @since 1.5.1
+ *
  */
 function sqauth_save_password($pass) {
     sqgetGlobalVar('base_uri',    $base_uri,   SQ_SESSION);
@@ -128,6 +138,7 @@ function cram_md5_response ($username,$password,$challenge) {
  */
 function digest_md5_response ($username,$password,$challenge,$service,$host,$authz='') {
     $result=digest_md5_parse_challenge($challenge);
+    //FIXME we should check that $result contains the expected values that we use below
 
     // verify server supports qop=auth
     // $qop = explode(",",$result['qop']);
@@ -152,6 +163,9 @@ function digest_md5_response ($username,$password,$challenge,$service,$host,$aut
     $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
@@ -186,7 +200,8 @@ function digest_md5_response ($username,$password,$challenge,$service,$host,$aut
  */
 function digest_md5_parse_challenge($challenge) {
     $challenge=base64_decode($challenge);
-    while (isset($challenge)) {
+    $parsed = array();
+    while (!empty($challenge)) {
         if ($challenge{0} == ',') { // First char is a comma, must not be 1st time through loop
             $challenge=substr($challenge,1);
         }
@@ -259,7 +274,7 @@ function hmac_md5($data, $key='') {
  *
  * @param string $user Reference to SMTP username
  * @param string $pass Reference to SMTP password (unencrypted)
- * @since 1.5.0
+ * @since 1.4.11
  */
 function get_smtp_user(&$user, &$pass) {
     global $username, $smtp_auth_mech,
@@ -276,4 +291,11 @@ function get_smtp_user(&$user, &$pass) {
         $user = $username;
         $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);
 }