Create GPGMailer

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+sudo: false
+
+php:
+    - "7.0"
+
+matrix:
+    fast_finish: true
+
+install:
+    - composer self-update
+    - composer update
+
+script:
+    - vendor/bin/phpunit

README.md

@@ -0,0 +1,37 @@
+# GPG-Mailer
+
+Send GPG-encrypted emails (using [zend-mail](https://github.com/zendframework/zend-mail)
+and [Crypt_GPG](https://github.com/pear/Crypt_GPG)).
+
+## Example
+
+```php
+<?php
+use \ParagonIE\GPGMailer\GPGMailer;
+use \Zend\Mail\Message;
+use \Zend\Mail\Transport\Sendmail;
+
+// First, create a Zend\Mail message as usual:
+$message = new Message;
+$message->addTo('[email protected]', 'Test Email');
+$message->setBody('Cleartext for now. Do not worry; this gets encrypted.');
+
+// Instantiate GPGMailer:
+$gpgMailer = new GPGMailer(
+    new Sendmail(), 
+    ['homedir' => '/homedir/containing/keyring']
+);
+
+// GPG public key for <security@paragonie.com> (fingerprint):
+$fingerprint = '7F52D5C61D1255C731362E826B97A1C2826404DA';
+
+// Finally:
+$gpgMailer->send($message, $fingerprint); 
+```
+
+If you're encrypting with a user provided public key (and they didn't tell you
+their fingerprint), do this instead:
+
+```php
+$fingerprint = $gpgMailer->import($ASCIIArmoredPublicKey);
+```

composer.json

@@ -0,0 +1,39 @@
+{
+  "name": "paragonie/gpg-mailer",
+  "description": "Encrypt outbound emails with Crypt_GPG",
+  "license": [
+    "GPL-3.0+",
+    "proprietary"
+  ],
+  "authors": [
+    {
+      "name": "Paragon Initiative Enterprises",
+      "email": "[email protected]",
+      "homepage": "https://paragonie.com",
+      "role": "Development Team"
+    }
+  ],
+  "keywords": [
+    "Cryptography",
+    "Email",
+    "GPG",
+    "GnuPG",
+    "Mailer"
+  ],
+  "homepage": "https://paragonie.com",
+  "type": "library",
+  "autoload": {
+    "psr-4": {
+      "ParagonIE\\GPGMailer\\": "src/"
+    }
+  },
+  "require-dev": {
+    "phpunit/phpunit": "*"
+  },
+  "require": {
+    "php": "^7.0",
+    "ext-openssl": "*",
+    "zendframework/zend-mail": "^2.7",
+    "pear/crypt_gpg": "^1.4"
+  }
+}

phpunit.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="true"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnError="false"
+         stopOnFailure="false"
+         syntaxCheck="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <testsuites>
+        <testsuite name="GPGMailer Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/GPGMailer.php

@@ -0,0 +1,87 @@
+<?php
+declare(strict_types=1);
+namespace ParagonIE\GPGMailer;
+
+use Zend\Mail\{
+    Message,
+    Transport\TransportInterface
+};
+
+/**
+ * Class GPGMailer
+ * @package ParagonIE\GPGMailer
+ */
+class GPGMailer
+{
+    /**
+     * @var TransportInterface
+     */
+    protected $mailer;
+
+    /**
+     * @var array
+     */
+    protected $options;
+
+    /**
+     * GPGMailer constructor.
+     * @param TransportInterface $transport
+     * @param array $options
+     */
+    public function __construct(
+        TransportInterface $transport,
+        array $options = []
+    ) {
+        $this->mailer = $transport;
+        $this->options = $options;
+    }
+
+    /**
+     * @param Message $message
+     * @param string $fingerprint
+     * @return Message
+     */
+    public function encrypt(Message $message, string $fingerprint): Message
+    {
+
+        $gnupg = new \Crypt_GPG($this->options);
+        $gnupg->addEncryptKey($fingerprint);
+
+        // Replace the message with its encrypted counterpart
+        $encrypted = $gnupg->encrypt($message->getBodyText(), true);
+
+        return $message->setBody($encrypted);
+    }
+
+    /**
+     * Encrypt then email a message
+     *
+     * @param Message $message    The message data
+     * @param string $fingerprint Which public key fingerprint to use
+     */
+    public function send(Message $message, string $fingerprint)
+    {
+        $this->mailer->send(
+            $this->encrypt($message, $fingerprint)
+        );
+    }
+
+    /**
+     * Import a public key, return the fingerprint
+     *
+     * @param string $publicKey
+     * @return string
+     */
+    public function import(string $publicKey): string
+    {
+        try {
+            $gnupg = new \Crypt_GPG($this->options);
+            $data = $gnupg->importKey($publicKey);
+            return $data['fingerprint'];
+        } catch (\Crypt_GPG_NoDataException $ex) {
+            return '';
+        } catch (\Crypt_GPG_Exception $ex) {
+            return '';
+        }
+    }
+}

tests/EmailTest.php

@@ -0,0 +1,77 @@
+<?php
+use \ParagonIE\GPGMailer\GPGMailer;
+use \Zend\Mail\Message;
+use \Zend\Mail\Transport\Sendmail;
+
+class EmailTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers GPGMailer::encrypt()
+     * @covers GPGMailer::import()
+     */
+    public function testEncryptedMessage()
+    {
+        // First, create a Zend\Mail message as usual:
+        $message = new Message;
+        $message->addTo('[email protected]', 'GPGMailer Test Email');
+        $message->setBody(
+            'Cleartext for now. Do not worry; this gets encrypted. Don\' actually send this, however.'
+        );
+
+        // Instantiate GPGMailer:
+        $gpgMailer = new GPGMailer(
+            new Sendmail(),
+            ['homedir' => '~']
+        );
+
+        $publicKey = '-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: SKS 1.1.5
+
+mQENBFUgwRUBCADcIpqNwyYc5UmY/tpx1sF/rQ3knR1YNXYZThzFV+Gmqhp1fDH5qBs9foh1
+xwI6O7knWmQngnf/nBumI3x6xj7PuOdEZUh2FwCG/VWnglW8rKmoHzHAivjiu9SLnPIPAgHS
+Heh2XD7q3Ndm3nenbjAiRFNl2iXcwA2cTQp9Mmfw9vVcw0G0z1o0G3s8cC8ZS6flFySIervv
+fSRWj7A1acI5eE3+AH/qXJRdEJ+9J8OB65p1JMfk6+fWgOB1XZxMpz70S0rW6IX38WDSRhEK
+2fXyZJAJjyt+YGuzjZySNSoQR/V6vNYnsyrNPCJ2i5CgZQxAkyBBcr7koV9RIhPRzct/ABEB
+AAG0IVNlY3VyaXR5IDxzZWN1cml0eUBwYXJhZ29uaWUuY29tPokBOQQTAQIAIwUCVSDBFQIb
+AwcLCQgHAwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJEGuXocKCZATat2YIAIoejNFEQ2c1iaOE
+tSuB7Pn/WLbsDsHNLDKOV+UnfaCjv/vL7D+5NMChFCi2frde/NQb2TsjqmIH+V+XbnJtlrXD
+Vj7yvMVal+Jqjwj7v4eOEWcKVcFZk+9cfUgh7t92T2BMX58RpgZF0IQZ6Z1R3FfC9Ub4X6yk
+W+te1q0/4CoRycniwmlQi6iGSr99LQ5pfJq2Qlmz/luTZ0UX0h575T7dcp2T1sX/zFRk/fHe
+ANWSksipdDBjAXR7NMnYZgw2HghEdFk/xRDY7K1NRWNZBf05WrMHmh6AIVJiWZvI175URxEe
+268hh+wThBhXQHMhFNJM1qPIuzb4WogxM3UUD7mJAhwEEAECAAYFAlUgxJcACgkQRigTqCu8
+gE3Z0g//WqUZSQE5QbtRmAUAoWIr6ug/ytFGe9dZ8F1qBiUsJVAHyKf1bFBZgfC63oVHJNfO
+4qxJ2qGLKKNQy4YNrYBE0enrrsgDTcp3qDENne9VSE4I+bMJIFDMfwd73DfJsF3PgxgkpumN
+Pd7lFSraY9yjdRyC5iz7q4bEEiiZ6rdDLuVOvtnwnTyoduN0ZtpmbT/6I40LOMeP00peq+2n
+OHdggnRtmm/0wVu38GLz8SgYl4Q/IccbKiXnbsPZDvtXCyviFNT+Shve017uJFjQtz9lUGqf
++w/o2g3By9bGjIDSOvmgY7i0HF2B4GMZK4B7MT1haJ/ObIDKPyqRxrunvUSh38bv6KZc5F+V
+/4u7qz4Wy03rC8HHSJan5yuxUCQXgMIopk5DOcCvKQ6GAq0WPwPWy0EgSPjbjxpHeSx9lgsI
+ERimEGPl8tOnnVh0DlJCEGttAkE+a2e0R572yTRUM50zSct6ZnVYGB4v7hFFD8censaF1/Jm
+ZhpDd73RQZFApdkBiIVpXgQzzRl6mxX05WkWZHjlQigatjUUQWQtOBTCa+9pFGHopTqA12ju
+rLqrQyYMlSfQCyXtc1fQGvedXhTVnBYQ6DXH6hE+uFDj5/iT4WUVCm8ngfnhqH38NoB+RNn2
+F3EBq5RMx0NF5Kzx3XkZvWvNgFXlSlxkDE7GUpLa6me5AQ0EVSDBFQEIALNkpzSuJsHAHh79
+sc0AYWztdUe2MzyofQbbOnOCpWZebYsC3EXU335fIg59k0m6f+O7GmEZzzIv5v0i99GS1R8C
+Jm6FvhGqtH8ZqmOGbc71WdJSiNVE0kpQoJlVzRbig6ZyyjzrggbM1eh5OXOk5pw4+23FFEdw
+7JWU0HJS2o71r1hwp05Zvy21kcUEobz/WWQQyGS0Neo7PJn+9KS6wOxXul/UE0jct/5f7KLM
+dWMJ1VgniQmmhjvkHLPSICteqCI04RfcmMseW9gueHQXeUu1SNIvsWa2MhxjeBej3pDnrZWs
+zKwygF45GO9/v4tkIXNMy5J1AtOyRgQ3IUMqp8EAEQEAAYkBHwQYAQIACQUCVSDBFQIbDAAK
+CRBrl6HCgmQE2jnIB/4/xFz8InpM7eybnBOAir3uGcYfs3DOmaKn7qWVtGzvrKpQPYnVtlU2
+i6Z5UO4c4jDLT/8Xm1UDz3Lxvqt4xCaDwJvBZexU5BMK8l5DvOzH6o6P2L1UDu6BvmPXpVZz
+7/qUhOnyf8VQg/dAtYF4/ax19giNUpI5j5o5mX5w80RxqSXV9NdSL4fdjeG1g/xXv2luhoV5
+3T1bsycI3wjk/x5tV+M2KVhZBvvuOm/zhJjeoLWp0saaESkGXIXqurj6gZoujJvSvzl0n9F9
+VwqMEizDUfrXgtD1siQGhP0sVC6qha+F/SAEJ0jEquM4TfKWWU2S5V5vgPPpIQSYRnhQW4b1
+=Z4m0
+-----END PGP PUBLIC KEY BLOCK-----';
+
+        $fingerprint = $gpgMailer->import($publicKey);
+        $this->assertSame(
+            '7F52D5C61D1255C731362E826B97A1C2826404DA',
+            $fingerprint
+        );
+
+        $encrypted = $gpgMailer->encrypt($message, $fingerprint);
+        $body = $encrypted->getBodyText();
+        $this->assertTrue(
+            \strpos($body, '-----BEGIN PGP MESSAGE-----') !== false
+        );
+    }
+}