PhpOffice\PhpSpreadsheet\Shared\PasswordHasher Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\PasswordHasher:

Static Public Member Functions
static	hashPassword (string $password, string $algorithm='', string $salt='', int $spinCount=10000)
	Create a password hash from a given string by a specific algorithm. More...

Static Private Member Functions
static	getAlgorithm (string $algorithmName)
	Get algorithm name for PHP. More...
static	defaultHashPassword (string $pPassword)
	Create a password hash from a given string. More...

Detailed Description

Definition at line 8 of file PasswordHasher.php.

Member Function Documentation

defaultHashPassword()

static PhpOffice\PhpSpreadsheet\Shared\PasswordHasher::defaultHashPassword ( string  $pPassword )

staticprivate

Create a password hash from a given string.

This method is based on the algorithm provided by Daniel Rentz of OpenOffice and the PEAR package Spreadsheet_Excel_Writer by Xavier Noguer xnogu.nosp@m.er@r.nosp@m.ezebr.nosp@m.a.co.nosp@m.m.

Parameters

string

$pPassword

Password to hash

Definition at line 49 of file PasswordHasher.php.

                                                                  : string
    {
        $password = 0x0000;
        $charPos = 1; // char position
 
        // split the plain text password in its component characters
        $chars = preg_split('//', $pPassword, -1, PREG_SPLIT_NO_EMPTY);
        foreach ($chars as $char) {
            $value = ord($char) << $charPos++; // shifted ASCII value
            $rotated_bits = $value >> 15; // rotated bits beyond bit 15
            $value &= 0x7fff; // first 15 bits
            $password ^= ($value | $rotated_bits);
        }
 
        $password ^= strlen($pPassword);
        $password ^= 0xCE4B;
 
        return strtoupper(dechex($password));
    }

References $password.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword().

Here is the caller graph for this function:

getAlgorithm()

static PhpOffice\PhpSpreadsheet\Shared\PasswordHasher::getAlgorithm ( string  $algorithmName )

staticprivate

Get algorithm name for PHP.

Definition at line 13 of file PasswordHasher.php.

                                                               : string
    {
        if (!$algorithmName) {
            return '';
        }
 
        // Mapping between algorithm name in Excel and algorithm name in PHP
        $mapping = [
            Protection::ALGORITHM_MD2 => 'md2',
            Protection::ALGORITHM_MD4 => 'md4',
            Protection::ALGORITHM_MD5 => 'md5',
            Protection::ALGORITHM_SHA_1 => 'sha1',
            Protection::ALGORITHM_SHA_256 => 'sha256',
            Protection::ALGORITHM_SHA_384 => 'sha384',
            Protection::ALGORITHM_SHA_512 => 'sha512',
            Protection::ALGORITHM_RIPEMD_128 => 'ripemd128',
            Protection::ALGORITHM_RIPEMD_160 => 'ripemd160',
            Protection::ALGORITHM_WHIRLPOOL => 'whirlpool',
        ];
 
        if (array_key_exists($algorithmName, $mapping)) {
            return $mapping[$algorithmName];
        }
 
        throw new Exception('Unsupported password algorithm: ' . $algorithmName);
    }

References PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_MD2, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_MD4, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_MD5, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_RIPEMD_128, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_RIPEMD_160, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_SHA_1, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_SHA_256, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_SHA_384, PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_SHA_512, and PhpOffice\PhpSpreadsheet\Worksheet\Protection\ALGORITHM_WHIRLPOOL.

Referenced by PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\hashPassword().

Here is the caller graph for this function:

hashPassword()

static PhpOffice\PhpSpreadsheet\Shared\PasswordHasher::hashPassword ( string  $password, string  $algorithm = '', string  $salt = '', int  $spinCount = 10000  )

static

Create a password hash from a given string by a specific algorithm.

2.4.2.4 ISO Write Protection Method

See also

https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-offcrypto/1357ea58-646e-4483-92ef-95d718079d6f

Parameters

string	$password	Password to hash
string	$algorithm	Hash algorithm used to compute the password hash value
string	$salt	Pseudorandom string
int	$spinCount	Number of times to iterate on a hash of a password

Returns

string Hashed password

Definition at line 83 of file PasswordHasher.php.

                                                                                                                            : string
    {
        $phpAlgorithm = self::getAlgorithm($algorithm);
        if (!$phpAlgorithm) {
            return self::defaultHashPassword($password);
        }
 
        $saltValue = base64_decode($salt);
        $encodedPassword = mb_convert_encoding($password, 'UCS-2LE', 'UTF-8');
 
        $hashValue = hash($phpAlgorithm, $saltValue . $encodedPassword, true);
        for ($i = 0; $i < $spinCount; ++$i) {
            $hashValue = hash($phpAlgorithm, $hashValue . pack('L', $i), true);
        }
 
        return base64_encode($hashValue);
    }

References $i, $password, PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\defaultHashPassword(), PhpOffice\PhpSpreadsheet\Shared\PasswordHasher\getAlgorithm(), and GuzzleHttp\Psr7\hash().

Referenced by PhpOffice\PhpSpreadsheet\Worksheet\Protection\setPassword(), PhpOffice\PhpSpreadsheet\Document\Security\setRevisionsPassword(), PhpOffice\PhpSpreadsheet\Document\Security\setWorkbookPassword(), and PhpOffice\PhpSpreadsheet\Worksheet\Protection\verify().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Shared/PasswordHasher.php