Mercurial > hg > rc1
diff plugins/enigma/lib/enigma_driver.php @ 0:1e000243b222
vanilla 1.3.3 distro, I hope
| author | Charlie Root |
|---|---|
| date | Thu, 04 Jan 2018 15:50:29 -0500 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plugins/enigma/lib/enigma_driver.php Thu Jan 04 15:50:29 2018 -0500 @@ -0,0 +1,142 @@ +<?php + +/** + +-------------------------------------------------------------------------+ + | Abstract driver for the Enigma Plugin | + | | + | Copyright (C) 2010-2015 The Roundcube Dev Team | + | | + | Licensed under the GNU General Public License version 3 or | + | any later version with exceptions for skins & plugins. | + | See the README file for a full license statement. | + | | + +-------------------------------------------------------------------------+ + | Author: Aleksander Machniak <alec@alec.pl> | + +-------------------------------------------------------------------------+ +*/ + +abstract class enigma_driver +{ + /** + * Class constructor. + * + * @param string User name (email address) + */ + abstract function __construct($user); + + /** + * Driver initialization. + * + * @return mixed NULL on success, enigma_error on failure + */ + abstract function init(); + + /** + * Encryption (and optional signing). + * + * @param string Message body + * @param array List of keys (enigma_key objects) + * @param enigma_key Optional signing Key ID + * + * @return mixed Encrypted message or enigma_error on failure + */ + abstract function encrypt($text, $keys, $sign_key = null); + + /** + * Decryption (and sig verification if sig exists). + * + * @param string Encrypted message + * @param array List of key-password + * @param enigma_signature Signature information (if available) + * + * @return mixed Decrypted message or enigma_error on failure + */ + abstract function decrypt($text, $keys = array(), &$signature = null); + + /** + * Signing. + * + * @param string Message body + * @param enigma_key The signing key + * @param int Signing mode (enigma_engine::SIGN_*) + * + * @return mixed True on success or enigma_error on failure + */ + abstract function sign($text, $key, $mode = null); + + /** + * Signature verification. + * + * @param string Message body + * @param string Signature, if message is of type PGP/MIME and body doesn't contain it + * + * @return mixed Signature information (enigma_signature) or enigma_error + */ + abstract function verify($text, $signature); + + /** + * Key/Cert file import. + * + * @param string File name or file content + * @param bolean True if first argument is a filename + * @param array Optional key => password map + * + * @return mixed Import status array or enigma_error + */ + abstract function import($content, $isfile = false, $passwords = array()); + + /** + * Key/Cert export. + * + * @param string Key ID + * @param bool Include private key + * @param array Optional key => password map + * + * @return mixed Key content or enigma_error + */ + abstract function export($key, $with_private = false, $passwords = array()); + + /** + * Keys listing. + * + * @param string Optional pattern for key ID, user ID or fingerprint + * + * @return mixed Array of enigma_key objects or enigma_error + */ + abstract function list_keys($pattern = ''); + + /** + * Single key information. + * + * @param string Key ID, user ID or fingerprint + * + * @return mixed Key (enigma_key) object or enigma_error + */ + abstract function get_key($keyid); + + /** + * Key pair generation. + * + * @param array Key/User data (name, email, password, size) + * + * @return mixed Key (enigma_key) object or enigma_error + */ + abstract function gen_key($data); + + /** + * Key deletion. + * + * @param string Key ID + * + * @return mixed True on success or enigma_error + */ + abstract function delete_key($keyid); + + /** + * Returns a name of the hash algorithm used for the last + * signing operation. + * + * @return string Hash algorithm name e.g. sha1 + */ + abstract function signature_algorithm(); +}
