4 * Description: Send notification mail encrypted with user-defined public GPG key
6 * Author: Fabio Comuni <http://kirgroup.com/profile/fabrixxm>
10 use Friendica\Core\Hook;
11 use Friendica\Core\Logger;
12 use Friendica\Core\Renderer;
14 use Friendica\Util\Emailer;
16 require_once __DIR__ . '/vendor/autoload.php';
18 function securemail_install()
20 Hook::register('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
21 Hook::register('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
23 Hook::register('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
25 Logger::log('installed securemail');
28 function securemail_uninstall()
30 Hook::unregister('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
31 Hook::unregister('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
33 Hook::unregister('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
35 Logger::log('removed securemail');
39 * @brief Build user settings form
41 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
43 * @param App $a App instance
44 * @param string $s output html
48 function securemail_settings(App &$a, &$s)
54 $enable = intval(DI::pConfig()->get(local_user(), 'securemail', 'enable'));
55 $publickey = DI::pConfig()->get(local_user(), 'securemail', 'pkey');
57 $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/securemail/');
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"']
69 * @brief Handle data from user settings form
71 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
73 * @param App $a App instance
74 * @param array $b hook data
78 function securemail_settings_post(App &$a, array &$b)
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);
90 if ($_POST['securemail-submit'] == DI::l10n()->t('Save and send test')) {
91 $sitename = DI::config()->get('config', 'sitename');
93 $hostname = DI::baseUrl()->getHostname();
94 if (strpos($hostname, ':')) {
95 $hostname = substr($hostname, 0, strpos($hostname, ':'));
98 $sender_email = DI::config()->get('config', 'sender_email');
99 if (empty($sender_email)) {
100 $sender_email = 'noreply@' . $hostname;
103 $subject = 'Friendica - Secure Mail - Test';
104 $message = 'This is a test message from your Friendica Secure Mail addon.';
106 // enable addon for test
107 DI::pConfig()->set(local_user(), 'securemail', 'enable', 1);
109 $res = DI::emailer()->send($sitename, $sender_email, $sender_email,
110 $a->user['email'], $subject, "<p>{$message}</p>", $message,
113 // revert to saved value
114 DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
117 info(DI::l10n()->t('Test email sent') . EOL);
119 notice(DI::l10n()->t('There was an error sending the test email') . EOL);
126 * @brief Encrypt notification emails text
128 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
130 * @param App $a App instance
131 * @param array $b hook data
135 function securemail_emailer_send_prepare(App &$a, array &$b)
137 if (empty($b['uid'])) {
143 $enable_checked = DI::pConfig()->get($uid, 'securemail', 'enable');
144 if (!$enable_checked) {
148 $public_key_ascii = DI::pConfig()->get($uid, 'securemail', 'pkey');
150 preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
151 $marker = empty($matches[1]) ? 'MESSAGE' : $matches[1];
152 $public_key = OpenPGP::unarmor($public_key_ascii, $marker);
154 $key = OpenPGP_Message::parse($public_key);
156 $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
158 'filename' => 'encrypted.gpg'
160 $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
161 $armored_encrypted = wordwrap(
162 OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
168 $b['textVersion'] = $armored_encrypted;
169 $b['htmlVersion'] = null;