shelluser_jailkit_plugin.inc.php 17.2 KB
Newer Older
tbrehm's avatar
tbrehm committed
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
<?php

/*
Copyright (c) 2007, Till Brehm, projektfarm Gmbh
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 shelluser_jailkit_plugin {
	
	//* $plugin_name and $class_name have to be the same then the name of this class
	var $plugin_name = 'shelluser_jailkit_plugin';
	var $class_name = 'shelluser_jailkit_plugin';
	
	//* 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']['web'] == true) {
			return true;
		} else {
			return false;
		}
		
	}
	
		
	/*
	 	This function is called when the plugin is loaded
	*/
	
	function onLoad() {
		global $app;
		
		/*
		Register for the events
		*/
		
		$app->plugins->registerEvent('shell_user_insert',$this->plugin_name,'insert');
		$app->plugins->registerEvent('shell_user_update',$this->plugin_name,'update');
		$app->plugins->registerEvent('shell_user_delete',$this->plugin_name,'delete');

		
	}
	
	//* This function is called, when a shell user is inserted in the database
	function insert($event_name,$data) {
		global $app, $conf;
		
		$app->uses('system');
74
		$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".$data['new']['parent_domain_id']);
tbrehm's avatar
tbrehm committed
75 76 77 78 79 80 81 82
		
		if($app->system->is_user($data['new']['username'])) {
		
			/**
		 	* Setup Jailkit Chroot System If Enabled 
		 	*/
			if ($data['new']['chroot'] == "jailkit")
			{
83
				
84
				
tbrehm's avatar
tbrehm committed
85 86 87 88 89
				// load the server configuration options
				$app->uses("getconf");
				$this->data = $data;
				$this->app = $app;
				$this->jailkit_config = $app->getconf->get_server_config($conf["server_id"], 'jailkit');
90
				
tbrehm's avatar
tbrehm committed
91
				$this->_update_website_security_level();
92 93
				
				$app->system->web_folder_protection($web['document_root'],false);
tbrehm's avatar
tbrehm committed
94 95 96
			
				$this->_setup_jailkit_chroot();
				
97 98
				$this->_add_jailkit_user();
				
99
				//* call the ssh-rsa update function
100 101
				$this->_setup_ssh_rsa();
				
102 103 104 105 106 107
				//$command .= 'usermod -s /usr/sbin/jk_chrootsh -U '.escapeshellcmd($data['new']['username']);
				//exec($command);
				$app->system->usermod($data['new']['username'], 0, 0, '', '/usr/sbin/jk_chrootsh', '', '');
				
				//* Unlock user
				$command = 'usermod -U '.escapeshellcmd($data['new']['username']);
108 109
				exec($command);
				
tbrehm's avatar
tbrehm committed
110
				$this->_update_website_security_level();
111
				$app->system->web_folder_protection($web['document_root'],true);
tbrehm's avatar
tbrehm committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
			}
		
			$app->log("Jailkit Plugin -> insert username:".$data['new']['username'],LOGLEVEL_DEBUG);
			
		} else {
			$app->log("Jailkit Plugin -> insert username:".$data['new']['username']." skipped, the user does not exist.",LOGLEVEL_WARN);
		}
		
	}
	
	//* This function is called, when a shell user is updated in the database
	function update($event_name,$data) {
		global $app, $conf;
		
		$app->uses('system');
127
		$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".$data['new']['parent_domain_id']);
tbrehm's avatar
tbrehm committed
128 129 130 131 132 133 134 135
		
		if($app->system->is_user($data['new']['username'])) {
		
			/**
		 	* Setup Jailkit Chroot System If Enabled 
		 	*/
			if ($data['new']['chroot'] == "jailkit")
			{
136
				
tbrehm's avatar
tbrehm committed
137 138 139 140 141
				// load the server configuration options
				$app->uses("getconf");
				$this->data = $data;
				$this->app = $app;
				$this->jailkit_config = $app->getconf->get_server_config($conf["server_id"], 'jailkit');
142 143
				
				$this->_update_website_security_level();
144 145
				
				$app->system->web_folder_protection($web['document_root'],false);
tbrehm's avatar
tbrehm committed
146 147 148
			
				$this->_setup_jailkit_chroot();
				$this->_add_jailkit_user();
tbrehm's avatar
tbrehm committed
149
				
150
				//* call the ssh-rsa update function
151 152
				$this->_setup_ssh_rsa();
				
tbrehm's avatar
tbrehm committed
153
				$this->_update_website_security_level();
154 155
				
				$app->system->web_folder_protection($web['document_root'],true);
tbrehm's avatar
tbrehm committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
			}
		
			$app->log("Jailkit Plugin -> update username:".$data['new']['username'],LOGLEVEL_DEBUG);
			
		} else {
			$app->log("Jailkit Plugin -> update username:".$data['new']['username']." skipped, the user does not exist.",LOGLEVEL_WARN);
		}
		
	}
	
	//* This function is called, when a shell user is deleted in the database
	/**
	 * TODO: Remove chroot user home and from the chroot passwd file
	 */ 
	function delete($event_name,$data) {
		global $app, $conf;
		
		$app->uses('system');
		
175
		$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".$data['old']['parent_domain_id']);
176
		
tbrehm's avatar
tbrehm committed
177 178 179 180 181 182 183 184 185 186
		if ($data['old']['chroot'] == "jailkit")
		{
			$app->uses("getconf");
			$this->jailkit_config = $app->getconf->get_server_config($conf["server_id"], 'jailkit');
			
			$jailkit_chroot_userhome = $this->_get_home_dir($data['old']['username']);
			
			//commented out proved to be dangerous on config errors
			//exec('rm -rf '.$data['old']['dir'].$jailkit_chroot_userhome);
			
187 188
			$app->system->web_folder_protection($web['document_root'],false);
			
tbrehm's avatar
tbrehm committed
189
			if(@is_dir($data['old']['dir'].$jailkit_chroot_userhome)) {
190
				$command = 'userdel -f';
tbrehm's avatar
tbrehm committed
191 192 193 194
				$command .= ' '.escapeshellcmd($data['old']['username']);
				exec($command);
				$app->log("Jailkit Plugin -> delete chroot home:".$data['old']['dir'].$jailkit_chroot_userhome,LOGLEVEL_DEBUG);
			}
tbrehm's avatar
tbrehm committed
195
			
196 197
			$app->system->web_folder_protection($web['document_root'],true);
			
tbrehm's avatar
tbrehm committed
198 199 200 201 202 203 204 205 206
		}
		
		$app->log("Jailkit Plugin -> delete username:".$data['old']['username'],LOGLEVEL_DEBUG);
		
		
	}
	
	function _setup_jailkit_chroot()
	{
207 208
			global $app;
			
tbrehm's avatar
tbrehm committed
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
			//check if the chroot environment is created yet if not create it with a list of program sections from the config
			if (!is_dir($this->data['new']['dir'].'/etc/jailkit'))
			{
				$command = '/usr/local/ispconfig/server/scripts/create_jailkit_chroot.sh';
				$command .= ' '.escapeshellcmd($this->data['new']['dir']);
				$command .= ' \''.$this->jailkit_config['jailkit_chroot_app_sections'].'\'';
				exec($command);
				
				$this->app->log("Added jailkit chroot with command: ".$command,LOGLEVEL_DEBUG);
				
				$this->_add_jailkit_programs();
				
				//add bash.bashrc script
				//we need to collect the domain name to be used as the HOSTNAME in the bashrc script
				$web = $this->app->db->queryOneRecord("SELECT domain FROM web_domain WHERE domain_id = ".intval($this->data['new']["parent_domain_id"]));
				
				$this->app->load('tpl');
		
				$tpl = new tpl();
				$tpl->newTemplate("bash.bashrc.master");
				
				$tpl->setVar('jailkit_chroot',true);
				$tpl->setVar('domain',$web['domain']);
				$tpl->setVar('home_dir',$this->_get_home_dir(""));
				
				$bashrc = escapeshellcmd($this->data['new']['dir']).'/etc/bash.bashrc';
235
				if(@is_file($bashrc) || @is_link($bashrc)) unlink($bashrc);
tbrehm's avatar
tbrehm committed
236 237 238 239
				
				file_put_contents($bashrc,$tpl->grab());
				unset($tpl);
				
240
				$this->app->log("Added bashrc script : ".$bashrc,LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
241 242 243 244 245 246 247
				
				$tpl = new tpl();
				$tpl->newTemplate("motd.master");
				
				$tpl->setVar('domain',$web['domain']);
				
				$motd = escapeshellcmd($this->data['new']['dir']).'/var/run/motd';
248
				if(@is_file($motd) || @is_link($motd)) unlink($motd);
tbrehm's avatar
tbrehm committed
249
				
250
				$app->system->file_put_contents($motd,$tpl->grab());
tbrehm's avatar
tbrehm committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
				
			}
	}
	
	function _add_jailkit_programs()
	{
		//copy over further programs and its libraries
		$command = '/usr/local/ispconfig/server/scripts/create_jailkit_programs.sh';
		$command .= ' '.escapeshellcmd($this->data['new']['dir']);
		$command .= ' \''.$this->jailkit_config['jailkit_chroot_app_programs'].'\'';
		exec($command);
		
		$this->app->log("Added programs to jailkit chroot with command: ".$command,LOGLEVEL_DEBUG);
	}
	
	function _get_home_dir($username)
	{
268
		return str_replace("[username]",escapeshellcmd($username),$this->jailkit_config['jailkit_chroot_home']);
tbrehm's avatar
tbrehm committed
269 270 271 272
	}
	
	function _add_jailkit_user()
	{
273 274
			global $app;
			
tbrehm's avatar
tbrehm committed
275 276 277 278
			//add the user to the chroot
			$jailkit_chroot_userhome = $this->_get_home_dir($this->data['new']['username']);
			$jailkit_chroot_puserhome = $this->_get_home_dir($this->data['new']['puser']);
			
279 280
			if(!is_dir($this->data['new']['dir'].'/etc')) mkdir($this->data['new']['dir'].'/etc', 0755);
			if(!is_file($this->data['new']['dir'].'/etc/passwd')) touch($this->data['new']['dir'].'/etc/passwd', 0755);
tbrehm's avatar
tbrehm committed
281
			
tbrehm's avatar
tbrehm committed
282 283 284 285 286 287 288 289 290 291 292 293
			// IMPORTANT!
			// ALWAYS create the user. Even if the user was created before
			// if we check if the user exists, then a update (no shell -> jailkit) will not work
			// and the user has FULL ACCESS to the root of the server!
			$command = '/usr/local/ispconfig/server/scripts/create_jailkit_user.sh';
			$command .= ' '.escapeshellcmd($this->data['new']['username']);
			$command .= ' '.escapeshellcmd($this->data['new']['dir']);
			$command .= ' '.$jailkit_chroot_userhome;
			$command .= ' '.escapeshellcmd($this->data['new']['shell']);
			$command .= ' '.$this->data['new']['puser'];
			$command .= ' '.$jailkit_chroot_puserhome;
			exec($command);
294 295 296 297
			
			//* Change the homedir of the shell user and parent user
			//* We have to do this manually as the usermod command fails 
			//* when the user is logged in or a command is running under that user
298
			/*
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
			$passwd_file_array = file('/etc/passwd');
			$passwd_out = '';
			if(is_array($passwd_file_array)) {
				foreach($passwd_file_array as $line) {
					$line = trim($line);
					$parts = explode(':',$line);
					if($parts[0] == $this->data['new']['username']) {
						$parts[5] = escapeshellcmd($this->data['new']['dir'].'/.'.$jailkit_chroot_userhome);
						$parts[6] = escapeshellcmd('/usr/sbin/jk_chrootsh');
						$new_line = implode(':',$parts);
						copy('/etc/passwd','/etc/passwd~');
						chmod('/etc/passwd~',0600);
						$app->uses('system');
						$app->system->replaceLine('/etc/passwd',$line,$new_line,1,0);
					}
				}
315
			}*/
316
			
317 318
			$app->system->usermod($this->data['new']['username'], 0, 0, $this->data['new']['dir'].'/.'.$jailkit_chroot_userhome, '/usr/sbin/jk_chrootsh');
			$app->system->usermod($this->data['new']['puser'], 0, 0, $this->data['new']['dir'].'/.'.$jailkit_chroot_userhome, '/usr/sbin/jk_chrootsh');
tbrehm's avatar
tbrehm committed
319 320
				
			$this->app->log("Added jailkit user to chroot with command: ".$command,LOGLEVEL_DEBUG);
321 322
						
			if(!is_dir($this->data['new']['dir'].$jailkit_chroot_userhome)) mkdir(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_userhome), 0755, true);
323 324
			$app->system->chown(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_userhome), $this->data['new']['username']);
			$app->system->chgrp(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_userhome), $this->data['new']['pgroup']);
