ctf-party 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c9bbfee898723defee53d242711a127753c3bef4f6828477d4f686e4487713e
-  data.tar.gz: 69f0e9e1e7bb5fd27dcbd37b2c86d8ce6514307f3eb413d196e89822ad8e6e6e
+  metadata.gz: aa3a85e4dd2db7d636cd1e6f66ca0b32fb34567886901b1102eae35fcb1fbb1c
+  data.tar.gz: aa6c2db8fb07651887d5711d0bfb6b544d422c4f091aaf1893cc6d345e467cc6
 SHA512:
-  metadata.gz: 58b042d0a45a771eb5889438497c15c8126039016b70362d0dcffd58b41a35442735351a14d099744603a778a3dc9684e76a1f72334adca4b2124552205e0b2f
-  data.tar.gz: 35c6e42f0c33448bba0acfd9ac126221ac557cfd47f4042edf844aed7bccf0272aaba52e38ee184959dbe0c56630f10c08575b6f0be25e9eeb3bd2a21ac02537
+  metadata.gz: b1eebe8e48be92a2f4ce8141f6c41a8f4023a3db5d4091358b41a41f5f3b4d123552e382c323d80e29db256818934b2ca8f036e23af10f56a4c1a04861a4f9d9
+  data.tar.gz: 067e1e47c7bad059917fa3774c9d5f37eb9ba37dcd0d8df0320a01bffeccae90a1958d8de8d41d6308040f5cc21e07025a5a34f4b6ef9ce8165ebb7246349134

data/lib/ctf_party.rb

@@ -5,3 +5,4 @@ require 'ctf_party/base64'
 require 'ctf_party/rot'
 require 'ctf_party/digest'
 require 'ctf_party/flag'
+require 'ctf_party/hex'

data/lib/ctf_party/base64.rb

@@ -27,11 +27,7 @@ class String
   #   myStr.to_b64! # => nil
   #   myStr # => "UnVieQ=="
   def to_b64!(opts = {})
-    opts[:mode] ||= :strict
-    replace(to_b64) if opts[:mode] == :strict ||
-                       opts[:mode] == :rfc4648
-    replace(to_b64(mode: :rfc2045)) if opts[:mode] == :rfc2045
-    replace(to_b64(mode: :urlsafe)) if opts[:mode] == :urlsafe
+    replace(to_b64(opts))
   end
 
   # Decode the string from base64
@@ -57,11 +53,7 @@ class String
   #   a.from_b64! # => nil
   #   a # => "Hello world!"
   def from_b64!(opts = {})
-    opts[:mode] ||= :strict
-    replace(from_b64) if opts[:mode] == :strict ||
-                         opts[:mode] == :rfc4648
-    replace(from_b64(mode: :rfc2045)) if opts[:mode] == :rfc2045
-    replace(from_b64(mode: :urlsafe)) if opts[:mode] == :urlsafe
+    replace(from_b64(opts))
   end
 
   # Is the string encoded in base64?

data/lib/ctf_party/digest.rb

@@ -13,7 +13,7 @@ class String
     Digest::MD5.hexdigest self
   end
 
-  # Calculate the md5 hash of the string in place as described for {#md5}.
+  # Calculate the md5 hash of the string in place as described for {String#md5}.
   # @example
   #   a = '\o/' # => "\\o/"
   #   a.md5! # => "881419964e480e66162da521ccc25ebf"
@@ -31,7 +31,8 @@ class String
     Digest::SHA1.hexdigest self
   end
 
-  # Calculate the sha1 hash of the string in place as described for {#sha1}.
+  # Calculate the sha1 hash of the string in place as described for
+  #   {String#sha1}.
   # @example
   #   bob = 'alice' # => "alice"
   #   bob.sha1! # => "522b276a356bdf39013dfabea2cd43e141ecc9e8"
@@ -55,7 +56,8 @@ class String
     Digest::SHA2.new(opts[:bitlen]).hexdigest self
   end
 
-  # Calculate the sha2 hash of the string in place as described for {#sha2}.
+  # Calculate the sha2 hash of the string in place as described for
+  #   {String#sha2}.
   # @example
   #   th = 'try harder' # => "try harder"
   #   th.sha2!(bitlen: 384) # => "bb7f60b9562a19c3a83c23791440af11591c42ede9..."
@@ -64,32 +66,32 @@ class String
     replace(sha2(opts))
   end
 
-  # Alias for {#sha2} with default value ( +sha2(bitlen: 256)+ ).
+  # Alias for {String#sha2} with default value ( +sha2(bitlen: 256)+ ).
   def sha2_256
     sha2
   end
 
-  # Alias for {#sha2!} with default value ( +sha2!(bitlen: 256)+ ).
+  # Alias for {String#sha2!} with default value ( +sha2!(bitlen: 256)+ ).
   def sha2_256!
     replace(sha2)
   end
 
