ronin-support 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c0497bcfff1b6974a0a158789ca21a7c3846e07d84886cc6cc510362ac2167
-  data.tar.gz: e66f1e80259ea4d499413b8b467a18a295b367d334e6cff21b830bc37cf6a59d
+  metadata.gz: 5d96039ef4f773da9342b3d259bf962d9f55a905e14059d63b8ff6d083e48a48
+  data.tar.gz: c5bf732c0dfa506ccf45f212e041c5341d7b01c95b2cdd9ea7bb0c8ac096d84e
 SHA512:
-  metadata.gz: e7ef5cbb4321d71fc9b6ea54eb6bef5b281a5918289a0c8370f6a3f9cf7809a2ea06d2ff84991330c9e9494c09bcc1cad5b86641ed01827170f93692b44114c7
-  data.tar.gz: 78e0d4a25719229fc6ac45bb38e08436740fb7c85e7258d28be6547b8def9dc47f1ca0ba6df4fcb87cedac4136289f24a50281eefad6ee01cf1953a8d7a09679
+  metadata.gz: 025746e89756222d9feb09d87a02bf76ccf82df466a5e605e63ae01676cb3f0feec9084f9b32b1f5ec7dc85f7310863bc739f07b6d86e3b3efe16f05d67cd653
+  data.tar.gz: 2cba1d2ec2e473136650a41cbc5e6703c326278f206144df0afa7a3316bf445b26948e95c22261f725d8efcd01142895b229ce9e835afa52549eaea119abe1e5

data/ChangeLog.md

@@ -359,9 +359,11 @@
   {Ronin::Support::Network} module.
 * Removed `Net` core-exts.
 * Removed `Ronin::Support::Binary::Template.translate`.
