mail_plugin_dkim.inc.php 11.2 KB
Newer Older
1
2
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<?php

/*
todo:
- DNS interaction
*/
/*
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.
*/

class mail_plugin_dkim {

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

	// private variables
	var $action = '';

	/* 
		This function is called during ispconfig installation to determine
		if a symlink shall be created for this plugin.
	*/
	function onInstall() {
		global $conf;

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

	}

	/*
	 	This function is called when the plugin is loaded
	*/
	function onLoad() {
		global $app,$conf;
		/*
		Register for the events
		*/
		$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');

                // Register service
                $app->services->registerService('amavisd','mail_module','restartAmavisd');
	}

        /*
                This function gets the amavisd-config file
        */
	function get_amavis_config() {
		$pos_config=array(
			'/etc/amavisd.conf',
			'/etc/amavisd.conf/50-user'
		);
		$amavis_configfile='';
                foreach($pos_config as $conf) {
			if (is_file($conf)) {
				$amavis_configfile=$conf;
				break;
			}
                }
		return $amavis_configfile;
	}

	/*
		This function checks the relevant configs and disables dkim for the domain 
		if the directory for dkim is not writeable or does not exist
	*/
	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()) ) {
			$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 (!is_writeable($mail_config['dkim_path'])) {
				$app->log('DKIM Path '.$mail_config['dkim_path'].' not found or not writeable.',LOGLEVEL_ERROR);
				$check=false;
               		}
		} else {
			$app->log('Unable to write DKIM settings; Check your config!',LOGLEVEL_ERROR);
			$check=false;
		}
		if (!$check) {
               		$app->db->query("UPDATE mail_domain SET dkim = 'n' WHERE domain = '".$data['new']['domain']."'");
               		$app->dbmaster->query("UPDATE mail_domain SET dkim = 'n' WHERE domain = '".$data['new']['domain']."'");
		}
		return $check;
	}
        
	/*
		This function restarts amavis
	*/
	function restart_amavis() {
		global $app,$conf;
		$initfile=$conf['init_scripts'].'/amavis';
		$app->log('Restarting amavis.',LOGLEVEL_DEBUG);
//			exec($conf['init_scripts'].'/amavis restart',$output);
//			foreach($output as $logline) $app->log($logline,LOGLEVEL_DEBUG);
	}

	/*
                This function writes the keyfiles (public and private)
                The public-key is always created and stored into the db and local key-file
        */
	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) { 
			$app->log('Saved DKIM Private-key to '.$key_file.'.private',LOGLEVEL_DEBUG);
			$success=true;
			/* now we get the DKIM Public-key */
			exec('cat "'.$key_file.'.private'.'"|openssl rsa -pubout',$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) 
				$app->log('Saved DKIM Public to '.$key_domain.'.',LOGLEVEL_DEBUG);
			else $app->log('Unable to save DKIM Public to '.$key_domain.'.',LOGLEVEL_WARNING);
			/* store the private-key to the databse(s) */
			$app->log('Store the DKIM Public-key in database.',LOGLEVEL_DEBUG);
       	     		$app->db->query("UPDATE mail_domain SET dkim_public = '".$public_key."' WHERE domain = '".$ky_domain."'");
   	     		$app->dbmaster->query("UPDATE mail_domain SET dkim_public = '".$public_key."' WHERE domain = '".$key_domain."'");
		} 
		return $success;
	}

	/*
		This function removes the keyfiles
	*/
	function remove_dkim_key($key_file,$key_domain) {
		global $app;
		if (file_exists($key_file.'.private')) {
			exec('rm -f '.$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 '.$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
	*/
	function add_to_amavis($key_domain) {
		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();
		}
	}

	/*
		This function removes the entry from the amavisd-config
	*/
	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);
	}

	/*
		This function controlls new key-files and amavisd-entries
	*/
	function add_dkim($data) {
		global $app;
                $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']);
		} else {
			$app->log('Error saving the DKIM Private-key for '.$data['new']['domain'].' - DKIM is now disabled for the domain.',LOGLEVEL_ERROR);
               		$app->db->query("UPDATE mail_domain SET dkim = 'n' WHERE domain = '".$data['new']['domain']."'");
               		$app->dbmaster->query("UPDATE mail_domain SET dkim = 'n' WHERE domain = '".$data['new']['domain']."'");
		}
	}

	/*
		This function controlls the removement of keyfiles (public and private)
		and the entry in the amavisd-config
	*/
	function remove_dkim($_data) {
		global $app;
                $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']);
	}

	/*
		Functions called by onLoad
	*/
	function domain_dkim_delete($event_name,$data) {
		if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y') $this->remove_dkim($data['old']);
	}

	function domain_dkim_insert($event_name,$data) {
		if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data)) {
			/* if the domain is already defined, remove from amavis */
			$this->remove_from_amavis($data['new']['domain']);
//			$this->remove_from_amavis("dkim_key('".$data['new']['domain']."', 'default', '".$mail_config['dkim_path']."/".$data['new']['domain'].".private');\n",$data['new']['domain']);
			$this->add_dkim($data);
		}
	}

	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)) {
				/* new domain-name */
        		        if ($data['old']['domain'] != $data['new']['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']);
	        	                }
        	        	}
			}	
		}
		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']);
	}
}
?>