ctf-party 1.3.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f09406956f91fdbe561c73f343efc68e28ad20c774370053e88472ebb1bb5098
-  data.tar.gz: 8bf8dfddfdbb4780578216b022d4815778f6f79d489506a2dba9fa0355bc8f90
+  metadata.gz: 4d60cac63a1449a4ddc3bf3b34ab1ff58db23b62adb3f5710b7bfe4822827088
+  data.tar.gz: 9fdc5fdaced3468d7003865e2e334ee756f6162a7204b64d99665c6e378a7bf8
 SHA512:
-  metadata.gz: 40adf3307a9e8b99ccda9af3d1ab063413433998455cf92c292eb9b6e8d3deb754280673e796d7d980e22c87c222b7eb07c1fd7a6434d4597c186857ea973937
-  data.tar.gz: e3d1bbf14cf1dd05112833a7fa8096acaf0ee6065a266990fa56a71c30415f504a83255c8ae835188dfbd25593e37b983d06b7c137ed5e3d0598ebd3dcc83edd
+  metadata.gz: 4212f6d4908cf82c3921b581424109c05d3bdd06d26bb8531c61cd903754260de7732bd019ee04dbf8d500dd1d947773701fb41a29ddf8142dd3f0388d59f778
+  data.tar.gz: ab4919f51fe339643dd6f6a4da0086e42451245f68438049c66f81ebf9f9ad14aadfe6ef2f04c28f4b26b473d0440283e9324be331e6643519e7b462a798de55

