ronin-support 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a9cca292661aabc9b8b8360bef73af12a140bac7b80bbe969671a78d5c4cb8
-  data.tar.gz: cb8920fa647c56bcf03c9a4b5796f6e58fd732d82ea79027bce10d77246f1af6
+  metadata.gz: 3f47bb5e6e9e8b720f2b2e66cfd1eb49bcb4562e5ed0025a3ed491ee7e39f106
+  data.tar.gz: a68c5f263d3d7caf40f789354e51a977ada25c52cb7a93f58c4c10208c40da67
 SHA512:
-  metadata.gz: '04831026ac5813990e5db208ac229f707f24cfb0bcff277ff0da70eecdce58b379925ed944b5377ead08ac63f7e6fce0a323bcfe05a4a617a6d0cfa5987ec90b'
-  data.tar.gz: ed25a967fe35242afdb9a9d2e3dc8dff096de0e7737494100b6a54c96f67c4288d2ff21ab2e6eadce4f07fe6284037e454e37498ae1b108dfeda024b115bf26b
+  metadata.gz: 302af7c9324ba08daff8107236734c211b10f969723f55cac2843ec52a5e367357c1b3c06d4138215553960a994ae4c3338e3a4302105979fedb1dac51b2cc20
+  data.tar.gz: 542b8b0d1caab51fce5fedf516b3b849c2a673492995916db6a43b3522090cd8bb1acc1b3200741832153e874522fcd60eae76f74e2aa90bb76d57dafb6daa1e

data/ChangeLog.md

