norad_cli 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee3ee9bdac3c8085081dff219d3140a9997863c
-  data.tar.gz: 5940350f98bd7fcf5a4c3ca90a43faea66a8569f
+  metadata.gz: 8860651242fcd0bf3b1705504a70f600823d6aac
+  data.tar.gz: 21aa5ac57a4b9a8c76ead029a59d4e6d57b9762d
 SHA512:
-  metadata.gz: bf126637083ca0da75e0d4f820e215d5fb9c1995cc200a69871af92ded5afc08f6499d7cd0ee1272362d78c4c6d57c3c833b0f0885ab7ccb6b4551540a2d0cb3
-  data.tar.gz: 3f6192b73394053b2eed6d5d1700a8ad20580c2a86dd4c7cdace6cc4ee1fcb59c4aa43603f5658be24bbbcd5667fc26d9fc3f3af4db920adc301704811984ecd
+  metadata.gz: cd71776227fa2fe192b53349624b8f09d4f2843554b0146d48c172c1a8339692e6fc338d00ac022032e71539a26f552dbc2935be61eb135cbbc413329c5989c9
+  data.tar.gz: b05c1f5a97cb2bca7a72239e04f99fb4d74e0a35f6a20a8a095baabb0217d99dd7b3e3694df6af78c48beabdf606f327bc3d12e42c29fa505c56ca4a6cdd0fe7

data/.rubocop.yml

@@ -49,3 +49,6 @@ Style/Next:
 Style/IfUnlessModifier:
     Exclude:
     - 'lib/norad_cli/cli/sectest.rb'
+Style/ClassVars:
+  Exclude:
+    - 'lib/norad_cli/cli/sectest.rb'

data/lib/norad_cli/cli/sectest.rb

@@ -15,13 +15,14 @@ class Sectest < Thor
                              ssh_user: ['-u', 'If the sectest requires authentication, then the username for authentication'],
                              ssh_key: ['-k', 'If the sectest requires authentication, then the path to the ssh key file'],
                              port: ['-p', 'The port to use for testing'],
-                             service_username: ['-e', 'FILL ME IN'],
-                             service_password: ['-r', 'FILL ME IN'],
-                             web_service_protocolweb_service_url_blacklist: ['-b', 'FILL ME IN'],
-                             web_service_auth_type: ['-a', 'FILL ME IN'],
-                             web_service_starting_page_path: ['-g', 'FILL ME IN'],
-                             web_service_login_form_username_field_name: ['-l', 'FILL ME IN'],
-                             web_service_login_form_password_field_name: ['-m', 'FILL ME IN'] }
+                             service_username: ['-e', 'Username to authenticate with the service, e.g. web application, database server, etc'],
+                             service_password: ['-r', 'Password to authenticate with the service'],
+                             web_service_protocol: ['-c', 'Protocol used to load the web application, http or https'],
+                             web_service_url_blacklist: ['-b', 'Comma separated list of words to avoid when spidering web application links'],
+                             web_service_auth_type: ['-a', 'Authentication method used by the web application'],
+                             web_service_starting_page_path: ['-g', 'Path where web application scan should begin, e.g. /'],
+                             web_service_login_form_username_field_name: ['-l', 'HTML form field name for the username portion of web application authentication'],
+                             web_service_login_form_password_field_name: ['-m', 'HTML form field name for the password portion of web application authentication'] }
 
   def self.source_root
     File.join(File.dirname(File.expand_path(__FILE__)), '../templates/')
@@ -29,20 +30,24 @@ class Sectest < Thor
 
   # Loads a manifest file depending on the command
   # rubocop:disable Style/GuardClause
-  def self.load_manifest
-    @sectest_manifest = {}
+  def self.load_manifest(sectest_name)
+    @@sectest_manifest = {}
 
     # Set defaults just in case no manifest.yml to overwrite
-    @sectest_manifest['registry'] = 'norad-registry.cisco.com:5000'
-    @sectest_manifest['version'] = 'latest'
+    @@sectest_manifest['registry'] = 'norad-registry.cisco.com:5000'
+    @@sectest_manifest['version'] = 'latest'
 
     # Dynamically add options and description based on the needs of the sectest container
