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