+* Removed `Ronin::Templates` in favor of {Ronin::Support::Text::ERB}.
 * Removed `ssl_server` and `ssl_server_session` in favor of
   {Ronin::Support::Network::SSL::Mixin#ssl_server_socket ssl_server_socket}.
 * Removed `String#depack` in favor of overriding {String#unpack}.
+* Also override {String#unpack1} to match the functionality of {String#unpack}.
 
 [wordlist]: https://github.com/postmodern/wordlist.rb#readme
 [ronin-core]: https://github.com/ronin-rb/ronin-core#readme

data/README.md

@@ -91,6 +91,7 @@ It's like [pwntools] combined with [activesupport].
     * Generating typos.
     * Generating homoglyphs.
     * Regexs for matching/extracting common types of data.
+* Small memory footprint (~46Kb).
 * Has 95% documentation coverage.
 * Has 93% test coverage.
 
@@ -118,7 +119,7 @@ puts data.base64_decode
 ```
 
 For more examples of the convenience methods provided by ronin-support,
-please see [Everyday Ronin].
+please see the [API documentation](https://ronin-rb.dev/docs/ronin-support).
 
 ## Requirements
 
@@ -170,11 +171,10 @@ You should have received a copy of the GNU Lesser General Public License
 along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 
 [ronin-rb]: https://ronin-rb.dev
-[Everyday Ronin]: https://ronin-rb.dev/guides/everyday_ronin.html
 [Ruby]: https://www.ruby-lang.org/
 
-[pwntools]: https://github.com/Gallopsled/pwntools
-[activesupport]: https://github.com/rails/rails/tree/main/activesupport#readme
+[pwntools]: https://github.com/Gallopsled/pwntools#readme
+[activesupport]: https://guides.rubyonrails.org/active_support_core_extensions.html
 
 [chars]: https://github.com/postmodern/chars#readme
 [hexdump]: https://github.com/postmodern/hexdump#readme

data/gemspec.yml

@@ -17,10 +17,10 @@ homepage: https://ronin-rb.dev
 has_yard: true
 
 metadata:
-  documentation_uri: https://ronin-rb.dev/docs/ronin-support/frames
+  documentation_uri: https://ronin-rb.dev/docs/ronin-support
   source_code_uri:   https://github.com/ronin-rb/ronin-support
   bug_tracker_uri:   https://github.com/ronin-rb/ronin-support/issues
-  changelog_uri:     https://github.com/ronin-rb/ronin-support/blob/master/ChangeLog.md
+  changelog_uri:     https://github.com/ronin-rb/ronin-support/blob/main/ChangeLog.md
   rubygems_mfa_required: 'true'
 
 required_ruby_version: ">= 3.0.0"

data/lib/ronin/support/binary/core_ext/string.rb

@@ -18,6 +18,7 @@
 
 require 'ronin/support/binary/core_ext/integer'
 require 'ronin/support/binary/template'
+require 'ronin/support/binary/ctypes'
 require 'ronin/support/binary/bit_flip'
 
 class String
@@ -74,6 +75,52 @@ class String
     end
   end
 
+  alias unpack1_original unpack1
+
+  #
+  # Unpacks a single value from the String.
+  #
+  # @param [String, Symbol] argument
+  #   The `String#unpack` format String (ex: `L<`) or a
+  #   {Ronin::Support::Binary::CTypes} type name (ex: `:uint32_le`).
+  #
+  # @param [Hash{Symbol => Object}] kwargs
+  #   Additional keyword arguments for
+  #   {Ronin::Support::Binary::Template#initialize}.
+  #
+  # @option kwargs [:little, :big, :net, nil] :endian
+  #   The desired endianness of the packed data.
+  #
+  # @option kwargs [:x86, :x86_64, :ppc, :ppc64,
+  #                 :arm, :arm_be, :arm64, :arm64_be,
+  #                 :mips, :mips_le, :mips64, :mips64_le, nil] :arch
+  #   The desired architecture that the data was packed for.
+  #
+  # @return [Integer, Float, String]
+  #   The unpacked value.
+  #
+  # @raise [ArgumentError]
+  #   The given argument was not a String or a Symbol, or the given C type is
+  #   unknown.
+  #
+  # @since 1.0.0
+  #
+  # @api public
+  #
+  def unpack1(argument,**kwargs)
+    case argument
+    when String
+      unpack1_original(argument)
+    when Symbol
+      platform = Ronin::Support::Binary::CTypes.platform(**kwargs)
+      type     = platform[argument]
+
+      unpack1_original(type.pack_string)
+    else
+      raise(ArgumentError,"argument must be either a String or a Symbol: #{argument.inspect}")
+    end
+  end
+
   #
   # Enumerates over every bit flip of every byte in the string.
   #

data/lib/ronin/support/core_ext.rb

@@ -22,6 +22,7 @@ require 'ronin/support/core_ext/integer'
 require 'ronin/support/core_ext/ipaddr'
 require 'ronin/support/core_ext/resolv'
 require 'ronin/support/core_ext/kernel'
+require 'ronin/support/binary/core_ext'
 require 'ronin/support/compression/core_ext'
 require 'ronin/support/archive/core_ext'
 require 'ronin/support/crypto/core_ext'

data/lib/ronin/support/text/patterns/source_code.rb

@@ -141,7 +141,7 @@ module Ronin
         # Regular expression to match any single-line or multi-line comments.
         #
         # @since 1.0.0
-        COMMENT = /#{SHELL_COMMENT}|#{C_COMMENT}/
+        COMMENT = /#{SHELL_STYLE_COMMENT}|#{C_STYLE_COMMENT}/
       end
     end
   end

data/lib/ronin/support/text/patterns.rb

@@ -20,6 +20,7 @@ require 'ronin/support/text/patterns/language'
 require 'ronin/support/text/patterns/numeric'
 require 'ronin/support/text/patterns/credentials'
 require 'ronin/support/text/patterns/crypto'
+require 'ronin/support/text/patterns/file_system'
 require 'ronin/support/text/patterns/network'
 require 'ronin/support/text/patterns/pii'
 require 'ronin/support/text/patterns/source_code'

data/lib/ronin/support/version.rb

@@ -19,6 +19,6 @@
 module Ronin
   module Support
     # ronin-support version
-    VERSION = '1.0.0.beta1'
+    VERSION = '1.0.0.beta2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-support
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-01 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chars
@@ -446,10 +446,10 @@ homepage: https://ronin-rb.dev
 licenses:
 - LGPL-3.0
 metadata:
-  documentation_uri: https://ronin-rb.dev/docs/ronin-support/frames
+  documentation_uri: https://ronin-rb.dev/docs/ronin-support
   source_code_uri: https://github.com/ronin-rb/ronin-support
   bug_tracker_uri: https://github.com/ronin-rb/ronin-support/issues
-  changelog_uri: https://github.com/ronin-rb/ronin-support/blob/master/ChangeLog.md
+  changelog_uri: https://github.com/ronin-rb/ronin-support/blob/main/ChangeLog.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []