mail_plugin_dkim.inc.php 11.3 KB
Newer Older
1 2
<?php

Florian Schaal's avatar
Florian Schaal committed
3
/**
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 Copyright (c) 2007 - 2013, Till Brehm, projektfarm Gmbh
 Copyright (c) 2013, Florian Schaal, info@schaal-24.de
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 * Neither the name of ISPConfig nor the names of its contributors
 may be used to endorse or promote products derived from this software without
 specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 @author Florian Schaal, info@schaal-24.de
 @copyrighth Florian Schaal, info@schaal-24.de
 */

tbrehm's avatar
tbrehm committed
35 36 37 38 39 40 41 42 43

class mail_plugin_dkim {

	var $plugin_name = 'mail_plugin_dkim';
	var $class_name = 'mail_plugin_dkim';

	// private variables
	var $action = '';

44 45 46 47
	/**
	 * This function is called during ispconfig installation to determine
	 * if a symlink shall be created for this plugin.
	 */
tbrehm's avatar
tbrehm committed
48 49 50 51 52 53 54 55 56 57 58
	function onInstall() {
		global $conf;

		if($conf['services']['mail'] == true) {
			return true;
		} else {
			return false;
		}

	}

Florian Schaal's avatar
Florian Schaal committed
59
	/**
60 61
	 * This function is called when the plugin is loaded
	 */
tbrehm's avatar
tbrehm committed
62
	function onLoad() {
63
		global $app, $conf;
tbrehm's avatar
tbrehm committed
64 65 66
		/*
		Register for the events
		*/
67 68 69
		$app->plugins->registerEvent('mail_domain_delete', $this->plugin_name, 'domain_dkim_delete');
		$app->plugins->registerEvent('mail_domain_insert', $this->plugin_name, 'domain_dkim_insert');
		$app->plugins->registerEvent('mail_domain_update', $this->plugin_name, 'domain_dkim_update');
70 71
	}

72 73 74 75
	/**
	 * This function gets the amavisd-config file
	 * @return string path to the amavisd-config for dkim-keys
	 */
76 77 78 79
	function get_amavis_config() {
		$pos_config=array(
			'/etc/amavisd.conf',
			'/etc/amavisd.conf/50-user',
80 81
			'/etc/amavis/conf.d/50-user',
			'/etc/amavisd/amavisd.conf'
82 83
		);
		$amavis_configfile='';
84
		foreach($pos_config as $conf) {
tbrehm's avatar
tbrehm committed
85 86 87 88
			if (is_file($conf)) {
				$amavis_configfile=$conf;
				break;
			}
89
		}
tbrehm's avatar
tbrehm committed
90 91 92
		return $amavis_configfile;
	}

Florian Schaal's avatar
Florian Schaal committed
93
	/**
94 95 96 97 98
	 * This function checks the relevant configs and disables dkim for the domain
	 * if the directory for dkim is not writeable or does not exist
	 * @param array $data mail-settings
	 * @return boolean - true when the amavis-config and the dkim-dir are writeable
	 */
tbrehm's avatar
tbrehm committed
99
	function check_system($data) {
100 101
		global $app, $mail_config;
		$app->uses('getconf');
tbrehm's avatar
tbrehm committed
102 103 104
		$check=true;
		/* check for amavis-config */
		if ( $this->get_amavis_config() == '' || !is_writeable($this->get_amavis_config()) ) {
105
			$app->log('Amavis-config not found or not writeable.', LOGLEVEL_ERROR);
tbrehm's avatar
tbrehm committed
106 107 108
			$check=false;
		}
		/* dir for dkim-keys writeable? */
109
		$mail_config = $app->getconf->get_server_config($conf['server_id'], 'mail');
tbrehm's avatar
tbrehm committed
110 111
		if (isset($mail_config['dkim_path']) && isset($data['new']['dkim_private']) && !empty($data['new']['dkim_private'])) {
			if (!is_writeable($mail_config['dkim_path'])) {
112
				$app->log('DKIM Path '.$mail_config['dkim_path'].' not found or not writeable.', LOGLEVEL_ERROR);
tbrehm's avatar
tbrehm committed
113
				$check=false;
114
			}
tbrehm's avatar
tbrehm committed
115
		} else {
116
			$app->log('Unable to write DKIM settings; Check your config!', LOGLEVEL_ERROR);
117 118 119 120
			$check=false;
		}
		return $check;
	}
121

Florian Schaal's avatar
Florian Schaal committed
122
	/**
123 124
	 * This function restarts amavis
	 */
tbrehm's avatar
tbrehm committed
125
	function restart_amavis() {
126
		global $app, $conf;
127 128 129 130 131 132 133 134 135 136 137 138 139
		$pos_init=array(
			$conf['init_scripts'].'/amavis',
			$conf['init_scripts'].'/amavisd'
		);
		$initfile='';
		foreach($pos_init as $init) {
			if (is_executable($init)) {
				$initfile=$init;
				break;
				}
		}
		$app->log('Restarting amavis: '.$initfile.'.', LOGLEVEL_DEBUG);
		exec(escapeshellarg($initfile).' restart', $output);
140
		foreach($output as $logline) $app->log($logline, LOGLEVEL_DEBUG);
141 142
	}

Florian Schaal's avatar
Florian Schaal committed
143
	/**
144 145 146 147 148 149 150 151
	 * 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
	 */
	function write_dkim_key($key_file, $key_value, $key_domain) {
		global $app, $mailconfig;
tbrehm's avatar
tbrehm committed
152
		$success=false;
153 154
		if (!file_put_contents($key_file.'.private', $key_value) === false) {
			$app->log('Saved DKIM Private-key to '.$key_file.'.private', LOGLEVEL_DEBUG);
155 156
			$success=true;
			/* now we get the DKIM Public-key */
157
			exec('cat '.escapeshellarg($key_file.'.private').'|openssl rsa -pubout', $pubkey, $result);
158 159 160
			$public_key='';
			foreach($pubkey as $values) $public_key=$public_key.$values."\n";
			/* save the DKIM Public-key in dkim-dir */
161 162 163 164
			if (!file_put_contents($key_file.'.public', $public_key) === false)
				$app->log('Saved DKIM Public to '.$key_domain.'.', LOGLEVEL_DEBUG);
			else $app->log('Unable to save DKIM Public to '.$key_domain.'.', LOGLEVEL_WARNING);
		}
165 166
		return $success;
	}
tbrehm's avatar
tbrehm committed
167

Florian Schaal's avatar
Florian Schaal committed
168
	/**
169 170 171 172 173
	 * This function removes the keyfiles
	 * @param string $key_file full path to the key-file
	 * @param string $key_domain mail-domain
	 */
	function remove_dkim_key($key_file, $key_domain) {
174 175 176
		global $app;
		if (file_exists($key_file.'.private')) {
			exec('rm -f '.escapeshellarg($key_file.'.private'));
177 178
			$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);
179 180
		if (file_exists($key_file.'.public')) {
			exec('rm -f '.escapeshellarg($key_file.'.public'));
181 182
			$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);
183
	}
tbrehm's avatar
tbrehm committed
184

Florian Schaal's avatar
Florian Schaal committed
185
	/**
186 187 188
	 * This function adds the entry to the amavisd-config
	 * @param string $key_domain mail-domain
	 */
tbrehm's avatar
tbrehm committed
189
	function add_to_amavis($key_domain) {
190
		global $app, $mail_config;
tbrehm's avatar
tbrehm committed
191
		$amavis_config = file_get_contents($this->get_amavis_config());
192
		$key_value="dkim_key('".$key_domain."', 'default', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
193 194 195 196 197 198 199 200
		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();
			}
		} else {
			$app->log('DKIM Private-key already in amavis-config.',LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
201 202 203
		}
	}

Florian Schaal's avatar
Florian Schaal committed
204
	/**
205 206 207
	 * This function removes the entry from the amavisd-config
	 * @param string $key_domain mail-domain
	 */
tbrehm's avatar
tbrehm committed
208 209 210 211 212
	function remove_from_amavis($key_domain) {
		global $app;
		$amavis_config = file($this->get_amavis_config());
		$i=0;$found=false;
		foreach($amavis_config as $line) {
213
			if (preg_match("/^\bdkim_key\b.*\b".$key_domain."\b/", $line)) {
tbrehm's avatar
tbrehm committed
214 215 216 217 218 219 220
				unset($amavis_config[$i]);
				$found=true;
			}
			$i++;
		}
		if ($found) {
			file_put_contents($this->get_amavis_config(), $amavis_config);
221
			$app->log('Deleted the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
222
			$this->restart_amavis();
223
		} else $app->log('Unable to delete the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_ERROR);
tbrehm's avatar
tbrehm committed
224 225
	}

Florian Schaal's avatar
Florian Schaal committed
226
	/**
227 228 229
	 * This function controlls new key-files and amavisd-entries
	 * @param array $data mail-settings
	 */
tbrehm's avatar
tbrehm committed
230 231
	function add_dkim($data) {
		global $app;
Florian Schaal's avatar
Florian Schaal committed
232
		if ($data['new']['active'] == 'y') {
233 234 235 236 237
			$mail_config = $app->getconf->get_server_config($conf['server_id'], 'mail');
			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']);
Florian Schaal's avatar
Florian Schaal committed
238
			} else {
239
				$app->log('Error saving the DKIM Private-key for '.$data['new']['domain'].' - DKIM is not enabled for the domain.', LOGLEVEL_ERROR);
Florian Schaal's avatar
Florian Schaal committed
240 241 242
			}
		}
		else {
243
			$app->log('DKIM for '.$data['new']['domain'].' not written to disk - domain is inactive', LOGLEVEL_DEBUG);
244 245 246
		}
	}

Florian Schaal's avatar
Florian Schaal committed
247
	/**
248 249 250 251
	 * This function controlls the removement of keyfiles (public and private)
	 * and the entry in the amavisd-config
	 * @param array $data mail-settings
	 */
tbrehm's avatar
tbrehm committed
252 253
	function remove_dkim($_data) {
		global $app;
254 255 256 257 258
		$mail_config = $app->getconf->get_server_config($conf['server_id'], 'mail');
		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']);
tbrehm's avatar
tbrehm committed
259 260
	}

Florian Schaal's avatar
Florian Schaal committed
261
	/**
262 263 264 265
	 * Function called by onLoad
	 * deletes dkim-keys
	 */
	function domain_dkim_delete($event_name, $data) {
266
		if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y' && $data['old']['active'] == 'y') $this->remove_dkim($data['old']);	
tbrehm's avatar
tbrehm committed
267
	}
268

Florian Schaal's avatar
Florian Schaal committed
269
	/**
270 271 272 273
	 * Function called by onLoad
	 * insert dkim-keys
	 */
	function domain_dkim_insert($event_name, $data) {
274 275 276 277
		if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data)) {
			$this->add_dkim($data);
		}
	}
