diff options
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/iservercontainer.php | 13 | ||||
-rw-r--r-- | lib/public/security/ihasher.php | 48 |
2 files changed, 61 insertions, 0 deletions
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index a52dc2d13dc..794bba6bfb6 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -128,6 +128,19 @@ interface IServerContainer { */ function getConfig(); + /** + * Returns a Crypto instance + * + * @return \OCP\Security\ICrypto + */ + function getCrypto(); + + /** + * Returns a Hasher instance + * + * @return \OCP\Security\IHasher + */ + function getHasher(); /** * Returns an instance of the db facade diff --git a/lib/public/security/ihasher.php b/lib/public/security/ihasher.php new file mode 100644 index 00000000000..75900fb55ac --- /dev/null +++ b/lib/public/security/ihasher.php @@ -0,0 +1,48 @@ +<?php +/** + * Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Security; + +/** + * 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); + * + * @package OCP\Security + */ +interface IHasher { + /** + * 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. + * + * @param string $message Message to generate hash from + * @return string Hash of the message with appended version parameter + */ + public function hash($message); + + /** + * @param string $message Message to verify + * @param string $hash Assumed hash of the message + * @param null|string &$newHash Reference will contain the updated hash if necessary. Update the existing hash with this one. + * @return bool Whether $hash is a valid hash of $message + */ + public function verify($message, $hash, &$newHash = null); +} |