tbrehm's avatar
tbrehm committed
325 326 327
				
			$this->app->log("Added created jailkit user home in : ".$this->data['new']['dir'].$jailkit_chroot_userhome,LOGLEVEL_DEBUG);
			
328
			if(!is_dir($this->data['new']['dir'].$jailkit_chroot_puserhome)) mkdir(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_puserhome), 0755, true);
329 330
			$app->system->chown(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_puserhome), $this->data['new']['puser']);
			$app->system->chgrp(escapeshellcmd($this->data['new']['dir'].$jailkit_chroot_puserhome), $this->data['new']['pgroup']);
tbrehm's avatar
tbrehm committed
331
				
332
			$this->app->log("Added jailkit parent user home in : ".$this->data['new']['dir'].$jailkit_chroot_puserhome,LOGLEVEL_DEBUG);
333
			
334

tbrehm's avatar
tbrehm committed
335 336
	}
	
337 338 339 340 341 342 343 344 345 346 347 348
	//* Update the website root directory permissions depending on the security level
	function _update_website_security_level() {
		global $app,$conf;
		
		// load the server configuration options
		$app->uses("getconf");
		$web_config = $app->getconf->get_server_config($conf["server_id"], 'web');
		
		// Get the parent website of this shell user
		$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".$this->data['new']['parent_domain_id']);
		
		//* If the security level is set to high
349 350 351 352 353 354
		if($web_config['security_level'] == 20 && is_array($web)) {
			$app->system->web_folder_protection($web["document_root"],false);
			$app->system->chmod($web["document_root"],0755);
			$app->system->chown($web["document_root"],'root');
			$app->system->chgrp($web["document_root"],'root');
			$app->system->web_folder_protection($web["document_root"],true);
355 356 357 358
		}
		
	}
	
