bug(software): Bug fix with software detection

Ubuntu.png - Add new Ubuntu checklist icon
Database_Baseline.zip - Update software detection tables
checklist.inc - Fix software icon detection for IE and SLES, and added detection for Ubuntu
software.inc - Fix bug adding extra spaces to software strings
parse_stig.php - Formatting and add save for when icon is updated
parse_stig_viewer.php - Add scan note when CKL file is missing or has empty <HOST_NAME> tag

Fix #87

classes/checklist.inc

@@ -5,7 +5,7 @@
  * Purpose: Represents a checklist that links a PDI and software package
  * Created: Sep 12, 2013
  *
- * Portions Copyright 2017: Cyber Perspectives, All rights reserved
+ * Portions Copyright 2017-2019: CyberPerspectives, LLC, All rights reserved
  * Released under the Apache v2.0 License
  *
  * Portions Copyright (c) 2012-2015, Salient Federal Solutions
@@ -406,7 +406,7 @@ class checklist
                 case (preg_match("/Dot Net|DotNet/i", $this->name) ? true : false):
                     $this->icon = 'Microsoft .NET.png';
                     break;
-                case (preg_match("/Internet Explorer/i", $this->name) ? true : false):
+                case (preg_match("/Internet Explorer|Microsoft IE/i", $this->name) ? true : false):
                     $this->icon = 'Internet Explorer.png';
                     break;
                 case (preg_match("/Windows Phone/i", $this->name) ? true : false):
@@ -452,7 +452,7 @@ class checklist
                 case (preg_match("/Red ?Hat/i", $this->name) ? true : false):
                     $this->icon = 'RedHat Linux.jpg';
                     break;
-                case (preg_match("/SUSE Linux/i", $this->name) ? true : false):
+                case (preg_match("/SUSE Linux|SLES/i", $this->name) ? true : false):
                     $this->icon = 'SUSE Linux.png';
                     break;
                 case (preg_match("/Solaris/i", $this->name) ? true : false):
@@ -461,6 +461,9 @@ class checklist
                 case (preg_match("/Storage Area/i", $this->name) ? true : false):
                     $this->icon = 'Storage Area Network.gif';
                     break;
+                case (preg_match("/Ubuntu/i", $this->name) ? true : false):
+                    $this->icon = 'Ubuntu.png';
+                    break;
                 case (preg_match("/z\/OS/i", $this->name) ? true : false):
                     $this->icon = 'ZOS.jpg';
                     break;

classes/software.inc