-  # Alias for {#sha2} with default value ( +sha2(bitlen: 384)+ ).
+  # Alias for {String#sha2} with default value ( +sha2(bitlen: 384)+ ).
   def sha2_384
     sha2(bitlen: 384)
   end
 
-  # Alias for {#sha2!} with default value ( +sha2!(bitlen: 384)+ ).
+  # Alias for {String#sha2!} with default value ( +sha2!(bitlen: 384)+ ).
   def sha2_384!
     replace(sha2(bitlen: 384))
   end
 
-  # Alias for {#sha2} with default value ( +sha2(bitlen: 512)+ ).
+  # Alias for {String#sha2} with default value ( +sha2(bitlen: 512)+ ).
   def sha2_512
     sha2(bitlen: 512)
   end
 
-  # Alias for {#sha2!} with default value ( +sha2!(bitlen: 512)+ ).
+  # Alias for {String#sha2!} with default value ( +sha2!(bitlen: 512)+ ).
   def sha2_512!
     replace(sha2(bitlen: 512))
   end
@@ -104,7 +106,7 @@ class String
   end
 
   # Calculate the RIPEMD-160 hash of the string in place as described for
-  # {#rmd160}.
+  # {String#rmd160}.
   # @example
   #   pl = 'payload' # => "payload"
   #   pl.rmd160! # => "3c6255c112d409dafdb84d5b0edba98dfd27b44f"

data/lib/ctf_party/flag.rb

@@ -72,7 +72,7 @@ class String
   end
 
   # Format the current string into the configured flag format in place as
-  # described for {#flag}.
+  # described for {String#flag}.
   def flag!
     replace(flag)
   end

data/lib/ctf_party/hex.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+class String
+  # Encode an hexadecimal string to a decimal string
+  # @param opts [Hash] optional parameters
+  # @option opts [String] :prefix Prefix of the input. Default value is a void
+  #   string. Example of values: +0x+, +\x+.
+  # @return [String] the decimal encoded string
+  # @example
+  #   'ff'.hex2dec # => "255"
+  #   '\xf3'.hex2dec(prefix: '\x') # => "243"
+  def hex2dec(opts = {})
+    opts[:prefix] ||= ''
+    # remove prefix
+    out = sub(opts[:prefix], '')
+    # convert
+    return out.hex.to_s
+  end
+
+  # Encode an hexadecimal string to a decimal string in place as described
+  # for {String#hex2dec}.
+  # @example
+  #   a = 'ff'
+  #   a.hex2dec!
+  #   a # => => "255"
+  def hex2dec!(opts = {})
+    replace(hex2dec(opts))
+  end
+
+  # Encode an decimal string to a hexadecimal string
+  # @param opts [Hash] optional parameters
+  # @option opts [String] :prefix Prefix of the output. Default value is a void
+  #   string. Example of values: +0x+, +\x+.
+  # @option opts [Symbol] :case Char case of the ouput. Default value +:lower+.
+  #   Other valid value +:upper+.
+  # @return [String] the hexadecimal encoded string
+  # @example
+  #   '255'.dec2hex # => "ff"
+  #   '255'.dec2hex({prefix: '0x', case: :upper}) # => "0xFF"
+  def dec2hex(opts = {})
+    opts[:prefix] ||= ''
+    opts[:case] ||= :lower
+    # convert
+    out = to_i.to_s(16)
+    # char case management
+    out = out.upcase if opts[:case] == :upper
+    # adding prefix must be done after case change
+    return opts[:prefix] + out
+  end
+
+  # Encode an decimal string to a hexadecimal string in place as described
+  # for {String#dec2hex}.
+  # @example
+  #   a = '255'
+  #   a.dec2hex!
+  #   a # => "ff"
+  def dec2hex!(opts = {})
+    replace(dec2hex(opts))
+  end
+
+  # Encode a string into hexadecimal
+  # @param opts [Hash] optional parameters
+  # @option opts [String] :prefix Prefix of the output. Default value is a void
+  #   string. Example of values: +0x+, +\x+.
+  # @option opts [Symbol] :case Char case of the ouput. Default value +:lower+.
+  #   Other valid value +:upper+.
+  # @option opts [Symbol] :nibble Display output with high nibble first
+  #   (+:high+ default) or low nibble first (+:low+).
+  # @return [String] the hexadecimal encoded string
+  # @example
+  #   'noraj'.to_hex # => "6e6f72616a"
+  #   'noraj'.to_hex(prefix: '0x') # => "0x6e6f72616a"
+  #   'noraj'.to_hex(case: :upper) # => "6E6F72616A"
+  #   'noraj'.to_hex(nibble: :low) # => "e6f62716a6"
+  def to_hex(opts = {})
+    opts[:prefix] ||= ''
+    opts[:case] ||= :lower
+    opts[:nibble] ||= :high
+    # convert
+    out = ''
+    if opts[:nibble] == :high
+      out = unpack1('H*')
+    elsif opts[:nibble] == :low
+      out = unpack1('h*')
+    end
+    # char case management
+    out = out.upcase if opts[:case] == :upper
+    # adding prefix must be done after case change
+    return opts[:prefix] + out
+  end
+
+  # Encode a string into hexadecimal in place as described
+  # for {String#to_hex}.
+  # @example
+  #   a = 'noraj'
+  #   a.to_hex!
+  #   a # => "6e6f72616a"
+  def to_hex!(opts = {})
+    replace(to_hex(opts))
+  end
+
+  # Decode a hexadecimal string
+  # @param opts [Hash] optional parameters
+  # @option opts [String] :prefix Prefix of the input. Default value is a void
+  #   string. Example of values: +0x+, +\x+.
+  # @option opts [Symbol] :nibble Display input with high nibble first
+  #   (+:high+ default) or low nibble first (+:low+).
+  # @return [String] the hexadecimal decoded string
+  # @example
+  #   "6e6f72616a".from_hex # => "noraj"
+  #   "0x6e6f72616a".from_hex(prefix: '0x') # => "noraj"
+  #   "e6f62716a6".from_hex(nibble: :low) # => "noraj"
+  def from_hex(opts = {})
+    opts[:prefix] ||= ''
+    opts[:nibble] ||= :high
+    # remove prefix
+    out = sub(opts[:prefix], '')
+    # convert
+    return Array(out).pack('H*') if opts[:nibble] == :high
+    return Array(out).pack('h*') if opts[:nibble] == :low
+
+    raise ArgumentError ':nibble expects :high or :low'
+  end
+
+  # Decode a hexadecimal string in place as described
+  # for {String#from_hex}.
+  # @example
+  #   a = "6e6f72616a"
+  #   a.from_hex!
+  #   a # => "noraj"
+  def from_hex!(opts = {})
+    replace(from_hex(opts))
+  end
+end

