modified method to take string as input instead of algorithmSid

Author: troosan

src/Common/Microsoft/PasswordEncoder.php

@@ -22,21 +22,36 @@
  */
 class PasswordEncoder
 {
+    const ALGORITHM_MD2 = 'MD2';
+    const ALGORITHM_MD4 = 'MD4';
+    const ALGORITHM_MD5 = 'MD5';
+    const ALGORITHM_SHA_1 = 'SHA-1';
+    const ALGORITHM_SHA_256 = 'SHA-256';
+    const ALGORITHM_SHA_384 = 'SHA-384';
+    const ALGORITHM_SHA_512 = 'SHA-512';
+    const ALGORITHM_RIPEMD = 'RIPEMD';
+    const ALGORITHM_RIPEMD_160 = 'RIPEMD-160';
+    const ALGORITHM_MAC = 'MAC';
+    const ALGORITHM_HMAC= 'HMAC';
+
+    /**
+     * Mapping between algorithm name and algorithm ID
+     *
+     * @var array
+     * @see https://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.writeprotection.cryptographicalgorithmsid(v=office.14).aspx
+     */
     private static $algorithmMapping = array(
-        1  => 'md2',
-        2  => 'md4',
-        3  => 'md5',
-        4  => 'sha1',
-        5  => '', // 'mac' -> not possible with hash()
-        6  => 'ripemd',
-        7  => 'ripemd160',
-        8  => '',
-        9  => '', //'hmac' -> not possible with hash()
-        10 => '',
-        11 => '',
-        12 => 'sha256',
-        13 => 'sha384',
-        14 => 'sha512',
+        self::ALGORITHM_MD2 => array(1, 'md2'),
+        self::ALGORITHM_MD4 => array(2, 'md4'),
+        self::ALGORITHM_MD5 => array(3, 'md5'),
+        self::ALGORITHM_SHA_1 => array(4, 'sha1'),
+        self::ALGORITHM_MAC => array(5, ''), // 'mac' -> not possible with hash()
+        self::ALGORITHM_RIPEMD => array(6, 'ripemd'),
+        self::ALGORITHM_RIPEMD_160 => array(7, 'ripemd160'),
+        self::ALGORITHM_HMAC => array(9, ''), //'hmac' -> not possible with hash()
+        self::ALGORITHM_SHA_256 => array(12, 'sha256'),
+        self::ALGORITHM_SHA_384 => array(13, 'sha384'),
+        self::ALGORITHM_SHA_512 => array(14, 'sha512'),
     );
 
     private static $initialCodeArray = array(
@@ -82,12 +97,12 @@ class PasswordEncoder
      * @see https://blogs.msdn.microsoft.com/vsod/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0/
      *
      * @param string $password
-     * @param integer $algorithmSid
+     * @param string $algorithmName
      * @param string $salt
      * @param integer $spinCount
      * @return string
      */
-    public static function hashPassword($password, $algorithmSid = 4, $salt = null, $spinCount = 10000)
+    public static function hashPassword($password, $algorithmName = PasswordEncoder::ALGORITHM_SHA_1, $salt = null, $spinCount = 10000)
     {
         $origEncoding = mb_internal_encoding();
         mb_internal_encoding('UTF-8');
@@ -118,7 +133,7 @@ public static function hashPassword($password, $algorithmSid = 4, $salt = null,
         // Implementation Notes List:
         //   Word requires that the initial hash of the password with the salt not be considered in the count.
         //   The initial hash of salt + key is not included in the iteration count.
-        $algorithm = self::getAlgorithm($algorithmSid);
+        $algorithm = self::getAlgorithm($algorithmName);
         $generatedKey = hash($algorithm, $salt . $generatedKey, true);
 
         for ($i = 0; $i < $spinCount; $i++) {
@@ -134,12 +149,12 @@ public static function hashPassword($password, $algorithmSid = 4, $salt = null,
     /**
      * Get algorithm from self::$algorithmMapping
      *
-     * @param int $sid
+     * @param string $algorithmName
      * @return string
      */
-    private static function getAlgorithm($sid)
+    private static function getAlgorithm($algorithmName)
     {
-        $algorithm = self::$algorithmMapping[$sid];
+        $algorithm = self::$algorithmMapping[$algorithmName][1];
         if ($algorithm == '') {
             $algorithm = 'sha1';
         }

tests/Common/Tests/Microsoft/PasswordEncoderTest.php

@@ -50,7 +50,7 @@ public function testEncodePasswordWithSalt()
         $salt = base64_decode('uq81pJRRGFIY5U+E9gt8tA==');
 
         //when
-        $hashPassword = PasswordEncoder::hashPassword($password, 4, $salt);
+        $hashPassword = PasswordEncoder::hashPassword($password, PasswordEncoder::ALGORITHM_SHA_1, $salt);
 
         //then
         $this->assertEquals('QiDOcpia1YzSVJPiKPwWebl9p/0=', $hashPassword);
@@ -66,7 +66,7 @@ public function testDafaultsToSha1IfUnsupportedAlgorithm()
         $salt = base64_decode('uq81pJRRGFIY5U+E9gt8tA==');
 
         //when
-        $hashPassword = PasswordEncoder::hashPassword($password, 5, $salt);
+        $hashPassword = PasswordEncoder::hashPassword($password, PasswordEncoder::ALGORITHM_MAC, $salt);
 
         //then
         $this->assertEquals('QiDOcpia1YzSVJPiKPwWebl9p/0=', $hashPassword);
@@ -82,7 +82,7 @@ public function testEncodePasswordWithNullAsciiCodeInPassword()
         $salt = base64_decode('uq81pJRRGFIY5U+E9gt8tA==');
 
         //when
-        $hashPassword = PasswordEncoder::hashPassword($password, 5, $salt, 1);
+        $hashPassword = PasswordEncoder::hashPassword($password, PasswordEncoder::ALGORITHM_MAC, $salt, 1);
 
         //then
         $this->assertEquals('rDV9sgdDsztoCQlvRCb1lF2wxNg=', $hashPassword);