ruby-masscan 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15780e5572b3c89f6b4a8f275ebd72ef93a895e408dc2bf3456b92442c06e9c
-  data.tar.gz: cac62c4fd70e73924e82380f4521aaccf929c232863720e617af3cd300393f63
+  metadata.gz: bd5ccf856ca875649425af00ffe4f90092cc81e250b30a54c640acd575504387
+  data.tar.gz: b1f064fe48e81cee639f7a32d8e0b77334593ba757ff30d8f554c2fb3a4860bf
 SHA512:
-  metadata.gz: 4cbb1a2dd3f23f28cd729896d12cc5cae1ef153ce9110893e19525fd50842e131bb2559762f823ce86db4aa24b49f509a821df7b75e3b556571d0b9be3195418
-  data.tar.gz: b17dddd6f06b9fc900a230069fcb07f28a3b62192d6766f197261739d7110f2f6248d5ed8c881cdf3e8668bcefa22fb4dfa8f625d9e78fb26414c67baf6ca5de
+  metadata.gz: ec9bc404c40601950b44f6414af17809cf42132b2ee8e83e26268ede21ee297f33f9ae843f9aacc650861d0ffeba3bfe75268293d56b488aebbd1d2b476b8154
+  data.tar.gz: '06797c919c865cbe5147cdb79412883a174ca3835f72706881f1f99b58becf65836a200be6afd1b9e85f5efeac4f19e98e5aaf9ca4a08811afbdbcc200f2df86'

data/ChangeLog.md