tbrehm's avatar
tbrehm committed
278

Florian Schaal's avatar
Florian Schaal committed
279
	/**
280 281 282 283
	 * Function called by onLoad
	 * chang dkim-settings
	 */
	function domain_dkim_update($event_name, $data) {
tbrehm's avatar
tbrehm committed
284
		global $app;
285 286 287 288 289 290 291 292
		if ($this->check_system($data)) {
			/* maildomain disabled */
			if ($data['new']['active'] == 'n' && $data['old']['active'] == 'y') {
				$app->log('Maildomain '.$data['new']['domain'].' disabled - remove DKIM-settings', LOGLEVEL_DEBUG);
				if ($data['new']['dkim']=='y') {
					$this->remove_dkim($data['new']);
				}
				if ($data['old']['dkim']=='y') {
tbrehm's avatar
tbrehm committed
293
					$this->remove_dkim($data['old']);
294 295 296 297 298 299
				}
			}

			/* maildomain re-enabled */
			if ($data['new']['active'] == 'y' && $data['old']['active'] == 'n') {
				if ($data['new']['dkim']=='y') {
tbrehm's avatar
tbrehm committed
300 301
					$this->add_dkim($data);
				}
302 303 304 305 306 307 308 309 310 311
			}

			/* 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') {
tbrehm's avatar
tbrehm committed
312 313
					$this->add_dkim($data);
				}
314 315 316 317
				/* new private-key or new domain-name */
				if ($data['new']['dkim_private'] != $data['old']['dkim_private'] || $data['new']['domain'] != $data['old']['domain']) {
					$this->remove_dkim($data['old']);
					$this->add_dkim($data);
318 319
				}
			}
320 321 322 323 324

			/* resync */
			if ($data['new']['active'] == 'y' && $data['new'] == $data['old']) {
				$this->add_dkim($data);
			}
tbrehm's avatar
tbrehm committed
325 326
		}
	}
327

tbrehm's avatar
tbrehm committed
328
}
329

tbrehm's avatar
tbrehm committed
330
?>