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\Hook;
  11 use Friendica\Core\Logger;
  12 use Friendica\Core\Renderer;
  13 use Friendica\DI;
  14 use Friendica\Util\Emailer;
  15
  16 require_once __DIR__ . '/vendor/autoload.php';
  17
  18 function securemail_install()
  19 {
  20         Hook::register('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
  21         Hook::register('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
  22
  23         Hook::register('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
  24
  25         Logger::log('installed securemail');
  26 }
  27
  28 function securemail_uninstall()
  29 {
  30         Hook::unregister('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
  31         Hook::unregister('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
  32
  33         Hook::unregister('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
  34
  35         Logger::log('removed securemail');
  36 }
  37
  38 /**
  39  * @brief Build user settings form
  40  *
  41  * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
  42  *
  43  * @param App    $a App instance
  44  * @param string $s output html
  45  *
  46  * @see   App
  47  */
  48 function securemail_settings(App &$a, &$s)
  49 {
  50         if (!local_user()) {
  51                 return;
  52         }
  53
  54         $enable = intval(DI::pConfig()->get(local_user(), 'securemail', 'enable'));
  55         $publickey = DI::pConfig()->get(local_user(), 'securemail', 'pkey');
  56
  57         $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/securemail/');
  58
  59         $s .= Renderer::replaceMacros($t, [
  60                 '$title' => DI::l10n()->t('"Secure Mail" Settings'),
  61                 '$submit' => DI::l10n()->t('Save Settings'),
  62                 '$test' => DI::l10n()->t('Save and send test'), //NOTE: update also in 'post'
  63                 '$enable' => ['securemail-enable', DI::l10n()->t('Enable Secure Mail'), $enable, ''],
  64                 '$publickey' => ['securemail-pkey', DI::l10n()->t('Public key'), $publickey, DI::l10n()->t('Your public PGP key, ascii armored format'), 'rows="10"']
  65         ]);
  66 }
  67
  68 /**
  69  * @brief Handle data from user settings form
  70  *
  71  * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
  72  *
  73  * @param App   $a App instance
  74  * @param array $b hook data
  75  *
  76  * @see   App
  77  */
  78 function securemail_settings_post(App &$a, array &$b)
  79 {
  80         if (!local_user()) {
  81                 return;
  82         }
  83
  84         if ($_POST['securemail-submit']) {
  85                 DI::pConfig()->set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
  86                 $enable = (!empty($_POST['securemail-enable']) ? 1 : 0);
  87                 DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
  88                 info(DI::l10n()->t('Secure Mail Settings saved.') . EOL);
  89
  90                 if ($_POST['securemail-submit'] == DI::l10n()->t('Save and send test')) {
  91                         $sitename = DI::config()->get('config', 'sitename');
  92
  93                         $hostname = DI::baseUrl()->getHostname();
  94                         if (strpos($hostname, ':')) {
  95                                 $hostname = substr($hostname, 0, strpos($hostname, ':'));
  96                         }
  97
  98                         $sender_email = DI::config()->get('config', 'sender_email');
  99                         if (empty($sender_email)) {
 100                                 $sender_email = 'noreply@' . $hostname;
 101                         }
 102
 103                         $subject = 'Friendica - Secure Mail - Test';
 104                         $message = 'This is a test message from your Friendica Secure Mail addon.';
 105
 106                         $params = [
 107                                 'uid' => local_user(),
 108                                 'fromName' => $sitename,
 109                                 'fromEmail' => $sender_email,
 110                                 'toEmail' => $a->user['email'],
 111                                 'messageSubject' => $subject,
 112                                 'htmlVersion' => "<p>{$message}</p>",
 113                                 'textVersion' => $message,
 114                         ];
 115
 116                         // enable addon for test
 117                         DI::pConfig()->set(local_user(), 'securemail', 'enable', 1);
 118
 119                         $res = Emailer::send($params);
 120
 121                         // revert to saved value
 122                         DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
 123
 124                         if ($res) {
 125                                 info(DI::l10n()->t('Test email sent') . EOL);
 126                         } else {
 127                                 notice(DI::l10n()->t('There was an error sending the test email') . EOL);
 128                         }
 129                 }
 130         }
 131 }
 132
 133 /**
 134  * @brief Encrypt notification emails text
 135  *
 136  * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
 137  *
 138  * @param App   $a App instance
 139  * @param array $b hook data
 140  *
 141  * @see   App
 142  */
 143 function securemail_emailer_send_prepare(App &$a, array &$b)
 144 {
 145         if (empty($b['uid'])) {
 146                 return;
 147         }
 148
 149         $uid = $b['uid'];
 150
 151         $enable_checked = DI::pConfig()->get($uid, 'securemail', 'enable');
 152         if (!$enable_checked) {
 153                 return;
 154         }
 155
 156         $public_key_ascii = DI::pConfig()->get($uid, 'securemail', 'pkey');
 157
 158         preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
 159         $marker = empty($matches[1]) ? 'MESSAGE' : $matches[1];
 160         $public_key = OpenPGP::unarmor($public_key_ascii, $marker);
 161
 162         $key = OpenPGP_Message::parse($public_key);
 163
 164         $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
 165                 'format' => 'u',
 166                 'filename' => 'encrypted.gpg'
 167         ]);
 168         $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
 169         $armored_encrypted = wordwrap(
 170                 OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
 171                 64,
 172                 "\n",
 173                 true
 174         );
 175
 176         $b['textVersion'] = $armored_encrypted;
 177         $b['htmlVersion'] = null;
 178 }