@@ -1,3 +1,18 @@
+### 0.2.2 / 2023-04-20
+
+* Corrected option definitions:
+  * The `--range` option expects a IP or CIDR range value.
+  * The `--exclude` option requires a value.
+  * `--range`, `--exclude`, `--excludefile`, `--includefile` options may be
+    repeated.
+  * The --pcap-payloads` option expects a file.
+  * The `--retries` option requires an argument.
+
+### 0.2.1 / 2023-03-15
+
+* Unescape `\\xXX` hex escaped characters in payload strings parsed from `.list`
+  masscan files.
+
 ### 0.2.0 / 2021-11-30
 
 * Replaced the `rprogram` dependency with [command_mapper].

data/Gemfile

@@ -11,6 +11,7 @@ group :development do
   gem 'simplecov',      '~> 0.7'
 
   gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
   gem 'yard',           '~> 0.9'
   gem 'yard-spellcheck', require: false
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Hal Brodigan
+Copyright (c) 2021-2023 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

@@ -82,11 +82,11 @@ end
 #<struct Masscan::Status status=:open, protocol=:tcp, port=443, reason=nil, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:50 -0700, mac=nil>
 #<struct Masscan::Status status=:open, protocol=:tcp, port=80, reason=nil, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:50 -0700, mac=nil>
 #<struct Masscan::Status status=:open, protocol=:icmp, port=0, reason=nil, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:50 -0700, mac=nil>
-#<struct Masscan::Banner protocol=:tcp, port=443, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:ssl3, payload="TLS/1.1 cipher:0xc013, www.example.org, www.example.org, example.com, example.edu, example.net, example.org, www.example.com, www.example.edu, www.example.net">
-#<struct Masscan::Banner protocol=:tcp, port=443, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:x509, payload="MIIG1TCCBb2gAwIBAgIQD74IsIVNBXOKsMzhya/uyTANBgkqhkiG9w0BAQsFADBPMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBEaWdpQ2VydCBUTFMgUlNBIFNIQTI1NiAyMDIwIENBMTAeFw0yMDExMjQwMDAwMDBaFw0yMTEyMjUyMzU5NTlaMIGQMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTEUMBIGA1UEBxMLTG9zIEFuZ2VsZXMxPDA6BgNVBAoTM0ludGVybmV0IENvcnBvcmF0aW9uIGZvciBBc3NpZ25lZCBOYW1lcyBhbmQgTnVtYmVyczEYMBYGA1UEAxMPd3d3LmV4YW1wbGUub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuvzuzMoKCP8Okx2zvgucA5YinrFPEK5RQP1TX7PEYUAoBO6i5hIAsIKFmFxtW2sghERilU5rdnxQcF3fEx3sY4OtY6VSBPLPhLrbKozHLrQ8ZN/rYTb+hgNUeT7NA1mP78IEkxAj4qG5tli4Jq41aCbUlCt7equGXokImhC+UY5IpQEZS0tKD4vu2ksZ04Qetp0k8jWdAvMA27W3EwgHHNeVGWbJPC0Dn7RqPw13r7hFyS5TpleywjdY1nB7ad6kcZXZbEcaFZ7ZuerA6RkPGE+PsnZRb1oFJkYoXimsuvkVFhWeHQXCGC1cuDWSrM3cpQvOzKH2vS7d15+zGls4IwIDAQABo4IDaTCCA2UwHwYDVR0jBBgwFoAUt2ui6qiqhIx56rTaD5iyxZV2ufQwHQYDVR0OBBYEFCYa+OSxsHKEztqBBtInmPvtOj0XMIGBBgNVHREEejB4gg93d3cuZXhhbXBsZS5vcmeCC2V4YW1wbGUuY29tggtleGFtcGxlLmVkdYILZXhhbXBsZS5uZXSCC2V4YW1wbGUub3Jngg93d3cuZXhhbXBsZS5jb22CD3d3dy5leGFtcGxlLmVkdYIPd3d3LmV4YW1wbGUubmV0MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwgYsGA1UdHwSBgzCBgDA+oDygOoY4aHR0cDovL2NybDMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0VExTUlNBU0hBMjU2MjAyMENBMS5jcmwwPqA8oDqGOGh0dHA6Ly9jcmw0LmRpZ2ljZXJ0LmNv">
-#<struct Masscan::Banner protocol=:tcp, port=80, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:http_server, payload="ECS (sec/974D)">
-#<struct Masscan::Banner protocol=:tcp, port=80, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:html_title, payload="404 - Not Found">
-#<struct Masscan::Banner protocol=:tcp, port=80, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:http, payload="HTTP/1.0 404 Not Found\\x0d\\x0aContent-Type: text/html\\x0d\\x0aDate: Thu, 26 Aug 2021 06:47:52 GMT\\x0d\\x0aServer: ECS (sec/974D)\\x0d\\x0aContent-Length: 345\\x0d\\x0aConnection: close\\x0d\\x0a\\x0d">
+#<struct Masscan::Banner protocol=:tcp, port=443, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:ssl3, payload="TLS/1.1 cipher:0xc013, www.example.org, www.example.org, example.com, example.edu, example.net, example.org, www.example.com, www.example.edu, www.example.net">
+#<struct Masscan::Banner protocol=:tcp, port=443, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:x509, payload="MIIG1TCCBb2gAwIBAgIQD74IsIVNBXOKsMzhya/uyTANBgkqhkiG9w0BAQsFADBPMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBEaWdpQ2VydCBUTFMgUlNBIFNIQTI1NiAyMDIwIENBMTAeFw0yMDExMjQwMDAwMDBaFw0yMTEyMjUyMzU5NTlaMIGQMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTEUMBIGA1UEBxMLTG9zIEFuZ2VsZXMxPDA6BgNVBAoTM0ludGVybmV0IENvcnBvcmF0aW9uIGZvciBBc3NpZ25lZCBOYW1lcyBhbmQgTnVtYmVyczEYMBYGA1UEAxMPd3d3LmV4YW1wbGUub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuvzuzMoKCP8Okx2zvgucA5YinrFPEK5RQP1TX7PEYUAoBO6i5hIAsIKFmFxtW2sghERilU5rdnxQcF3fEx3sY4OtY6VSBPLPhLrbKozHLrQ8ZN/rYTb+hgNUeT7NA1mP78IEkxAj4qG5tli4Jq41aCbUlCt7equGXokImhC+UY5IpQEZS0tKD4vu2ksZ04Qetp0k8jWdAvMA27W3EwgHHNeVGWbJPC0Dn7RqPw13r7hFyS5TpleywjdY1nB7ad6kcZXZbEcaFZ7ZuerA6RkPGE+PsnZRb1oFJkYoXimsuvkVFhWeHQXCGC1cuDWSrM3cpQvOzKH2vS7d15+zGls4IwIDAQABo4IDaTCCA2UwHwYDVR0jBBgwFoAUt2ui6qiqhIx56rTaD5iyxZV2ufQwHQYDVR0OBBYEFCYa+OSxsHKEztqBBtInmPvtOj0XMIGBBgNVHREEejB4gg93d3cuZXhhbXBsZS5vcmeCC2V4YW1wbGUuY29tggtleGFtcGxlLmVkdYILZXhhbXBsZS5uZXSCC2V4YW1wbGUub3Jngg93d3cuZXhhbXBsZS5jb22CD3d3dy5leGFtcGxlLmVkdYIPd3d3LmV4YW1wbGUubmV0MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwgYsGA1UdHwSBgzCBgDA+oDygOoY4aHR0cDovL2NybDMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0VExTUlNBU0hBMjU2MjAyMENBMS5jcmwwPqA8oDqGOGh0dHA6Ly9jcmw0LmRpZ2ljZXJ0LmNv">
+#<struct Masscan::Banner protocol=:tcp, port=80, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:http_server, payload="ECS (sec/974D)">
+#<struct Masscan::Banner protocol=:tcp, port=80, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:html_title, payload="404 - Not Found">
+#<struct Masscan::Banner protocol=:tcp, port=80, ttl=nil, ip=#<IPAddr: IPv4:93.184.216.34/255.255.255.255>, timestamp=2021-08-25 23:47:52 -0700, app_protocol=:http, payload="HTTP/1.0 404 Not Found\r\nContent-Type: text/html\r\nDate: Thu, 26 Aug 2021 06:47:52 GMT\r\nServer: ECS (sec/974D)\r\nContent-Length: 345\r\nConnection: close\r\n\r">
 ```
 
 Parse `masscan` JSON output files:
