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\Addon;
11 use Friendica\Core\L10n;
12 use Friendica\Core\PConfig;
13 use Friendica\Util\Emailer;
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);
23 require_once 'openpgp.php';
24 require_once 'openpgp_crypt_symmetric.php';
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');
31 Addon::registerHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
33 logger('installed securemail');
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');
40 Addon::unregisterHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
42 logger('removed securemail');
46 * @brief Build user settings form
48 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
50 * @param App $a App instance
51 * @param string $s output html
55 function securemail_settings(App &$a, &$s){
60 $enable = intval(PConfig::get(local_user(), 'securemail', 'enable'));
61 $publickey = PConfig::get(local_user(), 'securemail', 'pkey');
63 $t = get_markup_template('admin.tpl', 'addon/securemail/');
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"']
75 * @brief Handle data from user settings form
77 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
79 * @param App $a App instance
80 * @param array $b hook data
84 function securemail_settings_post(App &$a, array &$b){
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);
96 if ($_POST['securemail-submit'] == L10n::t('Save and send test')) {
97 $sitename = $a->config['sitename'];
99 $hostname = $a->get_hostname();
100 if (strpos($hostname, ':')) {
101 $hostname = substr($hostname, 0, strpos($hostname, ':'));
104 $sender_email = $a->config['sender_email'];
105 if (empty($sender_email)) {
106 $sender_email = 'noreply@' . $hostname;
109 $subject = 'Friendica - Secure Mail - Test';
110 $message = 'This is a test message from your Friendica Secure Mail addon.';
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,
122 // enable addon for test
123 PConfig::set(local_user(), 'securemail', 'enable', 1);
125 $res = Emailer::send($params);
127 // revert to saved value
128 PConfig::set(local_user(), 'securemail', 'enable', $enable);
131 info(L10n::t('Test email sent') . EOL);
133 notice(L10n::t('There was an error sending the test email') . EOL);
140 * @brief Encrypt notification emails text
142 * @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
144 * @param App $a App instance
145 * @param array $b hook data
149 function securemail_emailer_send_prepare(App &$a, array &$b) {
156 $enable_checked = PConfig::get($uid, 'securemail', 'enable');
157 if (!$enable_checked) {
161 $public_key_ascii = PConfig::get($uid, 'securemail', 'pkey');
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);
167 $key = OpenPGP_Message::parse($public_key);
169 $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
171 'filename' => 'encrypted.gpg'
173 $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
174 $armored_encrypted = wordwrap(
175 OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
181 $b['textVersion'] = $armored_encrypted;
182 $b['htmlVersion'] = null;
187 * add addon composer autoloader maps to system autoloader
189 function securemail_autoloader() {
191 $loader = require dirname(dirname(__DIR__)) . '/vendor/autoload.php';
193 $map = require __DIR__ . '/vendor/composer/autoload_namespaces.php';
194 foreach ($map as $namespace => $path) {
195 $loader->set($namespace, $path);
198 $map = require __DIR__ . '/vendor/composer/autoload_psr4.php';
199 foreach ($map as $namespace => $path) {
200 $loader->setPsr4($namespace, $path);
203 $classMap = require __DIR__ . '/vendor/composer/autoload_classmap.php';
205 $loader->addClassMap($classMap);
208 securemail_autoloader();