data/lib/ctf_party/rot.rb

@@ -35,12 +35,12 @@ class String
     replace(rot(opts))
   end
 
-  # Alias for {#rot} with default value ( +rot(shift: 13)+ ).
+  # Alias for {String#rot} with default value ( +rot(shift: 13)+ ).
   def rot13
     rot
   end
 
-  # Alias for {#rot!} with default value ( +rot!(shift: 13)+ ).
+  # Alias for {String#rot!} with default value ( +rot!(shift: 13)+ ).
   def rot13!
     rot!
   end

data/lib/ctf_party/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Version
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ctf-party
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexandre ZANNI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: '0.80'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -122,69 +122,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: A library to enhance and speed up script/exploit writtingfor CTF players
+description: A library to enhance and speed up script/exploit writingfor CTF players
   (or security researchers, bug bountyhunters, pentesters but mostly focused on CTF)
   bypatching the String class to add a short syntax of usual code patterns.
 email: alexandre.zanni@engineer.com
 executables:
 - ctf_party_console
-- ctf_party_setup
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- ".yardopts"
-- ".yardopts-dev"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.md
-- Rakefile
 - bin/ctf_party_console
-- bin/ctf_party_setup
-- docs/.nojekyll
-- docs/About.md
-- docs/CHANGELOG.md
-- docs/README.md
-- docs/_coverpage.md
-- docs/_media/logo.png
-- docs/_navbar.md
-- docs/_sidebar.md
-- docs/index.html
-- docs/pages/documentation.md
-- docs/pages/install.md
-- docs/pages/publishing.md
-- docs/pages/quick-start.md
-- docs/pages/usage.md
-- docs/vendor/docsify.js
-- docs/vendor/plugins/emoji.min.js
-- docs/vendor/plugins/search.min.js
-- docs/vendor/prismjs/components/prism-ruby.min.js
-- docs/vendor/themes/vue.css
-- docs/yard/String.html
-- docs/yard/Version.html
-- docs/yard/_index.html
-- docs/yard/class_list.html
-- docs/yard/css/common.css
-- docs/yard/css/full_list.css
-- docs/yard/css/style.css
-- docs/yard/file.LICENSE.html
-- docs/yard/file.README.html
-- docs/yard/file_list.html
-- docs/yard/frames.html
-- docs/yard/index.html
-- docs/yard/js/app.js
-- docs/yard/js/full_list.js
-- docs/yard/js/jquery.js
-- docs/yard/method_list.html
-- docs/yard/top-level-namespace.html
 - lib/ctf_party.rb
 - lib/ctf_party/base64.rb
 - lib/ctf_party/digest.rb
 - lib/ctf_party/flag.rb
+- lib/ctf_party/hex.rb
 - lib/ctf_party/rot.rb
 - lib/ctf_party/version.rb
-- test/test_string.rb
 homepage: https://orange-cyberdefense.github.io/ctf-party/
 licenses:
 - MIT
@@ -210,9 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A library to enhance and speed up script/exploit writting for CTF players
-test_files:
-- test/test_string.rb
+summary: A library to enhance and speed up script/exploit writing for CTF players
+test_files: []