-    if %w(build build:all build:image build:specs execute).include?(ARGV[1]) && ARGV[2] && !ARGV[2].start_with?('-', '--')
+    if %w(build build:all build:image build:specs execute).include?(ARGV[1]) && sectest_name && !sectest_name.start_with?('-', '--')
       # Read in the program arguments
-      if File.exist?("sectests/#{ARGV[2]}/manifest.yml")
-        @sectest_manifest = YAML.safe_load(File.read("sectests/#{ARGV[2]}/manifest.yml"))
+      if File.exist?("sectests/#{sectest_name}/manifest.yml")
+        @@sectest_manifest = YAML.safe_load(File.read("sectests/#{sectest_name}/manifest.yml"))
+
+        # Precautionary, remove all leading and trailing whitespace
+        @@sectest_manifest['registry'].strip!
+        @@sectest_manifest['version'].strip!
       else
-        puts Rainbow("Error: #{ARGV[2]} sectest does not exist or it is missing sectests/#{ARGV[2]}/manifest.yml").red
+        puts Rainbow("Error: #{sectest_name} sectest does not exist or it is missing sectests/#{sectest_name}/manifest.yml").red
         puts Rainbow('Exiting...').red
         exit(1)
       end
@@ -59,12 +64,12 @@ class Sectest < Thor
 
   # Load the manifest file if necessary
   # Correct set default registry and version
-  load_manifest
+  load_manifest(ARGV[2])
 
   desc 'scaffold TESTNAME', 'Create a new security test with standard files + testing'
   option :test_type, aliases: '-t', default: 'whole_host', desc: 'The security test type, Options: [authenticated|web_application|brute_force|ssl_crypto|ssh_crypto|whole_host]'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry to store docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the security test'
+  option :registry, aliases: '-r', default: @@sectest_manifest['registry'], desc: 'The Docker registry to store docker images'
+  option :version, aliases: '-v', default: @@sectest_manifest['version'], desc: 'The version of the security test'
   option :base_image, aliases: '-b', default: 'norad-registry.cisco.com:5000/norad:0.0.1', desc: 'Base Docker image to use (i.e. FROM field in the Dockerfile)'
   option :configurable, type: :boolean, aliases: '-c', desc: 'Is the security test configurable (e.g. Qualys username and password)'
   def scaffold(sectest_name)
@@ -105,26 +110,29 @@ class Sectest < Thor
 
   desc 'build', 'Build all sectest images and specs for the entire repository'
   option :debug, aliases: '-d', type: :boolean, default: true, desc: 'Turn on debugging messages (e.g. Docker build logs to stdout)'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry for Docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the sectest container to build'
   def build
     # Error check to ensure this is a plugin directory
     Dir.glob('sectests/*').select do |f|
-      if File.directory? f
-        # Build all for the sectest
-        send('build:all', f.split('/')[-1])
-      end
+      # Skip if the entry is not a directory
+      next if !File.directory? f
+
+      # Grab the name of the sectest
+      sectest_name = f.split('/')[-1]
+
+      # Load the manifest for the sectest
+      Sectest.load_manifest(sectest_name)
+
+      # Build all for the sectest
+      send('build:all', sectest_name)
     end
   end
 
   # Define arguments and options
   desc 'build:image SECTESTNAME', 'Build the docker image for the security test SECTESTNAME'
   option :debug, aliases: '-d', type: :boolean, default: true, desc: 'Turn on debugging messages (e.g. Docker build logs to stdout)'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry for Docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the sectest container to build'
   define_method 'build:image' do |name|
     imgs_to_build = {}
-    imgs_to_build["sectests/#{name}"] = "#{options[:registry]}/#{name}:#{options[:version]}"
+    imgs_to_build["sectests/#{name}"] = "#{@@sectest_manifest['registry']}/#{name}:#{@@sectest_manifest['version']}"
 
     # Check for the Dockerfile
     if !dockerfile?(imgs_to_build.keys[0])
