You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.3 KiB
67 lines
2.3 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* This program is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU Affero General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU Affero General Public License, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OCP\Security; |
|
|
|
/** |
|
* Class Crypto provides a high-level encryption layer using AES-CBC. If no key has been provided |
|
* it will use the secret defined in config.php as key. Additionally the message will be HMAC'd. |
|
* |
|
* Usage: |
|
* $encryptWithDefaultPassword = \OC::$server->getCrypto()->encrypt('EncryptedText'); |
|
* $encryptWithCustomPassword = \OC::$server->getCrypto()->encrypt('EncryptedText', 'password'); |
|
* |
|
* @package OCP\Security |
|
* @since 8.0.0 |
|
*/ |
|
interface ICrypto { |
|
|
|
/** |
|
* @param string $message The message to authenticate |
|
* @param string $password Password to use (defaults to `secret` in config.php) |
|
* @return string Calculated HMAC |
|
* @since 8.0.0 |
|
*/ |
|
public function calculateHMAC(string $message, string $password = ''): string; |
|
|
|
/** |
|
* Encrypts a value and adds an HMAC (Encrypt-Then-MAC) |
|
* @param string $plaintext |
|
* @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
* @return string Authenticated ciphertext |
|
* @since 8.0.0 |
|
*/ |
|
public function encrypt(string $plaintext, string $password = ''): string; |
|
|
|
/** |
|
* Decrypts a value and verifies the HMAC (Encrypt-Then-Mac) |
|
* @param string $authenticatedCiphertext |
|
* @param string $password Password to encrypt, if not specified the secret from config.php will be taken |
|
* @return string plaintext |
|
* @throws \Exception If the HMAC does not match |
|
* @throws \Exception If the decryption failed |
|
* @since 8.0.0 |
|
*/ |
|
public function decrypt(string $authenticatedCiphertext, string $password = ''): string; |
|
}
|
|
|