jira_scan 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2U3MTgzNjZlMDY0N2Q5MzJiMTJhYjFlZjA3ODg4Njg3YmNmYzVlOA==
+    YjNmYTk1OWYwM2VjNzJlZjVmZGFlZGIyNzdlYmUyOGE3Mzg0NTIxNg==
   data.tar.gz: !binary |-
-    ZTBmYmNhMmQ0MDQ0MTdmY2Q4MWRiYzQ1MzUxMWNmOWJmNmQwZjljOQ==
+    NDA1MWUyMjE2ODIwODBhMThjYjU2ZWNlY2VhMjcxY2E0YWIyODYyZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTg1NzllMDk0MWNlNWRjZDEwNTcyMTc0YWJlMmMzYjUzYjk3ZjUzMjkyYWIw
-    M2U2YmI5MjllMTEzNTc0NGE4YWVkMzE0Y2I2MzVkOWY3NDAyYjc1MTVkZjQ2
-    YTJjMGZiYTcyYWFjMjRmZmI2YzdkMDAwMTVkMTVjYzRlODVmNDE=
+    MjliM2EyYWE0MzFjNDllMWMyOTljMDYyOGRkYTU3ZDc2NTk2MDc0ZTg0ODJi
+    Zjg3MTAwOGU5MjkzNmEzNmZkNGZkYWY4YTNhMDE3Mzg0YzEzNjVkOGUzMjMy
+    YTI1MGQ0NDg1NzA4Y2YzNjE3ODM0MWQ2NTJiOTk1NDUzZDI1ZmU=
   data.tar.gz: !binary |-
-    NDc1ODc0MjIzMGY1YzlkMGYzMGY4Y2Q1ZmI3MDkwNjczNzI4ZDE5NDdhYmQ1
-    NzgwMTZiOGU3N2Y3MGVkYTQxMGE1ODMxMTVkNTBjNTIwOTQxMjI2OTJkZTg0
-    YmExYzZlOWFkNGUyODZkYTA0M2QwYWJhZTI1YmQwZGM5N2UxNmQ=
+    NDM2MTdiY2ViMzVlYmEwZTg5MTY4NGI0NWY0M2IwZmFjMGFjYmM5MzRhZmFi
+    NmYxYTkzYWE4ODAzNDYwNzNjZTNmNGE1OGM1OGJjMzAyZDYwYWRkMzg0NWRl
+    NzVmNTQ2NmY3NTNhZWQ3ODA0MWZhNDVjN2M0YzQ2OTQ5Y2M1MDg=

data/bin/jira-scan

