summaryrefslogtreecommitdiff
path: root/plugins/enigma/lib/enigma_driver.php
diff options
context:
space:
mode:
authorthomascube <thomas@roundcube.net>2011-01-12 15:47:44 +0000
committerthomascube <thomas@roundcube.net>2011-01-12 15:47:44 +0000
commit62a83b3bd5813885d964d9fd1509d52bb9c4f12c (patch)
tree241e4407b51747889e63cc2d26219301639c238d /plugins/enigma/lib/enigma_driver.php
parent28a4d4a49ebc4090155f97aeaf9a409f8e1549dc (diff)
Copying plugins to release branch
Diffstat (limited to 'plugins/enigma/lib/enigma_driver.php')
-rw-r--r--plugins/enigma/lib/enigma_driver.php106
1 files changed, 106 insertions, 0 deletions
diff --git a/plugins/enigma/lib/enigma_driver.php b/plugins/enigma/lib/enigma_driver.php
new file mode 100644
index 000000000..a9a3e4715
--- /dev/null
+++ b/plugins/enigma/lib/enigma_driver.php
@@ -0,0 +1,106 @@
+<?php
+/*
+ +-------------------------------------------------------------------------+
+ | Abstract driver for the Enigma Plugin |
+ | |
+ | This program is free software; you can redistribute it and/or modify |
+ | it under the terms of the GNU General Public License version 2 |
+ | 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 General Public License for more details. |
+ | |
+ | You should have received a copy of the GNU General Public License along |
+ | with this program; if not, write to the Free Software Foundation, Inc., |
+ | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
+ | |
+ +-------------------------------------------------------------------------+
+ | 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.
+ */
+ abstract function encrypt($text, $keys);
+
+ /**
+ * Decryption..
+ */
+ abstract function decrypt($text, $key, $passwd);
+
+ /**
+ * Signing.
+ */
+ abstract function sign($text, $key, $passwd);
+
+ /**
+ * 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 bollean True if first argument is a filename
+ *
+ * @return mixed Import status array or enigma_error
+ */
+ abstract function import($content, $isfile=false);
+
+ /**
+ * 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
+ *
+ * @return mixed Key (enigma_key) object or enigma_error
+ */
+ abstract function gen_key($data);
+
+ /**
+ * Key deletion.
+ */
+ abstract function del_key($keyid);
+}