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

diff --git a/functions/auth.php b/functions/auth.php
index ac30c4b4..53b96d9f 100644
--- a/functions/auth.php
+++ b/functions/auth.php
@@ -3,72 +3,96 @@
 /**
  * auth.php
  *
- * Copyright (c) 1999-2005 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.
  *
+ * @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 (! isset($use_imap_tls)) {
-    $use_imap_tls = false;
-}
+    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');
+    }
 
-if (! isset($use_smtp_tls)) {
-    $use_smtp_tls = false;
+    session_write_close();
+
+    return false;
 }
 
 /**
- * Check if user has previously logged in to the SquirrelMail session.  If user
- * has not logged in, execution will stop inside this function.
+ * Reads and decodes stored user password information
  *
- * @return int A positive value is returned if user has previously logged in
- * successfully.
+ * Direct access to password information is deprecated.
+ * @return string password in plain text
+ * @since 1.5.1
  */
-function is_logged_in() {
+function sqauth_read_password() {
+    sqgetGlobalVar('key',         $key,       SQ_COOKIE);
+    sqgetGlobalVar('onetimepad',  $onetimepad,SQ_SESSION);
 
-    if ( sqsession_is_registered('user_is_logged_in') ) {
-        return;
-    } else {
-        global $PHP_SELF, $session_expired_post,
-               $session_expired_location, $squirrelmail_language;
-
-        //  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');
-        }
+    return OneTimePadDecrypt($key, $onetimepad);
+}
 
-        // signout page will deal with users who aren't logged
-        // in on its own; don't show error here
-        //
-        if (strpos($PHP_SELF, 'signout.php') !== FALSE) {
-           return;
-        }
+/**
+ * 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.
+ *
+ * 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 sqauth_save_password($pass) {
+    sqgetGlobalVar('base_uri',    $base_uri,   SQ_SESSION);
 
-        include_once( SM_PATH . 'functions/display_messages.php' );
-        set_up_language($squirrelmail_language, true);
-        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;
 }
 
 /**
@@ -79,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);
@@ -101,9 +125,11 @@ 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) {
+function digest_md5_response ($username,$password,$challenge,$service,$host,$authz='') {
     $result=digest_md5_parse_challenge($challenge);
 
     // verify server supports qop=auth
@@ -129,6 +155,9 @@ function digest_md5_response ($username,$password,$challenge,$service,$host) {
     $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
@@ -144,6 +173,9 @@ function digest_md5_response ($username,$password,$challenge,$service,$host) {
     $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";
 
@@ -156,6 +188,7 @@ 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);
@@ -202,6 +235,7 @@ 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')) {
@@ -231,6 +265,7 @@ function hmac_md5($data, $key='') {
  *
  * @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,
@@ -239,14 +274,19 @@ function get_smtp_user(&$user, &$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();
     }
-}
 
-?>
\ No newline at end of file
+    // 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);
+}