\OCP\SecurityIHasher

Class Hasher provides some basic hashing functions. Furthermore, it supports legacy hashes used by previous versions of ownCloud and helps migrating those hashes to newer ones.

The hashes generated by this class are prefixed (version|hash) with a version parameter to allow possible updates in the future. Possible versions:

  • 1 (Initial version)

Usage: // Hashing a message $hash = \OC::$server->getHasher()->hash('MessageToHash'); // Verifying a message - $newHash will contain the newly calculated hash $newHash = null; var_dump(\OC::$server->getHasher()->verify('a', '86f7e437faa5a7fce15d1ddcb9eaeaea377667b8', $newHash)); var_dump($newHash);

Summary

Methods
Constants
hash()
verify()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

hash()

hash(string  $message) : string

Hashes a message using PHP's `password_hash` functionality.

Please note that the size of the returned string is not guaranteed and can be up to 255 characters.

Parameters

string $message

Message to generate hash from

Returns

string —

Hash of the message with appended version parameter

verify()

verify(string  $message, string  $hash,   $newHash = null) : boolean

Parameters

string $message

Message to verify

string $hash

Assumed hash of the message

$newHash

Returns

boolean —

Whether $hash is a valid hash of $message