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\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\Util\Emailer;
18 /* because the fraking openpgp-php is in composer, require libs in composer
19 * and then don't use autoloader to load classes... */
20 $path = __DIR__ . '/vendor/phpseclib/phpseclib/phpseclib/';
21 set_include_path(get_include_path() . PATH_SEPARATOR . $path);
22 /* so, we don't use the autoloader and include what we need */
23 $path = __DIR__ . '/vendor/singpolyma/openpgp-php/lib';
24 set_include_path(get_include_path() . PATH_SEPARATOR . $path);
26 require_once 'openpgp.php';
27 require_once 'openpgp_crypt_symmetric.php';
30 function securemail_install() {
31 Hook::register('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
32 Hook::register('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
34 Hook::register('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
36 Logger::log('installed securemail');
39 function securemail_uninstall() {
40 Hook::unregister('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
41 Hook::unregister('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
43 Hook::unregister('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
45 Logger::log('removed securemail');
49 * @brief Build user settings form
51 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
53 * @param App $a App instance
54 * @param string $s output html
58 function securemail_settings(App &$a, &$s){
63 $enable = intval(PConfig::get(local_user(), 'securemail', 'enable'));
64 $publickey = PConfig::get(local_user(), 'securemail', 'pkey');
66 $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/securemail/');
68 $s .= Renderer::replaceMacros($t, [
69 '$title' => L10n::t('"Secure Mail" Settings'),
70 '$submit' => L10n::t('Save Settings'),
71 '$test' => L10n::t('Save and send test'), //NOTE: update also in 'post'
72 '$enable' => ['securemail-enable', L10n::t('Enable Secure Mail'), $enable, ''],
73 '$publickey' => ['securemail-pkey', L10n::t('Public key'), $publickey, L10n::t('Your public PGP key, ascii armored format'), 'rows="10"']
78 * @brief Handle data from user settings form
80 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
82 * @param App $a App instance
83 * @param array $b hook data
87 function securemail_settings_post(App &$a, array &$b){
93 if ($_POST['securemail-submit']) {
94 PConfig::set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
95 $enable = (!empty($_POST['securemail-enable']) ? 1 : 0);
96 PConfig::set(local_user(), 'securemail', 'enable', $enable);
97 info(L10n::t('Secure Mail Settings saved.') . EOL);
99 if ($_POST['securemail-submit'] == L10n::t('Save and send test')) {
100 $sitename = Config::get('config', 'sitename');
102 $hostname = $a->getHostName();
103 if (strpos($hostname, ':')) {
104 $hostname = substr($hostname, 0, strpos($hostname, ':'));
107 $sender_email = Config::get('config', 'sender_email');
108 if (empty($sender_email)) {
109 $sender_email = 'noreply@' . $hostname;
112 $subject = 'Friendica - Secure Mail - Test';
113 $message = 'This is a test message from your Friendica Secure Mail addon.';
116 'uid' => local_user(),
117 'fromName' => $sitename,
118 'fromEmail' => $sender_email,
119 'toEmail' => $a->user['email'],
120 'messageSubject' => $subject,
121 'htmlVersion' => "<p>{$message}</p>",
122 'textVersion' => $message,
125 // enable addon for test
126 PConfig::set(local_user(), 'securemail', 'enable', 1);
128 $res = Emailer::send($params);
130 // revert to saved value
131 PConfig::set(local_user(), 'securemail', 'enable', $enable);
134 info(L10n::t('Test email sent') . EOL);
136 notice(L10n::t('There was an error sending the test email') . EOL);
143 * @brief Encrypt notification emails text
145 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
147 * @param App $a App instance
148 * @param array $b hook data
152 function securemail_emailer_send_prepare(App &$a, array &$b) {
153 if (empty($b['uid'])) {
159 $enable_checked = PConfig::get($uid, 'securemail', 'enable');
160 if (!$enable_checked) {
164 $public_key_ascii = PConfig::get($uid, 'securemail', 'pkey');
166 preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
167 $marker = empty($matches[1]) ? 'MESSAGE' : $matches[1];
168 $public_key = OpenPGP::unarmor($public_key_ascii, $marker);
170 $key = OpenPGP_Message::parse($public_key);
172 $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
174 'filename' => 'encrypted.gpg'
176 $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
177 $armored_encrypted = wordwrap(
178 OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
184 $b['textVersion'] = $armored_encrypted;
185 $b['htmlVersion'] = null;
190 * add addon composer autoloader maps to system autoloader
192 function securemail_autoloader() {
194 $loader = require dirname(dirname(__DIR__)) . '/vendor/autoload.php';
196 $map = require __DIR__ . '/vendor/composer/autoload_namespaces.php';
197 foreach ($map as $namespace => $path) {
198 $loader->set($namespace, $path);
201 $map = require __DIR__ . '/vendor/composer/autoload_psr4.php';
202 foreach ($map as $namespace => $path) {
203 $loader->setPsr4($namespace, $path);
206 $classMap = require __DIR__ . '/vendor/composer/autoload_classmap.php';
208 $loader->addClassMap($classMap);
211 securemail_autoloader();