fixing editing dns, mail, db and web domain servers by client issue

Sebastien JEAN

2013-11-18 f19308703c8769cd943dfcef416484c3353fd5fb

 server/plugins-available/mail_plugin_dkim.inc.php

@@ -1,10 +1,6 @@
<?php

/*
todo:
- DNS interaction
*/
/*
/**
Copyright (c) 2007 - 2013, Till Brehm, projektfarm Gmbh
Copyright (c) 2013, Florian Schaal, info@schaal-24.de
All rights reserved.
@@ -31,6 +27,9 @@
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
*/

class mail_plugin_dkim {
@@ -41,9 +40,9 @@
   // private variables
   var $action = '';

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

   }

   /*
       This function is called when the plugin is loaded
   /**
   * This function is called when the plugin is loaded
   */
   function onLoad() {
      global $app,$conf;
@@ -67,18 +66,17 @@
      $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
        /**
        * This function gets the amavisd-config file
   * @return string path to the amavisd-config for dkim-keys
        */
   function get_amavis_config() {
      $pos_config=array(
         '/etc/amavisd.conf',
         '/etc/amavisd.conf/50-user'
         '/etc/amavisd.conf/50-user',
         '/etc/amavis/conf.d/50-user'
      );
      $amavis_configfile='';
                foreach($pos_config as $conf) {
@@ -90,9 +88,11 @@
      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
   /**
   * 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
   */
   function check_system($data) {
      global $app,$mail_config;
@@ -114,27 +114,26 @@
         $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
   /**
   * 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);
      exec(escapeshellarg($conf['init_scripts']).escapeshellarg('/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
   /**
        * 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;
@@ -143,38 +142,37 @@
         $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);
         exec('cat '.escapeshellarg($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
   /**
   * 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) {
      global $app;
      if (file_exists($key_file.'.private')) {
         exec('rm -f '.$key_file.'.private');
         exec('rm -f '.escapeshellarg($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');
         exec('rm -f '.escapeshellarg($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
   /**
   * This function adds the entry to the amavisd-config
   * @param string $key_domain mail-domain
   */
   function add_to_amavis($key_domain) {
      global $app,$mail_config;
@@ -187,8 +185,9 @@
      }
   }

   /*
      This function removes the entry from the amavisd-config
   /**
   * This function removes the entry from the amavisd-config
   * @param string $key_domain mail-domain
   */
   function remove_from_amavis($key_domain) {
      global $app;
@@ -208,26 +207,31 @@
      } 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
   /**
   * This function controlls new key-files and amavisd-entries
   * @param array $data mail-settings
   */
   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']."'");
      if ($data['new']['active'] == 'y') {
                   $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 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)
      and the entry in the amavisd-config
   /**
   * This function controlls the removement of keyfiles (public and private)
   * and the entry in the amavisd-config
   * @param array $data mail-settings
   */
   function remove_dkim($_data) {
      global $app;
@@ -238,22 +242,28 @@
                  $this->remove_from_amavis($_data['domain']);
   }

   /*
      Functions called by onLoad
   /**
   * 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']);
   }

   /**
   * 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 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 called by onLoad
   * chang dkim-settings
   */
   function domain_dkim_update($event_name,$data) {
      global $app;
                /* get the config */