@@ -152,8 +160,6 @@ class Sectest < Thor
   # Define arguments and options
   desc 'build:specs SECTESTNAME', 'Build the spec images (test images) for the security test SECTESTNAME'
   option :debug, aliases: '-d', type: :boolean, default: true, desc: 'Turn on debugging messages (e.g. Docker build logs to stdout)'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry for Docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the sectest container to build'
   define_method 'build:specs' do |name|
     imgs_to_build = {}
     imgs_to_build["#{File.expand_path(File.dirname(__FILE__))}/../templates/spec/support/Dockerfile.testserver"] = 'docker-images-test-results-server:latest'
@@ -182,8 +188,6 @@ class Sectest < Thor
   # Define arguments and options
   desc 'build:all SECTESTNAME', 'Build sectest images for SECTESTNAME and all testing images for SECTESTNAME'
   option :debug, aliases: '-d', type: :boolean, default: true, desc: 'Turn on debugging messages (e.g. Docker build logs to stdout)'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry for Docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the sectest container to build'
   define_method 'build:all' do |name|
     # Build the sectest image
     send('build:image', name)
@@ -197,7 +201,7 @@ class Sectest < Thor
     desc "execute #{ARGV[2]}", "Execute #{ARGV[2]} against an arbitrary target"
 
     # Dynamically create options
-    @sectest_manifest['prog_args'].scan(/{(.*?)}/).each do |ar|
+    @@sectest_manifest['prog_args'].scan(/{(.*?)}/).each do |ar|
       if @reserved_sectest_args.key?(ar[0].to_sym)
         option ar[0].to_sym, aliases: @reserved_sectest_args[ar[0].to_sym][0], desc: @reserved_sectest_args[ar[0].to_sym][1]
       else
@@ -209,8 +213,6 @@ class Sectest < Thor
   end
   option :debug, aliases: '-d', type: :boolean, default: false, desc: 'Turn on debugging messages (e.g. Docker build logs to stdout)'
   option :format, aliases: '-f', type: :boolean, default: false, desc: 'Print the JSON results formatted'
-  option :registry, aliases: '-r', default: @sectest_manifest['registry'], desc: 'The Docker registry for Docker images'
-  option :version, aliases: '-v', default: @sectest_manifest['version'], desc: 'The version of the sectest container to build'
   def execute(sectest_name)
     # Ensure the results server is built by building the images specs (code reuse)
     send('build:specs', sectest_name)
@@ -219,7 +221,8 @@ class Sectest < Thor
     send('build:image', sectest_name)
 
     # Allocate an instance of the sectest
-    sectest_instance = NoradCli::SecTestContainer.new(ARGV[2], options)
+    sectest_instance = NoradCli::SecTestContainer.new(ARGV[2], @@sectest_manifest['registry'],
+                                                      @@sectest_manifest['version'], options)
 
     # Start the test
     sectest_instance.start

data/lib/norad_cli/support/sectest_container.rb

@@ -11,11 +11,11 @@ module NoradCli
     attr_accessor :sectest_image
     attr_accessor :results_server
 
-    def initialize(sectest_name, options)
+    def initialize(sectest_name, registry, version, options)
       # Generate a random assessment id
       @assessment_id = SecureRandom.hex(32)
 
-      @sectest_image = "#{options['registry']}/#{sectest_name}:#{options[:version]}"
+      @sectest_image = "#{registry}/#{sectest_name}:#{version}"
 
       # Create a results server
       @results_server = NoradCli::ResultsServer.new('docker-images-test-results-server')
@@ -39,7 +39,7 @@ module NoradCli
       # Grab the program arguments (minus other function options)
       # Options is a Thor::CoreExt::HashWithIndifferentAccess (except does not work)
       prog_arg_hash = options.each_with_object({}) do |(k, v), hsh|
-        hsh[k.to_sym] = v unless k == 'debug' || k == 'registry' || k == 'version'
+        hsh[k.to_sym] = v unless k == 'debug'
       end
 
       # Load the prog_arg format

data/lib/norad_cli/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module NoradCli
-  VERSION = '0.1.15'
+  VERSION = '0.1.16'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: norad_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Blake Hitchcock