ruby-nmap 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c140058ce1941bb9671a06f6c35b32c702479601d00a9c21906fae39eb18cbf3
-  data.tar.gz: d94fbbffd46099d543aa8f27c0577fa8c387ff45d267911d8b47e5b5348f8500
+  metadata.gz: d68c401c750d115bbd1dbe2d660702749ca20444012e5ef9f06fae022d13029d
+  data.tar.gz: 7909d00c750adbfddb72ede9e50e298d1c3a39803c8f9075bf174bb875d4ae5c
 SHA512:
-  metadata.gz: 98bcdb056f50dc8640ef5b4c3e3eaf1daacc2055328f0fd1c995faec543abf81d2fac5da1290e91ec88a91ea8f9bdbbc9fa03b16c9f02709ed65078c9ceeea82
-  data.tar.gz: 444e4918a0debc3686c346456b38e7e9a2a12573144a83c01519c28253ecdee8ab331c9e5cc7d74dee61a224eb59aea0729140d42ae1c59f8a391449ed395ae3
+  metadata.gz: 746169835110421deadef68c804a225b6c7fc4a1b33436deadbf22013b8113ffc48c3edda145a9ff51c5f1d1cb782b4a174baa6b64cc673baa90cd354b44615b
+  data.tar.gz: 42f3be8d68f03624920cd86d752bb525eb0ba66aebea2915a7ee516c2c5ce92b4abbd8a8cbc55072fa91c48b5e8455dcee1ef271324183bae44e44348e8b3f44

data/ChangeLog.md

@@ -1,3 +1,15 @@
+### 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)
+
 ### 1.0.0 / 2022-11-11
 
 * Switched from [rprogram] to [command_mapper].

data/UPGRADING.md

@@ -1,4 +1,4 @@
-# Migration Guide
+# Upgrading Guide
 
 ## 0.10.0 -> 1.0.0
 

data/gemspec.yml

@@ -10,6 +10,13 @@ email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/ruby-nmap#readme
 has_yard: true
 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ruby-nmap
+  source_code_uri:   https://github.com/postmodern/ruby-nmap
+  bug_tracker_uri:   https://github.com/postmodern/ruby-nmap/issues
+  changelog_uri:     https://github.com/postmodern/ruby-nmap/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
 required_ruby_version: ">= 2.0.0"
 
 requirements: nmap >= 5.00

data/lib/nmap/command.rb

@@ -185,17 +185,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 +212,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 +238,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 +254,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 +294,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 +324,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 +348,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 +395,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 +425,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 +474,8 @@ module Nmap
 
     end
 
+    #
+    # Represents a hex string.
     #
     # @api private
     #
@@ -478,11 +511,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 +528,7 @@ module Nmap
         fin: 'FIN'
       }
 
+      # Regular expression to validate the given scan flags.
       REGEXP = /\A(?:\d+|(?:URG|ACK|PSH|RST|SYN|FIN)+)\z/
 
       #
@@ -752,7 +789,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,4 @@
 module Nmap
   # ruby-nmap version
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/nmap/xml/os.rb

@@ -71,7 +71,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/script.rb

@@ -57,7 +57,7 @@ module Nmap
       #   The parsed data.
       #
       def parse_tables(node)
-        if (tables = @node.xpath('table')).empty?
+        if (tables = node.xpath('table')).empty?
           return
         end
 

data/ruby-nmap.gemspec

@@ -20,6 +20,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] }
 

data/spec/command_spec.rb

@@ -43,9 +43,9 @@ describe Nmap::Command do
           context "but it's less than 1" do
             let(:value) { '0' }
 
-            it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "(#{value.inspect}) not within the range of acceptable values (1..65535)"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -53,9 +53,9 @@ describe Nmap::Command do
           context "but it's greater than 65535" do
             let(:value) { '65536' }
 
-            it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "(#{value.inspect}) not within the range of acceptable values (1..65535)"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -87,8 +87,10 @@ describe Nmap::Command do
           context "and it starts with digits" do
             let(:value) { "1ci-smcs" }
 
-            it "must return true" do
-              expect(subject.validate(value)).to be(true)
+            it "must return  [false, \"must be a valid port number or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number or service name (#{value.inspect})"]
+              )
             end
           end
 
@@ -101,7 +103,7 @@ describe Nmap::Command do
           end
 
           context "and it contains a '-' character" do
-            let(:value) { "3gpp-cbsp" }
+            let(:value) { "iphone-sync" }
 
             it "must return true" do
               expect(subject.validate(value)).to be(true)
@@ -111,9 +113,9 @@ describe Nmap::Command do
           context "but it starts with a '-' character" do
             let(:value) { "-foo" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -121,9 +123,9 @@ describe Nmap::Command do
           context "but it ends with a '-' character" do
             let(:value) { "foo-" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -139,9 +141,9 @@ describe Nmap::Command do
           context "but it starts with a '_' character" do
             let(:value) { "_foo" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -149,9 +151,9 @@ describe Nmap::Command do
           context "but it ends with a '_' character" do
             let(:value) { "foo_" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -167,19 +169,19 @@ describe Nmap::Command do
           context "but it starts with a '/' character" do
             let(:value) { "/foo" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
 
-          context "but it starts with a '/' character" do
+          context "but it ends with a '/' character" do
             let(:value) { "foo/" }
 
-            it "must return [false, \"must be a port number or service name (...)\"]" do
+            it "must return [false, \"must be a valid port number or service name (...)\"]" do
               expect(subject.validate(value)).to eq(
-                [false, "must be a port number or service name (#{value.inspect})"]
+                [false, "must be a valid port number or service name (#{value.inspect})"]
               )
             end
           end
@@ -191,9 +193,211 @@ describe Nmap::Command do
   describe described_class::PortRange do
     describe "#validate" do
       context "when given an Integer value" do
+        let(:value) { 443 }
+
+        it "must return true" do
+          expect(subject.validate(value)).to be(true)
+        end
+
+        context "but it's less than 1" do
+          let(:value) { 0 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (1..65535)"]
+            )
+          end
+        end
+
+        context "but it's greater than 65535" do
+          let(:value) { 65536 }
+
+          it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "(#{value.inspect}) not within the range of acceptable values (1..65535)"]
+            )
+          end
+        end
       end
 
       context "when given a String value" do
+        context "and it's a number" do
+          let(:value) { '443' }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but it's less than 1" do
+            let(:value) { '0' }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it's greater than 65535" do
+            let(:value) { '65536' }
+
+            it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+        end
+
+        context "and it's a range of two numbers" do
+          let(:value) { "1-1024" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but the first number is omitted" do
+            let(:value) { "-1024" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but the last number is omitted" do
+            let(:value) { "1-" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+        end
+
+        context "and it's a service name" do
+          let(:value) { "http" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "and it ends with a '*' character" do
+            let(:value) { "http*" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it contains uppercase letters" do
+            let(:value) { "XmlIpcRegSvc" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it starts with digits" do
+            let(:value) { "1ci-smcs" }
+
+            it "must return  [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contains digits" do
+            let(:value) { "neo4j" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it contains a '-' character" do
+            let(:value) { "iphone-sync" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '-' character" do
+            let(:value) { "-foo" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it ends with a '-' character" do
+            let(:value) { "foo-" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contains a '_' character" do
+            let(:value) { "kerberos_master" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '_' character" do
+            let(:value) { "_foo" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it ends with a '_' character" do
+            let(:value) { "foo_" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contain's a '/' character" do
+            let(:value) { "cl/1" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '/' character" do
+            let(:value) { "/foo" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it starts with a '/' character" do
+            let(:value) { "foo/" }
+
+            it "must return [false, \"must be a valid port number, port range, or service name (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a valid port number, port range, or service name (#{value.inspect})"]
+              )
+            end
+          end
+        end
       end
 
       context "when given a Range of port numbers" do
@@ -226,12 +430,292 @@ describe Nmap::Command do
 
   describe described_class::PortRangeList do
     describe "#validate" do
-      context "when given a single port number" do
+      context "when given an Integer value" do
         let(:value) { 443 }
 
         it "must return true" do
           expect(subject.validate(value)).to be(true)
         end
+
+        context "but it's less than 1" do
+          let(:value) { 0 }
+
+          it "must return [false, \"element (...) not within the range of acceptable values (1..65535)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "element (#{value.inspect}) not within the range of acceptable values (1..65535)"]
+            )
+          end
+        end
+
+        context "but it's greater than 65535" do
+          let(:value) { 65536 }
+
+          it "must return [false, \"element (...) not within the range of acceptable values (1..65535)\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "element (#{value.inspect}) not within the range of acceptable values (1..65535)"]
+            )
+          end
+        end
+      end
+
+      context "when given a String value" do
+        context "and it's a number" do
+          let(:value) { '443' }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but it's less than 1" do
+            let(:value) { '0' }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it's greater than 65535" do
+            let(:value) { '65536' }
+
+            it "must return [false, \"(...) not within the range of acceptable values (1..65535)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+        end
+
+        context "and it's a range of two numbers" do
+          let(:value) { "1-1024" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but the first number is omitted" do
+            let(:value) { "-1024" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but the last number is omitted" do
+            let(:value) { "1-" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+        end
+
+        context "and it's a service name" do
+          let(:value) { "http" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "and it ends with a '*' character" do
+            let(:value) { "http*" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it contains uppercase letters" do
+            let(:value) { "XmlIpcRegSvc" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it starts with digits" do
+            let(:value) { "1ci-smcs" }
+
+            it "must return  [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contains digits" do
+            let(:value) { "neo4j" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "and it contains a '-' character" do
+            let(:value) { "iphone-sync" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '-' character" do
+            let(:value) { "-foo" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it ends with a '-' character" do
+            let(:value) { "foo-" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contains a '_' character" do
+            let(:value) { "kerberos_master" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '_' character" do
+            let(:value) { "_foo" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it ends with a '_' character" do
+            let(:value) { "foo_" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "and it contain's a '/' character" do
+            let(:value) { "cl/1" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but it starts with a '/' character" do
+            let(:value) { "/foo" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+
+          context "but it starts with a '/' character" do
+            let(:value) { "foo/" }
+
+            it "must return [false, \"not a valid port range list (...)\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "not a valid port range list (#{value.inspect})"]
+              )
+            end
+          end
+        end
+
+        context "and it's a comma separated list of port numbers" do
+          let(:value) { "1,22,80,443" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a comma separated list of port ranges" do
+          let(:value) { "1-22,8000-9000" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a comma separated list of port numbers and ranges" do
+          let(:value) { "1-22,80,443,8000-9000" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a range of two numbers, with a protocol prefix" do
+          let(:value) { "T:1-1024" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but the first number is omitted" do
+            let(:value) { "T:-1024" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+
+          context "but the last number is omitted" do
+            let(:value) { "T:1-" }
+
+            it "must return true" do
+              expect(subject.validate(value)).to be(true)
+            end
+          end
+        end
+
+        context "and it's a service name, with a protocol prefix" do
+          let(:value) { "T:http" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a comma separated list of port numbers, with protocol prefixes" do
+          let(:value) { "T:1,T:22,T:80,T:443,U:9000" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a comma separated list of port ranges, with protocol prefixes" do
+          let(:value) { "T:1-22,U:8000-9000" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
+
+        context "and it's a comma separated list of port numbers and ranges, with protocol prefixes" do
+          let(:value) { "T:1-22,T:80,T:443,U:8000-9000" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+        end
       end
 
       context "when given a Range of port numbers" do
@@ -319,9 +803,9 @@ describe Nmap::Command do
             {tcp: [1,2,3,4], udp: [1, bad_port, 3], sctp: [1,2,3,4]}
           end
 
-          it "must return [false, \"element not a valid port range (...)\"]" do
+          it "must return [false, \"element element must be a valid port number, port range, or service name (...)\"]" do
             expect(subject.validate(value)).to eq(
-              [false, "element not a valid port range (#{bad_port.inspect})"]
+              [false, "element must be a valid port number, port range, or service name (#{bad_port.inspect})"]
             )
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-nmap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -145,7 +145,12 @@ files:
 homepage: https://github.com/postmodern/ruby-nmap#readme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ruby-nmap
+  source_code_uri: https://github.com/postmodern/ruby-nmap
+  bug_tracker_uri: https://github.com/postmodern/ruby-nmap/issues
+  changelog_uri: https://github.com/postmodern/ruby-nmap/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -162,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - nmap >= 5.00
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Ruby API to nmap.