ronin-support 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f75dd96200bd01190ad5ae040cc28dfc658c3f6bcf6c7f299bcdb01d1ee974
-  data.tar.gz: 2a9b6e98f9959efacbbc81fccecbaa68b1620a8f52e38efdc941dcdba74ba38d
+  metadata.gz: 04b9f7e7aa3d25c5742621faaeba6ce51150d3959d82867d41901c7cd1a2af06
+  data.tar.gz: 4e081a47953f762edca8e267c6a31fc168cf8a91f93ce464f7586a1d3e81b2dc
 SHA512:
-  metadata.gz: 604e499c76bfd98e82dd2711a203edb85263742df23f128179d52b283c1f6e468334a34b456119b76c1a0d84b2d06969100d4b75e880a5b4ab963e6ccf244742
-  data.tar.gz: 843289f09e088afc611ee793f645cdb978bb51613d69176591599c26fdc4e8bfcc8b255e76fc01a7b8c40b1024aa94b69976754de3d9ef84b9ae5eecc62d4223
+  metadata.gz: 5611fdbe096f30f8ad9a4d828b722c221e90b93a9e217e6fb9c3ca3eb54dc7103cb0d39e7b5b98f5a74192c6339adedad97c5c11f69bb5019b2ebc7ca0ef3b03
+  data.tar.gz: 107956428d0b34d47378c338143e70820cee6a62fedf24927157d5f06f16b4b978957fb02f945f7eabb75e897dc81a2ab58665fbcf56b072a7f7ad4493bb116a

data/.github/workflows/ruby.yml

@@ -12,6 +12,7 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
           # - jruby
           # - truffleruby
     name: Ruby ${{ matrix.ruby }}

data/.rubocop.yml

@@ -107,3 +107,11 @@ Naming/BinaryOperatorParameterName:
 Lint/RescueException:
   Exclude:
     - 'lib/ronin/support/core_ext/kernel.rb'
+
+# make an exception when we need to test the #each method directly
+Style/MapIntoArray:
+  Exclude:
+    - 'spec/archive/zip/reader_spec.rb'
+    - 'spec/network/ip_range/cidr_spec.rb'
+    - 'spec/network/ip_range/glob_spec.rb'
+    - 'spec/network/ip_range_spec.rb'

data/ChangeLog.md

@@ -1,3 +1,22 @@
+### 1.0.6 / 2024-06-19
+
+* Fixed error messages in {Ronin::Support::Encoding::Base64.encode} and
+  {Ronin::Support::Encoding::Base64.decode}.
+* Fixed {Ronin::Support::Network::IPRange::Glob#each} to support `*` in IPv6
+  glob ranges.
+* {Ronin::Support::Network::TCP.connect},
+  {Ronin::Support::Network::UDP.connect}, and
+  {Ronin::Support::Network::HTTP.connect}, when given a block, now returns the
+  block's return value.
+* {Ronin::Support::Network::TCP.connect} and
+  {Ronin::Support::Network::UDP.connect} properly closes the socket when passed
+  a block that raises an exception.
+
+### 1.0.5 / 2023-12-27
+
+* Fixed a bug in {Ronin::Support::Binary::Stream::Methods#read_string} on Ruby
+  3.3.0.
+
 ### 1.0.4 / 2023-12-15
 
 * Fixed a bug in {Array#pack} where complex types (ex: `[[:uint32, 4], 10]`)
@@ -699,4 +718,3 @@
   * Require combinatorics ~> 0.3.
   * Require uri-query_params ~> 0.5, >= 0.5.2.
   * Require data_paths ~> 0.2, >= 0.2.1.
-

data/lib/ronin/support/binary/stream/methods.rb

@@ -111,7 +111,11 @@ module Ronin
           # @api public
           #
           def read_string(length=nil)
-            new_string = String.new('', encoding: external_encoding)
+            new_string = if (encoding = external_encoding)
+                           String.new('', encoding: encoding)
+                         else
+                           String.new('')
+                         end
 
             if length
               length.times do

data/lib/ronin/support/encoding/base64.rb

@@ -52,7 +52,7 @@ module Ronin
           when :url_safe then ::Base64.urlsafe_encode64(data)
           when nil       then ::Base64.encode64(data)
           else
-            raise(ArgumentError,"Base64 mode must be either :string, :url, or nil: #{mode.inspect}")
+            raise(ArgumentError,"Base64 mode must be either :string, :url_safe, or nil: #{mode.inspect}")
           end
         end
 
@@ -74,7 +74,7 @@ module Ronin
           when :url_safe then ::Base64.urlsafe_decode64(data)
           when nil       then ::Base64.decode64(data)
           else
-            raise(ArgumentError,"Base64 mode must be either :string, :url, or nil: #{mode.inspect}")
+            raise(ArgumentError,"Base64 mode must be either :string, :url_safe, or nil: #{mode.inspect}")
           end
         end
       end

data/lib/ronin/support/network/http.rb

@@ -473,8 +473,11 @@ module Ronin
           http = new(host,port, ssl: ssl, **kwargs)
 
           if block_given?
-            yield http
-            http.close
+            begin
+              yield http
+            ensure
+              http.close
+            end
           else
             return http
           end

data/lib/ronin/support/network/ip_range/cidr.rb

@@ -31,7 +31,6 @@ module Ronin
         #     cidr.each { |ip puts }
         #     # 10.0.0.0
         #     # 10.0.0.1
-        #     # 10.0.0.2
         #     # ...
         #     # 10.0.0.254
         #     # 10.0.0.255
@@ -151,8 +150,8 @@ module Ronin
           #
           # @example
           #   IPRange::CIDR.each('10.0.0.1/24') { |ip| puts ip }
+          #   # 10.0.0.0
           #   # 10.0.0.1
-          #   # 10.0.0.2
           #   # ...
           #   # 10.0.0.254
           #   # 10.0.0.255
@@ -174,17 +173,14 @@ module Ronin
           #
           # @return [self]
           #
-          # @note
-          #   This method will skip IPv4 addresses ending in `.0` or `.255`.
-          #
           # @example
           #   cidr = IPAddr.new('10.1.1.1/24')
           #   cidr.each { |ip| puts ip }
+          #   # 10.0.0.0
           #   # 10.0.0.1
-          #   # 10.0.0.2
           #   # ...
-          #   # 10.0.0.253
           #   # 10.0.0.254
+          #   # 10.0.0.255
           #
           def each
             return enum_for(__method__) unless block_given?
@@ -192,14 +188,7 @@ module Ronin
             family_mask = MASKS[@family]
 
             (0..((~@mask_addr) & family_mask)).each do |i|
-              ip_uint = (@addr | i)
-
-              # skip IPv4 addresses ending in .0 or .255
-              if (ipv4? && ((ip_uint & 0xff) == 0 || (ip_uint & 0xff) == 0xff))
-                next
-              end
-
-              yield _to_string(ip_uint)
+              yield _to_string(@addr | i)
             end
 
             return self

data/lib/ronin/support/network/ip_range/glob.rb

@@ -29,23 +29,23 @@ module Ronin
         #
         #     ip_range = IPRange::Glob.new('10.0.1-3.*/24')
         #     ip_range.each { |ip| puts ip }
+        #     # 10.0.1.0
         #     # 10.0.1.1
-        #     # 10.0.1.2
         #     # ...
-        #     # 10.0.1.253
         #     # 10.0.1.254
+        #     # 10.0.1.255
         #     # ...
+        #     # 10.0.2.0
         #     # 10.0.2.1
-        #     # 10.0.2.2
         #     # ...
-        #     # 10.0.2.253
         #     # 10.0.2.254
+        #     # 10.0.2.255
         #     # ...
+        #     # 10.0.3.0
         #     # 10.0.3.1
-        #     # 10.0.3.2
         #     # ...
-        #     # 10.0.3.253
         #     # 10.0.3.254
+        #     # 10.0.3.255
         #
         # @api public
         #
@@ -71,22 +71,25 @@ module Ronin
 
             if @string.include?(':') # IPv6
               @version   = 6
-              @separator = ':'
               @base      = 16
               @formatter = method(:format_ipv6_address)
+
+              separator   = ':'
+              octet_range = (0..0xffff)
             else # IPv4
               @version   = 4
-              @separator = '.'
               @base      = 10
               @formatter = method(:format_ipv4_address)
+
+              separator   = '.'
+              octet_range = (0..255)
             end
 
-            @ranges = @string.split(@separator).map do |segment|
-              case segment
-              when '*' then (1..254)
-              when /,/ then parse_list(segment)
-              when /-/ then parse_range(segment)
-              else          [segment]
+            @ranges = @string.split(separator).map do |segment|
+              if    segment == '*'        then octet_range
+              elsif segment.include?(',') then parse_list(segment)
+              elsif segment.include?('-') then parse_range(segment)
+              else                             [segment]
               end
             end
           end
@@ -123,23 +126,23 @@ module Ronin
           #
           # @example Enumerate through a IPv4 glob range:
           #   IPRange::Glob.each('10.0.1-3.*') { |ip| puts ip }
+          #   # 10.0.1.0
           #   # 10.0.1.1
-          #   # 10.0.1.2
           #   # ...
-          #   # 10.0.1.253
           #   # 10.0.1.254
+          #   # 10.0.1.255
           #   # ...
+          #   # 10.0.2.0
           #   # 10.0.2.1
-          #   # 10.0.2.2
           #   # ...
-          #   # 10.0.2.253
           #   # 10.0.2.254
+          #   # 10.0.2.255
           #   # ...
+          #   # 10.0.3.0
           #   # 10.0.3.1
-          #   # 10.0.3.2
           #   # ...
-          #   # 10.0.3.253
           #   # 10.0.3.254
+          #   # 10.0.3.255
           #
           # @example Enumerate through a globbed IPv6 range:
           #   IPRange::Glob.each('::ff::02-0a::c3') { |ip| puts ip }
@@ -181,23 +184,23 @@ module Ronin
           # @example Enumerate through a IPv4 glob range:
           #   ip_range = IPRange::Glob.new('10.0.1-3.*')
           #   ip_range.each { |ip| puts ip }
+          #   # 10.0.1.0
           #   # 10.0.1.1
-          #   # 10.0.1.2
           #   # ...
-          #   # 10.0.1.253
           #   # 10.0.1.254
+          #   # 10.0.1.255
           #   # ...
+          #   # 10.0.2.0
           #   # 10.0.2.1
-          #   # 10.0.2.2
           #   # ...
-          #   # 10.0.2.253
           #   # 10.0.2.254
+          #   # 10.0.2.255
           #   # ...
+          #   # 10.0.3.0
           #   # 10.0.3.1
-          #   # 10.0.3.2
           #   # ...
-          #   # 10.0.3.253
           #   # 10.0.3.254
+          #   # 10.0.3.255
           #
           # @example Enumerate through a globbed IPv6 range:
           #   ip_range = IPRange::Glob.new('::ff::02-0a::c3')

data/lib/ronin/support/network/ip_range/range.rb

@@ -171,26 +171,14 @@ module Ronin
           # @return [Enumerator]
           #   If no block is given, an Enumerator will be returned.
           #
-          # @note
-          #   This method will skip IPv4 addresses ending in `.0` or `.255`.
-          #
           # @example
-          #   range = IPRange::Range.new('1.1.1.0','1.1.1.255')
+          #   range = IPRange::Range.new('1.1.1.1','1.1.3.42')
           #   range.each { |ip| puts ip }
           #   # 1.1.1.1
           #   # 1.1.1.2
           #   # ...
-          #   # 1.1.1.253
-          #   # 1.1.1.254
-          #
-          # @example
-          #   range IPRange::Range.new('1.1.1.100','1.1.3.200')
-          #   range.each { |ip| puts ip }
-          #   # 1.1.1.100
-          #   # 1.1.1.101
-          #   # ...
-          #   # 1.1.3.199
-          #   # 1.1.3.200
+          #   # 1.1.3.41
+          #   # 1.1.3.42
           #
           def each
             return enum_for(__method__) unless block_given?
@@ -198,11 +186,6 @@ module Ronin
             ipaddr = @begin.clone
 
             (@begin_uint..@end_uint).each do |ip_uint|
-              # skip IPv4 addresses ending in .0 or .255
-              if (ipv4? && ((ip_uint & 0xff) == 0 || (ip_uint & 0xff) == 0xff))
-                next
-              end
-
               ipaddr.send(:set,ip_uint)
               yield ipaddr.to_s
             end

data/lib/ronin/support/network/ip_range.rb

@@ -41,23 +41,23 @@ module Ronin
       # Enumerating over a IP-glob range:
       #
       #     IPRange.each('10.0.1-3.*') { |ip| puts ip }
+      #     # 10.0.1.0
       #     # 10.0.1.1
-      #     # 10.0.1.2
       #     # ...
-      #     # 10.0.1.253
       #     # 10.0.1.254
+      #     # 10.0.1.255
       #     # ...
+      #     # 10.0.2.0
       #     # 10.0.2.1
-      #     # 10.0.2.2
       #     # ...
-      #     # 10.0.2.253
       #     # 10.0.2.254
+      #     # 10.0.2.255
       #     # ...
+      #     # 10.0.3.0
       #     # 10.0.3.1
-      #     # 10.0.3.2
       #     # ...
-      #     # 10.0.3.253
       #     # 10.0.3.254
+      #     # 10.0.3.255
       #
       # @api public
       #
@@ -126,23 +126,23 @@ module Ronin
         #
         # @example Enumerating over a IP-glob range:
         #   IPRange.each('10.0.1-3.*') { |ip| puts ip }
+        #   # 10.0.1.0
         #   # 10.0.1.1
-        #   # 10.0.1.2
         #   # ...
-        #   # 10.0.1.253
         #   # 10.0.1.254
+        #   # 10.0.1.255
         #   # ...
+        #   # 10.0.2.0
         #   # 10.0.2.1
-        #   # 10.0.2.2
         #   # ...
-        #   # 10.0.2.253
         #   # 10.0.2.254
+        #   # 10.0.2.255
         #   # ...
+        #   # 10.0.3.0
         #   # 10.0.3.1
-        #   # 10.0.3.2
         #   # ...
-        #   # 10.0.3.253
         #   # 10.0.3.254
+        #   # 10.0.3.255
         #
         # @see #each
         #
@@ -181,6 +181,9 @@ module Ronin
         #
         # @return [String]
         #
+        # @see CIDR#string
+        # @see Glob#string
+        #
         def string
           @range.string
         end
@@ -190,6 +193,9 @@ module Ronin
         #
         # @return [Boolean]
         #
+        # @see CIDR#ipv4?
+        # @see Glob#ipv4?
+        #
         def ipv4?
           @range.ipv4?
         end
@@ -199,6 +205,9 @@ module Ronin
         #
         # @return [Boolean]
         #
+        # @see CIDR#ipv6?
+        # @see Glob#ipv6?
+        #
         def ipv6?
           @range.ipv6?
         end
@@ -230,23 +239,23 @@ module Ronin
         # @example Enumerating over a IP-glob range:
         #   ip_range = IPRange.new('10.0.1-3.*')
         #   ip_range.each { |ip| puts ip }
+        #   # 10.0.1.0
         #   # 10.0.1.1
-        #   # 10.0.1.2
         #   # ...
-        #   # 10.0.1.253
         #   # 10.0.1.254
+        #   # 10.0.1.255
         #   # ...
+        #   # 10.0.2.0
         #   # 10.0.2.1
-        #   # 10.0.2.2
         #   # ...
-        #   # 10.0.2.253
         #   # 10.0.2.254
+        #   # 10.0.2.255
         #   # ...
+        #   # 10.0.3.0
         #   # 10.0.3.1
-        #   # 10.0.3.2
         #   # ...
-        #   # 10.0.3.253
         #   # 10.0.3.254
+        #   # 10.0.3.255
         #
         # @see CIDR#each
         # @see Glob#each

data/lib/ronin/support/network/pop3/mixin.rb

@@ -100,8 +100,11 @@ module Ronin
             pop3.start(user,password)
 
             if block_given?
-              yield pop3
-              pop3.finish
+              begin
+                yield pop3
+              ensure
+                pop3.finish
+              end
             else
               return pop3
             end

data/lib/ronin/support/network/smtp/mixin.rb

@@ -164,8 +164,11 @@ module Ronin
             smtp.start(helo,user,password,auth)
 
             if block_given?
-              yield smtp
-              smtp.finish
+              begin
+                yield smtp
+              ensure
+                smtp.finish
+              end
             else
               return smtp
             end

data/lib/ronin/support/network/ssl/mixin.rb

@@ -108,7 +108,7 @@ module Ronin
           #   Path to the CA certificate file or directory.
           #
           # @return [OpenSSL::SSL::SSLSocket]
-          #   the new SSL Socket.
+          #   The new SSL Socket.
           #
           # @api public
           #
@@ -246,7 +246,7 @@ module Ronin
           #   The new SSL Socket.
           #
           # @return [OpenSSL::SSL::SSLSocket, nil]
-          #   the new SSL Socket. If a block is given, then `nil` will be
+          #   The new SSL Socket. If a block is given, then `nil` will be
           #   returned.
           #
           # @example
@@ -573,7 +573,7 @@ module Ronin
           #   Path to the CA certificate file or directory.
           #
           # @return [OpenSSL::SSL::SSLSocket]
-          #   the new SSL Socket.
+          #   The new SSL Socket.
           #
           # @api public
           #

data/lib/ronin/support/network/tcp.rb

@@ -131,8 +131,11 @@ module Ronin
                    end
 
           if block_given?
-            yield socket
-            socket.close
+            begin
+              yield socket
+            ensure
+              socket.close
+            end
           else
             return socket
           end

data/lib/ronin/support/network/tls/mixin.rb

@@ -107,7 +107,7 @@ module Ronin
           #   Path to the CA certificate file or directory.
           #
           # @return [OpenSSL::SSL::SSLSocket]
-          #   the new SSL Socket.
+          #   The new SSL Socket.
           #
           # @api public
           #
@@ -233,7 +233,7 @@ module Ronin
           #   The new SSL Socket.
           #
           # @return [OpenSSL::SSL::SSLSocket, nil]
-          #   the new SSL Socket. If a block is given, then `nil` will be
+          #   The new SSL Socket. If a block is given, then `nil` will be
           #   returned.
           #
           # @example
@@ -519,7 +519,7 @@ module Ronin
           #   * `:client_once`
           #
           # @return [OpenSSL::SSL::SSLSocket]
-          #   the new SSL Socket.
+          #   The new SSL Socket.
           #
           # @api public
           #

data/lib/ronin/support/network/udp.rb

@@ -137,8 +137,11 @@ module Ronin
           socket.connect(host,port)
 
           if block_given?
-            yield socket
-            socket.close
+            begin
+              yield socket
+            ensure
+              socket.close
+            end
           else
             return socket
           end

data/lib/ronin/support/version.rb

@@ -19,6 +19,6 @@
 module Ronin
   module Support
     # ronin-support version
-    VERSION = '1.0.4'
+    VERSION = '1.0.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-support
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chars
@@ -470,7 +470,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A support library for ronin-rb.