ruby-nmap 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10533e46eeeaa57e4cf26c7944e4414ea3921999e31c6aa54d55de225f32494b
-  data.tar.gz: 65aaebd79d602846dfc6cf0eecbcdef71cb0ae0282fd0d2dab54a3d1db571587
+  metadata.gz: 7e3189bf536d0b75455d40015a117eb26746aefbde6a6cccd605860be7fb8b6f
+  data.tar.gz: 303dcff7ac2ecb8f0a3e923ba9834e3044fd976be710a5f76d702e986827a640
 SHA512:
-  metadata.gz: b82ab296170e41097a4eaba98480d1c4715643d6288d33f7626d959ad90c8cc925dee6fdf6654ed84e9bf03db1a4c9847bffac312bff4e4067c0b13af92aa145
-  data.tar.gz: c6c439fd6e7999116dc61fd4b8713fa862be346c4e0c465dbba4c697363e18acb4985dd22358c2de77585579cb87cd91bbda451996e2b104ede04b23284b91e0
+  metadata.gz: 879272c70b52dc9b77abbb1990b4b48973d7a8f2e01b9a608ce9c3ce9a7c5240abeab1fc4bcdc4d30c59a8790b083f82a85a3254d962d0ccab0f7e4d2608c480
+  data.tar.gz: 709b91ce49dd96614de4441305a711cdb18fcb8185fffcc988f8c65ba9989785d65f69bf5e3dc05af7686ca26b0db43c90fb4710e86be44ddc20340042741507

data/.github/workflows/ruby.yml

@@ -9,14 +9,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '2.7'
           - '3.0'
           - '3.1'
+          - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/ChangeLog.md