@@ -1,3 +1,41 @@
+### 1.0.3 / 2023-09-19
+
+* {Ronin::Support::Crypto::Cert::Name#entries} now returns UTF-8 encoded
+  Strings.
+* {Ronin::Support::Crypto::Cert.Name} now passes through
+  {Ronin::Support::Crypto::Cert::Name} objects instead of copying them.
+* Fixed a bug in {Ronin::Support::Crypto::Cert.generate} when it is given a
+  `OpenSSL::PKey::EC` signing key.
+* Fixed a bug in {Ronin::Support::Network::SSL::Mixin#ssl_connect} where the
+  `OpenSSL::SSL::SSLSocket#hostname` attribute was not being set to the
+  host being connected to, which prevented connecting to TLS servers that use
+  SNI.
+* Fixed {Ronin::Support::Network::IP#set} to return `self`.
+* Fixed {Ronin::Support::Network::IP#inspect} to call the lazy-initialized
+  {Ronin::Support::Network::IP#address} method instead of the `@address`
+  instance variable directly.
+
+### 1.0.2 / 2023-06-09
+
+* Fixed a bug in {Ronin::Support::Encoding::Base32.decode},
+  {Ronin::Support::Encoding::Hex.unescape},
+  {Ronin::Support::Encoding::C.unescape},
+  {Ronin::Support::Encoding::JS.unescape},
+  {Ronin::Support::Encoding::PowerShell.unescape},
+  {Ronin::Support::Encoding::Ruby.unescape},
+  {Ronin::Support::Encoding::XML.unescape},
+  {Ronin::Support::Path#join}, {String#encode_bytes}, and {String#encode_chars}
+  where ASCII-bit Strings were always being returned instead of UTF-8 Strings.
+* Fixed a bug where {Ronin::Support::Network::IP#address} was being improperly
+  cached.
+* Added missing `require` for {File.tar}, {File.untar}, {File.zip}, and
+  {File.unzip} core-ext methods.
+* Added missing `require` for {Integer#pack} and {Float#pack} core-ext methods.
+* No longer include {Ronin::Support::Mixin} into {Kernel} which caused Mixin
+  methods to be included into *every* Class and object.
+* Added more example code to documentation.
+* Documentation fixes.
+
 ### 1.0.1 / 2023-03-01
 
 * {Ronin::Support::Network::HTTP.connect_uri} can now infer when to enable

data/README.md

@@ -8,7 +8,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-support/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-support/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description

data/lib/ronin/support/archive/core_ext/file.rb

@@ -38,6 +38,22 @@ class File
   # @return [Ronin::Support::Archive::Tar::Reader]
   #   The tar reader object.
   #
+  # @example Enumerating over each entry in the tar archive:
+  #   File.untar('file.tar') do |tar|
+  #     tar.each do |entry|
+  #       puts entry.full_name
+  #       puts '-' * 80
+  #       puts entry.read
+  #       puts '-' * 80
+  #     end
+  #   end
+  #
+  # @example Reads a specific file from the tar archive:
+  #   File.untar('file.tar') do |tar|
+  #     data = tar.read('foo.txt')
+  #     # ...
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0
@@ -61,6 +77,12 @@ class File
   # @return [Ronin::Support::Archive::Tar::Writer]
   #   The tar writer object.
   #
+  # @example
+  #   File.tar('output.tar') do |tar|
+  #     tar.mkdir('foo')
+  #     tar.add_file('foo/bar.txt','Hello World!')
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0
@@ -84,6 +106,22 @@ class File
   # @return [Ronin::Support::Archive::Zip::Reader]
   #   The zip reader object.
   #
+  # @example Enumerating over each file in a zip archive:
+  #   File.unzip('file.zip') do |zip|
+  #     zip.each do |entry|
+  #       puts entry.name
+  #       puts '-' * 80
+  #       puts entry.read
+  #       puts '-' * 80
+  #     end
+  #   end
+  #
+  # @example Reads a specific file from a zip archive:
+  #   File.unzip('file.zip') do |zip|
+  #     data = zip.read('foo.txt')
+  #     # ...
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0
@@ -107,6 +145,11 @@ class File
   # @return [Ronin::Support::Archive::Zip::Writer]
   #   The zip writer object.
   #
+  # @example
+  #   File.zip('output.zip') do |zip|
+  #     zip.add_file('foo/bar.txt','Hello World!')
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0

data/lib/ronin/support/archive/core_ext.rb

@@ -16,4 +16,4 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/support/compression/core_ext/file'
+require 'ronin/support/archive/core_ext/file'

data/lib/ronin/support/binary/array.rb

@@ -35,7 +35,7 @@ module Ronin
       #
       # Creating an array of `int32`s:
       #
-      #     array = Binary::Array.new(:int32, 4)
+      #     array = Binary::Binary::Array.new(:int32, 4)
       #     # => #<Ronin::Support::Binary::Binary::Array: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00">
       #     array[0] = 0x11111111
       #     array[1] = 0x22222222

data/lib/ronin/support/binary/buffer.rb

@@ -30,7 +30,7 @@ module Ronin
       #
       # Writing bytes into an empty buffer:
       #
-      #     buffer = Buffer.new(10)
+      #     buffer = Binary::Buffer.new(10)
       #     # => #<Ronin::Support::Binary::Buffer: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00">
       #     buffer[0] = 0x41
       #     buffer[1] = 0x42
@@ -40,7 +40,7 @@ module Ronin
       #
       # Writing different types of data to a buffer:
       #
-      #     buffer = Buffer.new(16)
+      #     buffer = Binary::Buffer.new(16)
       #     # => #<Ronin::Support::Binary::Buffer: "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00">
       #     buffer.put_uint32(0,0x11223344)
       #     buffer.put_int32(4,-1)
@@ -51,7 +51,7 @@ module Ronin
       #
       # Creating a buffer from an existing String:
       #
-      #     buffer = Buffer.new("\x41\x00\x00\x00\x42\x00\x00\x00")
+      #     buffer = Binary::Buffer.new("\x41\x00\x00\x00\x42\x00\x00\x00")
       #     # => #<Ronin::Support::Binary::Buffer: "A\u0000\u0000\u0000B\u0000\u0000\u0000">
       #     buffer.get_uint32(0)
       #     # => 65

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

@@ -16,6 +16,8 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'ronin/support/binary/core_ext/integer'
+require 'ronin/support/binary/core_ext/float'
 require 'ronin/support/binary/core_ext/string'
 require 'ronin/support/binary/core_ext/array'
 require 'ronin/support/binary/core_ext/io'

data/lib/ronin/support/binary/cstring.rb

@@ -24,6 +24,49 @@ module Ronin
       #
       # Represents a null terminated C string.
       #
+      # ## Examples
+      #
+      # ### Initializing C Strings
+      #
+      # From a String:
+      #
+      #     str = Binary::CString.new("hello ")
+      #     # => #<Ronin::Support::Binary::CString:0x00007fc94ba577f8 @string="hello \u0000">
+      #
+      # From a binary C string:
+      #
+      #     str = Binary::CString.new("world\0".b)
+      #     # => #<Ronin::Support::Binary::CString:0x00007fc94ba06f88 @string="world\u0000">
+      #
+      # From characters:
+      #
+      #     str = Binary::CString['A', 'B', 'C']
+      #     # => #<Ronin::Support::Binary::CString:0x00007fc94ba6f268 @string="ABC\x00">
+      #
+      # ### Modifying C Strings
+      #
+      # Concating Strings to a C String:
+      #
+      #     str = Binary::CString.new("hello ")
+      #     str.concat("world")
+      #     # => #<Ronin::Support::Binary::CString:0x00007fc94b978df0 @string="hello world\u0000">
+      #     str.to_s
+      #     # => "hello world"
+      #
+      # Appending two C Strings:
+      #
+      #     str1 = Binary::CString.new("hello ")
+      #     str2 = Binary::CString.new("world\0")
+      #     str = str1 + str2
+      #     # => #<Ronin::Support::Binary::CString:0x00007fc94b9523f8 @string="hello world\u0000">
+      #
+      # Setting characters:
+      #
+      #     str = Binary::CString.new("hello")
+      #     str[0] = 'X'
+      #     str.to_s
+      #     # => "Xello"
+      #
       # @api public
       #
       # @since 1.0.0

data/lib/ronin/support/binary/ctypes/array_type.rb

@@ -152,7 +152,7 @@ module Ronin
             if @pack_string
               super(array)
             else
-              buffer = String.new("", encoding: Encoding::ASCII_8BIT)
+              buffer = String.new
 
               @length.times do |index|
                 value = array[index] || @type.uninitialized_value

data/lib/ronin/support/binary/ctypes/os/bsd.rb

@@ -33,7 +33,7 @@ module Ronin
           class BSD < UNIX
 
             #
-            # Initializes the FreeBSD types object.
+            # Initializes the common BSD types object.
             #
             # @param [#[]] types
             #   The base types module.

data/lib/ronin/support/binary/ctypes/unbounded_array_type.rb

@@ -149,7 +149,7 @@ module Ronin
             if @pack_string
               super(array)
             else
-              buffer = String.new('', encoding: Encoding::ASCII_8BIT)
+              buffer = String.new
 
               array.each do |element|
                 buffer << @type.pack(element)

data/lib/ronin/support/binary/packet.rb

@@ -24,6 +24,83 @@ module Ronin
       #
       # Represents a network packet in network byte-order.
       #
+      # ## Examples
+      #
+      # ### Defining Packet Fields
+      #
+      #     class Packet < Ronin::Support::Binary::Packet
+      #
+      #       member :flags,  :uint8
+      #       member :src,    :uint32
+      #       member :dst,    :uint32
+      #       member :length, :uint32
+      #
+      #     end
+      #
+      # ### Initializing Packets
+      #
+      # From a Hash:
+      #
+      #     packet = Packet.new(
+      #       flags:  0x0c,
+      #       src:    IPAddr.new('1.2.3.4').to_i,
+      #       dst:    IPAddr.new('5.6.7.8').to_i,
+      #       length: 1024
+      #     )
+      #
+      # From a buffer:
+      #
+      #     packet = Packet.unpack("\f\x01\x02\x03\x04\x05\x06\a\b\x00\x00\x04\x00")
+      #
+      # ### Reading Fields
+      #
+      #     packet = Packet.new("\f\x01\x02\x03\x04\x05\x06\a\b\x00\x00\x04\x00")
+      #     packet[:flags]
+      #     # => 12
+      #     packet.flags
+      #     # => 12
+      #
+      # ### Packing Packets
+      #
+      #     class Packet < Ronin::Support::Binary::Packet
+      #
+      #       member :flags,  :uint8
+      #       member :src,    :uint32
+      #       member :dst,    :uint32
+      #       member :length, :uint32
+      #
+      #     end
+      #
+      #     packet = Packet.new(
+      #       flags:  0x0c,
+      #       src:    IPAddr.new('1.2.3.4').to_i,
+      #       dst:    IPAddr.new('5.6.7.8').to_i,
+      #       length: 1024
+      #     )
+      #     packet.pack
+      #     # => "\f\x01\x02\x03\x04\x05\x06\a\b\x00\x00\x04\x00"
+      #
+      # ### Unpacking Packets
+      #
+      #     class Packet < Ronin::Support::Binary::Packet
+      #
+      #       member :flags,  :uint8
+      #       member :src,    :uint32
+      #       member :dst,    :uint32
+      #       member :length, :uint32
+      #
+      #     end
+      #
+      #     packet = Packet.unpack("\f\x01\x02\x03\x04\x05\x06\a\b\x00\x00\x04\x00")
+      #     packet.flags
+      #     # => 12
+      #     packet.src
+      #     # => 16909060
+      #     packet.dst
+      #     # => 84281096
+      #     packet.length
+      #     # => 1024
+      #
       class Packet < Binary::Struct
 
         platform endian: :net

data/lib/ronin/support/binary/stack.rb

@@ -36,7 +36,7 @@ module Ronin
       #
       # Creating a new stack:
       #
-      #     stack = Stack.new
+      #     stack = Binary::Stack.new
       #     # => #<Ronin::Support::Binary::Stack: "">
       #     stack.push 0x41414141
       #     # => #<Ronin::Support::Binary::Stack: "AAAA\x00\x00\x00\x00">
@@ -49,7 +49,7 @@ module Ronin
       #
       # Creating a stack from an existing String:
       #
-      #     stack = Stack.new("\x41\x00\x00\x00\x00\x00\x00\x00\x42\x00\x00\x00\x00\x00\x00\x00")
+      #     stack = Binary::Stack.new("\x41\x00\x00\x00\x00\x00\x00\x00\x42\x00\x00\x00\x00\x00\x00\x00")
       #     stack[0]
       #     # => 65
       #     stack[8]
@@ -125,7 +125,7 @@ module Ronin
             @size   = @string.bytesize
             @length = @size / @machine_word.size
           else
-            @string = String.new("", encoding: Encoding::ASCII_8BIT)
+            @string = String.new
             @size   = 0
             @length = 0
           end

data/lib/ronin/support/binary/template.rb

@@ -36,10 +36,6 @@ module Ronin
       # * `:int16` - signed 16-bit integer.
       # * `:int32` - signed 32-bit integer.
       # * `:int64` - signed 64-bit integer.
-      # * `:uint16_le` - unsigned 16-bit integer, little endian.
-      # * `:uint32_le` - unsigned 32-bit integer, little endian.
-      # * `:uint16_be` - unsigned 16-bit integer, big endian.
-      # * `:uint32_be` - unsigned 32-bit integer, big endian.
       # * `:uchar` - unsigned character.
       # * `:ushort` - unsigned short integer, native endian.
       # * `:uint` - unsigned integer, native endian.
@@ -209,7 +205,7 @@ module Ronin
 
             values.pack(@pack_string)
           else
-            buffer = String.new('', encoding: Encoding::ASCII_8BIT)
+            buffer = String.new
 
             @types.each do |type|
               # shift off the next value and pack it

data/lib/ronin/support/binary.rb

@@ -19,6 +19,7 @@
 require 'ronin/support/binary/core_ext'
 require 'ronin/support/binary/template'
 require 'ronin/support/binary/buffer'
+require 'ronin/support/binary/cstring'
 require 'ronin/support/binary/array'
 require 'ronin/support/binary/stack'
 require 'ronin/support/binary/struct'

data/lib/ronin/support/cli/io_shell.rb

@@ -26,6 +26,8 @@ module Ronin
       #
       # ## Example
       #
+      #     require 'ronin/support/cli/io_shell'
+      #
       #     socket = TCPSocket.new('irc.undernet.org',6667)
       #     CLI::IOShell.sstart(socket)
       #

data/lib/ronin/support/compression/core_ext/file.rb

@@ -36,6 +36,13 @@ class File
   # @return [Ronin::Support::Compression::Gzip::Reader]
   #   The gzip reader object.
   #
+  # @example
+  #   File.gunzip('wordlist.gz') do |gz|
+  #     gz.each_line do |line|
+  #       # ...
+  #     end
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0
@@ -59,6 +66,15 @@ class File
   # @return [Ronin::Support::Compression::Gzip::Writer]
   #   The gzip writer object.
   #
+  # @example
+  #   File.gunzip('file.gz') do |gz|
+  #     # gzip header info
+  #     gz.mtime = Time.now
+  #     gz.orig_name = 'file.txt'
+  #
+  #     gz.write('Hello World!')
+  #   end
+  #
   # @api public
   #
   # @since 1.0.0

data/lib/ronin/support/core_ext/kernel.rb

@@ -16,11 +16,7 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/support/mixin'
-
 module Kernel
-  include Ronin::Support::Mixin
-
   #
   # Calls the given block and ignores any raised exceptions.
   #

data/lib/ronin/support/crypto/cert.rb

@@ -18,6 +18,7 @@
 
 require 'ronin/support/crypto/openssl'
 require 'ronin/support/crypto/key/rsa'
+require 'ronin/support/crypto/key/ec'
 
 module Ronin
   module Support
@@ -83,7 +84,9 @@ module Ronin
           # @return [Hash{String => String}]
           #
           def entries
-            @entries ||= to_a.to_h { |(oid,value,type)| [oid, value] }
+            @entries ||= to_a.to_h do |(oid,value,type)|
+              [oid, value && value.force_encoding(Encoding::UTF_8)]
+            end
           end
 
           alias to_h entries
@@ -160,7 +163,7 @@ module Ronin
         #
         # Coerces a value into a {Name} object.
         #
-        # @param [String, Hash, OpenSSL::X509::Name] name
+        # @param [String, Hash, OpenSSL::X509::Name, Name] name
         #   The name value to coerce.
         #
         # @return [Cert::Name]
@@ -170,8 +173,9 @@ module Ronin
         #
         def self.Name(name)
           case name
-          when String              then Name.parse(name)
-          when Hash                then Name.build(**name)
+          when String then Name.parse(name)
+          when Hash   then Name.build(**name)
+          when Name   then name
           when OpenSSL::X509::Name
             new_name = Name.allocate
             new_name.send(:initialize_copy,name)
@@ -269,7 +273,7 @@ module Ronin
         #     key: key,
         #     subject: {
         #       common_name:         'localhost',
-        #       organization:        'Test Co..',
+        #       organization:        'Test Co.',
         #       organizational_unit: 'Test Dept',
         #       locality:            'Test City',
         #       state:               'XX',
@@ -288,7 +292,7 @@ module Ronin
         #     key: ca_key,
         #     subject: {
         #       common_name:         'Test CA',
-        #       organization:        'Test CA, Inc..',
+        #       organization:        'Test CA, Inc.',
         #       organizational_unit: 'Test Dept',
         #       locality:            'Test City',
         #       state:               'XX',
@@ -309,7 +313,7 @@ module Ronin
         #     ca_cert: ca_cert,
         #     subject: {
         #       common_name:         'test.com',
-        #       organization:        'Test Co..',
+        #       organization:        'Test Co.',
         #       organizational_unit: 'Test Dept',
         #       locality:            'Test City',
         #       state:               'XX',
@@ -343,7 +347,10 @@ module Ronin
 
           cert.not_before = not_before
           cert.not_after  = not_after
-          cert.public_key = key.public_key
+          cert.public_key = case key
+                            when OpenSSL::PKey::EC then key
+                            else                        key.public_key
+                            end
           cert.subject    = Name(subject) if subject
           cert.issuer     = if ca_cert then ca_cert.subject
                             else            cert.subject
@@ -491,7 +498,7 @@ module Ronin
       #
       # Coerces a value into a {Cert} object.
       #
-      # @param [String, OpenSSL::X509::Certificate] cert
+      # @param [String, OpenSSL::X509::Certificate, Cert] cert
       #   The certificate String or `OpenSSL::X509::Certificate` value.
       #
       # @return [Cert]
@@ -505,6 +512,7 @@ module Ronin
       def self.Cert(cert)
         case cert
         when String then Cert.parse(cert)
+        when Cert   then cert
         when OpenSSL::X509::Certificate
           new_cert = Cert.allocate
           new_cert.send(:initialize_copy,cert)

data/lib/ronin/support/crypto/core_ext/file.rb

@@ -224,6 +224,10 @@ class File
   # @return [String]
   #   The encrypted data.
   #
+  # @example
+  #   File.encrypt('file.txt', 'aes-256-cbc', password: 's3cr3t')
+  #   # => "..."
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -281,6 +285,10 @@ class File
   # @return [String]
   #   The decrypted data.
   #
+  # @example
+  #   File.decrypt('encrypted.bin', 'aes-256-cbc', password: 's3cr3t')
+  #   # => "..."
+  #
   # @see http://rubydoc.info/stdlib/openssl/OpenSSL/Cipher
   #
   # @since 0.6.0
@@ -338,6 +346,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes_encrypt('file.txt', key_size: 256, password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -390,6 +402,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes_decrypt('encrypted.bin', key_size: 256, password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -439,6 +455,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes128_encrypt('file.txt', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes128_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -488,6 +508,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_decrypt('encrypted.bin', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes128_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -537,6 +561,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_encrypt('file.txt', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes256_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
@@ -586,6 +614,10 @@ class File
   # @raise [ArgumentError]
   #   Either the the `key:` or `password:` keyword argument must be given.
   #
+  # @example
+  #   File.aes256_decrypt('encrypted.bin', password: 's3cr3t')
+  #   # => "..."
+  #
   # @since 1.0.0
   #
   def self.aes256_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)