<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Encryption;

/**
* Encryptor interface
*
* @api
* @since 100.0.2
*/
interface EncryptorInterface
{
/**
* Generate a [salted] hash.
*
* $salt can be:
* false - salt is not used
* true - random salt of the default length will be generated
* integer - random salt of specified length will be generated
* string - actual salt value to be used
*
* @param string $password
* @param bool|int|string $salt
* @return string
*/
public function getHash($password, $salt = false);

/**
* Hash a string.
*
* Returns one-way encrypted string, always the same result for the same value. Suitable for signatures.
*
* @param string $data
* @return string
*/
public function hash($data);

/**
* Synonym to isValidHash.
*
* @param string $password
* @param string $hash
* @return bool
* @throws \Exception
* @see isValidHash
*/
public function validateHash($password, $hash);

/**
* Validate hash against hashing method.
*
* Works for both hashes returned by hash() and getHash().
*
* @param string $password
* @param string $hash
* @return bool
* @throws \Exception
*/
public function isValidHash($password, $hash);

/**
* Validate hashing algorithm version
*
* @param string $hash
* @param bool $validateCount
* @return bool
*/
public function validateHashVersion($hash, $validateCount = false);

/**
* Encrypt a string
*
* @param string $data
* @return string
*/
public function encrypt($data);

/**
* Decrypt a string
*
* @param string $data
* @return string
*/
public function decrypt($data);

/**
* Return crypt model, instantiate if it is empty
*
* @param string $key
* @return \Magento\Framework\Encryption\Crypt
*/
public function validateKey($key);
}