@@ -135,7 +135,7 @@ gem 'ruby-masscan', '~> 0.2'
 
 ## License
 
-Copyright (c) 2021 Hal Brodigan
+Copyright (c) 2021-2023 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.
 

data/lib/masscan/command.rb

@@ -7,11 +7,11 @@ module Masscan
   # ## Example
   #
   #     require 'masscan/command'
-  #     
+  #
   #     Masscan::Command.sudo do |masscan|
   #       masscan.output_format = :list
   #       masscan.output_file   = 'masscan.txt'
-  #     
+  #
   #       masscan.ips   = '192.168.1.1/24'
   #       masscan.ports = [20,21,22,23,25,80,110,443,512,522,8080,1080]
   #     end
@@ -82,6 +82,8 @@ module Masscan
   #
   # @see https://github.com/robertdavidgraham/masscan/blob/master/doc/masscan.8.markdown
   #
+  # @since 0.2.0
+  #
   class Command < CommandMapper::Command
 
     class PortList < CommandMapper::Types::Num
@@ -157,7 +159,7 @@ module Masscan
     end
 
     command "masscan" do
-      option '--range', name: :range, value: {type: List.new}
+      option '--range', name: :range, value: true, repeats: true
       option '-p', name: :ports, value: {type: PortList.new}
       option '--banners', name: :banners
       option '--rate',    name: :rate, value: {type: Num.new}
@@ -171,14 +173,14 @@ module Masscan
       option '--adapter-vlan', name: :adapter_vlan, value: true
       option '--router-mac', name: :router_mac, value: true
       option '--ping', name: :ping