tbrehm's avatar
tbrehm committed
359 360 361
	//* Wrapper for exec function for easier debugging
	private function _exec($command) {
		global $app;
362
		$app->log('exec: '.$command,LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
363 364
		exec($command);
	}
tbrehm's avatar
tbrehm committed
365

366
	private function _setup_ssh_rsa() {
367
		global $app;
368 369
		$this->app->log("ssh-rsa setup shelluser_jailkit",LOGLEVEL_DEBUG); 
		// Get the client ID, username, and the key
370 371
		$domain_data = $this->app->db->queryOneRecord('SELECT sys_groupid FROM web_domain WHERE web_domain.domain_id = '.intval($this->data['new']['parent_domain_id']));
		$sys_group_data = $this->app->db->queryOneRecord('SELECT * FROM sys_group WHERE sys_group.groupid = '.intval($domain_data['sys_groupid']));
372 373
		$id = intval($sys_group_data['client_id']);
		$username= $sys_group_data['name'];
374
		$client_data = $this->app->db->queryOneRecord('SELECT * FROM client WHERE client.client_id = '.$id);
375 376 377 378 379
		$userkey = $client_data['ssh_rsa'];
		unset($domain_data);
		unset($client_data);
		
		// ssh-rsa authentication variables
380
		$sshrsa = $this->data['new']['ssh_rsa'];
381
		$usrdir = escapeshellcmd($this->data['new']['dir']).'/'.$this->_get_home_dir($this->data['new']['username']);
382 383 384 385 386 387
		$sshdir = $usrdir.'/.ssh';
		$sshkeys= $usrdir.'/.ssh/authorized_keys';
			
		$app->uses('file');
		$sshrsa = $app->file->unix_nl($sshrsa);
		$sshrsa = $app->file->remove_blank_lines($sshrsa,0);
388 389
		
		// If this user has no key yet, generate a pair
390
		if ($userkey == '' && $id > 0){
391 392
			//Generate ssh-rsa-keys
			exec('ssh-keygen -t rsa -C '.$username.'-rsa-key-'.time().' -f /tmp/id_rsa -N ""');
393 394
			
			// use the public key that has been generated
395
			$userkey = $app->system->file_get_contents('/tmp/id_rsa.pub');
396
			
397
			// save keypair in client table
398
			$this->app->db->query("UPDATE client SET created_at = ".time().", id_rsa = '".$app->db->quote($app->system->file_get_contents('/tmp/id_rsa'))."', ssh_rsa = '".$app->db->quote($userkey)."' WHERE client_id = ".$id);
399

400 401
			$app->system->unlink('/tmp/id_rsa');
			$app->system->unlink('/tmp/id_rsa.pub');
402 403 404
			$this->app->log("ssh-rsa keypair generated for ".$username,LOGLEVEL_DEBUG);
		};
		
405
		if (!file_exists($sshkeys)){
406
			// add root's key
407
			$app->file->mkdirs($sshdir, '0755');
408
			if(is_file('/root/.ssh/authorized_keys')) $app->system->file_put_contents($sshkeys, $app->system->file_get_contents('/root/.ssh/authorized_keys'));
409 410
		
			// Remove duplicate keys
411
			$existing_keys = @file($sshkeys);
412
			$new_keys = explode("\n", $userkey);
413
			$final_keys_arr = @array_merge($existing_keys, $new_keys);
414 415 416 417 418 419 420 421
			$new_final_keys_arr = array();
			if(is_array($final_keys_arr) && !empty($final_keys_arr)){
				foreach($final_keys_arr as $key => $val){
					$new_final_keys_arr[$key] = trim($val);
				}
			}
			$final_keys = implode("\n", array_flip(array_flip($new_final_keys_arr)));
			
422
			// add the user's key
423 424
			file_put_contents($sshkeys, $final_keys);
			$app->file->remove_blank_lines($sshkeys);
425 426
			$this->app->log("ssh-rsa authorisation keyfile created in ".$sshkeys,LOGLEVEL_DEBUG);
		}
427 428 429 430 431 432 433 434 435 436
		//* Get the keys
		$existing_keys = file($sshkeys);
		$new_keys = explode("\n", $sshrsa);
		$old_keys = explode("\n",$this->data['old']['ssh_rsa']);
			
		//* Remove all old keys
		if(is_array($old_keys)) {
			foreach($old_keys as $key => $val) {
				$k = array_search(trim($val),$existing_keys);
				unset($existing_keys[$k]);
437
			}
438
		}
439
			
440 441 442 443 444
		//* merge the remaining keys and the ones fom the ispconfig database.
		if(is_array($new_keys)) {
			$final_keys_arr = array_merge($existing_keys, $new_keys);
		} else {
			$final_keys_arr = $existing_keys;
445
		}
446 447 448 449 450 451 452 453 454 455
			
		$new_final_keys_arr = array();
		if(is_array($final_keys_arr) && !empty($final_keys_arr)){
			foreach($final_keys_arr as $key => $val){
				$new_final_keys_arr[$key] = trim($val);
			}
		}
		$final_keys = implode("\n", array_flip(array_flip($new_final_keys_arr)));
			
		// add the custom key 
456
		$app->system->file_put_contents($sshkeys, $final_keys);
457 458 459
		$app->file->remove_blank_lines($sshkeys);
		$this->app->log("ssh-rsa key updated in ".$sshkeys,LOGLEVEL_DEBUG);
		
460
		// set proper file permissions
461 462
		exec("chown -R ".escapeshellcmd($this->data['new']['puser']).":".escapeshellcmd($this->data['new']['pgroup'])." ".$sshdir);
		exec("chmod 700 ".$sshdir);
463 464 465
		exec("chmod 600 '$sshkeys'");
		
	}
tbrehm's avatar
tbrehm committed
466 467
} // end class

468
?>