avs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bb99919abb59c669c0bcdb832755f893aa4c882e1393914b70f14192af603cb
-  data.tar.gz: 43d608e74bfde138cf7a879e905db2244fdacdba3abf9919822825411efa3bfb
+  metadata.gz: e3d8707cf431524fd229b1214e8b9fa6e04e79355679917afa9999d5f9b4b54b
+  data.tar.gz: b8ad24e89a29dc34ceedfb2eec8c16b6b49f38793dca9c5e33b3000e5f9eef03
 SHA512:
-  metadata.gz: 3ffc5c54d18016ee458012ac4e41ecfae27dd0eac9f6961758ab84a37e2365832e5ba7e9760aab661bfa75daaf4101dcdb966d3b12b1aef73f0c84598801f5be
-  data.tar.gz: 167d7e2663fb659649d986af8d269ea3d7023396e5f2e936c3a8ed68929ad468666bb41dde58cc82c8a3b230598147a6e219664354136c67265de0b7987ee383
+  metadata.gz: 1bfaca46b315a65f95364f29d977fa7f62e3ff7016b236f6a432a9f73cf098ed64d633800e4c7a1acbbb66043bd39a42052c2b53aa8070450493a7454f82a830
+  data.tar.gz: e965e76ae0b0da5416368d75b924f149c86449f52027825f37b5ed43e8923e9029f4c094a1531a6c5210c0a2bf3e3f7318872ade05bdbb2b369bf9c349ae4c2b

data/.gitignore