@@ -1,3 +1,20 @@
+### 1.0.3 / 2024-01-25
+
+* Switched to using `require_relative` to improve load-times.
+* Added `# frozen_string_literal: true` to all files.
+
+#### Nmap::Command
+
+* The `--mtu` option now accepts an option numeric value.
+
+### 1.0.2 / 2023-09-01
+
+#### Nmap::Command
+
+* Fixed a typo in the `--unprivileged` option mapping.
+* Improved validations for port number, service name, port range, and
+  port list String values.
+
 ### 1.0.1 / 2022-12-12
 
 * Fixed an infinite loop in {Nmap::XML::Script#parse_tables}. (@myztique)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2022 Postmodern
+Copyright (c) 2009-2024 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -129,8 +129,6 @@ $ gem install ruby-nmap
 
 ## License
 
-Copyright (c) 2009-2022 Postmodern
-
 See {file:LICENSE.txt} for license information.
 
 [nmap]: http://www.insecure.org/

data/lib/nmap/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'command_mapper/command'
 
 module Nmap
@@ -185,17 +187,23 @@ module Nmap
   #
   class Command < CommandMapper::Command
 
+    #
+    # Represents a port number.
     #
     # @api private
     #
     class Port < CommandMapper::Types::Num
 
-      PORT_NUMBER_REGEXP = /\d{1,5}/
+      # Regular expression that validates a port number.
+      PORT_NUMBER_REGEXP = /[1-9][0-9]{0,3}|[1-5][0-9][0-9][0-9][0-9]|6[0-4][0-9][0-9][0-9]|65[0-4][0-9][0-9]|655[0-2][0-9]|6553[0-5]/
 
-      SERVICE_NAME_REGEXP = /[A-Za-z0-9]+(?:[\/_-][A-Za-z0-9]+)*\*?/
+      # Regular expression that validates a service name.
+      SERVICE_NAME_REGEXP = /[A-Za-z][A-Za-z0-9]*(?:[\/_-][A-Za-z0-9]+)*\*?/
 
+      # Regular expression that validates either a port number or service name.
       PORT_REGEXP = /(?:#{PORT_NUMBER_REGEXP}|#{SERVICE_NAME_REGEXP})/
 
+      # Regular expression that validates either a port number or service name.
       REGEXP = /\A#{PORT_REGEXP}\z/
 
       #
@@ -206,22 +214,22 @@ module Nmap
       end
 
       #
-      # Validates the given value.
+      # Validates the given port number value.
       #
       # @param [Object] value
+      #   The value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
         when String
-          case value
-          when /\A#{PORT_NUMBER_REGEXP}\z/
-            super(value)
-          when /\A#{SERVICE_NAME_REGEXP}\z/
+          if value =~ REGEXP
             return true
           else
-            return [false, "must be a port number or service name (#{value.inspect})"]
+            return [false, "must be a valid port number or service name (#{value.inspect})"]
           end
         else
           super(value)
@@ -232,8 +240,10 @@ module Nmap
       # Formats the given value.
       #
       # @param [Integer, String] value
+      #   The port number value to format.
       #
       # @return [String]
+      #   The formatted port number.
       #
       def format(value)
         case value
@@ -246,21 +256,28 @@ module Nmap
 
     end
 
+    #
+    # Represents a port range.
     #
     # @api private
     #
     class PortRange < Port
 
-      PORT_RANGE_REGEXP = /(?:#{PORT_REGEXP}|#{PORT_REGEXP}?-#{PORT_REGEXP}?)/
+      # Regular expression to validate either a port or a port range.
+      PORT_RANGE_REGEXP = /(?:#{PORT_NUMBER_REGEXP})?-(?:#{PORT_NUMBER_REGEXP})?|#{PORT_REGEXP}/
 
+      # Regular expression to validate either a port or a port range.
       REGEXP = /\A#{PORT_RANGE_REGEXP}\z/
 
       #
-      # Validates the given value.
+      # Validates the given port or port range value.
       #
       # @param [Object] value
+      #   The port or port range value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
@@ -279,22 +296,24 @@ module Nmap
 
           return true
         when String
-          unless value =~ REGEXP
-            return [false, "not a valid port range (#{value.inspect})"]
+          if value =~ REGEXP
+            return true
+          else
+            return [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
           end
-
-          return true
         else
           super(value)
         end
       end
 
       #
-      # Formats the given value.
+      # Formats the given port or port range value.
       #
       # @param [Range, Integer, String] value
+      #   The port or port range value to format.
       #
       # @return [String]
+      #   The formatted port or port range.
       #
       def format(value)
         case value
@@ -307,13 +326,17 @@ module Nmap
 
     end
 
+    #
+    # Represents a list of ports or port ranges.
     #
     # @api private
     #
     class PortRangeList < CommandMapper::Types::List
 
+      # Regular expression for validating a port or port range.
       PORT_RANGE_REGEXP = PortRange::PORT_RANGE_REGEXP
 
+      # Regular expression for validating an nmap port range.
       REGEXP = /\A(?:[TUS]:)?#{PORT_RANGE_REGEXP}(?:,(?:[TUS]:)?#{PORT_RANGE_REGEXP})*\z/
 
       #
@@ -327,8 +350,11 @@ module Nmap
       # Validates the given port range list value.
       #
       # @param [Object] value
+      #   The given port range list value to validate.
       #
       # @return [true, (false, String)]
+      #   Returns true if the value is valid, or `false` and a validation error
+      #   message if the value is not compatible.
       #
       def validate(value)
         case value
@@ -371,11 +397,13 @@ module Nmap
       }
 
       #
-      # Formats the given value.
+      # Formats the given port range list value.
       #
       # @param [Hash, Range, String, Integer] value
+      #   The port range list value.
       #
       # @return [String]
+      #   The formatted port range list.
       #
       def format(value)
         case value
@@ -399,16 +427,21 @@ module Nmap
 
     end
 
+    #
+    # Represents a list of protocols.
     #
     # @api private
     #
     ProtocolList = PortRangeList
 
+    #
+    # Represents a unit of time.
     #
     # @api private
     #
     class Time < CommandMapper::Types::Str
 
+      # Regular expression for validating a unit of time.
       REGEXP = /\A\d+(?:h|m|s|ms)?\z/
 
       #
@@ -443,6 +476,8 @@ module Nmap
 
     end
 
+    #
+    # Represents a hex string.
     #
     # @api private
     #
@@ -478,11 +513,14 @@ module Nmap
 
     end
 
+    #
+    # Represents one or more TCP scan flags.
     #
     # @api private
     #
     class ScanFlags < CommandMapper::Types::Str
 
+      # Mapping of symbol scan flags to String values.
       FLAGS = {
         urg: 'URG',
         ack: 'ACK',
@@ -492,6 +530,7 @@ module Nmap
         fin: 'FIN'
       }
 
+      # Regular expression to validate the given scan flags.
       REGEXP = /\A(?:\d+|(?:URG|ACK|PSH|RST|SYN|FIN)+)\z/
 
       #
@@ -697,7 +736,7 @@ module Nmap
 
       # FIREWALL/IDS EVASION AND SPOOFING:
       option '-f', name: :packet_fragments
-      option '--mtu'
+      option '--mtu', value: {type: Num.new, required: false}
       option '-D', name: :decoys, value: {type: List.new}
       option '-S', name: :spoof, value: true
       option '-e', name: :interface, value: true
@@ -752,7 +791,7 @@ module Nmap
       option '--send-eth'
       option '--send-ip'
       option '--privileged'
-      option '--unprivleged'
+      option '--unprivileged'
       option '--release-memory'
       option '--noninteractive', name: :non_interactive
       option '-V', name: :version

data/lib/nmap/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Nmap
   # ruby-nmap version
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

data/lib/nmap/xml/address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/cpe/url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     module CPE

data/lib/nmap/xml/cpe.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/cpe/url'
+# frozen_string_literal: true
+
+require_relative 'cpe/url'
 
 module Nmap
   class XML

data/lib/nmap/xml/hop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/host.rb

@@ -1,14 +1,16 @@
-require 'nmap/xml/status'
-require 'nmap/xml/address'
-require 'nmap/xml/hostname'
-require 'nmap/xml/os'
-require 'nmap/xml/port'
-require 'nmap/xml/ip_id_sequence'
-require 'nmap/xml/tcp_sequence'
-require 'nmap/xml/tcp_ts_sequence'
-require 'nmap/xml/uptime'
-require 'nmap/xml/traceroute'
-require 'nmap/xml/host_script'
+# frozen_string_literal: true
+
+require_relative 'status'
+require_relative 'address'
+require_relative 'hostname'
+require_relative 'os'
+require_relative 'port'
+require_relative 'ip_id_sequence'
+require_relative 'tcp_sequence'
+require_relative 'tcp_ts_sequence'
+require_relative 'uptime'
+require_relative 'traceroute'
+require_relative 'host_script'
 
 require 'nokogiri'
 require 'time'
@@ -258,7 +260,7 @@ module Nmap
       # @yield [uptime]
       #   If a block is given, it will be passed the resulting object
       #
-      # @yieldparam [Uptime] 
+      # @yieldparam [Uptime]
       #   Uptime value.
       #
       # @return [Uptime]

data/lib/nmap/xml/host_script.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/scripts'
+# frozen_string_literal: true
+
+require_relative 'scripts'
 
 module Nmap
   class XML

data/lib/nmap/xml/hostname.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/ip_id_sequence.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/sequence'
+# frozen_string_literal: true
+
+require_relative 'sequence'
 
 module Nmap
   class XML

data/lib/nmap/xml/os.rb

@@ -1,5 +1,7 @@
-require 'nmap/xml/os_class'
-require 'nmap/xml/os_match'
+# frozen_string_literal: true
+
+require_relative 'os_class'
+require_relative 'os_match'
 
 module Nmap
   class XML
@@ -71,7 +73,7 @@ module Nmap
       def each_match
         return enum_for(__method__) unless block_given?
 
-        @node.xpath("osmatch").map do |osclass|
+        @node.xpath("osmatch").each do |osclass|
           os_match = OSMatch.new(
             osclass['name'],
             osclass['accuracy'].to_i

data/lib/nmap/xml/os_class.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/cpe'
+# frozen_string_literal: true
+
+require_relative 'cpe'
 
 module Nmap
   class XML

data/lib/nmap/xml/os_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/port.rb

@@ -1,5 +1,7 @@
-require 'nmap/xml/service'
-require 'nmap/xml/scripts'
+# frozen_string_literal: true
+
+require_relative 'service'
+require_relative 'scripts'
 
 module Nmap
   class XML

data/lib/nmap/xml/postscript.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/scripts'
+# frozen_string_literal: true
+
+require_relative 'scripts'
 
 module Nmap
   class XML

data/lib/nmap/xml/prescript.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/scripts'
+# frozen_string_literal: true
+
+require_relative 'scripts'
 
 module Nmap
   class XML

data/lib/nmap/xml/run_stat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/scan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/scan_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/scanner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/scripts.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/script'
+# frozen_string_literal: true
+
+require_relative 'script'
 
 module Nmap
   class XML
@@ -27,7 +29,6 @@ module Nmap
 
         return @scripts
       end
-
     end
   end
 end

data/lib/nmap/xml/sequence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #
@@ -24,7 +26,7 @@ module Nmap
       #
       # @return [String]
       #   The sequence class from nmap.
-      # 
+      #
       # @since 0.5.0
       #
       def description

data/lib/nmap/xml/service.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/cpe'
+# frozen_string_literal: true
+
+require_relative 'cpe'
 
 module Nmap
   class XML

data/lib/nmap/xml/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml/tcp_sequence.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/sequence'
+# frozen_string_literal: true
+
+require_relative 'sequence'
 
 module Nmap
   class XML
@@ -14,7 +16,7 @@ module Nmap
       #   The difficulty index from nmap
       #
       # @since 0.5.0
-      #   
+      #
       def index
         @index ||= if (index_string = @node['index'])
                      index_string.to_i

data/lib/nmap/xml/tcp_ts_sequence.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/sequence'
+# frozen_string_literal: true
+
+require_relative 'sequence'
 
 module Nmap
   class XML

data/lib/nmap/xml/traceroute.rb

@@ -1,4 +1,6 @@
-require 'nmap/xml/hop'
+# frozen_string_literal: true
+
+require_relative 'hop'
 
 module Nmap
   class XML

data/lib/nmap/xml/uptime.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nmap
   class XML
     #

data/lib/nmap/xml.rb

@@ -1,10 +1,12 @@
-require 'nmap/xml/scanner'
-require 'nmap/xml/scan_task'
-require 'nmap/xml/scan'
-require 'nmap/xml/host'
-require 'nmap/xml/run_stat'
-require 'nmap/xml/prescript'
-require 'nmap/xml/postscript'
+# frozen_string_literal: true
+
+require_relative 'xml/scanner'
+require_relative 'xml/scan_task'
+require_relative 'xml/scan'
+require_relative 'xml/host'
+require_relative 'xml/run_stat'
+require_relative 'xml/prescript'
+require_relative 'xml/postscript'
 
 require 'nokogiri'
 

data/lib/nmap.rb

@@ -1,3 +1,5 @@
-require 'nmap/program'
-require 'nmap/xml'
-require 'nmap/version'
+# frozen_string_literal: true
+
+require_relative 'nmap/program'
+require_relative 'nmap/xml'
+require_relative 'nmap/version'

data/ruby-nmap.gemspec

@@ -7,10 +7,7 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
-
-                  require 'nmap/version'
+                  require_relative 'lib/nmap/version'
                   Nmap::VERSION
                 end
 
@@ -20,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }