ruby-masscan 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15780e5572b3c89f6b4a8f275ebd72ef93a895e408dc2bf3456b92442c06e9c
-  data.tar.gz: cac62c4fd70e73924e82380f4521aaccf929c232863720e617af3cd300393f63
+  metadata.gz: 064d7200b60b80a1ed4f0459239235d21f96587a3199833988dd5953728cd168
+  data.tar.gz: 619757cb909fcec538c63ef5d37d2cb1f1029509d71e957be9aa6f74726ad4ea
 SHA512:
-  metadata.gz: 4cbb1a2dd3f23f28cd729896d12cc5cae1ef153ce9110893e19525fd50842e131bb2559762f823ce86db4aa24b49f509a821df7b75e3b556571d0b9be3195418
-  data.tar.gz: b17dddd6f06b9fc900a230069fcb07f28a3b62192d6766f197261739d7110f2f6248d5ed8c881cdf3e8668bcefa22fb4dfa8f625d9e78fb26414c67baf6ca5de
+  metadata.gz: 9d9fa47ab80653e00c4d3f16b02e1cbe824575d0979b43596f7a52c703b9eda0616882e8bd7effdb77a3f9bfafe40b50043ace08a06f4725b59335dab724fee2
+  data.tar.gz: ad559b68f9af88c2c2e1b66711a93b3bceda9962cd0b3f1f478400a0f1dd7d79a7a87eab81eef4ff9c1cca426c135732d05437affb757fdc3d1ebcfc64b681b2

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 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

@@ -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

@@ -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

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.1'
 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.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2023-03-15 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.