securemail/securemail.php

   1 <?php
   2 /**
   3  * Name: Secure Mail
   4  * Description: Send notification mail encrypted with user-defined public GPG key
   5  * Version: 2.0
   6  * Author: Fabio Comuni <http://kirgroup.com/profile/fabrixxm>
   7  */
   8
   9 use Friendica\App;
  10 use Friendica\Core\Addon;
  11 use Friendica\Core\Config;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\Logger;
  14 use Friendica\Core\PConfig;
  15 use Friendica\Util\Emailer;
  16
  17 /* because the fraking openpgp-php is in composer, require libs in composer
  18  * and then don't use autoloader to load classes... */
  19 $path = __DIR__ . '/vendor/phpseclib/phpseclib/phpseclib/';
  20 set_include_path(get_include_path() . PATH_SEPARATOR . $path);
  21 /* so, we don't use the autoloader and include what we need */
  22 $path = __DIR__ . '/vendor/singpolyma/openpgp-php/lib';
  23 set_include_path(get_include_path() . PATH_SEPARATOR . $path);
  24
  25 require_once 'openpgp.php';
  26 require_once 'openpgp_crypt_symmetric.php';
  27
  28
  29 function securemail_install() {
  30     Addon::registerHook('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
  31     Addon::registerHook('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
  32
  33     Addon::registerHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
  34
  35     Logger::log('installed securemail');
  36 }
  37
  38 function securemail_uninstall() {
  39     Addon::unregisterHook('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
  40     Addon::unregisterHook('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
  41
  42     Addon::unregisterHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
  43
  44     Logger::log('removed securemail');
  45 }
  46
  47 /**
  48  * @brief Build user settings form
  49  *
  50  * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
  51  *
  52  * @param App $a App instance
  53  * @param string $s output html
  54  *
  55  * @see App
  56  */
  57 function securemail_settings(App &$a, &$s){
  58     if (!local_user()) {
  59         return;
  60     }
  61
  62     $enable = intval(PConfig::get(local_user(), 'securemail', 'enable'));
  63     $publickey = PConfig::get(local_user(), 'securemail', 'pkey');
  64
  65     $t = get_markup_template('admin.tpl', 'addon/securemail/');
  66
  67     $s .= replace_macros($t, [
  68         '$title' => L10n::t('"Secure Mail" Settings'),
  69         '$submit' => L10n::t('Save Settings'),
  70         '$test' => L10n::t('Save and send test'), //NOTE: update also in 'post'
  71         '$enable' => ['securemail-enable', L10n::t('Enable Secure Mail'), $enable, ''],
  72         '$publickey' => ['securemail-pkey', L10n::t('Public key'), $publickey, L10n::t('Your public PGP key, ascii armored format'), 'rows="10"']
  73     ]);
  74 }
  75
  76 /**
  77  * @brief Handle data from user settings form
  78  *
  79  * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
  80  *
  81  * @param App $a App instance
  82  * @param array $b hook data
  83  *
  84  * @see App
  85  */
  86 function securemail_settings_post(App &$a, array &$b){
  87
  88     if (!local_user()) {
  89         return;
  90     }
  91
  92     if ($_POST['securemail-submit']) {
  93         PConfig::set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
  94         $enable = ((x($_POST, 'securemail-enable')) ? 1 : 0);
  95         PConfig::set(local_user(), 'securemail', 'enable', $enable);
  96         info(L10n::t('Secure Mail Settings saved.') . EOL);
  97
  98         if ($_POST['securemail-submit'] == L10n::t('Save and send test')) {
  99             $sitename = Config::get('config', 'sitename');
 100
 101             $hostname = $a->getHostName();
 102             if (strpos($hostname, ':')) {
 103                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
 104             }
 105
 106             $sender_email = Config::get('config', 'sender_email');
 107             if (empty($sender_email)) {
 108                 $sender_email = 'noreply@' . $hostname;
 109             }
 110
 111             $subject = 'Friendica - Secure Mail - Test';
 112             $message = 'This is a test message from your Friendica Secure Mail addon.';
 113
 114             $params = [
 115                 'uid' => local_user(),
 116                 'fromName' => $sitename,
 117                 'fromEmail' => $sender_email,
 118                 'toEmail' => $a->user['email'],
 119                 'messageSubject' => $subject,
 120                 'htmlVersion' => "<p>{$message}</p>",
 121                 'textVersion' => $message,
 122             ];
 123
 124             // enable addon for test
 125             PConfig::set(local_user(), 'securemail', 'enable', 1);
 126
 127             $res = Emailer::send($params);
 128
 129             // revert to saved value
 130             PConfig::set(local_user(), 'securemail', 'enable', $enable);
 131
 132             if ($res) {
 133                 info(L10n::t('Test email sent') . EOL);
 134             } else {
 135                 notice(L10n::t('There was an error sending the test email') . EOL);
 136             }
 137         }
 138     }
 139 }
 140
 141 /**
 142  * @brief Encrypt notification emails text
 143  *
 144  * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
 145  *
 146  * @param App $a App instance
 147  * @param array $b hook data
 148  *
 149  * @see App
 150  */
 151 function securemail_emailer_send_prepare(App &$a, array &$b) {
 152     if (!x($b, 'uid')) {
 153         return;
 154     }
 155
 156     $uid = $b['uid'];
 157
 158     $enable_checked = PConfig::get($uid, 'securemail', 'enable');
 159     if (!$enable_checked) {
 160         return;
 161     }
 162
 163     $public_key_ascii = PConfig::get($uid, 'securemail', 'pkey');
 164
 165     preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
 166     $marker = (empty($matches[1])) ? 'MESSAGE' : $matches[1];
 167     $public_key = OpenPGP::unarmor($public_key_ascii, $marker);
 168
 169     $key = OpenPGP_Message::parse($public_key);
 170
 171     $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
 172         'format' => 'u',
 173         'filename' => 'encrypted.gpg'
 174     ]);
 175     $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
 176     $armored_encrypted = wordwrap(
 177         OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
 178         64,
 179         "\n",
 180         true
 181     );
 182
 183     $b['textVersion'] = $armored_encrypted;
 184     $b['htmlVersion'] = null;
 185 }
 186
 187
 188 /**
 189  * add addon composer autoloader maps to system autoloader
 190
 191 function securemail_autoloader() {
 192
 193     $loader = require dirname(dirname(__DIR__)) . '/vendor/autoload.php';
 194
 195     $map = require __DIR__ . '/vendor/composer/autoload_namespaces.php';
 196     foreach ($map as $namespace => $path) {
 197         $loader->set($namespace, $path);
 198     }
 199
 200     $map = require __DIR__ . '/vendor/composer/autoload_psr4.php';
 201     foreach ($map as $namespace => $path) {
 202         $loader->setPsr4($namespace, $path);
 203     }
 204
 205     $classMap = require __DIR__ . '/vendor/composer/autoload_classmap.php';
 206     if ($classMap) {
 207         $loader->addClassMap($classMap);
 208     }
 209 }
 210 securemail_autoloader();
 211
 212 */