-      option '--exclude', name: :exclude, value: {type: List.new}
-      option '--excludefile', name: :exclude_file, value: {type: InputFile.new}
-      option '--includefile', name: :include_file, value: {type: InputFile.new}
+      option '--exclude', name: :exclude, value: true, repeats: true
+      option '--excludefile', name: :exclude_file, value: {type: InputFile.new}, repeats: true
+      option '--includefile', name: :include_file, value: {type: InputFile.new}, repeats: true
       option '--append-output', name: :append_output
       option '--iflist', name: :list_interfaces
-      option '--retries', name: :retries
+      option '--retries', name: :retries, value: {type: Num.new}
       option '--nmap', name: :nmap_help
-      option '--pcap-payloads', name: :pcap_payloads
+      option '--pcap-payloads', name: :pcap_payloads, value: {type: InputFile.new}
       option '--nmap-payloads', name: :nmap_payloads, value: {type: InputFile.new}
 
       option '--http-method',     name: :http_method, value: true

data/lib/masscan/parsers/list.rb

@@ -64,7 +64,7 @@ module Masscan
               timestamp: parse_timestamp(timestamp)
             )
           elsif line.start_with?('banner ')
-            type, ip_proto, port, ip, timestamp, app_proto, banner = line.split(' ',7)
+            type, ip_proto, port, ip, timestamp, app_proto, payload = line.split(' ',7)
 
             yield Banner.new(
               protocol:     parse_ip_protocol(ip_proto),
@@ -72,11 +72,28 @@ module Masscan
               ip:           parse_ip(ip),
               timestamp:    parse_timestamp(timestamp),
               app_protocol: parse_app_protocol(app_proto),
-              payload:      banner
+              payload:      parse_payload(payload)
             )
           end
         end
       end
+
+      #
+      # Parses a payload string and removes any `\\xXX` hex escaped characters.
+      #
+      # @param [String] payload
+      #   The payload string to unescape.
+      #
+      # @return [String]
+      #   The raw payload string.
+      #
+      # @api private
+      #
+      def self.parse_payload(payload)
+        payload.gsub(/\\x[0-9a-f]{2}/) do |hex_escape|
+          hex_escape[2..].to_i(16).chr
+        end
+      end
     end
   end
 end

data/lib/masscan/version.rb

@@ -1,4 +1,4 @@
 module Masscan
   # ruby-masscan version
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/lib/masscan.rb

@@ -1,2 +1,3 @@
 require 'masscan/command'
+require 'masscan/program'
 require 'masscan/output_file'

data/spec/parsers/list_spec.rb

@@ -104,6 +104,31 @@ describe Masscan::Parsers::List do
         expect(yielded_banner.service).to eq(service_keyword)
         expect(yielded_banner.payload).to  eq(payload)
       end
+
+      context "when the payload field contains '\\xXX' hex escaped characters" do
+        let(:escaped_payload) do
+          "HTTP/1.0 404 Not Found\\x0d\\x0aContent-Type: text/html\\x0d\\x0aDate: Thu, 26 Aug 2021 06:47:52 GMT\\x0d\\x0aServer: ECS (sec/974D)\\x0d\\x0aContent-Length: 345\\x0d\\x0aConnection: close\\x0d\\x0a\\x0d"
+        end
+        let(:unescaped_payload) do
+          "HTTP/1.0 404 Not Found\r\nContent-Type: text/html\r\nDate: Thu, 26 Aug 2021 06:47:52 GMT\r\nServer: ECS (sec/974D)\r\nContent-Length: 345\r\nConnection: close\r\n\r"
+        end
+
+        let(:line) do
+          "banner #{protocol} #{port} #{ip} #{timestamp.to_i} #{service_name} #{escaped_payload}"
+        end
+
+        it "must unescape the '\\xXX' hex escaped characters" do
+          yielded_records = []
+
+          subject.parse(io) do |record|
+            yielded_records << record
+          end
+
+          yielded_banner = yielded_records.first
+
+          expect(yielded_banner.payload).to eq(unescaped_payload)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-masscan
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command_mapper
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - masscan >= 1.0.0
-rubygems_version: 3.2.22
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A Ruby interface to masscan.