Added missing examples for File.aes256_encrypt and `File.aes256_dec…

…rypt`.
ronin-rb · Jun 9, 2023 · f3cc768 · f3cc768
1 parent 66278dc
commit f3cc768
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/ronin/support/crypto/core_ext/file.rb b/lib/ronin/support/crypto/core_ext/file.rb
@@ -561,6 +561,10 @@ def self.aes128_decrypt(path, block_size: 16384, output: nil, **kwargs,&block)
   # @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)
@@ -610,6 +614,10 @@ def self.aes256_encrypt(path, block_size: 16384, output: nil, **kwargs,&block)
   # @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)