GEANT / CAT

devices/linux/DeviceLinuxSh.php

Indentation +117 added lines, -117 removed lines

@@ -31,15 +31,15 @@ 
 use Exception;
 class DeviceLinuxSh extends \core\DeviceConfig {
 
-      final public function __construct() {
-  parent::__construct();
-      $this->setSupportedEapMethods([\core\common\EAP::EAPTYPE_PEAP_MSCHAP2, \core\common\EAP::EAPTYPE_TTLS_PAP, \core\common\EAP::EAPTYPE_TTLS_MSCHAP2, \core\common\EAP::EAPTYPE_TLS, \core\common\EAP::EAPTYPE_SILVERBULLET]);
-      $this->local_dir = '.cat_installer';
-      $this->conf_file = '$HOME/'.$this->local_dir.'/cat_installer.conf';
+        final public function __construct() {
+    parent::__construct();
+        $this->setSupportedEapMethods([\core\common\EAP::EAPTYPE_PEAP_MSCHAP2, \core\common\EAP::EAPTYPE_TTLS_PAP, \core\common\EAP::EAPTYPE_TTLS_MSCHAP2, \core\common\EAP::EAPTYPE_TLS, \core\common\EAP::EAPTYPE_SILVERBULLET]);
+        $this->local_dir = '.cat_installer';
+        $this->conf_file = '$HOME/'.$this->local_dir.'/cat_installer.conf';
     }
 
-   public function writeInstaller() {
-      $out_string = '#!/usr/bin/env bash
+    public function writeInstaller() {
+        $out_string = '#!/usr/bin/env bash
 if [ -z "$BASH" ] ; then
    bash  $0
    exit
@@ -47,42 +47,42 @@ 
 
 
 ';
-      $out_string .= $this->printFunctions();
-      $out_string .= $this->printStart();
-      $out_string .= $this->printProfileConfirmation();
-      $out_string .= $this->printUserConsent();
-      $out_string .= $this->printCheckDirectory();
-      $CAs = $this->attributes['internal:CAs'][0];
-      $this->server_name = $this->glueServerNames($this->attributes['eap:server_name']);
-      $this->server_alt_subject_name_list = $this->mkSubjectAltNameList($this->attributes['eap:server_name']);
-      $out_string .= "# save certificates\n";
-      $out_string .= 'echo "';
-      foreach ($CAs as $ca) {
+        $out_string .= $this->printFunctions();
+        $out_string .= $this->printStart();
+        $out_string .= $this->printProfileConfirmation();
+        $out_string .= $this->printUserConsent();
+        $out_string .= $this->printCheckDirectory();
+        $CAs = $this->attributes['internal:CAs'][0];
+        $this->server_name = $this->glueServerNames($this->attributes['eap:server_name']);
+        $this->server_alt_subject_name_list = $this->mkSubjectAltNameList($this->attributes['eap:server_name']);
+        $out_string .= "# save certificates\n";
+        $out_string .= 'echo "';
+        foreach ($CAs as $ca) {
         $out_string .= $ca['pem']."\n";
-      }
-      $out_string .= '"'." > \$HOME/$this->local_dir/ca.pem\n";
+        }
+        $out_string .= '"'." > \$HOME/$this->local_dir/ca.pem\n";
 
-     $SSIDs = $this->attributes['internal:SSID'];
-     $delSSIDs = $this->attributes['internal:remove_SSID'];
+        $SSIDs = $this->attributes['internal:SSID'];
+        $delSSIDs = $this->attributes['internal:remove_SSID'];
 
-     $out_string .= $this->printNMScript($SSIDs,$delSSIDs);
-     $out_string .= $this->writeWpaConf($SSIDs);
-     if($this->selected_eap == \core\common\EAP::EAPTYPE_TLS) 
-       $out_string .= $this->printP12Dialog();
-     else
-       $out_string .= $this->printPasswordDialog();
-     $out_string .= $this->checkNMResultAndCont();
-     $installer_path = $this->installerBasename.'.sh';
-      file_put_contents($installer_path, $out_string);
-      return($installer_path);
-   }
+        $out_string .= $this->printNMScript($SSIDs,$delSSIDs);
+        $out_string .= $this->writeWpaConf($SSIDs);
+        if($this->selected_eap == \core\common\EAP::EAPTYPE_TLS) 
+        $out_string .= $this->printP12Dialog();
+        else
+        $out_string .= $this->printPasswordDialog();
+        $out_string .= $this->checkNMResultAndCont();
+        $installer_path = $this->installerBasename.'.sh';
+        file_put_contents($installer_path, $out_string);
+        return($installer_path);
+    }
 
     public function writeDeviceInfo() {
     $ssid_ct=count($this->attributes['internal:SSID']);
     $out = '';
 
-   $out .= _("The installer is in the form of a bash script. It will try to configure eduroam under Network Manager and if this is either not appropriate for your system or your version of Network Manager is too old, a wpa_supplicant config file will be created instead.");
-   $out .= "<p>";
+    $out .= _("The installer is in the form of a bash script. It will try to configure eduroam under Network Manager and if this is either not appropriate for your system or your version of Network Manager is too old, a wpa_supplicant config file will be created instead.");
+    $out .= "<p>";
     if($ssid_ct > 1) {
         if($ssid_ct > 2) {
             $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to the following networks:"),implode(', ',\config\ConfAssistant::CONSORTIUM['ssid']))." ";
@@ -90,39 +90,39 @@ 
             $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to:"),implode(', ',\config\ConfAssistant::CONSORTIUM['ssid']))." ";
         $i = 0;
         foreach ($this->attributes['internal:SSID'] as $ssid=>$v) {
-           if(! in_array($ssid, \config\ConfAssistant::CONSORTIUM['ssid'])) {
-             if($i > 0)
-           $out .= ", ";
-         $i++;
-         $out .= "<strong>$ssid</strong>";
-       }
+            if(! in_array($ssid, \config\ConfAssistant::CONSORTIUM['ssid'])) {
+                if($i > 0)
+            $out .= ", ";
+            $i++;
+            $out .= "<strong>$ssid</strong>";
+        }
     }
     $out .= "<p>";
     }
-   $out .= _("The installer will create .cat_installer sub-directory in your home directory and will copy your server certificates there.");
+    $out .= _("The installer will create .cat_installer sub-directory in your home directory and will copy your server certificates there.");
 if($this->eap == \core\common\EAP::EAPTYPE_TLS)
-   $out .= _("In order to connect to the network you will need a personal certificate in the form of a p12 file. You should obtain this certificate from your home institution. Consult the support page to find out how this certificate can be obtained. Such certificate files are password protected. You should have both the file and the password available during the installation process. Your p12 file will also be copied to the .cat_installer directory.");
+    $out .= _("In order to connect to the network you will need a personal certificate in the form of a p12 file. You should obtain this certificate from your home institution. Consult the support page to find out how this certificate can be obtained. Such certificate files are password protected. You should have both the file and the password available during the installation process. Your p12 file will also be copied to the .cat_installer directory.");
 else {
-   $out .= _("In order to connect to the network you will need an account from your home institution. You should consult the support page to find out how this account can be obtained. It is very likely that your account is already activated.");
-   $out .= "<p>";
-   $out .= _("You will be requested to enter your account credentials during the installation. This information will be saved so that you will reconnect to the network automatically each time you are in the range.");
+    $out .= _("In order to connect to the network you will need an account from your home institution. You should consult the support page to find out how this account can be obtained. It is very likely that your account is already activated.");
+    $out .= "<p>";
+    $out .= _("You will be requested to enter your account credentials during the installation. This information will be saved so that you will reconnect to the network automatically each time you are in the range.");
 }
     $out .= "<p>";
     return $out;
-  }
+    }
 
 
-  private function printCheckDirectory() {
+    private function printCheckDirectory() {
 $out = 'if [ -d $HOME/'.$this->local_dir.' ] ; then
    if ! ask "'.sprintf(_("Directory %s exists; some of its files may be overwritten."),'$HOME/'.$this->local_dir).'" "'._("Continue").'" 1 ; then exit; fi
 else
   mkdir $HOME/'.$this->local_dir.'
 fi
 ';
- return $out;
-  }
+    return $out;
+    }
 
-  private function checkNMResultAndCont() {
+    private function checkNMResultAndCont() {
     $out = 'if run_python_script ; then
    show_info "'._("Installation successful").'"
 else
@@ -137,50 +137,50 @@ 
    show_info "'.sprintf(_("Output written to %s"),$this->conf_file).'"
 fi
 ';
-  return $out;
-  }
+    return $out;
+    }
 
 private function printStart() {
-     $out = "setup_environment\n";
-     $out .= 'show_info "'._("This installer has been prepared for \${ORGANISATION}").'\n\n'._("More information and comments:").'\n\nEMAIL: ${SUPPORT}\nWWW: ${URL}\n\n'.
+        $out = "setup_environment\n";
+        $out .= 'show_info "'._("This installer has been prepared for \${ORGANISATION}").'\n\n'._("More information and comments:").'\n\nEMAIL: ${SUPPORT}\nWWW: ${URL}\n\n'.
 _("Installer created with software from the GEANT project.").'"
 ';
-  return $out;
+    return $out;
 }
 
 
 private function printProfileConfirmation() {
- if($this->attributes['internal:profile_count'][0] > 1)
-       $out = 'if ! ask "'.sprintf(_("This installer will only work properly if you are a member of %s and the user group: %s."),'${bf}'.$this->attributes['general:instname'][0].'${n}','${bf}'.$this->attributes['profile:name'][0]).'${n}"';
+    if($this->attributes['internal:profile_count'][0] > 1)
+        $out = 'if ! ask "'.sprintf(_("This installer will only work properly if you are a member of %s and the user group: %s."),'${bf}'.$this->attributes['general:instname'][0].'${n}','${bf}'.$this->attributes['profile:name'][0]).'${n}"';
     else
-       $out = 'if ! ask "'.sprintf(_("This installer will only work properly if you are a member of %s."),'${bf}'.$this->attributes['general:instname'][0]).'${n}"';
+        $out = 'if ! ask "'.sprintf(_("This installer will only work properly if you are a member of %s."),'${bf}'.$this->attributes['general:instname'][0]).'${n}"';
     $out .= ' "'._("Continue").'" 1 ; then exit; fi
 ';
-  return $out;
+    return $out;
 
 }
 
 
-  private function printUserConsent() {
+    private function printUserConsent() {
     $out = '';
     if(isset($this->attributes['support:info_file'])) {
-      if( $this->attributes['internal:info_file'][0]['mime'] == 'txt') {
-         $handle = fopen($this->attributes['internal:info_file'][0]['name'],"r");
-         $consent = '';
-         while (($buffer = fgets($handle, 4096)) !== false) {
-           $consent .= rtrim($buffer) . '\n';
-         }
-         $out = 'if ! ask "'.$consent.'${n}" "'._("Continue").'" 1 ; then exit; fi
+        if( $this->attributes['internal:info_file'][0]['mime'] == 'txt') {
+            $handle = fopen($this->attributes['internal:info_file'][0]['name'],"r");
+            $consent = '';
+            while (($buffer = fgets($handle, 4096)) !== false) {
+            $consent .= rtrim($buffer) . '\n';
+            }
+            $out = 'if ! ask "'.$consent.'${n}" "'._("Continue").'" 1 ; then exit; fi
 ';
-      }
+        }
     }
     return $out;
-  }
+    }
 # ask user for confirmation
 # the first argument is the user prompt
 # if the second argument is 0 then the first element of yes_no array
 # will be the default value prompted to the user
-  private function printFunctions() {
+    private function printFunctions() {
 $url = (isset($this->attributes['support:url'][0]) && $this->attributes['support:url'][0] ) ? $this->attributes['support:url'][0] : $this->support_url_substitute;
 $support=(isset($this->attributes['support:email'][0]) && $this->attributes['support:email'][0] ) ? $this->attributes['support:email'][0] : $this->support_email_substitute;
 $out ='
@@ -390,11 +390,11 @@ 
 }
 
 
-  private function writeWpaConf($SSIDs) {
-     $e = \core\common\EAP::eapDisplayName($this->selected_eap);
+    private function writeWpaConf($SSIDs) {
+        $e = \core\common\EAP::eapDisplayName($this->selected_eap);
 $out = 'function create_wpa_conf {
 cat << EOFW >> '.$this->conf_file."\n";
-     foreach (array_keys($SSIDs) as $ssid) {
+        foreach (array_keys($SSIDs) as $ssid) {
     $out .= '
 network={
   ssid="'.$ssid.'"
@@ -404,42 +404,42 @@ 
   eap='.$e['OUTER'].'
   ca_cert="${HOME}/'.$this->local_dir.'/ca.pem"
   identity="${USER_NAME}"';
-  if($this->server_name)
+    if($this->server_name)
     $out .= '
   domain_suffix_match="'.$this->server_name.'"';
-  if($this->selected_eap == \core\common\EAP::EAPTYPE_TLS) {
+    if($this->selected_eap == \core\common\EAP::EAPTYPE_TLS) {
     $out .= '
   private_key="${HOME}/'.$this->local_dir.'/user.p12"
   private_key_passwd="${PASSWORD}"';
-  } else {
+    } else {
     $out .= '
   phase2="auth='.$e['INNER'].'"
   password="${PASSWORD}"';
-  if($this->attributes['internal:use_anon_outer'][0] == 1) 
+    if($this->attributes['internal:use_anon_outer'][0] == 1) 
     $out .= '
   anonymous_identity="'.$this->attributes['internal:anon_local_value'][0].'@'.$this->attributes['internal:realm'][0].'"';
-  }
+    }
     $out .= '
 }';
 }
-  $out .= '
+    $out .= '
 EOFW
 chmod 600 '.$this->conf_file.'
 }
 ';
-  return $out;
+    return $out;
 }
 
 
 
-  private function printPasswordDialog() {
-  $out = '#prompt user for credentials
+    private function printPasswordDialog() {
+    $out = '#prompt user for credentials
   user_cred
   ';
-  return $out;
+    return $out;
 }
-  private function printP12Dialog() {
-  $out ='function p12dialog {
+    private function printP12Dialog() {
+    $out ='function p12dialog {
   if [ ! -z $ZENITY ] ; then
     if ! cert=`$ZENITY --file-selection --file-filter="'._("personal certificate file (p12 or pfx)").' | *.p12 *.P12 *.pfx *.PFX" --file-filter="All files | *" --title="'._("personal certificate file (p12 or pfx)").'" 2>/dev/null` ; then
        exit
@@ -494,7 +494,7 @@ 
     done
 ';
         if (isset($this->attributes['eap-specific:tls_use_other_id']) && $this->attributes['eap-specific:tls_use_other_id'][0] == 'on') {
-           $out .= '      if ! USERNAME=`prompt_nonempty_string 1 "'._("enter your userid").'" "$USER_NAME"` ; then
+            $out .= '      if ! USERNAME=`prompt_nonempty_string 1 "'._("enter your userid").'" "$USER_NAME"` ; then
        exit 1
     fi
 ';
@@ -510,37 +510,37 @@ 
 }  
 p12dialog
 ';
- return $out;
+    return $out;
 }
 
 
 private function glueServerNames($server_list) {
-  if(! $server_list)
+    if(! $server_list)
     return '';
-  $A0 =  array_reverse(explode('.',array_shift($server_list)));
-  $B = $A0;
-  foreach($server_list as $a) {
-     $A= array_reverse(explode('.',$a));
-     $B = array_intersect_assoc($A0,$A);
-     $A0 = $B;
-   }
-  return(implode('.',array_reverse($B)));
+    $A0 =  array_reverse(explode('.',array_shift($server_list)));
+    $B = $A0;
+    foreach($server_list as $a) {
+        $A= array_reverse(explode('.',$a));
+        $B = array_intersect_assoc($A0,$A);
+        $A0 = $B;
+    }
+    return(implode('.',array_reverse($B)));
 }
 
 private function mkSubjectAltNameList($server_list) {
-  if(! $server_list)
+    if(! $server_list)
     return '';
-  $out = '';
-  foreach($server_list as $a) {
-     if($out)
-       $out .= ','; 
-     $out .= "'DNS:$a'";
-  }
-  return $out;
+    $out = '';
+    foreach($server_list as $a) {
+        if($out)
+        $out .= ','; 
+        $out .= "'DNS:$a'";
+    }
+    return $out;
 }
 
 private function printNMScript($SSIDs,$delSSIDs) {
-   $e = \core\common\EAP::eapDisplayName($this->selectedEap);
+    $e = \core\common\EAP::eapDisplayName($this->selectedEap);
 $out = 'function run_python_script {
 PASSWORD=$( echo "$PASSWORD" | sed "s/\'/\\\\\\\'/g" )
 if python << EEE1 > /dev/null 2>&1
@@ -679,20 +679,20 @@ 
             \'identity\': \'$USER_NAME\',
             \'ca-cert\': dbus.ByteArray("file://{0}\0".format(self.cacert_file).encode(\'utf8\')),';
     if($this->server_name) {
-             $out .= '
+                $out .= '
              match_key: match_value,';
     }
     if($this->selected_eap == \core\common\EAP::EAPTYPE_TLS) {
-       $out .= '
+        $out .= '
             \'client-cert\':  dbus.ByteArray("file://{0}\0".format(self.pfx_file).encode(\'utf8\')),
             \'private-key\':  dbus.ByteArray("file://{0}\0".format(self.pfx_file).encode(\'utf8\')),
             \'private-key-password\':  \'$PASSWORD\',';
     } else {
-       $out .= '
+        $out .= '
             \'password\': \'$PASSWORD\',
             \'phase2-auth\': \''.strtolower($e['INNER']).'\',';
-         if($this->attributes['internal:use_anon_outer'][0] == 1) 
-              $out .= '
+            if($this->attributes['internal:use_anon_outer'][0] == 1) 
+                $out .= '
             \'anonymous-identity\': \''.$this->attributes['internal:anon_local_value'][0].'@'.$this->attributes['internal:realm'][0].'\',';
     }
     $out .= '
@@ -712,17 +712,17 @@ 
     def main(self):
         self.check_opts()
         ver = self.connect_to_NM()';
-     foreach (array_keys($SSIDs) as $ssid) {
-           $out .='
+        foreach (array_keys($SSIDs) as $ssid) {
+            $out .='
         self.delete_existing_connections(\''.$ssid.'\')
         self.add_connection(\''.$ssid.'\')';
-     }
+        }
 //   create a list of profiles to be deleted after installation
-     foreach ($delSSIDs as $ssid => $cipher) {
-         if($cipher == 'DEL')
+        foreach ($delSSIDs as $ssid => $cipher) {
+            if($cipher == 'DEL')
             $out .='
         self.delete_existing_connections(\''.$ssid.'\')';
-     }
+        }
 
 $out .='