friendica-addons/securemail/securemail.php

182 lines
5.1 KiB
PHP
Raw Normal View History

<?php
/**
* Name: Secure Mail
* Description: Send notification mail encrypted with user-defined public GPG key
* Version: 2.0
* Author: Fabio Comuni <http://kirgroup.com/profile/fabrixxm>
*/
2017-05-22 06:47:36 +00:00
use Friendica\App;
use Friendica\Core\Config;
use Friendica\Core\Hook;
2018-01-22 19:03:11 +00:00
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\PConfig;
use Friendica\Core\Renderer;
use Friendica\DI;
use Friendica\Util\Emailer;
require_once __DIR__ . '/vendor/autoload.php';
2019-02-10 13:45:14 +00:00
function securemail_install()
{
Hook::register('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
Hook::register('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
2019-02-10 13:45:14 +00:00
Hook::register('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
2019-02-10 13:45:14 +00:00
Logger::log('installed securemail');
}
2019-02-10 13:45:14 +00:00
function securemail_uninstall()
{
Hook::unregister('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
Hook::unregister('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
2019-02-10 13:45:14 +00:00
Hook::unregister('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
2019-02-10 13:45:14 +00:00
Logger::log('removed securemail');
}
2017-04-14 07:13:19 +00:00
/**
* @brief Build user settings form
*
2019-02-10 13:45:14 +00:00
* @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
2017-04-14 07:13:19 +00:00
*
2019-02-10 13:45:14 +00:00
* @param App $a App instance
2017-04-14 07:13:19 +00:00
* @param string $s output html
*
2019-02-10 13:45:14 +00:00
* @see App
2017-04-14 07:13:19 +00:00
*/
2019-02-10 13:45:14 +00:00
function securemail_settings(App &$a, &$s)
{
if (!local_user()) {
return;
}
$enable = intval(DI::pConfig()->get(local_user(), 'securemail', 'enable'));
$publickey = DI::pConfig()->get(local_user(), 'securemail', 'pkey');
2019-02-10 13:45:14 +00:00
$t = Renderer::getMarkupTemplate('admin.tpl', 'addon/securemail/');
$s .= Renderer::replaceMacros($t, [
'$title' => L10n::t('"Secure Mail" Settings'),
'$submit' => L10n::t('Save Settings'),
'$test' => L10n::t('Save and send test'), //NOTE: update also in 'post'
'$enable' => ['securemail-enable', L10n::t('Enable Secure Mail'), $enable, ''],
'$publickey' => ['securemail-pkey', L10n::t('Public key'), $publickey, L10n::t('Your public PGP key, ascii armored format'), 'rows="10"']
]);
}
2017-04-14 07:13:19 +00:00
/**
* @brief Handle data from user settings form
*
2019-02-10 13:45:14 +00:00
* @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
2017-04-14 07:13:19 +00:00
*
2019-02-10 13:45:14 +00:00
* @param App $a App instance
2017-04-14 07:13:19 +00:00
* @param array $b hook data
*
2019-02-10 13:45:14 +00:00
* @see App
2017-04-14 07:13:19 +00:00
*/
2019-02-10 13:45:14 +00:00
function securemail_settings_post(App &$a, array &$b)
{
if (!local_user()) {
return;
}
if ($_POST['securemail-submit']) {
DI::pConfig()->set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
2019-02-10 13:45:14 +00:00
$enable = (!empty($_POST['securemail-enable']) ? 1 : 0);
DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
2019-02-10 13:45:14 +00:00
info(L10n::t('Secure Mail Settings saved.') . EOL);
if ($_POST['securemail-submit'] == L10n::t('Save and send test')) {
$sitename = Config::get('config', 'sitename');
$hostname = DI::baseUrl()->getHostname();
2019-02-10 13:45:14 +00:00
if (strpos($hostname, ':')) {
$hostname = substr($hostname, 0, strpos($hostname, ':'));
}
$sender_email = Config::get('config', 'sender_email');
if (empty($sender_email)) {
$sender_email = 'noreply@' . $hostname;
}
$subject = 'Friendica - Secure Mail - Test';
$message = 'This is a test message from your Friendica Secure Mail addon.';
$params = [
'uid' => local_user(),
'fromName' => $sitename,
'fromEmail' => $sender_email,
'toEmail' => $a->user['email'],
'messageSubject' => $subject,
'htmlVersion' => "<p>{$message}</p>",
'textVersion' => $message,
];
// enable addon for test
DI::pConfig()->set(local_user(), 'securemail', 'enable', 1);
2019-02-10 13:45:14 +00:00
$res = Emailer::send($params);
// revert to saved value
DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
2019-02-10 13:45:14 +00:00
if ($res) {
info(L10n::t('Test email sent') . EOL);
} else {
notice(L10n::t('There was an error sending the test email') . EOL);
}
}
}
}
2017-04-14 07:13:19 +00:00
/**
* @brief Encrypt notification emails text
*
2019-02-10 13:45:14 +00:00
* @link https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
2017-04-14 07:13:19 +00:00
*
2019-02-10 13:45:14 +00:00
* @param App $a App instance
2017-04-14 07:13:19 +00:00
* @param array $b hook data
*
2019-02-10 13:45:14 +00:00
* @see App
2017-04-14 07:13:19 +00:00
*/
2019-02-10 13:45:14 +00:00
function securemail_emailer_send_prepare(App &$a, array &$b)
{
if (empty($b['uid'])) {
return;
}
$uid = $b['uid'];
$enable_checked = DI::pConfig()->get($uid, 'securemail', 'enable');
2019-02-10 13:45:14 +00:00
if (!$enable_checked) {
return;
}
$public_key_ascii = DI::pConfig()->get($uid, 'securemail', 'pkey');
2019-02-10 13:45:14 +00:00
preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
$marker = empty($matches[1]) ? 'MESSAGE' : $matches[1];
$public_key = OpenPGP::unarmor($public_key_ascii, $marker);
$key = OpenPGP_Message::parse($public_key);
$data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
'format' => 'u',
'filename' => 'encrypted.gpg'
]);
$encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
$armored_encrypted = wordwrap(
OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
64,
"\n",
true
);
$b['textVersion'] = $armored_encrypted;
$b['htmlVersion'] = null;
}