From dee987b263b021b990ea4c62cb15be47c6d61fb5 Mon Sep 17 00:00:00 2001
From: Marius Cramer <m.cramer@pixcept.de>
Date: Mon, 05 Jan 2015 08:30:12 -0500
Subject: [PATCH] Merge branch 'master' into 'master'
---
server/plugins-available/mail_plugin_dkim.inc.php | 270 +++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 185 insertions(+), 85 deletions(-)
diff --git a/server/plugins-available/mail_plugin_dkim.inc.php b/server/plugins-available/mail_plugin_dkim.inc.php
old mode 100644
new mode 100755
index 322ccd8..9fb927e
--- a/server/plugins-available/mail_plugin_dkim.inc.php
+++ b/server/plugins-available/mail_plugin_dkim.inc.php
@@ -41,7 +41,6 @@
// private variables
var $action = '';
-
/**
* This function is called during ispconfig installation to determine
* if a symlink shall be created for this plugin.
@@ -57,7 +56,6 @@
}
-
/**
* This function is called when the plugin is loaded
*/
@@ -71,7 +69,6 @@
$app->plugins->registerEvent('mail_domain_update', $this->plugin_name, 'domain_dkim_update');
}
-
/**
* This function gets the amavisd-config file
* @return string path to the amavisd-config for dkim-keys
@@ -80,7 +77,8 @@
$pos_config=array(
'/etc/amavisd.conf',
'/etc/amavisd.conf/50-user',
- '/etc/amavis/conf.d/50-user'
+ '/etc/amavis/conf.d/50-user',
+ '/etc/amavisd/amavisd.conf'
);
$amavis_configfile='';
foreach($pos_config as $conf) {
@@ -89,9 +87,12 @@
break;
}
}
+ //* If we can use seperate config-files with amavis use 60-dkim
+ if (substr_compare($amavis_configfile, '50-user', -7) === 0)
+ $amavis_configfile = str_replace('50-user', '60-dkim', $amavis_configfile);
+
return $amavis_configfile;
}
-
/**
* This function checks the relevant configs and disables dkim for the domain
@@ -101,68 +102,119 @@
*/
function check_system($data) {
global $app, $mail_config;
+
$app->uses('getconf');
$check=true;
+
/* check for amavis-config */
- if ( $this->get_amavis_config() == '' || !is_writeable($this->get_amavis_config()) ) {
+ $amavis_configfile = $this->get_amavis_config();
+
+ //* When we can use 60-dkim for the dkim-keys create the file if it does not exists.
+ if (substr_compare($amavis_configfile, '60-dkim', -7) === 0 && !file_exists($amavis_configfile))
+ $app->system->touch($amavis_configfile);
+
+ if ( $amavis_configfile == '' || !is_writeable($amavis_configfile) ) {
$app->log('Amavis-config not found or not writeable.', LOGLEVEL_ERROR);
$check=false;
}
+
/* dir for dkim-keys writeable? */
$mail_config = $app->getconf->get_server_config($conf['server_id'], 'mail');
- if (isset($mail_config['dkim_path']) && isset($data['new']['dkim_private']) && !empty($data['new']['dkim_private'])) {
+ if ( isset($mail_config['dkim_path']) &&
+ !empty($mail_config['dkim_path']) &&
+ isset($data['new']['dkim_private']) &&
+ !empty($data['new']['dkim_private']) &&
+ $mail_config['dkim_path'] != '/'
+ ) {
+ if (!is_dir($mail_config['dkim_path'])) {
+ $app->log('DKIM Path '.$mail_config['dkim_path'].' not found - (re)created.', LOGLEVEL_DEBUG);
+ if($app->system->is_user('amavis')) {
+ $amavis_user='amavis';
+ } elseif ($app->system->is_user('vscan')) {
+ $amavis_user='vscan';
+ }
+ else {
+ $amavis_user='';
+ }
+ if(!empty($amavis_user)) {
+ mkdir($mail_config['dkim_path'], 0750, true);
+ $app->system->chown($mail_config['dkim_path'], $amavis_user);
+ } else {
+ mkdir($mail_config['dkim_path'], 0755, true);
+ $app->log('No user amavis or vscan found - using root for '.$mail_config['dkim_path'], LOGLEVEL_WARNING);
+ }
+ } else {
+ if (!$app->system->checkpath($mail_config['dkim_path'])) {
+ $app->log('Unable to write DKIM settings - invalid DKIM-Path (symlink?)', LOGLEVEL_ERROR);
+ $check=false;
+ }
+ }
+
if (!is_writeable($mail_config['dkim_path'])) {
- $app->log('DKIM Path '.$mail_config['dkim_path'].' not found or not writeable.', LOGLEVEL_ERROR);
+ $app->log('DKIM Path '.$mail_config['dkim_path'].' not writeable.', LOGLEVEL_ERROR);
$check=false;
}
+
+ if ( !$app->system->checkpath($mail_config['dkim_path']) ) {
+ $app->log('DKIM Path '.$mail_config['dkim_path'].' failed in checkpath.', LOGLEVEL_ERROR);
+ $check = false;
+ }
+
} else {
- $app->log('Unable to write DKIM settings; Check your config!', LOGLEVEL_ERROR);
+ $app->log('Unable to write DKIM settings - no or invalid DKIM-Path defined', LOGLEVEL_ERROR);
$check=false;
}
return $check;
}
-
-
-
-
/**
* This function restarts amavis
*/
- function restart_amavis() {
- global $app, $conf;
- $initfile=$conf['init_scripts'].'/amavis';
- $app->log('Restarting amavis.', LOGLEVEL_DEBUG);
- exec(escapeshellarg($conf['init_scripts']).escapeshellarg('/amavis').' restart', $output);
- foreach($output as $logline) $app->log($logline, LOGLEVEL_DEBUG);
- }
-
+ function restart_amavis() {
+ global $app, $conf;
+ $pos_init=array(
+ $conf['init_scripts'].'/amavis',
+ $conf['init_scripts'].'/amavisd'
+ );
+ $initfile='';
+ foreach($pos_init as $init) {
+ if (is_executable($init)) {
+ $initfile=$init;
+ break;
+ }
+ }
+ if ( $initfile == '' ) $initfile = 'service amavis';
+ $app->log('Restarting amavis: '.$initfile.'.', LOGLEVEL_DEBUG);
+ exec(escapeshellarg($initfile).' restart', $output);
+ foreach($output as $logline) $app->log($logline, LOGLEVEL_DEBUG);
+ }
/**
* This function writes the keyfiles (public and private)
* @param string $key_file full path to the key-file
* @param string $key_value private-key
* @param string $key_domain mail-domain
- * @return bool - true when the key is written to disk
+ * @return bool - true when the private key was written to disk
*/
function write_dkim_key($key_file, $key_value, $key_domain) {
global $app, $mailconfig;
$success=false;
- if (!file_put_contents($key_file.'.private', $key_value) === false) {
+ if ( $app->system->file_put_contents($key_file.'.private', $key_value) ) {
$app->log('Saved DKIM Private-key to '.$key_file.'.private', LOGLEVEL_DEBUG);
$success=true;
/* now we get the DKIM Public-key */
- exec('cat '.escapeshellarg($key_file.'.private').'|openssl rsa -pubout', $pubkey, $result);
+ exec('cat '.escapeshellarg($key_file.'.private').'|openssl rsa -pubout 2> /dev/null', $pubkey, $result);
$public_key='';
foreach($pubkey as $values) $public_key=$public_key.$values."\n";
/* save the DKIM Public-key in dkim-dir */
- if (!file_put_contents($key_file.'.public', $public_key) === false)
+ if ( $app->system->file_put_contents($key_file.'.public', $public_key) )
$app->log('Saved DKIM Public to '.$key_domain.'.', LOGLEVEL_DEBUG);
- else $app->log('Unable to save DKIM Public to '.$key_domain.'.', LOGLEVEL_WARNING);
+ else $app->log('Unable to save DKIM Public to '.$key_domain.'.', LOGLEVEL_DEBUG);
+ } else {
+ $app->log('Unable to save DKIM Privte-key to '.$key_file.'.private', LOGLEVEL_ERROR);
}
return $success;
}
-
/**
* This function removes the keyfiles
@@ -172,31 +224,53 @@
function remove_dkim_key($key_file, $key_domain) {
global $app;
if (file_exists($key_file.'.private')) {
- exec('rm -f '.escapeshellarg($key_file.'.private'));
+ $app->system->unlink($key_file.'.private');
$app->log('Deleted the DKIM Private-key for '.$key_domain.'.', LOGLEVEL_DEBUG);
} else $app->log('Unable to delete the DKIM Private-key for '.$key_domain.' (not found).', LOGLEVEL_DEBUG);
if (file_exists($key_file.'.public')) {
- exec('rm -f '.escapeshellarg($key_file.'.public'));
+ $app->system->unlink($key_file.'.public');
$app->log('Deleted the DKIM Public-key for '.$key_domain.'.', LOGLEVEL_DEBUG);
} else $app->log('Unable to delete the DKIM Public-key for '.$key_domain.' (not found).', LOGLEVEL_DEBUG);
}
-
/**
* This function adds the entry to the amavisd-config
* @param string $key_domain mail-domain
*/
- function add_to_amavis($key_domain) {
+ function add_to_amavis($key_domain, $selector, $old_selector) {
global $app, $mail_config;
- $amavis_config = file_get_contents($this->get_amavis_config());
- $key_value="dkim_key('".$key_domain."', 'default', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
- if(strpos($amavis_config, $key_value) !== false) $amavis_config = str_replace($key_value, '', $amavis_config);
- if (!file_put_contents($this->get_amavis_config(), $key_value, FILE_APPEND) === false) {
- $app->log('Adding DKIM Private-key to amavis-config.', LOGLEVEL_DEBUG);
- $this->restart_amavis();
- }
- }
+ if (empty($selector)) $selector = 'default';
+ $restart = false;
+ $amavis_configfile = $this->get_amavis_config();
+
+ $search_regex = "/(\n|\r)?dkim_key\(\'".$key_domain."\',\ \'(".$selector."|".$old_selector."){1}?\'.*/";
+
+ //* If we are using seperate config-files with amavis remove existing keys from 50-user to avoid duplicate keys
+ if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
+ $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
+ $temp_config = $app->system->file_get_contents($temp_configfile, true);
+ if (preg_match($search_regex, $temp_config)) {
+ $temp_config = preg_replace($search_regex, '', $temp_config)."\n";
+ $app->system->file_put_contents($temp_configfile, $temp_config, true);
+ }
+ unset($temp_configfile);
+ unset($temp_config);
+ }
+
+ $key_value="dkim_key('".$key_domain."', '".$selector."', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
+ $amavis_config = $app->system->file_get_contents($amavis_configfile, true);
+ $amavis_config = preg_replace($search_regex, '', $amavis_config).$key_value;
+
+ if ( $app->system->file_put_contents($amavis_configfile, $amavis_config, true) ) {
+ $app->log('Adding DKIM Private-key to amavis-config.', LOGLEVEL_DEBUG);
+ $restart = true;
+ } else {
+ $app->log('Unable to add DKIM Private-key for '.$key_domain.' to amavis-config.', LOGLEVEL_ERROR);
+ }
+
+ return $restart;
+ }
/**
* This function removes the entry from the amavisd-config
@@ -204,22 +278,35 @@
*/
function remove_from_amavis($key_domain) {
global $app;
- $amavis_config = file($this->get_amavis_config());
- $i=0;$found=false;
- foreach($amavis_config as $line) {
- if (preg_match("/^\bdkim_key\b.*\b".$key_domain."\b/", $line)) {
- unset($amavis_config[$i]);
- $found=true;
- }
- $i++;
- }
- if ($found) {
- file_put_contents($this->get_amavis_config(), $amavis_config);
- $app->log('Deleted the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_DEBUG);
- $this->restart_amavis();
- } else $app->log('Unable to delete the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_ERROR);
- }
+ $restart = false;
+ $amavis_configfile = $this->get_amavis_config();
+ $amavis_config = $app->system->file_get_contents($amavis_configfile, true);
+
+ $search_regex = "/(\n|\r)?dkim_key.*".$key_domain.".*(\n|\r)?/";
+
+ if (preg_match($search_regex, $amavis_config)) {
+ $amavis_config = preg_replace($search_regex, '', $amavis_config);
+ $app->system->file_put_contents($amavis_configfile, $amavis_config, true);
+ $app->log('Deleted the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_DEBUG);
+ $restart = true;
+ }
+
+ //* If we are using seperate config-files with amavis remove existing keys from 50-user, too
+ if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
+ $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
+ $temp_config = $app->system->file_get_contents($temp_configfile, true);
+ if (preg_match($search_regex, $temp_config)) {
+ $temp_config = preg_replace($search_regex, '', $temp_config);
+ $app->system->file_put_contents($temp_configfile, $temp_config, true);
+ $restart = true;
+ }
+ unset($temp_configfile);
+ unset($temp_config);
+ }
+
+ return $restart;
+ }
/**
* This function controlls new key-files and amavisd-entries
@@ -232,16 +319,16 @@
if ( substr($mail_config['dkim_path'], strlen($mail_config['dkim_path'])-1) == '/' )
$mail_config['dkim_path'] = substr($mail_config['dkim_path'], 0, strlen($mail_config['dkim_path'])-1);
if ($this->write_dkim_key($mail_config['dkim_path']."/".$data['new']['domain'], $data['new']['dkim_private'], $data['new']['domain'])) {
- $this->add_to_amavis($data['new']['domain']);
+ if ($this->add_to_amavis($data['new']['domain'], $data['new']['dkim_selector'], $data['old']['dkim_selector'] )) {
+ $this->restart_amavis();
+ } else {
+ $this->remove_dkim_key($mail_config['dkim_path']."/".$data['new']['domain'], $data['new']['domain']);
+ }
} else {
$app->log('Error saving the DKIM Private-key for '.$data['new']['domain'].' - DKIM is not enabled for the domain.', LOGLEVEL_ERROR);
}
}
- else {
- $app->log('DKIM for '.$data['new']['domain'].' not written to disk - domain is inactive', LOGLEVEL_DEBUG);
- }
}
-
/**
* This function controlls the removement of keyfiles (public and private)
@@ -254,29 +341,27 @@
if ( substr($mail_config['dkim_path'], strlen($mail_config['dkim_path'])-1) == '/' )
$mail_config['dkim_path'] = substr($mail_config['dkim_path'], 0, strlen($mail_config['dkim_path'])-1);
$this->remove_dkim_key($mail_config['dkim_path']."/".$_data['domain'], $_data['domain']);
- $this->remove_from_amavis($_data['domain']);
+ if ($this->remove_from_amavis($_data['domain']))
+ $this->restart_amavis();
}
-
/**
* Function called by onLoad
* deletes dkim-keys
*/
function domain_dkim_delete($event_name, $data) {
- if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y') $this->remove_dkim($data['old']);
+ if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y' && $data['old']['active'] == 'y')
+ $this->remove_dkim($data['old']);
}
-
/**
* Function called by onLoad
* insert dkim-keys
*/
function domain_dkim_insert($event_name, $data) {
- if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data)) {
+ if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data))
$this->add_dkim($data);
- }
}
-
/**
* Function called by onLoad
@@ -284,31 +369,46 @@
*/
function domain_dkim_update($event_name, $data) {
global $app;
- /* get the config */
- if (isset($data['new']['dkim']) && $data['new']['dkim']=='y') { /* DKIM enabled */
- if ($this->check_system($data)) {
+ if ($this->check_system($data)) {
+ /* maildomain disabled */
+ if ($data['new']['active'] == 'n' && $data['old']['active'] == 'y' && $data['new']['dkim']=='y') {
+ $app->log('Maildomain '.$data['new']['domain'].' disabled - remove DKIM-settings', LOGLEVEL_DEBUG);
+ $this->remove_dkim($data['new']);
+ }
+ /* maildomain re-enabled */
+ if ($data['new']['active'] == 'y' && $data['old']['active'] == 'n' && $data['new']['dkim']=='y')
+ $this->add_dkim($data);
+
+ /* maildomain active - only dkim changes */
+ if ($data['new']['active'] == 'y' && $data['old']['active'] == 'y') {
+ /* dkim disabled */
+ if ($data['new']['dkim'] != $data['old']['dkim'] && $data['new']['dkim'] == 'n') {
+ $this->remove_dkim($data['new']);
+ }
+ /* dkim enabled */
+ elseif ($data['new']['dkim'] != $data['old']['dkim'] && $data['new']['dkim'] == 'y') {
+ $this->add_dkim($data);
+ }
+ /* new private-key */
+ if ($data['new']['dkim_private'] != $data['old']['dkim_private'] && $data['new']['dkim'] == 'y') {
+ $this->add_dkim($data);
+ }
+ /* new selector */
+ if ($data['new']['dkim_selector'] != $data['old']['dkim_selector'] && $data['new']['dkim'] == 'y') {
+ $this->add_dkim($data);
+ }
/* new domain-name */
- if ($data['old']['domain'] != $data['new']['domain']) {
+ if ($data['new']['domain'] != $data['old']['domain']) {
$this->remove_dkim($data['old']);
$this->add_dkim($data);
}
- /* new key */
- if (($data['old']['dkim_private'] != $data['new']['dkim_private']) || ($data['old']['dkim'] != $data['new']['dkim'])) {
- if ($data['new']['dkim_private'] != $data['old']['dkim_private']) $this->remove_dkim($data['new']);
- $this->add_dkim($data);
- }
- /* change active (on / off) */
- if ($data['old']['active'] != $data['new']['active']) {
- if ($data['new']['active'] == 'y') {
- $this->add_dkim($data);
- } else {
- $this->remove_dkim($data['new']);
- }
- }
+ }
+
+ /* resync */
+ if ($data['new']['active'] == 'y' && $data['new'] == $data['old']) {
+ $this->add_dkim($data);
}
}
- if (isset($data['new']['dkim']) && $data['old']['dkim'] != $data['new']['dkim'])
- if ($this->check_system($data) && $data['new']['dkim'] == 'n') $this->remove_dkim($data['new']);
}
}
--
Gitblit v1.9.1