From 7fe908c50c8dbc5cc05f571dbe11d66141caacd4 Mon Sep 17 00:00:00 2001
From: Marius Cramer <m.cramer@pixcept.de>
Date: Thu, 14 Nov 2013 09:01:22 -0500
Subject: [PATCH] Cleaning up code to match coding guidelines
---
server/plugins-available/shelluser_base_plugin.inc.php | 176 +++++++++++++++++++++++++++++-----------------------------
1 files changed, 88 insertions(+), 88 deletions(-)
diff --git a/server/plugins-available/shelluser_base_plugin.inc.php b/server/plugins-available/shelluser_base_plugin.inc.php
index 2924d49..33d8875 100755
--- a/server/plugins-available/shelluser_base_plugin.inc.php
+++ b/server/plugins-available/shelluser_base_plugin.inc.php
@@ -29,61 +29,61 @@
*/
class shelluser_base_plugin {
-
+
var $plugin_name = 'shelluser_base_plugin';
var $class_name = 'shelluser_base_plugin';
var $min_uid = 499;
-
+
//* 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');
-
+ $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');
+
+
}
-
-
- function insert($event_name,$data) {
+
+
+ function insert($event_name, $data) {
global $app, $conf;
-
+
$app->uses('system');
-
+
//* Check if the resulting path is inside the docroot
$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".intval($data['new']['parent_domain_id']));
- if(substr(realpath($data['new']['dir']),0,strlen($web['document_root'])) != $web['document_root']) {
- $app->log('Directory of the shell user is outside of website docroot.',LOGLEVEL_WARN);
+ if(substr(realpath($data['new']['dir']), 0, strlen($web['document_root'])) != $web['document_root']) {
+ $app->log('Directory of the shell user is outside of website docroot.', LOGLEVEL_WARN);
return false;
}
-
+
if($app->system->is_user($data['new']['puser'])) {
-
+
//* Remove webfolder protection
- $app->system->web_folder_protection($web['document_root'],false);
-
+ $app->system->web_folder_protection($web['document_root'], false);
+
// Get the UID of the parent user
$uid = intval($app->system->getuid($data['new']['puser']));
if($uid > $this->min_uid) {
@@ -95,53 +95,53 @@
$command .= ' -s '.escapeshellcmd($data['new']['shell']);
$command .= ' -u '.escapeshellcmd($uid);
$command .= ' '.escapeshellcmd($data['new']['username']);
-
+
exec($command);
- $app->log("Executed command: ".$command,LOGLEVEL_DEBUG);
- $app->log("Added shelluser: ".$data['new']['username'],LOGLEVEL_DEBUG);
-
+ $app->log("Executed command: ".$command, LOGLEVEL_DEBUG);
+ $app->log("Added shelluser: ".$data['new']['username'], LOGLEVEL_DEBUG);
+
// call the ssh-rsa update function
$app->uses("getconf");
$this->data = $data;
$this->app = $app;
$this->_setup_ssh_rsa();
-
+
//* Create .bash_history file
$app->system->touch(escapeshellcmd($data['new']['dir']).'/.bash_history');
$app->system->chmod(escapeshellcmd($data['new']['dir']).'/.bash_history', 0755);
$app->system->chown(escapeshellcmd($data['new']['dir']).'/.bash_history', $data['new']['username']);
$app->system->chgrp(escapeshellcmd($data['new']['dir']).'/.bash_history', $data['new']['pgroup']);
-
+
//* Disable shell user temporarily if we use jailkit
if($data['new']['chroot'] == 'jailkit') {
$command = 'usermod -s /bin/false -L '.escapeshellcmd($data['new']['username']).' 2>/dev/null';
exec($command);
- $app->log("Disabling shelluser temporarily: ".$command,LOGLEVEL_DEBUG);
+ $app->log("Disabling shelluser temporarily: ".$command, LOGLEVEL_DEBUG);
}
-
+
//* Add webfolder protection again
- $app->system->web_folder_protection($web['document_root'],true);
-
+ $app->system->web_folder_protection($web['document_root'], true);
+
} else {
- $app->log("UID = $uid for shelluser:".$data['new']['username']." not allowed.",LOGLEVEL_ERROR);
+ $app->log("UID = $uid for shelluser:".$data['new']['username']." not allowed.", LOGLEVEL_ERROR);
}
} else {
- $app->log("Skipping insertion of user:".$data['new']['username'].", parent user ".$data['new']['puser']." does not exist.",LOGLEVEL_WARN);
+ $app->log("Skipping insertion of user:".$data['new']['username'].", parent user ".$data['new']['puser']." does not exist.", LOGLEVEL_WARN);
}
}
-
- function update($event_name,$data) {
+
+ function update($event_name, $data) {
global $app, $conf;
-
+
$app->uses('system');
-
+
//* Check if the resulting path is inside the docroot
$web = $app->db->queryOneRecord("SELECT * FROM web_domain WHERE domain_id = ".intval($data['new']['parent_domain_id']));
- if(substr(realpath($data['new']['dir']),0,strlen($web['document_root'])) != $web['document_root']) {
- $app->log('Directory of the shell user is outside of website docroot.',LOGLEVEL_WARN);
+ if(substr(realpath($data['new']['dir']), 0, strlen($web['document_root'])) != $web['document_root']) {
+ $app->log('Directory of the shell user is outside of website docroot.', LOGLEVEL_WARN);
return false;
}
-
+
if($app->system->is_user($data['new']['puser'])) {
// Get the UID of the parent user
$uid = intval($app->system->getuid($data['new']['puser']));
@@ -158,45 +158,45 @@
// $command .= ' --uid '.escapeshellcmd($uid);
$command .= ' --login '.escapeshellcmd($data['new']['username']);
$command .= ' '.escapeshellcmd($data['old']['username']);
-
+
exec($command);
$app->log("Executed command: $command ",LOGLEVEL_DEBUG);
*/
//$groupinfo = $app->system->posix_getgrnam($data['new']['pgroup']);
- $app->system->usermod($data['old']['username'],0, $app->system->getgid($data['new']['pgroup']), $data['new']['dir'], $data['new']['shell'], $data['new']['password'], $data['new']['username']);
- $app->log("Updated shelluser: ".$data['old']['username'],LOGLEVEL_DEBUG);
-
+ $app->system->usermod($data['old']['username'], 0, $app->system->getgid($data['new']['pgroup']), $data['new']['dir'], $data['new']['shell'], $data['new']['password'], $data['new']['username']);
+ $app->log("Updated shelluser: ".$data['old']['username'], LOGLEVEL_DEBUG);
+
// call the ssh-rsa update function
$app->uses("getconf");
$this->data = $data;
$this->app = $app;
$this->_setup_ssh_rsa();
-
+
//* Create .bash_history file
if(!is_file($data['new']['dir']).'/.bash_history') {
$app->system->touch(escapeshellcmd($data['new']['dir']).'/.bash_history');
$app->system->chmod(escapeshellcmd($data['new']['dir']).'/.bash_history', 0755);
- $app->system->chown(escapeshellcmd($data['new']['dir']).'/.bash_history',escapeshellcmd($data['new']['username']));
- $app->system->chgrp(escapeshellcmd($data['new']['dir']).'/.bash_history',escapeshellcmd($data['new']['pgroup']));
+ $app->system->chown(escapeshellcmd($data['new']['dir']).'/.bash_history', escapeshellcmd($data['new']['username']));
+ $app->system->chgrp(escapeshellcmd($data['new']['dir']).'/.bash_history', escapeshellcmd($data['new']['pgroup']));
}
-
+
} else {
// The user does not exist, so we insert it now
- $this->insert($event_name,$data);
+ $this->insert($event_name, $data);
}
} else {
- $app->log("UID = $uid for shelluser:".$data['new']['username']." not allowed.",LOGLEVEL_ERROR);
+ $app->log("UID = $uid for shelluser:".$data['new']['username']." not allowed.", LOGLEVEL_ERROR);
}
} else {
- $app->log("Skipping update for user:".$data['new']['username'].", parent user ".$data['new']['puser']." does not exist.",LOGLEVEL_WARN);
+ $app->log("Skipping update for user:".$data['new']['username'].", parent user ".$data['new']['puser']." does not exist.", LOGLEVEL_WARN);
}
}
-
- function delete($event_name,$data) {
+
+ function delete($event_name, $data) {
global $app, $conf;
-
+
$app->uses('system');
-
+
if($app->system->is_user($data['old']['username'])) {
// Get the UID of the user
$userid = intval($app->system->getuid($data['old']['username']));
@@ -206,21 +206,21 @@
$command = 'userdel -f';
$command .= ' '.escapeshellcmd($data['old']['username']).' &> /dev/null';
exec($command);
- $app->log("Deleted shelluser: ".$data['old']['username'],LOGLEVEL_DEBUG);
+ $app->log("Deleted shelluser: ".$data['old']['username'], LOGLEVEL_DEBUG);
}
-
+
} else {
- $app->log("UID = $userid for shelluser:".$data['old']['username']." not allowed.",LOGLEVEL_ERROR);
+ $app->log("UID = $userid for shelluser:".$data['old']['username']." not allowed.", LOGLEVEL_ERROR);
}
} else {
- $app->log("User:".$data['new']['username']." does not exist in in /etc/passwd, skipping delete.",LOGLEVEL_WARN);
+ $app->log("User:".$data['new']['username']." does not exist in in /etc/passwd, skipping delete.", LOGLEVEL_WARN);
}
-
+
}
-
+
private function _setup_ssh_rsa() {
global $app;
- $this->app->log("ssh-rsa setup shelluser_base",LOGLEVEL_DEBUG);
+ $this->app->log("ssh-rsa setup shelluser_base", LOGLEVEL_DEBUG);
// Get the client ID, username, and the key
$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']));
@@ -230,38 +230,38 @@
$userkey = $client_data['ssh_rsa'];
unset($domain_data);
unset($client_data);
-
+
// ssh-rsa authentication variables
$sshrsa = $this->data['new']['ssh_rsa'];
$usrdir = escapeshellcmd($this->data['new']['dir']);
$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);
-
+ $sshrsa = $app->file->remove_blank_lines($sshrsa, 0);
+
// If this user has no key yet, generate a pair
if ($userkey == '' && $id > 0){
//Generate ssh-rsa-keys
exec('ssh-keygen -t rsa -C '.$username.'-rsa-key-'.time().' -f /tmp/id_rsa -N ""');
-
+
// use the public key that has been generated
$userkey = $app->system->file_get_contents('/tmp/id_rsa.pub');
-
+
// save keypair in client table
$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);
-
+
$app->system->unlink('/tmp/id_rsa');
$app->system->unlink('/tmp/id_rsa.pub');
- $this->app->log("ssh-rsa keypair generated for ".$username,LOGLEVEL_DEBUG);
+ $this->app->log("ssh-rsa keypair generated for ".$username, LOGLEVEL_DEBUG);
};
if (!file_exists($sshkeys)){
// add root's key
$app->file->mkdirs($sshdir, '0700');
if(is_file('/root/.ssh/authorized_keys')) $app->system->file_put_contents($sshkeys, $app->system->file_get_contents('/root/.ssh/authorized_keys'));
-
+
// Remove duplicate keys
$existing_keys = @file($sshkeys);
$new_keys = explode("\n", $userkey);
@@ -273,33 +273,33 @@
}
}
$final_keys = implode("\n", array_flip(array_flip($new_final_keys_arr)));
-
+
// add the user's key
$app->system->file_put_contents($sshkeys, $final_keys);
$app->file->remove_blank_lines($sshkeys);
- $this->app->log("ssh-rsa authorisation keyfile created in ".$sshkeys,LOGLEVEL_DEBUG);
+ $this->app->log("ssh-rsa authorisation keyfile created in ".$sshkeys, LOGLEVEL_DEBUG);
}
-
+
//* Get the keys
$existing_keys = file($sshkeys);
$new_keys = explode("\n", $sshrsa);
- $old_keys = explode("\n",$this->data['old']['ssh_rsa']);
-
+ $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);
+ $k = array_search(trim($val), $existing_keys);
unset($existing_keys[$k]);
}
}
-
+
//* 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;
}
-
+
$new_final_keys_arr = array();
if(is_array($final_keys_arr) && !empty($final_keys_arr)){
foreach($final_keys_arr as $key => $val){
@@ -307,18 +307,18 @@
}
}
$final_keys = implode("\n", array_flip(array_flip($new_final_keys_arr)));
-
- // add the custom key
+
+ // add the custom key
$app->system->file_put_contents($sshkeys, $final_keys);
$app->file->remove_blank_lines($sshkeys);
- $this->app->log("ssh-rsa key updated in ".$sshkeys,LOGLEVEL_DEBUG);
-
+ $this->app->log("ssh-rsa key updated in ".$sshkeys, LOGLEVEL_DEBUG);
+
// set proper file permissions
exec("chown -R ".escapeshellcmd($this->data['new']['puser']).":".escapeshellcmd($this->data['new']['pgroup'])." ".$sshdir);
exec("chmod 600 '$sshkeys'");
-
+
}
-
+
} // end class
--
Gitblit v1.9.1