@@ -595,7 +595,7 @@ class software {
 
                   if ($regex2['name_match']) {
                     foreach (explode(",", $regex2['name_match']) as $idx) {
-                      if (isset($match[$idx])) {
+                      if (isset($match[$idx]) && $match[$idx]) {
                         $sw['name'] .= " " . $match[$idx];
                       }
                     }
@@ -603,7 +603,7 @@ class software {
 
                   if ($regex2['ver_match']) {
                     foreach (explode(",", $regex2['ver_match']) as $idx) {
-                      if (isset($match[$idx])) {
+                      if (isset($match[$idx]) && $match[$idx]) {
                         $sw['ver'] .= $match[$idx] . " ";
                       }
                     }

exec/parse_stig.php

@@ -6,7 +6,7 @@
  * Purpose: To parse a STIG file
  * Created: Jul 9, 2014
  *
- * Portions Copyright 2016-2017: Cyber Perspectives, LLC, All rights reserved
+ * Portions Copyright 2016-2019: CyberPerspectives, LLC, All rights reserved
  * Released under the Apache v2.0 License
  *
  * Portions Copyright (c) 2012-2015, Salient Federal Solutions
@@ -31,7 +31,12 @@
  *  - Dec 27, 2017 - Added up date for load date
  *  - May 10, 2018 - Starting to migrate logging and fixed install status bar issues (#403)
  */
-$cmd = getopt("f:", ['debug::', 'ia_reset::', 'draft::', 'help::']);
+$cmd = getopt("f:", [
+    'debug::',
+    'ia_reset::',
+    'draft::',
+    'help::'
+]);
 
 if (! isset($cmd['f']) || isset($cmd['help'])) {
     die(usage());
@@ -50,9 +55,9 @@ use Monolog\Formatter\LineFormatter;
 $stream = new StreamHandler("php://output", Logger::INFO);
 $stream->setFormatter(new LineFormatter("%datetime% %level_name% %message%", "H:i:s.u"));
 /*
-$log = new Logger("parse_stig");
+ * $log = new Logger("parse_stig");
-$log->pushHandler(new StreamHandler(LOG_PATH . "/" . basename($cmd['f']) . ".log", LOG_LEVEL));
+ * $log->pushHandler(new StreamHandler(LOG_PATH . "/" . basename($cmd['f']) . ".log", LOG_LEVEL));
-$log->pushHandler($stream);
+ * $log->pushHandler($stream);
  */
 
 chdir(DOC_ROOT . "/exec");
@@ -62,8 +67,7 @@ $start = new DateTime();
 // Check to make sure file argument exists and is an XCCDF file
 if (! file_exists($cmd['f'])) {
     Sagacity_Error::err_handler("XML file not found {$cmd['f']}", E_ERROR);
-}
+} elseif (strpos(strtolower($cmd['f']), "xccdf") === false) {
-elseif (strpos(strtolower($cmd['f']), "xccdf") === false) {
     Sagacity_Error::err_handler("Only compatible with XCCDF file formats", E_ERROR);
 }
 
@@ -73,7 +77,11 @@ check_path(DOC_ROOT . "/reference/stigs");
 // open db connection
 $db = new db();
 
-$content = str_replace(["’", "–", "“", "â€"], ["'", "-", '"', '"'], file_get_contents($cmd['f']));
+$content = str_replace([
+    "’", "–", "“", "â€"
+], [
+    "'", "-", '"', '"'
+], file_get_contents($cmd['f']));
 file_put_contents($cmd['f'], $content);
 
 // open xml file
@@ -97,8 +105,13 @@ if (!$exists) {
     $db->add_Catalog_Script($base_name);
 }
 
-$db->update_Catalog_Script($base_name, ['name' => 'pid', 'value' => getmypid()]);
+$db->update_Catalog_Script($base_name, [
-$db->help->update("sagacity.settings", ['meta_value' => new DateTime()], [
+    'name' => 'pid',
+    'value' => getmypid()
+]);
+$db->help->update("sagacity.settings", [
+    'meta_value' => new DateTime()
+], [
     [
         'field' => 'meta_key',
         'op' => '=',
@@ -127,7 +140,18 @@ if (is_array($regex_arr) && !count($regex_arr)) {
 $csv_file = substr($cmd['f'], 0, - 3) . "csv";
 $csv = fopen($csv_file, "w");
 
-fputcsv($csv, ["STIG_ID", "VMS_ID", "CAT", "IA_Controls", "Short_Title", "Status", "Notes", "Check_Contents", "SV_Rule_ID", "Oval_ID"]);
+fputcsv($csv, [
+    "STIG_ID",
+    "VMS_ID",
+    "CAT",
+    "IA_Controls",
+    "Short_Title",
+    "Status",
+    "Notes",
+    "Check_Contents",
+    "SV_Rule_ID",
+    "Oval_ID"
+]);
 
 // get checklist data
 $checklist = [];
@@ -137,7 +161,10 @@ $checklist['status'] = getValue($xml, "/x:Benchmark/x:status");
 // Skip draft STIGs if debug flag is not set. @Ryan: Shouldn't this be checking the draft flag instead of debug?
 if (! isset($cmd['draft'])) {
     if (strtolower($checklist['status']) == 'draft') {
-    $db->update_Catalog_Script($base_name, ["name" => "status", "value" => "SKIPPED"]);
+        $db->update_Catalog_Script($base_name, [
+            "name" => "status",
+            "value" => "SKIPPED"
+        ]);
         fclose($csv);
         unset($xml);
         unlink($cmd['f']);
@@ -179,31 +206,25 @@ if (isset($cmd['debug'])) {
 
 foreach ($sw_arr as $key => $sw) {
     do {
-    $cpe = "cpe:/" . ($sw->is_OS() ? "o" : "a") . ":{$sw->get_Man()}:{$sw->get_Name()}" .
+        $cpe = "cpe:/" . ($sw->is_OS() ? "o" : "a") . ":{$sw->get_Man()}:{$sw->get_Name()}" . ($sw->get_Version() != '-' ? ":{$sw->get_Version()}" : "");
-        ($sw->get_Version() != '-' ? ":{$sw->get_Version()}" : "");
+        $cpe = str_replace([" ", "(", ")"], ["_", "%28","%29"], strtolower($cpe));
-    $cpe = str_replace(
-        [" ", "(", ")"], ["_", "%28", "%29"], strtolower($cpe)
-    );
 
         $db_sw = $db->get_Software($cpe);
 
         if (! count($db_sw) && ! count($checklist['software'])) {
             $sw->reduce_CPE();
-    }
+        } elseif (is_array($db_sw) && count($db_sw) == 1 && $db_sw[0]->get_Version() == '-' && ! preg_match("/generic/", $sw->get_CPE())) {
-    elseif (is_array($db_sw) && count($db_sw) == 1 && $db_sw[0]->get_Version() == '-' && !preg_match("/generic/", $sw->get_CPE())) {
             $checklist['software'] = array_merge($checklist['software'], $db_sw);
             $sw->reduce_CPE();
             $db_sw = [];
-    }
+        } else {
-    else {
             break;
         }
 
         if (isset($cmd['debug'])) {
             $log->script_log("$cpe found " . count($db_sw), E_DEBUG);
         }
-  }
+    } while (! count($db_sw));
-  while (!count($db_sw));
 
     $checklist['software'] = array_merge($checklist['software'], $db_sw);
 }
@@ -218,16 +239,14 @@ $match = [];
 
 if (preg_match('/Release: (\d+\.\d+|\d+)/', $checklist['plain_text'], $match)) {
     $checklist['rel'] = $match[1];
-}
+} else {
-else {
     $checklist['rel'] = '';
 }
 
 // Get the date of the benchmark in the 'plain-text' element or set to 'status-date' if match fails
 if (preg_match('/Benchmark Date: (.*)$/', $checklist['plain_text'], $match)) {
     $checklist['benchmark_date'] = new DateTime($match[1]);
-}
+} else {
-else {
     $checklist['benchmark_date'] = $checklist['status_date'];
 }
 
@@ -244,26 +263,22 @@ $checklist['type'] = 'benchmark';
 
 if (preg_match('/IAVM/i', $base_name)) {
     $checklist['type'] = 'iavm';
-}
+} elseif (preg_match('/policy|srg/i', $base_name)) {
-elseif (preg_match('/policy|srg/i', $base_name)) {
     $checklist['type'] = 'policy';
-}
+} elseif (preg_match('/manual/i', $base_name)) {
-elseif (preg_match('/manual/i', $base_name)) {
     $checklist['type'] = 'manual';
 }
 
 // Capture version release in filename as sometimes it doesn't match the plain_text element
 if (preg_match('/V(\d+)R/', $base_name, $match)) {
     $checklist['file_ver'] = $match[1];
-}
+} else {
-else {
     $checklist['file_ver'] = 0;
 }
 
 if (preg_match('/V\d+R(\d+|\d+\.\d+)/', $base_name, $match)) {
     $checklist['file_rel'] = $match[1];
-}
+} else {
-else {
     $checklist['file_rel'] = 0;
 }
 
@@ -310,28 +325,23 @@ if ($chk) {
     if (count($chk) && is_a($chk[0], 'checklist')) {
         $chk = $chk[0];
     }
+
+    /** @var checklist $chk */
+    $chk->find_Icon();
+
     // Update software products associated with this checklist
-  $sw_arr = [];
     foreach ($checklist['software'] as $sw) {
-    $sw_arr[] = [$chk->get_ID(), $sw->get_ID()];
+        $chk->add_SW($sw);
     }
 
-  if (is_array($sw_arr) && count($sw_arr)) {
+    $db->save_Checklist($chk);
-    $db->help->extended_insert("sagacity.checklist_software_lookup", ['chk_id', 'sw_id'], $sw_arr, true);
-    if (!$db->help->execute()) {
-      $db->debug(E_WARNING);
-    }
-  }
 
     if (isset($cmd['debug'])) {
         $log->script_log(print_r($chk, true), E_DEBUG);
     }
-}
+} else {
-else {
     // If checklist is not found, add checklist to DB
-  $chk = new checklist(
+    $chk = new checklist(null, $checklist['id'], $checklist['title'], $checklist['desc'], $checklist['status_date'], $base_name, $checklist['ver'], $checklist['rel'], ($checklist['type'] == 'iavm' ? 'IAVM' : ucfirst($checklist['type'])), null);
-      null, $checklist['id'], $checklist['title'], $checklist['desc'], $checklist['status_date'], $base_name, $checklist['ver'], $checklist['rel'], ($checklist['type'] == 'iavm' ? 'IAVM' : ucfirst($checklist['type'])), null
-  );
     $chk->add_SW($checklist['software']);
 
     if (! ($chk->id = $db->save_Checklist($chk))) {
@@ -351,7 +361,10 @@ $groups = getValue($xml, '/x:Benchmark/x:Group', null, true);
 
 $log->script_log("$groups->length STIGs to run", E_DEBUG);
 
-$db->update_Catalog_Script($base_name, ['name' => 'stig_count', 'value' => $groups->length]);
+$db->update_Catalog_Script($base_name, [
+    'name' => 'stig_count',
+    'value' => $groups->length
+]);
 
 print "File: $base_name" . PHP_EOL;
 print "Total: $groups->length" . PHP_EOL;
@@ -379,11 +392,9 @@ foreach ($groups as $group) {
     $cat = 0;
     if ($group_rule->getAttribute('severity') == 'high') {
         $cat = 1;
-  }
+    } elseif ($group_rule->getAttribute('severity') == 'medium') {
-  elseif ($group_rule->getAttribute('severity') == 'medium') {
         $cat = 2;
-  }
+    } elseif ($group_rule->getAttribute('severity') == 'low') {
-  elseif ($group_rule->getAttribute('severity') == 'low') {
         $cat = 3;
     }
 
@@ -397,8 +408,7 @@ foreach ($groups as $group) {
     $fix_text = getValue($xml, './/x:fixtext', $group_rule);
     if ($rule_check_ref->length) {
         $oval_id = $rule_check_ref->item(0)->getAttribute('name');
-  }
+    } else {
-  else {
         $oval_id = '';
     }
     $match = [];
@@ -431,8 +441,7 @@ foreach ($groups as $group) {
     if (! $rule_stig_id) {
         if ($vms_id == 'V0001073' || $vms_id == 'V-1073') {
             $rule_stig_id = '2.005';
-    }
+        } elseif ($vms_id == 'V0001103' || $vms_id == 'V-1103') {
-    elseif ($vms_id == 'V0001103' || $vms_id == 'V-1103') {
             $rule_stig_id = '4.010';
         }
     }
@@ -505,8 +514,7 @@ foreach ($groups as $group) {
         }
 
         $db->save_PDI($db_pdi, $chk);
-  }
+    } else {
-  else {
         print "*";
         // add pdi
         $new_count ++;
@@ -535,13 +543,17 @@ foreach ($groups as $group) {
     }
 
     /*
-    if (!$db->save_Check_Contents($db_pdi, $chk, $rule_check_content, $fix_text)) {
+     * if (!$db->save_Check_Contents($db_pdi, $chk, $rule_check_content, $fix_text)) {
-    $log->script_log("Couldn't save check contents for STIG ID: {$db_stig->get_ID()} in checklist {$chk->get_Checklist_ID()} ({$chk->get_File_Name()})\n", E_ERROR);
+     * $log->script_log("Couldn't save check contents for STIG ID: {$db_stig->get_ID()} in checklist {$chk->get_Checklist_ID()} ({$chk->get_File_Name()})\n", E_ERROR);
-    }
+     * }
      */
 
     $new_controls = [];
-  $control_fields = ['pdi_id', 'type', 'type_id'];
+    $control_fields = [
+        'pdi_id',
+        'type',
+        'type_id'
+    ];
 
     if (preg_match("/<IAControls>(.*)<\/IAControls>/i", $rule_desc, $match)) {
         $ia_controls = (isset($match[1]) && ! empty($match[1]) ? $match[1] : null);
@@ -553,8 +565,7 @@ foreach ($groups as $group) {
                 '1'
             ];
             $ias[] = "VIVM-1";
-    }
+        } elseif ($ia_controls) {
-    elseif ($ia_controls) {
             $split_ias = preg_split('/\, ?/', $ia_controls);
 
             foreach ($split_ias as $ia) {
@@ -570,8 +581,7 @@ foreach ($groups as $group) {
                 }
             }
         }
-  }
+    } elseif ($rule_ident->length) {
-  elseif ($rule_ident->length) {
         for ($x = 0; $x < $rule_ident->length; $x ++) {
             if (substr($rule_ident->item($x)->textContent, 0, 3) == 'CCI') {
                 $split_ia = explode("-", $rule_ident->item($x)->textContent);
@@ -586,8 +596,7 @@ foreach ($groups as $group) {
                 }
             }
         }
-  }
+    } else {
-  else {
         if ($is_iavm) {
             $ias[] = "CCI-002613";
             $new_controls[] = [
@@ -595,8 +604,7 @@ foreach ($groups as $group) {
                 "CCI",
                 "002613"
             ];
-    }
+        } else {
-    else {
             $ias[] = "CCI-000366";
             $new_controls[] = [
                 $pdi_id,
@@ -627,7 +635,9 @@ foreach ($groups as $group) {
     }
 
     $sv = new sv_rule($pdi_id, $sv_rule);
-  $db->save_SV_Rule(array(0 => $sv));
+    $db->save_SV_Rule(array(
+        0 => $sv
+    ));
 
     if ($rule_ident->length) {
         foreach ($rule_ident as $ident_node) {
@@ -643,15 +653,10 @@ foreach ($groups as $group) {
             if (substr($ref, 0, 3) == 'CVE' || substr($ref, 0, 3) == 'CAN') {
                 $tmp[] = new cve($pdi_id, $ref);
                 $db->save_CVE($tmp);
-      }
+            } elseif (substr($ref, 0, 3) == 'CCE') {
-      elseif (substr($ref, 0, 3) == 'CCE') {
                 $tmp[] = new cce($pdi_id, $ref);
                 $db->save_CCE($tmp);
-      }
+            } elseif (substr($ref, 0, 2) == 'KB') {} elseif (substr($ref, 0, 2) == 'MS') {
-      elseif (substr($ref, 0, 2) == 'KB') {
-
-      }
-      elseif (substr($ref, 0, 2) == 'MS') {
                 $tmp[] = new advisory($pdi_id, $ref, '', 'MS', '');
                 $db->save_Advisory($tmp);
             }
@@ -665,10 +670,24 @@ foreach ($groups as $group) {
     }
 
     // Output the CSV contents
-  fputcsv($csv, [$rule_stig_id, $vms_id, implode("", array_fill(0, $cat, "I")), implode(" ", $ias), $rule_title, "Not Reviewed", "", $rule_check_content, $sv_rule, $oval_id]);
+    fputcsv($csv, [
+        $rule_stig_id,
+        $vms_id,
+        implode("", array_fill(0, $cat, "I")),
+        implode(" ", $ias),
+        $rule_title,
+        "Not Reviewed",
+        "",
+        $rule_check_content,
+        $sv_rule,
+        $oval_id
+    ]);
 
     unset($references);
-  $db->update_Catalog_Script($base_name, ['name' => 'perc_comp', 'value' => ($perc_comp / $groups->length) * 100]);
+    $db->update_Catalog_Script($base_name, [
+        'name' => 'perc_comp',
+        'value' => ($perc_comp / $groups->length) * 100
+    ]);
 }
 
 $db->help->select_count("sagacity.stigs");
@@ -678,12 +697,15 @@ $db->set_Setting('stig-count', $stig_count);
 $end = new DateTime();
 $diff = $end->diff($start);
 
-print PHP_EOL . "Start Time: {$start->format("H:i:s")}" . PHP_EOL;
+print <<<EOO
-print "End Time: {$end->format("H:i:s")}" . PHP_EOL;
+
-print "Execution time: {$diff->format("%H:%I:%S")}" . PHP_EOL . PHP_EOL;
+Start Time: {$start->format("H:i:s")}
-print "New STIGs: $new_count" . PHP_EOL;
+End Time: {$end->format("H:i:s")}
-print "Updated STIGs: $updated_count" . PHP_EOL;
+Execution time: {$diff->format("%H:%I:%S")}
-print "Total STIGs: " . ($new_count + $updated_count) . PHP_EOL . PHP_EOL . PHP_EOL;
+
+New STIGs: $new_count
+Updated STIGs: $updated_count
+Total STIGs: ($new_count + $updated_count)
 
 $log->script_log("$groups->length complete");
 fclose($csv);
@@ -692,12 +714,17 @@ if (!isset($cmd['debug'])) {
     rename($cmd['f'], DOC_ROOT . "/reference/stigs/$base_name");
 }
 rename($csv_file, DOC_ROOT . "/reference/stigs/" . basename($csv_file));
-$db->update_Catalog_Script($base_name, ['name' => 'perc_comp', 'value' => 100, 'complete' => 1]);
+$db->update_Catalog_Script($base_name, [
+    'name' => 'perc_comp',
+    'value' => 100,
+    'complete' => 1
+]);
 
 /**
  * Usage output
  */
-function usage() {
+function usage()
+{
     print <<<EOO
 Purpose: To parse a STIG XCCDF checklist file and populate/update the database
 

exec/parse_stig_viewer.php

@@ -5,7 +5,7 @@
  * Purpose: Read STIG Viewer checklist files
  * Created: Apr 10, 2014
  *
- * Portions Copyright 2016-2017: Cyber Perspectives, LLC, All rights reserved
+ * Portions Copyright 2016-2019: CyberPerspectives, LLC, All rights reserved
  * Released under the Apache v2.0 License
  *
  * Portions Copyright (c) 2012-2015, Salient Federal Solutions
@@ -74,6 +74,7 @@ $host_mac  = getValue($xml, '//HOST_MAC');
 
 if (!$host_name) {
     $db->update_Running_Scan($base_name, ['name' => 'status', 'value' => 'TERMINATED']);
+    $db->update_Running_Scan($base_name, ['name' => 'notes', 'value' => 'File parsing was terminated because <HOST_NAME> was empty or absent']);
     unset($xml);
 
     rename($cmd['f'], TMP . "/terminated/{$base_name}");