# frozen_string_literal: true
#
# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# Ronin Support is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin Support is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
#

require 'ronin/support/crypto'

require 'digest'

class File

  #
  # Calculates the MD5 checksum of a file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @return [String]
  #   The MD5 checksum of the file.
  #
  # @example
  #   File.md5('data.txt')
  #   # => "5d41402abc4b2a76b9719d911017c592"
  #
  # @api public
  #
  def self.md5(path)
    Digest::MD5.file(path).hexdigest
  end

  #
  # Calculates the SHA1 checksum of a file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @return [String]
  #   The SHA1 checksum of the file.
  #
  # @example
  #   File.sha1('data.txt')
  #   # => "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"
  #
  # @api public
  #
  def self.sha1(path)
    Digest::SHA1.file(path).hexdigest
  end

  #
  # @see File.sha1
  #
  # @api public
  #
  def self.sha128(path)
    File.sha1(path)
  end

  #
  # Calculates the SHA256 checksum of a file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @return [String]
  #   The SHA256 checksum of the file.
  #
  # @example
  #   File.sha256('data.txt')
  #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
  #
  # @api public
  #
  def self.sha256(path)
    Digest::SHA256.file(path).hexdigest
  end

  #
  # @see File.sha256
  #
  # @api public
  #
  def self.sha2(path)
    File.sha256(path)
  end

  #
  # Calculates the SHA512 checksum of a file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @return [String]
  #   The SHA512 checksum of the file.
  #
  # @example
  #   File.sha512('data.txt')
  #   # => "9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043"
  #
  # @api public
  #
  def self.sha512(path)
    Digest::SHA512.file(path).hexdigest
  end

  #
  # @see File.sha512
  #
  # @api public
  #
  def self.sha5(path)
    File.sha512(path)
  end

  #
  # Calculates the RMD160 checksum for the File.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @return [String]
  #   The RMD160 checksum of the File.
  #
  # @example
  #   File.rmd160('data.txt')
  #   # => "108f07b8382412612c048d07d13f814118445acd"
  #
  # @api public
  #
  # @since 0.6.0
  #
  # @note JRuby and TruffleRuby do not yet support RMD160.
  #
  def self.rmd160(path)
    Digest::RMD160.file(path).hexdigest
  end

  #
  # Calculates the HMAC for a file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [String] key
  #   The secret key for the HMAC.
  #
  # @param [Symbol] digest
  #   The digest algorithm for the HMAC.
  #
  # @return [String]
  #   The hex-encoded HMAC for the String.
  #
  # @see Ronin::Support::Crypt.hmac
  #
  # @since 0.6.0
  #
  # @api public
  #
  def self.hmac(path, key: , digest: :sha1)
    hmac = Ronin::Support::Crypto.hmac(key: key, digest: digest)

    File.open(path,'rb') do |file|
      until file.eof?
        hmac.update(file.read(16384))
      end
    end

    return hmac.hexdigest
  end

  #
  # Encrypts the file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [String] cipher
  #   The cipher to use.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the encrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.cipher}.
  #
  # @option kwargs [Symbol] :hash (:sha1)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @yield [block]
  #   If a block is given, each encrypted block will be passed to it.
  #
  # @yieldparam [String] block
  #   An encrypted block from the 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
  #
  # @api public
  #
  def self.encrypt(path,cipher, block_size: 16384, output: nil, **kwargs,&block)
    cipher = Ronin::Support::Crypto.cipher(cipher, direction: :encrypt,
                                                   **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Decrypts the file.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [String] cipher
  #   The cipher to use.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the decrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.cipher}.
  #
  # @option kwargs [Symbol] :hash (:sha1)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @yield [block]
  #   If a block is given, each encrypted block will be passed to it.
  #
  # @yieldparam [String] block
  #   An encrypted block from the 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
  #
  # @api public
  #
  def self.decrypt(path,cipher, block_size: 16384, output: nil, **kwargs,&block)
    cipher = Ronin::Support::Crypto.cipher(cipher, direction: :decrypt,
                                                   **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Encrypts the file using AES.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES encrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes_cipher}.
  #
  # @option kwargs [Integer] :key_size
  #   The desired key size in bits.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:sha256)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes_cipher(direction: :encrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Decrypts the file using AES.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES decrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes_cipher}.
  #
  # @option kwargs [Integer] :key_size
  #   The desired key size in bits.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:sha256)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes_cipher(direction: :decrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Encrypts the file using AES-128.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES encrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes128_cipher}.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:md5)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes128_cipher(direction: :encrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Decrypts the file using AES-128.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES decrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes128_cipher}.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:md5)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes128_cipher(direction: :decrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Encrypts the file using AES-256.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES encrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes256_cipher}.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:sha256)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes256_cipher(direction: :encrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Decrypts the file using AES-256.
  #
  # @param [String] path
  #   The path to the file.
  #
  # @param [Integer] block_size
  #   Reads data from the file in chunks of the given block size.
  #
  # @param [String, #<<, nil] output
  #   The optional output buffer to append the AES decrypted data to.
  #   Defaults to an empty ASCII 8bit encoded String.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.aes256_cipher}.
  #
  # @option kwargs [:cbc, :cfb, :ofb, :ctr, Symbol] mode (:cbc)
  #   The desired AES cipher mode.
  #
  # @option kwargs [Symbol] :hash (:sha256)
  #   The algorithm to hash the `:password`.
  #
  # @option kwargs [String] :key
  #   The secret key to use.
  #
  # @option kwargs [String] :password
  #   The password for the cipher.
  #
  # @option kwargs [String] :iv
  #   The optional Initial Vector (IV).
  #
  # @option kwargs [Integer] :padding
  #   Sets the padding for the cipher.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @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)
    cipher = Ronin::Support::Crypto.aes256_cipher(direction: :decrypt, **kwargs)
    file   = File.open(path,'rb')

    return cipher.stream(file, block_size: block_size, output: output,&block)
  end

  #
  # Encrypts the file using the given RSA key.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.rsa_encrypt}.
  #
  # @option kwargs [String, nil] :key
  #   The PEM or DER encoded RSA key string.
  #
  # @option kwargs [String, nil] :key_file
  #   The path to the PEM or DER encoded RSA key file.
  #
  # @option kwargs [String, nil] :key_password
  #   The optional password to decrypt the encrypted RSA key.
  #
  # @option kwargs [:pkcs1_oaep, :pkcs1, :sslv23,
  #                 nil, false] :padding (:pkcs1)
  #   Optional padding mode. `nil` and `false` will disable padding.
  #
  # @return [String]
  #   The encrypted data.
  #
  # @raise [ArgumentError]
  #   Either the `key:` or `key_file:` keyword argument must be given.
  #
  # @since 1.0.0
  #
  def self.rsa_encrypt(path,**kwargs)
    Ronin::Support::Crypto.rsa_encrypt(File.binread(path),**kwargs)
  end

  #
  # Decrypts the file using the given RSA key.
  #
  # @param [Hash{Symbol => Object}] kwargs
  #   Additional keyword arguments for {Ronin::Support::Crypto.rsa_decrypt}.
  #
  # @option kwargs [String, nil] :key
  #   The PEM or DER encoded RSA key string.
  #
  # @option kwargs [String, nil] :key_file
  #   The path to the PEM or DER encoded RSA key file.
  #
  # @option kwargs [String, nil] :key_password
  #   The optional password to decrypt the encrypted RSA key.
  #
  # @option kwargs [:pkcs1_oaep, :pkcs1, :sslv23,
  #                 nil, false] :padding (:pkcs1)
  #   Optional padding mode. `nil` and `false` will disable padding.
  #
  # @return [String]
  #   The decrypted data.
  #
  # @raise [ArgumentError]
  #   Either the `key:` or `key_file:` keyword argument must be given.
  #
  # @since 1.0.0
  #
  def self.rsa_decrypt(path,**kwargs)
    Ronin::Support::Crypto.rsa_decrypt(File.binread(path),**kwargs)
  end

end