@@ -0,0 +1,2 @@
+.env
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    avs (0.0.2)
+      gli (~> 2.21.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bump (0.10.0)
+    gli (2.21.1)
+    minitest (5.22.3)
+    psych (5.1.2)
+      stringio
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    stringio (3.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  avs!
+  bump
+  minitest
+  rake
+  rdoc
+
+BUNDLED WITH
+   2.4.8

data/README.adoc

@@ -0,0 +1,162 @@
+= avs
+Christian Kyony <ckyony@changamuka.com>
+v0.0.1, 2024-03.14 
+
+:uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html
+
+
+
+
+== For security engineers
+who need to interact with a Rapid7 Nexpose console,
+the *avs* gem is a command line utility
+that manage (e.g. create, list, update, and remove) the following entities:
+  - sites,
+  - scans,
+  - assets,
+  - asset groups,
+  - reports,
+  - vulnerabilities
+  - etc...
+
+
+
+== Personal scratch
+
+I need to automate the creation of hundreds sites and reports.
+
+
+== Installation
+
+Simply run the command below
+
+----
+$ gem install avs
+----
+
+
+== Usage
+
+You can get help on available commands.
+
+----
+NAME
+    nsc - CLI to interface with Nexpose Security Console
+
+SYNOPSIS
+    nsc [global options] command [command options] [arguments...]
+
+VERSION
+    0.0.2
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --version - Display the program version
+
+COMMANDS
+    assets         - Manage assets
+    bulk_delete    - Bulk delete assets with unknown OS
+    connect, login - Verify connection to the server
+    groups         - Manage asset groups
+    help           - Shows a list of commands or help for one command
+    reports        - Manage reports
+    sites          - Manage sites
+----
+
+// List all active scans
+//
+//   nsc scan list
+//
+// Run an adhoc sql query and export via csv
+//
+//   nsc reports --sql "select * from dim_asset"
+//
+// or for more complex sql queries, put the sql into a file and run
+//
+//   nsc reports --sqlfile ./new_assets.sql
+//
+//
+// List all reports defined
+//
+//   nsc reports
+//
+// Request the console's version details
+//
+//   nsc console commands "ver"
+//
+// Run an adhoc scan for a single ip or network cidr-noted range ( --id )
+//
+//   nsc scans create --range 192.168.42.103/32
+//
+// how to add a new custom role for configuration within the console ui, based on a copy of existinsc role
+//
+//   nsc roles -n security-manager --description "New Role Name" --newname new-short-name
+//
+// how to add a new user, with default password of "nxpassword" until moved to yaml config is supported
+//
+//   nsc users create  --name <username> --fullname "Full Name"
+//
+// how to export packaged scan data in a single zip file
+//
+//   nsc scan  --update --scanpath ./ --action export --id <scan id>
+//
+
+== Configuration
+
+----
+# ~/lab.yaml consists of the following:
+
+config:
+   server: 10.10.10.10
+   port: 3780
+   user: nxuser
+   password: password
+----
+
+
+== Development
+
+Checkout the github repository
+
+  git clone https://github.com/rhc/avs
+
+Access the source code folder directory.
+
+  $ cd avs
+
+Install dependencies
+
+  bin/setup
+
+Run the tests
+
+  rake test
+
+Experiment with the code under development
+
+  run bin/console
+
+Install this gem onto your local machine
+
+  bundle exec rake install
+
+Release a new version
+
+  gem bump
+  gem release
+
+== Contributing
+
+In the spirit of {uri-freesoftware}[free software],
+everyone is encouraged to help improve this project.
+
+If you discover errors or omissions in the source code, documentation, or website content,
+please don’t hesitate to submit an issue or open a pull request with a fix. New contributors are always welcome!
+
+== License
+
+The gem is available as open source under the terms of the
+http://opensource.org/licenses/MIT[MIT License].
+
+
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('avs.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/avs.gemspec

@@ -0,0 +1,22 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','avs','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'avs'
+  s.version = Avs::VERSION
+  s.author = 'Christian Kyony'
+  s.email = 'ckyony@changamuka.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+  s.files = `git ls-files`.split(" ")
+  s.require_paths << 'lib'
+  s.extra_rdoc_files = ['README.adoc','avs.rdoc']
+  s.rdoc_options << '--title' << 'avs' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'avs'
+  s.add_development_dependency('bump')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('minitest')
+  s.add_runtime_dependency('gli','~> 2.21.1')
+end

data/lib/asset/command.rb

@@ -0,0 +1,74 @@
+require_relative 'model'
+
+# Reopen the App class or module to add the 'asset' command
+class App
+  extend GLI::App
+
+  desc 'Describe asset here'
+  arg_name 'Describe arguments to asset here'
+  command :asset do |c|
+    c.desc 'Describe a switch to asset'
+    c.switch :s
+
+    c.desc 'Describe a flag to asset'
+    c.default_value 'default'
+    c.flag :f
+    c.action do |_global_options, _options, _args|
+      # Your command logic specific to 'asset' here
+      assets = [
+        CmdbAsset.new(
+          id: 100,
+          country_code: 'cd',
+          business_unit: 'bu',
+          sub_area: 'sa',
+          application: 'ewallet',
+          utr: 'UTR01966',
+          fqdn: 'fqdn.co.za',
+          host_name: 'fqdn',
+          ip_address: '172.16.19.66',
+          operating_system: 'ubuntu',
+          server_environment: 'linux',
+          server_category: 'linux',
+          host_key: 'xxxx',
+          country: 'DRC'
+        ),
+        CmdbAsset.new(
+          id: 200,
+          country_code: 'mw',
+          business_unit: 'bu',
+          sub_area: 'sa',
+          application: 'atm',
+          utr: 'UTR01966',
+          fqdn: 'fqdn.co.za',
+          host_name: 'fqdn',
+          ip_address: '198.172.19.66',
+          operating_system: 'ubuntu',
+          server_environment: 'linux',
+          server_category: 'linux',
+          host_key: 'xxxx',
+          country: 'Malawi'
+        ),
+        CmdbAsset.new(
+          id: 300,
+          country_code: 'bw',
+          business_unit: 'bu',
+          sub_area: 'sa',
+          application: 'forex',
+          utr: 'UTR01986',
+          fqdn: 'fqdn.co.za',
+          host_name: 'fqdn',
+          ip_address: '10.12.19.66',
+          operating_system: 'ubuntu',
+          server_environment: 'linux',
+          server_category: 'linux',
+          host_key: 'xxxx',
+          country: 'Botswana'
+        )
+      ]
+      puts 'list assets'
+      assets.each do |asset|
+        puts asset
+      end
+    end
+  end
+end

data/lib/asset/model.rb

@@ -0,0 +1,71 @@
+class CmdbAsset
+  attr_accessor :id,
+                :country_code,
+                :business_unit,
+                :sub_area,
+                :application,
+                :utr,
+                :fqdn,
+                :host_name,
+                :ip_address,
+                :operating_system,
+                :server_environment,
+                :server_category,
+                :host_key,
+                :country
+
+  def initialize(id:,
+                 country_code:,
+                 business_unit:,
+                 sub_area:,
+                 application:,
+                 utr:,
+                 fqdn:,
+                 host_name:,
+                 ip_address:,
+                 operating_system:,
+                 server_environment:,
+                 server_category:,
+                 host_key:,
+                 country:)
+    @id = id
+    @country_code = country_code
+    @business_unit = business_unit
+    @sub_area = sub_area
+    @application = application
+    @utr = utr
+    @fqdn = fqdn
+    @host_name = host_name
+    @ip_address = ip_address
+    @operating_system = operating_system
+    @server_category = server_category
+    @server_environment = server_environment
+    @host_key = host_key
+    @country = country
+  end
+
+  def site_name
+    ['', country_code, business_unit, sub_area, application, utr].join(':')
+  end
+
+  def self.from_csv(row)
+    CmdbAsset.new(id: row[:id],
+                  country_code: row[:country_code],
+                  country: row[:country],
+                  business_unit: row[:business_unit],
+                  sub_area: row[:sub_area],
+                  application: row[:application],
+                  utr: row[:utr],
+                  fqdn: row[:fqdn],
+                  ip_address: row[:ip_address],
+                  host_name: row[:host_name],
+                  host_key: row[:host_key],
+                  operating_system: row[:operating_system],
+                  server_environment: row[:server_environment],
+                  server_category: row[:server_category])
+  end
+
+  def to_s
+    [id, site_name, fqdn, ip_address].join ','
+  end
+end

data/lib/avs/version.rb

@@ -0,0 +1,3 @@
+module Avs
+  VERSION = '0.0.2'
+end

data/lib/avs.rb

@@ -0,0 +1,5 @@
+require 'avs/version'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+require_relative 'asset/command'

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require_relative "test_helper"
+
+class DefaultTest < Minitest::Test
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+
+# Add test libraries you want to use here, e.g. mocha
+# Add helper classes or methods here, too

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christian Kyony
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,12 +86,23 @@ executables:
 - avs
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.adoc
 - avs.rdoc
 files:
-- README.rdoc
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.adoc
+- Rakefile
+- avs.gemspec
 - avs.rdoc
 - bin/avs
+- lib/asset/command.rb
+- lib/asset/model.rb
+- lib/avs.rb
+- lib/avs/version.rb
+- test/default_test.rb
+- test/test_helper.rb
 homepage: http://your.website.com
 licenses: []
 metadata: {}

data/README.rdoc

@@ -1,6 +0,0 @@
-= avs
-
-Describe your project here
-
-:include:avs.rdoc
-