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