IHasher

interface OCP\Security\IHasher
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);
Implemented by:OC\Security\Hasher
Source:lib/public/Security/IHasher.php#49

Methods

public OCP\Security\IHasher::hash($message)
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.
Source:

lib/public/Security/IHasher.php#59
Parameters:
  • $message (string) Message to generate hash from
Returns:

string Hash of the message with appended version parameter
Since:

8.0.0
public OCP\Security\IHasher::verify($message, $hash, &$newHash=null)
Source:

lib/public/Security/IHasher.php#68
Parameters:
  • $message (string) Message to verify
  • $hash (string) Assumed hash of the message
Returns:

bool Whether $hash is a valid hash of $message
Since:

8.0.0