@@ -17,7 +17,7 @@ def banner
   _   | | | '__/ _` |\\___ \\ / __/ _` | '_ \\ 
  | |__| | | | | (_| |____) | (_| (_| | | | |
   \\____/|_|_|  \\__,_|_____/ \\___\\__,_|_| |_|
-                               version 0.0.3"
+                               version 0.0.4"
   puts
   puts '-' * 60
 end
@@ -55,16 +55,20 @@ end
 
 opts.parse!
 
-$VERBOSE = true unless options[:verbose].nil?
-@check = true unless options[:skip]
-@insecure = false unless options[:insecure]
-
 if options[:url].nil?
  puts opts
  exit(1)
 end
 
-def scan(url)
+def scan(url, check: true, insecure: false, verbose: false)
+  JiraScan.logger = ::Logger.new($stdout).tap do |log|
+    log.progname = 'jira-scan'
+    log.level = verbose ? ::Logger::INFO : ::Logger::WARN
+    log.datetime_format = '%Y-%m-%d %H:%M:%S '
+  end
+
+  JiraScan.insecure = insecure
+
   puts "Scan started at #{Time.now.getutc}"
   puts "URL: #{url}"
 
@@ -89,7 +93,7 @@ def scan(url)
   puts '-' * 60
 
   # Check if the URL is Jira
-  if @check
+  if check
     is_jira = JiraScan::detectJiraDashboard(url)
     is_jira = JiraScan::detectJiraLogin(url) unless is_jira
     unless is_jira
@@ -177,4 +181,9 @@ def scan(url)
   puts '-' * 60
 end
 
-scan(options[:url])
+scan(
+  options[:url],
+  insecure: options[:insecure],
+  check: !options[:skip],
+  verbose: options[:verbose]
+)

data/lib/jira_scan.rb

@@ -6,11 +6,28 @@
 require 'uri'
 require 'cgi'
 require 'json'
+require 'logger'
 require 'net/http'
 require 'openssl'
 
 class JiraScan
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
+
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.insecure
+    @insecure ||= false
+  end
+
+  def self.insecure=(insecure)
+    @insecure = insecure
+  end
 
   #
   # Check if URL is running Jira using Login page
@@ -64,12 +81,9 @@ class JiraScan
     build = res.body.to_s.scan(%r{<meta name="ajs-build-number" content="(\d+)">}).flatten.first
 
     unless version && build
-      if res.body.to_s =~ /Version: ([\d\.]+)-#(\d+)/
-        version = $1
-        build = $2
-      else
-        return
-      end
+      return unless res.body.to_s =~ /Version: ([\d\.]+)-#(\d+)/
+      version = Regexp.last_match(1)
+      build = Regexp.last_match(2)
     end
 
     "#{version}-##{build}"
@@ -93,12 +107,9 @@ class JiraScan
     build = res.body.to_s.scan(%r{<meta name="ajs-build-number" content="(\d+)">}).flatten.first
 
     unless version && build
-      if res.body.to_s =~ /Version: ([\d\.]+)-#(\d+)/
-        version = $1
-        build = $2
-      else
-        return
-      end
+      return unless res.body.to_s =~ /Version: ([\d\.]+)-#(\d+)/
+      version = Regexp.last_match(1)
+      build = Regexp.last_match(2)
     end
 
     "#{version}-##{build}"
@@ -292,7 +303,7 @@ class JiraScan
     return [] unless res.code.to_i == 200
     return [] unless res.body.to_s.start_with?('{"startAt"')
 
-    JSON.parse(res.body.to_s, symbolize_names: true)[:dashboards].map {|d| [d[:id], d[:name]] }
+    JSON.parse(res.body.to_s, symbolize_names: true)[:dashboards].map { |d| [d[:id], d[:name]] }
   rescue
     []
   end
@@ -312,7 +323,7 @@ class JiraScan
     return [] unless res.code.to_i == 200
     return [] unless res.body.to_s.start_with?('{"searchers"')
 
-    searchers = JSON.parse(res.body.to_s)["searchers"]
+    searchers = JSON.parse(res.body.to_s)['searchers']
     return [] if searchers.empty?
 
     groups = searchers['groups']
@@ -325,7 +336,7 @@ class JiraScan
       end
     end
 
-    JSON.parse(field_names.to_json, symbolize_names: true).map {|f| [f[:name], f[:id], f[:key], f[:isShown].to_s, f[:lastViewed]] }
+    JSON.parse(field_names.to_json, symbolize_names: true).map { |f| [f[:name], f[:id], f[:key], f[:isShown].to_s, f[:lastViewed]] }
   rescue
     []
   end
@@ -345,7 +356,7 @@ class JiraScan
     return [] unless res.code.to_i == 200
     return [] unless res.body.to_s.start_with?('{"searchers"')
 
-    searchers = JSON.parse(res.body.to_s)["searchers"]
+    searchers = JSON.parse(res.body.to_s)['searchers']
     return [] if searchers.empty?
 
     groups = searchers['groups']
@@ -358,13 +369,11 @@ class JiraScan
       end
     end
 
-    JSON.parse(field_names.to_json, symbolize_names: true).map {|f| [f[:name], f[:id], f[:key], f[:isShown].to_s, f[:lastViewed]] }
+    JSON.parse(field_names.to_json, symbolize_names: true).map { |f| [f[:name], f[:id], f[:key], f[:isShown].to_s, f[:lastViewed]] }
   rescue
     []
   end
 
-  private
-
   #
   # Fetch URL
   #
@@ -374,7 +383,8 @@ class JiraScan
   #
   def self.sendHttpRequest(url)
     target = URI.parse(url)
-    puts "* Fetching #{target}" if $VERBOSE
+    @logger.info("Fetching #{target}")
+
     http = Net::HTTP.new(target.host, target.port)
     if target.scheme.to_s.eql?('https')
       http.use_ssl = true
@@ -394,11 +404,13 @@ class JiraScan
         res.body = gz.read
       end
     rescue Timeout::Error, Errno::ETIMEDOUT
-      puts "- Error: Timeout retrieving #{target}" if $VERBOSE
+      @logger.error("Could not retrieve URL #{target}: Timeout")
+      return nil
     rescue => e
-      puts "- Error: Could not retrieve URL #{target}\n#{e}" if $VERBOSE
+      @logger.error("Could not retrieve URL #{target}: #{e}")
+      return nil
     end
-    puts "+ Received reply (#{res.body.length} bytes)" if $VERBOSE
+    @logger.info("Received reply (#{res.body.length} bytes)")
     res
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jira_scan
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Brendan Coles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
-dependencies: []
+date: 2021-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple remote scanner for Atlassian Jira
 email: bcoles@gmail.com
 executables: