friendica-addons/securemail/securemail.php

210 lines
6.5 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\Addon;
use Friendica\Core\PConfig;
use Friendica\Util\Emailer;
/* because the fraking openpgp-php is in composer, require libs in composer
* and then don't use autoloader to load classes... */
2017-04-14 07:13:19 +00:00
$path = __DIR__ . '/vendor/phpseclib/phpseclib/phpseclib/';
set_include_path(get_include_path() . PATH_SEPARATOR . $path);
/* so, we don't use the autoloader and include what we need */
2017-04-14 07:13:19 +00:00
$path = __DIR__ . '/vendor/singpolyma/openpgp-php/lib';
set_include_path(get_include_path() . PATH_SEPARATOR . $path);
2017-04-14 07:13:19 +00:00
require_once 'openpgp.php';
require_once 'openpgp_crypt_symmetric.php';
function securemail_install() {
Addon::registerHook('plugin_settings', 'addon/securemail/securemail.php', 'securemail_settings');
Addon::registerHook('plugin_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
Addon::registerHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
2017-04-14 07:13:19 +00:00
logger('installed securemail');
}
function securemail_uninstall() {
Addon::unregisterHook('plugin_settings', 'addon/securemail/securemail.php', 'securemail_settings');
Addon::unregisterHook('plugin_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
Addon::unregisterHook('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
2017-04-14 07:13:19 +00:00
logger('removed securemail');
}
2017-04-14 07:13:19 +00:00
/**
* @brief Build user settings form
*
* @link https://github.com/friendica/friendica/blob/develop/doc/Plugins.md#plugin_settings 'plugin_settings' hook
*
* @param App $a App instance
* @param string $s output html
*
* @see App
*/
2017-04-14 14:13:49 +00:00
function securemail_settings(App &$a, &$s){
2017-04-14 07:13:19 +00:00
if (!local_user()) {
return;
}
$enable = intval(PConfig::get(local_user(), 'securemail', 'enable'));
$publickey = PConfig::get(local_user(), 'securemail', 'pkey');
2017-04-14 07:13:19 +00:00
$t = get_markup_template('admin.tpl', 'addon/securemail/');
2018-01-15 13:15:33 +00:00
$s .= replace_macros($t, [
'$title' => t('"Secure Mail" Settings'),
'$submit' => t('Save Settings'),
'$test' => t('Save and send test'), //NOTE: update also in 'post'
2018-01-15 13:15:33 +00:00
'$enable' => ['securemail-enable', t('Enable Secure Mail'), $enable, ''],
'$publickey' => ['securemail-pkey', t('Public key'), $publickey, 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
*
* @link https://github.com/friendica/friendica/blob/develop/doc/Plugins.md#plugin_settings_post 'plugin_settings_post' hook
*
* @param App $a App instance
* @param array $b hook data
*
* @see App
*/
function securemail_settings_post(App &$a, array &$b){
if (!local_user()) {
return;
}
2017-04-14 07:13:19 +00:00
if ($_POST['securemail-submit']) {
PConfig::set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
2017-04-14 07:13:19 +00:00
$enable = ((x($_POST, 'securemail-enable')) ? 1 : 0);
PConfig::set(local_user(), 'securemail', 'enable', $enable);
2017-04-14 07:13:19 +00:00
info(t('Secure Mail Settings saved.') . EOL);
if ($_POST['securemail-submit'] == t('Save and send test')) {
$sitename = $a->config['sitename'];
$hostname = $a->get_hostname();
2017-04-14 07:13:19 +00:00
if (strpos($hostname, ':')) {
$hostname = substr($hostname, 0, strpos($hostname, ':'));
}
$sender_email = $a->config['sender_email'];
2017-04-14 07:13:19 +00:00
if (empty($sender_email)) {
$sender_email = 'noreply@' . $hostname;
}
2017-04-14 07:13:19 +00:00
$subject = 'Friendica - Secure Mail - Test';
2017-04-14 14:13:49 +00:00
$message = 'This is a test message from your Friendica Secure Mail addon.';
2018-01-15 13:15:33 +00:00
$params = [
'uid' => local_user(),
'fromName' => $sitename,
'fromEmail' => $sender_email,
'toEmail' => $a->user['email'],
'messageSubject' => $subject,
'htmlVersion' => "<p>{$message}</p>",
'textVersion' => $message,
2018-01-15 13:15:33 +00:00
];
// enable addon for test
PConfig::set(local_user(), 'securemail', 'enable', 1);
$res = Emailer::send($params);
// revert to saved value
PConfig::set(local_user(), 'securemail', 'enable', $enable);
if ($res) {
2017-04-14 07:13:19 +00:00
info(t('Test email sent') . EOL);
} else {
2017-04-14 07:13:19 +00:00
notice(t('There was an error sending the test email') . EOL);
}
}
}
}
2017-04-14 07:13:19 +00:00
/**
* @brief Encrypt notification emails text
*
* @link https://github.com/friendica/friendica/blob/develop/doc/Plugins.md#emailer_send_prepare 'emailer_send_prepare' hook
*
* @param App $a App instance
* @param array $b hook data
*
* @see App
*/
function securemail_emailer_send_prepare(App &$a, array &$b) {
2017-04-14 14:13:49 +00:00
if (!x($b, 'uid')) {
return;
}
$uid = $b['uid'];
$enable_checked = PConfig::get($uid, 'securemail', 'enable');
if (!$enable_checked) {
return;
}
$public_key_ascii = PConfig::get($uid, 'securemail', 'pkey');
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);
2018-01-15 13:15:33 +00:00
$data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
'format' => 'u',
'filename' => 'encrypted.gpg'
2018-01-15 13:15:33 +00:00
]);
$encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
2017-04-14 07:13:19 +00:00
$armored_encrypted = wordwrap(
OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
64,
2017-04-14 14:13:49 +00:00
"\n",
2017-04-14 07:13:19 +00:00
true
);
$b['textVersion'] = $armored_encrypted;
$b['htmlVersion'] = null;
}
/**
* add addon composer autoloader maps to system autoloader
function securemail_autoloader() {
2017-04-14 07:13:19 +00:00
$loader = require dirname(dirname(__DIR__)) . '/vendor/autoload.php';
$map = require __DIR__ . '/vendor/composer/autoload_namespaces.php';
foreach ($map as $namespace => $path) {
$loader->set($namespace, $path);
}
$map = require __DIR__ . '/vendor/composer/autoload_psr4.php';
foreach ($map as $namespace => $path) {
$loader->setPsr4($namespace, $path);
}
$classMap = require __DIR__ . '/vendor/composer/autoload_classmap.php';
if ($classMap) {
$loader->addClassMap($classMap);
}
}
securemail_autoloader();
*/