Changeset 756 for branches/1.1dev/lib/Utilities.inc.php

Timestamp:

Nov 16, 2021 8:30:58 AM (2 years ago)

Author:

anonymous

Message:

Backport utility functions from v2.x

File:

• branches/1.1dev/lib/Utilities.inc.php (modified) (2 diffs)

branches/1.1dev/lib/Utilities.inc.php

@@ -739 +739 @@
 function hash64($string, $length=18)
 {
-    $app =& App::getInstance();
-
-    return mb_substr(preg_replace('/[^\w]/' . $app->getParam('preg_u'), '', base64_encode(hash('sha512', $string, true))), 0, $length);
+    return mb_substr(preg_replace('/[^\w]/', '', base64_encode(hash('sha512', $string, true))), 0, $length);
 }
 
 /**
  * Signs a value using md5 and a simple text key. In order for this
- * function to be useful (i.e. secure) the key must be kept secret, which
+ * function to be useful (i.e. secure) the salt must be kept secret, which
  * means keeping it as safe as database credentials. Putting it into an
  * environment variable set in httpd.conf is a good place.
  *
  * @access  public
- *
  * @param   string  $val    The string to sign.
- * @param   string  $key    (Optional) A text key to use for computing the signature.
- *
+ * @param   string  $salt   (Optional) A text key to use for computing the signature.
+ * @param   string  $length (Optional) The length of the added signature. Longer signatures are safer. Must match the length passed to verifySignature() for the signatures to match.
  * @return  string  The original value with a signature appended.
  */
-function addSignature($val, $key=null)
-{
-    global $CFG;
-
-    if ('' == $val) {
-        logMsg(sprintf('Adding signature to empty string.', null), LOG_NOTICE, __FILE__, __LINE__);
-    }
-
-    if (!isset($key)) {
-        $key = $CFG->signing_key;
-    }
-
-    return $val . '-' . substr(md5($val . $key), 0, 18);
+function addSignature($val, $salt=null, $length=18)
+{
+    if ('' == trim($val)) {
+        logMsg(sprintf('Cannot add signature to an empty string.', null), LOG_INFO, __FILE__, __LINE__);
+        return '';
+    }
+
+    if (!isset($salt)) {
+        global $CFG;
+        $salt = $CFG->signing_key;
+    }
+
+    return $val . '-' . mb_substr(preg_replace('/[^\w]/', '', base64_encode(hash('sha512', $val . $salt, true))), 0, $length);
 }
 
@@ -776 +773 @@
  *
  * @access  public
- *
  * @param   string  $signed_val     The string to sign.
- *
  * @return  string  The original value with a signature removed.
  */
 function removeSignature($signed_val)
 {
-    return substr($signed_val, 0, strrpos($signed_val, '-'));
-}
-
-/**
- * Verifies a signature appened to a value by addSignature().
+    if (empty($signed_val) || mb_strpos($signed_val, '-') === false) {
+        return '';
+    }
+    return mb_substr($signed_val, 0, mb_strrpos($signed_val, '-'));
+}
+
+/**
+ * Verifies a signature appended to a value by addSignature().
  *
  * @access  public
- *
  * @param   string  $signed_val A value with appended signature.
- * @param   string  $key        (Optional) A text key to use for computing the signature.
- *
+ * @param   string  $salt       (Optional) A text key to use for computing the signature.
+ * @param   string  $length (Optional) The length of the added signature.
  * @return  bool    True if the signature matches the var.
  */
-function verifySignature($signed_val, $key=null)
+function verifySignature($signed_val, $salt=null, $length=18)
 {
     // Strip the value from the signed value.
-    $val = substr($signed_val, 0, strrpos($signed_val, '-'));
+    $val = removeSignature($signed_val);
     // If the signed value matches the original signed value we consider the value safe.
-    if ($signed_val == addSignature($val, $key)) {
+    if ('' != $signed_val && $signed_val == addSignature($val, $salt, $length)) {
         // Signature verified.
-        return true;
+        return true;
     } else {
+        logMsg(sprintf('Failed signature (%s should be %s)', $signed_val, addSignature($val, $salt, $length)), LOG_DEBUG, __FILE__, __LINE__);
         return false;
     }