From 6e4642b12ca7a487690e4cf3e7a72fbade224d5a Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sun, 17 Apr 2016 03:32:59 -0400
Subject: [PATCH] Enigma: Add enigma_debug option
---
plugins/enigma/lib/enigma_driver_gnupg.php | 149 ++++++++++++++++++++++++++++++++++++++-----------
1 files changed, 116 insertions(+), 33 deletions(-)
diff --git a/plugins/enigma/lib/enigma_driver_gnupg.php b/plugins/enigma/lib/enigma_driver_gnupg.php
index c7fc2dc..9a8e59e 100644
--- a/plugins/enigma/lib/enigma_driver_gnupg.php
+++ b/plugins/enigma/lib/enigma_driver_gnupg.php
@@ -19,10 +19,10 @@
class enigma_driver_gnupg extends enigma_driver
{
- private $rc;
- private $gpg;
- private $homedir;
- private $user;
+ protected $rc;
+ protected $gpg;
+ protected $homedir;
+ protected $user;
function __construct($user)
@@ -40,17 +40,18 @@
function init()
{
$homedir = $this->rc->config->get('enigma_pgp_homedir', INSTALL_PATH . 'plugins/enigma/home');
+ $debug = $this->rc->config->get('enigma_debug');
if (!$homedir)
- return new enigma_error(enigma_error::E_INTERNAL,
+ return new enigma_error(enigma_error::INTERNAL,
"Option 'enigma_pgp_homedir' not specified");
// check if homedir exists (create it if not) and is readable
if (!file_exists($homedir))
- return new enigma_error(enigma_error::E_INTERNAL,
+ return new enigma_error(enigma_error::INTERNAL,
"Keys directory doesn't exists: $homedir");
if (!is_writable($homedir))
- return new enigma_error(enigma_error::E_INTERNAL,
+ return new enigma_error(enigma_error::INTERNAL,
"Keys directory isn't writeable: $homedir");
$homedir = $homedir . '/' . $this->user;
@@ -60,10 +61,10 @@
mkdir($homedir, 0700);
if (!file_exists($homedir))
- return new enigma_error(enigma_error::E_INTERNAL,
+ return new enigma_error(enigma_error::INTERNAL,
"Unable to create keys directory: $homedir");
if (!is_writable($homedir))
- return new enigma_error(enigma_error::E_INTERNAL,
+ return new enigma_error(enigma_error::INTERNAL,
"Unable to write to keys directory: $homedir");
$this->homedir = $homedir;
@@ -73,7 +74,7 @@
$this->gpg = new Crypt_GPG(array(
'homedir' => $this->homedir,
// 'binary' => '/usr/bin/gpg2',
- // 'debug' => true,
+ 'debug' => $debug ? array($this, 'debug') : false,
));
}
catch (Exception $e) {
@@ -82,10 +83,12 @@
}
/**
- * Encrypt a message
+ * Encryption.
*
- * @param string The message
- * @param array List of keys
+ * @param string Message body
+ * @param array List of key-password mapping
+ *
+ * @return mixed Encrypted message or enigma_error on failure
*/
function encrypt($text, $keys)
{
@@ -94,8 +97,7 @@
$this->gpg->addEncryptKey($key);
}
- $dec = $this->gpg->encrypt($text, true);
- return $dec;
+ return $this->gpg->encrypt($text, true);
}
catch (Exception $e) {
return $this->get_error_from_exception($e);
@@ -107,6 +109,8 @@
*
* @param string Encrypted message
* @param array List of key-password mapping
+ *
+ * @return mixed Decrypted message or enigma_error on failure
*/
function decrypt($text, $keys = array())
{
@@ -115,14 +119,23 @@
$this->gpg->addDecryptKey($key, $password);
}
- $dec = $this->gpg->decrypt($text);
- return $dec;
+ return $this->gpg->decrypt($text);
}
catch (Exception $e) {
return $this->get_error_from_exception($e);
}
}
+ /**
+ * Signing.
+ *
+ * @param string Message body
+ * @param string Key ID
+ * @param string Key password
+ * @param int Signing mode (enigma_engine::SIGN_*)
+ *
+ * @return mixed True on success or enigma_error on failure
+ */
function sign($text, $key, $passwd, $mode = null)
{
try {
@@ -134,6 +147,14 @@
}
}
+ /**
+ * 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
+ */
function verify($text, $signature)
{
try {
@@ -145,6 +166,14 @@
}
}
+ /**
+ * Key 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
+ */
public function import($content, $isfile=false)
{
try {
@@ -158,6 +187,30 @@
}
}
+ /**
+ * Key export.
+ *
+ * @param string Key ID
+ *
+ * @return mixed Key content or enigma_error
+ */
+ public function export($keyid)
+ {
+ try {
+ return $this->gpg->exportPublicKey($keyid, true);
+ }
+ catch (Exception $e) {
+ return $this->get_error_from_exception($e);
+ }
+ }
+
+ /**
+ * Keys listing.
+ *
+ * @param string Optional pattern for key ID, user ID or fingerprint
+ *
+ * @return mixed Array of enigma_key objects or enigma_error
+ */
public function list_keys($pattern='')
{
try {
@@ -176,6 +229,13 @@
}
}
+ /**
+ * Single key information.
+ *
+ * @param string Key ID, user ID or fingerprint
+ *
+ * @return mixed Key (enigma_key) object or enigma_error
+ */
public function get_key($keyid)
{
$list = $this->list_keys($keyid);
@@ -198,10 +258,11 @@
public function gen_key($data)
{
try {
+ $debug = $this->rc->config->get('enigma_debug');
$keygen = new Crypt_GPG_KeyGenerator(array(
'homedir' => $this->homedir,
// 'binary' => '/usr/bin/gpg2',
- // 'debug' => true,
+ 'debug' => $debug ? array($this, 'debug') : false,
));
$key = $keygen
@@ -216,6 +277,13 @@
}
}
+ /**
+ * Key deletion.
+ *
+ * @param string Key ID
+ *
+ * @return mixed True on success or enigma_error
+ */
public function delete_key($keyid)
{
// delete public key
@@ -226,14 +294,14 @@
$code = $result->getCode();
// if not found, delete private key
- if ($code == enigma_error::E_KEYNOTFOUND) {
+ if ($code == enigma_error::KEYNOTFOUND) {
$result = $this->delete_privkey($keyid);
}
// need to delete private key first
- else if ($code == enigma_error::E_DELKEY) {
+ else if ($code == enigma_error::DELKEY) {
$key = $this->get_key($keyid);
for ($i = count($key->subkeys) - 1; $i >= 0; $i--) {
- $type = $key->subkeys[$i]->can_encrypt ? 'priv' : 'pub';
+ $type = ($key->subkeys[$i]->usage & enigma_key::CAN_ENCRYPT) ? 'priv' : 'pub';
$result = $this->{'delete_' . $type . 'key'}($key->subkeys[$i]->id);
if ($result !== true) {
return $result;
@@ -245,7 +313,10 @@
return $result;
}
- public function delete_privkey($keyid)
+ /**
+ * Private key deletion.
+ */
+ protected function delete_privkey($keyid)
{
try {
$this->gpg->deletePrivateKey($keyid);
@@ -256,7 +327,10 @@
}
}
- public function delete_pubkey($keyid)
+ /**
+ * Public key deletion.
+ */
+ protected function delete_pubkey($keyid)
{
try {
$this->gpg->deletePublicKey($keyid);
@@ -274,27 +348,27 @@
*
* @return enigma_error Error object
*/
- private function get_error_from_exception($e)
+ protected function get_error_from_exception($e)
{
$data = array();
if ($e instanceof Crypt_GPG_KeyNotFoundException) {
- $error = enigma_error::E_KEYNOTFOUND;
+ $error = enigma_error::KEYNOTFOUND;
$data['id'] = $e->getKeyId();
}
else if ($e instanceof Crypt_GPG_BadPassphraseException) {
- $error = enigma_error::E_BADPASS;
+ $error = enigma_error::BADPASS;
$data['bad'] = $e->getBadPassphrases();
$data['missing'] = $e->getMissingPassphrases();
}
else if ($e instanceof Crypt_GPG_NoDataException) {
- $error = enigma_error::E_NODATA;
+ $error = enigma_error::NODATA;
}
else if ($e instanceof Crypt_GPG_DeletePrivateKeyException) {
- $error = enigma_error::E_DELKEY;
+ $error = enigma_error::DELKEY;
}
else {
- $error = enigma_error::E_INTERNAL;
+ $error = enigma_error::INTERNAL;
}
$msg = $e->getMessage();
@@ -309,7 +383,7 @@
*
* @return enigma_signature Signature object
*/
- private function parse_signature($sig)
+ protected function parse_signature($sig)
{
$user = $sig->getUserId();
@@ -333,7 +407,7 @@
*
* @return enigma_key Key object
*/
- private function parse_key($key)
+ protected function parse_key($key)
{
$ekey = new enigma_key();
@@ -358,8 +432,9 @@
$skey->expires = $subkey->getExpirationDate();
$skey->fingerprint = $subkey->getFingerprint();
$skey->has_private = $subkey->hasPrivate();
- $skey->can_sign = $subkey->canSign();
- $skey->can_encrypt = $subkey->canEncrypt();
+ $skey->algorithm = $subkey->getAlgorithm();
+ $skey->length = $subkey->getLength();
+ $skey->usage = $subkey->usage();
$ekey->subkeys[$idx] = $skey;
};
@@ -368,4 +443,12 @@
return $ekey;
}
+
+ /**
+ * Write debug info from Crypt_GPG to logs/enigma
+ */
+ public function debug($line)
+ {
+ rcube::write_log('enigma', 'GPG: ' . $line);
+ }
}
--
Gitblit v1.9.1