data/bin/ctf-party

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Ruby internal
+require 'pp'
+# Project internal
+require 'ctf_party'
+require 'ctf_party/version'
+# External
+require 'docopt'
+
+cmd_whitelist = {
+  alternatecase: 'Change one characte on two upcase and the other downcase',
+  bin2hex: 'Encode an binary string to a hexadecimal string',
+  bin2str: 'Alias for from_bin',
+  dec2hex: 'Encode an decimal string to a hexadecimal string',
+  dec2str: 'Alias for from_dec',
+  from_b64: 'Decode the string from base64',
+  from_bin: 'Decode a binary string',
+  from_dec: 'Decode a decimal string (decimal to hexadecimal then hexadecimal to string)',
+  from_hex: 'Decode a hexadecimal string',
+  from_hexip: 'Decode a hexadecimal IP string into a dotted decimal one',
+  hex2bin: 'Encode an hexadecimal string to a binary string',
+  hex2dec: 'Encode an hexadecimal string to a decimal string',
+  hex2str: 'Alias for from_hex',
+  htmlescape: 'HTML escape the string',
+  htmlunescape: 'HTML unescape the string',
+  istrip: 'Remove leading and trailing whitespace but also all inner whitespace',
+  leet: 'Transform into leet speak (l337 5p34k)',
+  md5: 'Calculate the md5 hash of the string',
+  randomcase: 'Change the case of characters randomly',
+  rmd160: 'Calculate the RIPEMD-160 hash of the string',
+  rot13: 'Encrypt / Decrypt the string with Caesar cipher with a shift of 13',
+  sha1: 'Calculate the sha1 hash of the string',
+  sha2: 'Calculate the sha2 hash of the string',
+  sha2_256: 'Alias for sha2 with bitlen of 256',
+  sha2_384: 'Alias for sha2 with bitlen of 384',
+  sha2_512: 'Alias for sha2 with bitlen of 512',
+  str2bin: 'Alias for to_bin',
+  str2dec: 'Alias for to_dec',
+  str2hex: 'Alias for to_hex',
+  to_b64: 'Encode the string into base64',
+  to_bin: 'Encode a string into binary',
+  to_dec: 'Encode a string into decimal (string to hexadecimal then hexadecimal to decimal)',
+  to_hex: 'Encode a string into hexadecimal',
+  to_hexip: 'Encode a dotted decimal IP into a hexadecimal one',
+  urldecode: 'URL-decode the string',
+  urlencode: 'URL-encode the string'
+}
+
+doc = <<~DOCOPT
+  ctf-party by noraj
+
+  Usage:
+    ctf-party <string> <cmd>... [--debug]
+    ctf-party --list-commands [--debug]
+    ctf-party -h | --help
+    ctf-party --version
+
+  Options:
+    -l, --list-commands   List available commands (see https://noraj.github.io/ctf-party/yard/String.html)
+    --debug               Display arguments
+    -h, --help            Show this screen
+    --version             Show version
+
+  Examples:
+    ctf-party 'security' to_hex
+    ctf-party 'NzQ2Zjc0NmY=' from_b64 hex2str str2bin
+DOCOPT
+
+begin
+  args = Docopt.docopt(doc, version: Version::VERSION)
+  # use case 1, using the tool
+  pp args if args['--debug']
+  if args['<string>']
+    wrong_cmd = args['<cmd>'] - cmd_whitelist.keys.map(&:to_s)
+    if wrong_cmd.empty?
+      output = args['<string>']
+      args['<cmd>'].each do |cmd|
+        output = output.public_send(cmd)
+      end
+      puts output
+    else
+      abort "Those commands don't exist: #{wrong_cmd}"
+    end
+  elsif args['--list-commands']
+    cmd_whitelist.each do |k, v|
+      puts "#{k.to_s.ljust(15)}#{v}"
+    end
+  end
+  # use case 2, help: already handled by docopt
+  # use case 3, version: already handled by docopt
+rescue Docopt::Exit => e
+  puts e.message
+end

data/lib/ctf_party/base64.rb

@@ -6,8 +6,8 @@ require 'base64'
 class String
   # Encode the string into base64
   # @param opts [Hash] optional parameters
-  # @option opts [Symbol] :mode Default value: +:strict+.
-  #   Other values are +:strict+ (+:rfc4648+) or +:urlsafe+.
+  # @option opts [Symbol] :mode Default value: `:strict`.
+  #   Other values are `:strict` (`:rfc4648`) or `:urlsafe`.
   # @see https://ruby-doc.org/stdlib-2.6.5/libdoc/base64/rdoc/Base64.html
   # @return [String] the Base64 encoded string
   # @example
@@ -32,8 +32,8 @@ class String
 
   # Decode the string from base64
   # @param opts [Hash] optional parameters
-  # @option opts [Symbol] :mode Default value: +:strict+.
-  #   Other values are +:strict+ (+:rfc4648+) or +:urlsafe+.
+  # @option opts [Symbol] :mode Default value: `:strict`.
+  #   Other values are `:strict` (`:rfc4648`) or `:urlsafe`.
   # @see https://ruby-doc.org/stdlib-2.6.5/libdoc/base64/rdoc/Base64.html
   # @return [String] the Base64 decoded string
   # @example
@@ -58,10 +58,10 @@ class String
 
   # Is the string encoded in base64?
   # @param opts [Hash] optional parameters
-  # @option opts [Symbol] :mode Default value: +:strict+.
-  #   Other values are +:strict+ (+:rfc4648+) or +:urlsafe+.
+  # @option opts [Symbol] :mode Default value: `:strict`.
+  #   Other values are `:strict` (`:rfc4648`) or `:urlsafe`.
   # @see https://ruby-doc.org/stdlib-2.6.5/libdoc/base64/rdoc/Base64.html
-  # @return [Boolean] +true+ if the string is a valid base64 string, +false+
+  # @return [Boolean] `true` if the string is a valid base64 string, `false`
   #   else.
   # @example
   #   'SGVsbG8gd29ybGQh'.b64? # => true

data/lib/ctf_party/binary.rb

@@ -4,7 +4,7 @@ class String
   # Encode a string into binary
   # @param opts [Hash] optional parameters
   # @option opts [Symbol] :bitnumbering Display output with most significant bit
-  #   first (+:MSB+ default) or least significant bit first (+:LSB+).
+  #   first (`:MSB` default) or least significant bit first (`:LSB`).
   # @return [String] the binary encoded string
   # @example
   #   'binary'.to_bin # => "011000100110100101101110011000010111001001111001"
@@ -41,7 +41,7 @@ class String
   # Decode a binary string
   # @param opts [Hash] optional parameters
   # @option opts [Symbol] :bitnumbering Display input with most significant bit
-  #   first (+:MSB+ default) or least significant bit first (+:LSB+).
+  #   first (`:MSB` default) or least significant bit first (`:LSB`).
   # @return [String] the binary decoded string
   # @example
   #   '011000100110100101101110011000010111001001111001'.from_bin # => "binary"
@@ -74,4 +74,4 @@ class String
   def bin2str!(opts = {})
     from_bin!(opts)
   end
-end
+end

data/lib/ctf_party/cgi.rb

@@ -4,12 +4,13 @@
 require 'cgi'
 
 class String
-  # URL-encode the string
+  # URL-encode the URL string (RFC2396)
   # @return [String] the URL-encoded string
   # @example
-  #   "'Stop!' said Fred".urlencode # => "%27Stop%21%27+said+Fred"
+  #   'http://vulnerable.site/search.aspx?txt="><script>alert(/Rubyfu/.source)</script>'.urlencode # => "http://vulnerable.site/search.aspx?txt=%22%3E%3Cscript%3Ealert(/Rubyfu/.source)%3C/script%3E"
+  #   "'Stop!' said Fred" # => "'Stop!'%20said%20Fred"
   def urlencode
-    CGI.escape self
+    URI::Parser.new.escape self
   end
 
   # URL-encode the string in place as described for {String#urlencode}.
@@ -17,12 +18,29 @@ class String
     replace(urlencode)
   end
 
-  # URL-decode the string
+  # URL-encode the URL component string
+  # @return [String] the URL-encoded string
+  # @example
+  #   "'Stop!' said Fred".urlencode_component # => "%27Stop%21%27+said+Fred"
+  #   'http://vulnerable.site/search.aspx?txt="><script>alert(/Rubyfu/.source)</script>'.urlencode_component # => "http%3A%2F%2Fvulnerable.site%2Fsearch.aspx%3Ftxt%3D%22%3E%3Cscript%3Ealert%28%2FRubyfu%2F.source%29%3C%2Fscript%3E"
+  def urlencode_component
+    CGI.escape self
+  end
+
+  # URL-encode the string in place as described for {String#urlencode_component}.
+  def urlencode_component!
+    replace(urlencode_component)
+  end
+
+  # URL-decode the URL string (RFC2396)
   # @return [String] the URL-decoded string
   # @example
-  #   "%27Stop%21%27+said+Fred".urldecode # => "'Stop!' said Fred"
+  #   'http://vulnerable.site/search.aspx?txt=%22%3E%3Cscript%3Ealert(/Rubyfu/.source)%3C/script%3E'.urldecode # => "http://vulnerable.site/search.aspx?txt=\"><script>alert(/Rubyfu/.source)</script>"
+  #   'http%3A%2F%2Fvulnerable.site%2Fsearch.aspx%3Ftxt%3D%22%3E%3Cscript%3Ealert%28%2FRubyfu%2F.source%29%3C%2Fscript%3E'.urldecode # => "http://vulnerable.site/search.aspx?txt=\"><script>alert(/Rubyfu/.source)</script>"
+  #   "'Stop!'%20said%20Fred".urldecode # => "'Stop!' said Fred"
+  #   '%27Stop%21%27+said+Fred'.urldecode # => "'Stop!'+said+Fred"
   def urldecode
-    CGI.unescape self
+    URI::Parser.new.unescape self
   end
 
   # URL-decode the string in place as described for {String#urldecode}.
@@ -30,6 +48,22 @@ class String
     replace(urldecode)
   end
 
+  # URL-decode the URL component string
+  # @return [String] the URL-decoded string
+  # @example
+  #   'http://vulnerable.site/search.aspx?txt=%22%3E%3Cscript%3Ealert(/Rubyfu/.source)%3C/script%3E'.urldecode_component # => "http://vulnerable.site/search.aspx?txt=\"><script>alert(/Rubyfu/.source)</script>"
+  #   'http%3A%2F%2Fvulnerable.site%2Fsearch.aspx%3Ftxt%3D%22%3E%3Cscript%3Ealert%28%2FRubyfu%2F.source%29%3C%2Fscript%3E'.urldecode_component # => "http://vulnerable.site/search.aspx?txt=\"><script>alert(/Rubyfu/.source)</script>"
+  #   "'Stop!'%20said%20Fred".urldecode_component => "'Stop!' said Fred"
+  #   '%27Stop%21%27+said+Fred'.urldecode_component # => "'Stop!' said Fred"
+  def urldecode_component
+    CGI.unescape self
+  end
+
+  # URL-decode the string in place as described for {String#urldecode_component}.
+  def urldecode_component!
+    replace(urldecode_component)
+  end
+
   # HTML escape the string
   # @return [String] the HTML escaped string
   # @example

data/lib/ctf_party/digest.rb

@@ -66,32 +66,32 @@ class String
     replace(sha2(opts))
   end
 
-  # Alias for {String#sha2} with default value ( +sha2(bitlen: 256)+ ).
+  # Alias for {String#sha2} with default value ( `sha2(bitlen: 256)` ).
   def sha2_256
     sha2
   end
 
-  # Alias for {String#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 {String#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 {String#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 {String#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 {String#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

data/lib/ctf_party/flag.rb

@@ -21,7 +21,7 @@ class String
   # @option hash [String] :prefix prefix of the flag. Default: none.
   # @option hash [String] :suffix suffix of the flag. Default: none.
   # @option hash [Array<String>] :enclosing the characters used to surround
-  #   the flag. Default are curly braces: +{+, +}+. The array must contain
+  #   the flag. Default are curly braces: `{`, `}`. The array must contain
   #   exactly 2 elements.
   # @option hash [String] :digest the hash algorithm to apply on the flag.
   #   Default: none. Allowed values: md5, sha1, sha2_256, sha2_384, sha2_512,

data/lib/ctf_party/hex.rb

@@ -4,15 +4,17 @@ 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+.
+  #   string. Example of values: `0x`, `\x`, `\\x`.
   # @return [String] the decimal encoded string
   # @example
   #   'ff'.hex2dec # => "255"
   #   '\xf3'.hex2dec(prefix: '\x') # => "243"
+  #   '6e6f72616a'.hex2dec # => "474316169578"
+  #   '\\x6e\\x6f\\x72\\x61\\x6a'.hex2dec(prefix: '\\x') # => "474316169578"
   def hex2dec(opts = {})
     opts[:prefix] ||= ''
     # remove prefix
-    out = sub(opts[:prefix], '')
+    out = gsub(opts[:prefix], '')
     # convert
     return out.hex.to_s
   end
@@ -30,26 +32,35 @@ class String
   # 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+.
+  #   string. Example of values: `0x`, `\x`.
+  # @option opts [String] :prefixall Prefix each byte. Default value is a void
+  #   string. Example of value: `\\x`.
+  # @option opts [Symbol] :case Char case of the output. Default value `:lower`.
+  #   Other valid value `:upper`.
   # @option opts [Symbol] :padding Minimum size of the hexadecimal display
-  #   (number of characters). Eg. 10 -> 0xA or 0x0A
+  #   (number of characters). Must be even.
   # @return [String] the hexadecimal encoded string
   # @example
   #   '255'.dec2hex # => "ff"
   #   '255'.dec2hex({prefix: '0x', case: :upper}) # => "0xFF"
+  #   '10'.dec2hex(padding: 2) # => "0a"
+  #   '10'.dec2hex(padding: 8) # => "0000000a"
+  #   '474316169578'.dec2hex(prefixall: '\\x') # => "\\x6e\\x6f\\x72\\x61\\x6a"
   def dec2hex(opts = {})
     opts[:prefix] ||= ''
+    opts[:prefixall] ||= ''
     opts[:case] ||= :lower
-    opts[:padding] ||= 1
+    opts[:padding] ||= 2
+    raise(ArgumentError, 'Padding must be even') if opts[:padding].odd?
+
     # convert
     out = to_i.to_s(16)
     # padding
-    out = ('0' * (opts[:padding] - 1)) + out if out.size < opts[:padding]
+    out = ('0' * (opts[:padding] - out.size)) + out if out.size < opts[:padding]
     # char case management
     out = out.upcase if opts[:case] == :upper
     # adding prefix must be done after case change
+    out = out.scan(/.{2}/).map { |x| opts[:prefixall] + x }.join
     return opts[:prefix] + out
   end
 
@@ -66,19 +77,23 @@ class String
   # 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+.
+  #   string. Example of values: `0x`, `\x`.
+  # @option opts [String] :prefixall Prefix each byte. Default value is a void
+  #   string. Example of value: `\\x`.
+  # @option opts [Symbol] :case Char case of the output. Default value `:lower`.
+  #   Other valid value `:upper`.
   # @option opts [Symbol] :nibble Display output with high nibble first
-  #   (+:high+ default) or low nibble first (+:low+).
+  #   (`: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"
+  #   'noraj'.to_hex(prefixall: '\\x') # => "\\x6e\\x6f\\x72\\x61\\x6a"
   def to_hex(opts = {})
     opts[:prefix] ||= ''
+    opts[:prefixall] ||= ''
     opts[:case] ||= :lower
     opts[:nibble] ||= :high
     # convert
@@ -92,6 +107,7 @@ class String
     # char case management
     out = out.upcase if opts[:case] == :upper
     # adding prefix must be done after case change
+    out = out.scan(/.{2}/).map { |x| opts[:prefixall] + x }.join
     return opts[:prefix] + out
   end
 
@@ -118,19 +134,20 @@ class String
   # 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+.
+  #   string. Example of values: `0x`, `\x`, `\\x`.
   # @option opts [Symbol] :nibble Display input with high nibble first
-  #   (+:high+ default) or low nibble first (+:low+).
+  #   (`: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"
+  #   '\\x6e\\x6f\\x72\\x61\\x6a'.from_hex(prefix: '\\x') # => "noraj"
   def from_hex(opts = {})
     opts[:prefix] ||= ''
     opts[:nibble] ||= :high
     # remove prefix
-    out = sub(opts[:prefix], '')
+    out = gsub(opts[:prefix], '')
     # convert
     return Array(out).pack('H*') if opts[:nibble] == :high
     return Array(out).pack('h*') if opts[:nibble] == :low
@@ -161,15 +178,16 @@ class String
   # Encode an hexadecimal string to a binary 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+.
+  #   string. Example of values: `0x`, `\x`, `\\x`.
   # @return [String] the binary encoded string
   # @example
   #   'ab'.hex2bin # => "10101011"
   #   '\xf3'.hex2bin(prefix: '\x') # => "11110011"
+  #   '\\x6e\\x6f\\x72\\x61\\x6a'.hex2bin(prefix: '\\x') # => "110111001101111011100100110000101101010"
   def hex2bin(opts = {})
     opts[:prefix] ||= ''
     # remove prefix
-    out = sub(opts[:prefix], '')
+    out = gsub(opts[:prefix], '')
     # convert
     return out.to_i(16).to_s(2)
   end
@@ -187,21 +205,26 @@ class String
   # Encode an binary 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+.
+  #   string. Example of values: `0x`, `\x`.
+  # @option opts [String] :prefixall Prefix each byte. Default value is a void
+  #   string. Example of value: `\\x`.
+  # @option opts [Symbol] :case Char case of the output. Default value `:lower`.
+  #   Other valid value `:upper`.
   # @return [String] the hexadecimal encoded string
   # @example
   #   '11110011'.bin2hex # => "f3"
   #   '11110011'.bin2hex({prefix: '0x', case: :upper}) # => "0xF3"
+  #   '0110111001101111011100100110000101101010'.bin2hex(prefixall: '\\x') # => "\\x6e\\x6f\\x72\\x61\\x6a"
   def bin2hex(opts = {})
     opts[:prefix] ||= ''
+    opts[:prefixall] ||= ''
     opts[:case] ||= :lower
     # convert
     out = to_i(2).to_s(16)
     # char case management
     out = out.upcase if opts[:case] == :upper
     # adding prefix must be done after case change
+    out = out.scan(/.{2}/).map { |x| opts[:prefixall] + x }.join
     return opts[:prefix] + out
   end
 
@@ -218,18 +241,19 @@ class String
   # Decode a hexadecimal IP string into a dotted decimal one
   # @param opts [Hash] optional parameters
   # @option opts [String] :prefix Prefix of the input. Default value is a void
-  #   string. Example of values: +0x+, +\x+.
+  #   string. Example of values: `0x`, `\x`, '\\x'.
   # @option opts [Symbol] :nibble Display input with high nibble first
-  #   (+:high+ default) or low nibble first (+:low+, used on Unix +/proc/net/tcp+).
+  #   (`:high` default) or low nibble first (`:low`, used on Unix `/proc/net/tcp`).
   # @return [String] the dotted decimal IP
   # @example
   #   '0100007F'.from_hexip(nibble: :low) # => "127.0.0.1"
   #   '0x7f000001'.from_hexip(prefix: '0x') # => "127.0.0.1"
+  #   '\\x7f\\x00\\x00\\x01'.from_hexip(prefix: '\\x') # => "127.0.0.1"
   def from_hexip(opts = {})
     opts[:prefix] ||= ''
     opts[:nibble] ||= :high
     # remove prefix
-    out = sub(opts[:prefix], '')
+    out = gsub(opts[:prefix], '')
     # convert
     out = out.scan(/.{2}/).map(&:hex2dec)
     out = out.reverse if opts[:nibble] == :low
@@ -245,17 +269,21 @@ class String
   # Encode a dotted decimal IP into a hexadecimal one
   # @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+.
+  #   string. Example of values: `0x`, `\x`.
+  # @option opts [String] :prefixall Prefix each byte. Default value is a void
+  #   string. Example of value: `\\x`.
+  # @option opts [Symbol] :case Char case of the output. Default value `:lower`.
+  #   Other valid value `:upper`.
   # @option opts [Symbol] :nibble Display output with high nibble first
-  #   (+:high+ default) or low nibble first (+:low+, used on Unix +/proc/net/tcp+).
+  #   (`:high` default) or low nibble first (`:low`, used on Unix `/proc/net/tcp`).
   # @return [String] the hexadecimal encoded IP
   # @example
   #   '127.0.0.1'.to_hexip # => "7f000001"
   #   '127.0.0.1'.to_hexip(nibble: :low) # => "0100007f"
+  #   '127.0.0.1'.to_hexip(prefixall: '\\x') # => "\\x7f\\x00\\x00\\x01"
   def to_hexip(opts = {})
     opts[:prefix] ||= ''
+    opts[:prefixall] ||= ''
     opts[:case] ||= :lower
     opts[:nibble] ||= :high
     # convert
@@ -265,6 +293,7 @@ class String
     # char case management
     out = out.upcase if opts[:case] == :upper
     # adding prefix must be done after case change
+    out = out.scan(/.{2}/).map { |x| opts[:prefixall] + x }.join
     return opts[:prefix] + out
   end
 

data/lib/ctf_party/misc.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class String
+  # Remove leading and trailing whitespace (like {String#strip}) but also all
+  # inner whitespace.
+  # @return [String] the whitespace-free string
+  # @example
+  #   "\t\n\v\f\r Hello \t\n\v\f\r World !\t\n\v\f\r ".istrip # => "HelloWorld!"
+  #   '73 74 72 69 70'.istrip # => "7374726970"
+  def istrip
+    strip.gsub(/\s/, '')
+  end
+
+  # Remove all whitespace in place as described for {String#istrip}.
+  def istrip!
+    replace(innerstrip)
+  end
+end

data/lib/ctf_party/rot.rb

@@ -2,7 +2,7 @@
 
 class String
   # "Encrypt / Decrypt" the string with Caesar cipher. This will shift the
-  # alphabet letters by +n+, where +n+ is the integer key. The same function
+  # alphabet letters by `n`, where `n` is the integer key. The same function
   # is used for encryption / decryption.
   # @param opts [Hash] optional parameters
   # @option opts [Integer] :shift The shift key. Default value: 13.
@@ -16,9 +16,9 @@ class String
   def rot(opts = {})
     opts[:shift] ||= 13
     alphabet = Array('a'..'z')
-    lowercase = Hash[alphabet.zip(alphabet.rotate(opts[:shift]))]
+    lowercase = alphabet.zip(alphabet.rotate(opts[:shift])).to_h
     alphabet = Array('A'..'Z')
-    uppercasecase = Hash[alphabet.zip(alphabet.rotate(opts[:shift]))]
+    uppercasecase = alphabet.zip(alphabet.rotate(opts[:shift])).to_h
     encrypter = lowercase.merge(uppercasecase)
     chars.map { |c| encrypter.fetch(c, c) }.join
   end
@@ -35,13 +35,22 @@ class String
     replace(rot(opts))
   end
 
-  # Alias for {String#rot} with default value ( +rot(shift: 13)+ ).
+  # Alias for {String#rot} with default value ( `rot(shift: 13)` ).
   def rot13
     rot
   end
 
-  # Alias for {String#rot!} with default value ( +rot!(shift: 13)+ ).
+  # Alias for {String#rot!} with default value ( `rot!(shift: 13)` ).
   def rot13!
     rot!
   end
+
+  # Compute all possibilities with {String#rot}
+  # @return [Hash] All possibilities with the shift index as key and the
+  #   (de)ciphered text as value
+  # @example
+  #   'noraj'.rot_all # => {1=>"opsbk", 2=>"pqtcl", 3=>"qrudm", ... }
+  def rot_all
+    (1..26).each_with_object({}) { |i, h| h[i] = rot(shift: i) }
+  end
 end

data/lib/ctf_party/version.rb

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

data/lib/ctf_party/xor.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+class String
+  # UTF-8 XOR with key, padding left the shortest element
+  # @param key [String] the element to xor the string with
+  # @return [String] the xored string (UTF-8)
+  # @example
+  #   'hello'.ulxor('key') # => "he\a\t\u0016"
+  #   'key'.ulxor('hello') # => "he\a\t\u0016"
+  def ulxor(key)
+    b1 = unpack('U*')
+    b2 = key.unpack('U*')
+    longest = [b1.length, b2.length].max
+    b1 = ([0] * (longest - b1.length)) + b1
+    b2 = ([0] * (longest - b2.length)) + b2
+    b1.zip(b2).map { |a, b| a ^ b }.pack('U*')
+  end
+
+  # UTF-8 XOR with key (padding left) in place as described for {String#ulxor}.
+  def ulxor!(key)
+    replace(ulxor(key))
+  end
+
+  # ASCII XOR with key, padding left the shortest element
+  # @param key [String] the element to xor the string with
+  # @return [String] the xored string (ASCII)
+  # @example
+  #   'hello'.alxor('key') # => "he\a\t\x16"
+  #   'key'.alxor('hello') # => "he\a\t\x16"
+  def alxor(key)
+    b1 = force_encoding('UTF-8')
+    b2 = key.force_encoding('UTF-8')
+    raise 'The string is not ASCII' unless b1.ascii_only?
+    raise 'The key is not ASCII' unless b2.ascii_only?
+
+    b1 = b1.chars.map(&:ord)
+    b2 = b2.chars.map(&:ord)
+    longest = [b1.length, b2.length].max
+    b1 = ([0] * (longest - b1.length)) + b1
+    b2 = ([0] * (longest - b2.length)) + b2
+    b1.zip(b2).map { |a, b| (a ^ b).chr }.join
+  end
+
+  # ASCII XOR with key (padding left) in place as described for {String#alxor}.
+  def alxor!(key)
+    replace(alxor(key))
+  end
+
+  # UTF-8 XOR with key, padding right the shortest element
+  # @param key [String] the element to xor the string with
+  # @return [String] the xored string (UTF-8)
+  # @example
+  #   'hello'.urxor('key') # => "\u0003\u0000\u0015lo"
+  #   'key'.urxor('hello') # => "\u0003\u0000\u0015lo"
+  def urxor(key)
+    b1 = unpack('U*')
+    b2 = key.unpack('U*')
+    longest = [b1.length, b2.length].max
+    b1 += [0] * (longest - b1.length)
+    b2 += [0] * (longest - b2.length)
+    b1.zip(b2).map { |a, b| a ^ b }.pack('U*')
+  end
+
+  # UTF-8 XOR with key (padding right) in place as described for {String#urxor}.
+  def urxor!(key)
+    replace(urxor(key))
+  end
+
+  # ASCII XOR with key, padding right the shortest element
+  # @param key [String] the element to xor the string with
+  # @return [String] the xored string (ASCII)
+  # @example
+  #   'hello'.arxor('key') # => "\x03\x00\x15lo"
+  #   'key'.arxor('hello') # => "\x03\x00\x15lo"
+  def arxor(key)
+    b1 = force_encoding('UTF-8')
+    b2 = key.force_encoding('UTF-8')
+    raise 'The string is not ASCII' unless b1.ascii_only?
+    raise 'The key is not ASCII' unless b2.ascii_only?
+
+    b1 = b1.chars.map(&:ord)
+    b2 = b2.chars.map(&:ord)
+    longest = [b1.length, b2.length].max
+    b1 += [0] * (longest - b1.length)
+    b2 += [0] * (longest - b2.length)
+    b1.zip(b2).map { |a, b| (a ^ b).chr }.join
+  end
+
+  # ASCII XOR with key (padding right) in place as described for {String#arxor}.
+  def arxor!(key)
+    replace(arxor(key))
+  end
+end

data/lib/ctf_party.rb

@@ -11,3 +11,5 @@ require 'ctf_party/cgi'
 require 'ctf_party/binary'
 require 'ctf_party/leet'
 require 'ctf_party/dec'
+require 'ctf_party/misc'
+require 'ctf_party/xor'

metadata

@@ -1,152 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: ctf-party
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexandre ZANNI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: commonmarker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: github-markup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: minitest-skip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-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.
+        version: '0.6'
+description: A CLI tool & library to enhance and speed up script/exploit writing for
+  CTF players (or security researchers, bug bounty hunters, pentesters but mostly
+  focused on CTF) by patching the String class to add a short syntax of usual code
+  patterns. Methods for base64, digest (hash), flag, rot (Caesar), hexadecimal, case,
+  cgi (URL encoding/decoding, HTML escaping/unescaping), binary, leet (1337), decimal,
+  XOR, whitespace strip.
 email: alexandre.zanni@engineer.com
 executables:
-- ctf_party_console
+- ctf-party
+- ctf-party_console
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
-- bin/ctf_party_console
+- bin/ctf-party
+- bin/ctf-party_console
 - lib/ctf_party.rb
 - lib/ctf_party/base64.rb
 - lib/ctf_party/binary.rb
@@ -157,8 +50,10 @@ files:
 - lib/ctf_party/flag.rb
 - lib/ctf_party/hex.rb
 - lib/ctf_party/leet.rb
+- lib/ctf_party/misc.rb
 - lib/ctf_party/rot.rb
 - lib/ctf_party/version.rb
+- lib/ctf_party/xor.rb
 homepage: https://noraj.github.io/ctf-party/
 licenses:
 - MIT
@@ -169,23 +64,28 @@ metadata:
   documentation_uri: https://noraj.github.io/ctf-party/
   homepage_uri: https://noraj.github.io/ctf-party/
   source_code_uri: https://github.com/noraj/ctf-party/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: A library to enhance and speed up script/exploit writing for CTF players
+summary: A CLI tool & library to enhance and speed up script/exploit writing with
+  string conversion/manipulation
 test_files: []