Module: Ronin::Support::Crypto::Mixin

Included in:

Mixin

Defined in:

lib/ronin/support/crypto/mixin.rb

Overview

Provides helper methods for cryptographic functions.

Since:

• 1.0.0

Instance Method Summary

• #crypto_aes128_cipher(**kwargs) ⇒ Cipher::AES (also: #aes128_cipher)

  Creates a new AES-128 cipher.

• #crypto_aes128_decrypt(data, **kwargs) ⇒ String (also: #aes128_decrypt)

  Decrypts data using AES-128.

• #crypto_aes128_encrypt(data, **kwargs) ⇒ String (also: #aes128_encrypt)

  Encrypts data using AES-128.

• #crypto_aes256_cipher(**kwargs) ⇒ Cipher::AES (also: #aes256_cipher)

  Creates a new AES-256 cipher.

• #crypto_aes256_decrypt(data, **kwargs) ⇒ String (also: #aes256_decrypt)

  Decrypts data using AES-256.

• #crypto_aes256_encrypt(data, **kwargs) ⇒ String (also: #aes256_encrypt)

  Encrypts data using AES-256.

• #crypto_aes_cipher(**kwargs) ⇒ Cipher::AES (also: #aes_cipher)

  Creates a new AES cipher.

• #crypto_aes_decrypt(data, **kwargs) ⇒ String (also: #aes_decrypt)

  Decrypts data using AES.

• #crypto_aes_encrypt(data, **kwargs) ⇒ String (also: #aes_encrypt)

  Encrypts data using AES.

• #crypto_cipher(name, **kwargs) ⇒ OpenSSL::Cipher (also: #cipher)

  Creates a cipher.

• #crypto_decrypt(data, cipher:, **kwargs) ⇒ String (also: #decrypt)

  Decrypts data using the cipher.

• #crypto_digest(name) ⇒ OpenSSL::Digest (also: #digest)

  Looks up a digest.

• #crypto_encrypt(data, cipher:, **kwargs) ⇒ String (also: #encrypt)

  Encrypts data using the cipher.

• #crypto_hmac(data = nil, key:, digest: :sha1) ⇒ String (also: #hmac)

  Creates a new HMAC.

• #crypto_rsa_decrypt(data, **kwargs) ⇒ String (also: #rsa_decrypt)

  Decrypts the given data using the given RSA key.

• #crypto_rsa_encrypt(data, **kwargs) ⇒ String (also: #rsa_encrypt)

  Encrypts the given data using the given RSA key.

Instance Method Details

#crypto_aes128_cipher(**kwargs) ⇒ Cipher::AES Also known as: aes128_cipher

Creates a new AES-128 cipher.

Examples:

Crypto.aes128_cipher(direction: :encrypt, password: 's3cr3t')
# => #<Ronin::Support::Crypto::Cipher::AES128:0x00007f8bde789648 @key_size=128, @mode=:cbc>

Parameters:

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Cipher::AES128#initialize.

Options Hash (**kwargs):

• :mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :md5 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (Cipher::AES) —

  The new AES cipher.

See Also:

• Ronin::Support::Crypto.aes128_cipher

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 371

def crypto_aes128_cipher(**kwargs)
  Crypto.aes128_cipher(**kwargs)
end

#crypto_aes128_decrypt(data, **kwargs) ⇒ String Also known as: aes128_decrypt

Decrypts data using AES-128.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes128_cipher.

Options Hash (**kwargs):

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :md5 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes128_decrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 453

def crypto_aes128_decrypt(data,**kwargs)
  Crypto.aes128_decrypt(data,**kwargs)
end

#crypto_aes128_encrypt(data, **kwargs) ⇒ String Also known as: aes128_encrypt

Encrypts data using AES-128.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes128_cipher.

Options Hash (**kwargs):

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :md5 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes128_encrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 412

def crypto_aes128_encrypt(data,**kwargs)
  Crypto.aes128_encrypt(data,**kwargs)
end

#crypto_aes256_cipher(**kwargs) ⇒ Cipher::AES Also known as: aes256_cipher

Creates a new AES-256 cipher.

Examples:

Crypto.aes256(direction: :encrypt, password: 's3cr3t')
# => #<Ronin::Support::Crypto::Cipher::AES256:0x00007f8bde789648 @key_size=256, @mode=:cbc>

Parameters:

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Cipher::AES256#initialize.

Options Hash (**kwargs):

• :mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (Cipher::AES) —

  The new AES cipher.

See Also:

• Ronin::Support::Crypto.aes256_cipher

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 492

def crypto_aes256_cipher(**kwargs)
  Crypto.aes256_cipher(**kwargs)
end

#crypto_aes256_decrypt(data, **kwargs) ⇒ String Also known as: aes256_decrypt

Decrypts data using AES-256.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes256_cipher.

Options Hash (**kwargs):

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sh256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes256_decrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 574

def crypto_aes256_decrypt(data,**kwargs)
  Crypto.aes256_decrypt(data,**kwargs)
end

#crypto_aes256_encrypt(data, **kwargs) ⇒ String Also known as: aes256_encrypt

Encrypts data using AES-256.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes256_cipher.

Options Hash (**kwargs):

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes256_encrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 533

def crypto_aes256_encrypt(data,**kwargs)
  Crypto.aes256_encrypt(data,**kwargs)
end

#crypto_aes_cipher(**kwargs) ⇒ Cipher::AES Also known as: aes_cipher

Creates a new AES cipher.

Examples:

crypto_aes_cipher(direction: :encrypt, password: 's3cr3t')
# => #<Ronin::Support::Crypto::Cipher::AES:0x00007f2b84dfa6b8 @key_size=256, @mode=:cbc>

Parameters:

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Cipher::AES#initialize.

Options Hash (**kwargs):

• :key_size (Integer) —

  The desired key size in bits.

• :mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (Cipher::AES) —

  The new AES cipher.

See Also:

• Ronin::Support::Crypto.aes_cipher

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 244

def crypto_aes_cipher(**kwargs)
  Crypto.aes_cipher(**kwargs)
end

#crypto_aes_decrypt(data, **kwargs) ⇒ String Also known as: aes_decrypt

Decrypts data using AES.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes_cipher.

Options Hash (**kwargs):

• :key_size (Integer) —

  The desired key size in bits.

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes_decrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 332

def crypto_aes_decrypt(data,**kwargs)
  Crypto.aes_decrypt(data,**kwargs)
end

#crypto_aes_encrypt(data, **kwargs) ⇒ String Also known as: aes_encrypt

Encrypts data using AES.

Parameters:

• data (#to_s) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.aes_cipher.

Options Hash (**kwargs):

• :key_size (Integer) —

  The desired key size in bits.

• mode (:cbc, :cfb, :ofb, :ctr, Symbol) — default: :cbc —

  The desired AES cipher mode.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.aes_encrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 288

def crypto_aes_encrypt(data,**kwargs)
  Crypto.aes_encrypt(data,**kwargs)
end

#crypto_cipher(name, **kwargs) ⇒ OpenSSL::Cipher Also known as: cipher

Creates a cipher.

Examples:

crypto_cipher('aes-128-cbc', mode: :encrypt, key 'secret'.md5)
# => #<OpenSSL::Cipher:0x0000000170d108>

Parameters:

• name (String) —

  The cipher name.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Cipher#initialize.

Options Hash (**kwargs):

• :direction (:encrypt, :decrypt) —

  Specifies whether to encrypt or decrypt data.

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (OpenSSL::Cipher) —

  The newly created cipher.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.cipher

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 120

def crypto_cipher(name,**kwargs)
  Crypto.cipher(name,**kwargs)
end

#crypto_decrypt(data, cipher:, **kwargs) ⇒ String Also known as: decrypt

Decrypts data using the cipher.

Parameters:

• data (#to_s) —

  The data to decrypt.

• cipher (String) —

  The cipher name (ex: "aes-256-cbc").

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for #cipher.

Options Hash (**kwargs):

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The decrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.decrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 202

def crypto_decrypt(data, cipher: ,**kwargs)
  Crypto.decrypt(data, cipher: cipher, **kwargs)
end

#crypto_digest(name) ⇒ OpenSSL::Digest Also known as: digest

Looks up a digest.

Examples:

crypto_digest(:ripemd160)
# => OpenSSL::Digest::RIPEMD160

Parameters:

• name (String, Symbol) —

  The name of the digest.

Returns:

• (OpenSSL::Digest) —

  The OpenSSL Digest class.

See Also:

• Ronin::Support::Crypto.digest

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 47

def crypto_digest(name)
  Crypto.digest(name)
end

#crypto_encrypt(data, cipher:, **kwargs) ⇒ String Also known as: encrypt

Encrypts data using the cipher.

Parameters:

• data (#to_s) —

  The data to encrypt.

• cipher (String) —

  The cipher name (ex: "aes-256-cbc").

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for #cipher.

Options Hash (**kwargs):

• :hash (Symbol) — default: :sha256 —

  The algorithm to hash the :password.

• :key (String) —

  The secret key to use.

• :password (String) —

  The password for the cipher.

• :iv (String) —

  The optional Initial Vector (IV).

• :padding (Integer) —

  Sets the padding for the cipher.

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or password: keyword argument must be given.

See Also:

• Ronin::Support::Crypto.encrypt

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 161

def crypto_encrypt(data, cipher: ,**kwargs)
  Crypto.encrypt(data, cipher: cipher, **kwargs)
end

#crypto_hmac(data = nil, key:, digest: :sha1) ⇒ String Also known as: hmac

Creates a new HMAC.

Examples:

crypto_hmac('secret')

Parameters:

• data (String, nil) (defaults to: nil) —

  The optional data to sign.

• key (String) —

  The secret key for the HMAC.

• digest (Symbol) (defaults to: :sha1) —

  The digest algorithm for the HMAC.

Returns:

• (String) —

  The hex-encoded HMAC for the String.

See Also:

• http://rubydoc.info/stdlib/openssl/OpenSSL/HMAC
• Ronin::Support::Crypto.hmac

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 75

def crypto_hmac(data=nil, key: , digest: :sha1)
  Crypto.hmac(data, key: key, digest: digest)
end

#crypto_rsa_decrypt(data, **kwargs) ⇒ String Also known as: rsa_decrypt

Decrypts the given data using the given RSA key.

Optional padding mode. nil and false will disable padding.

Parameters:

• data (String) —

  The data to decrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.rsa_decrypt.

Options Hash (**kwargs):

• :key (String, nil) —

  The PEM or DER encoded RSA key string.

• :key_file (String, nil) —

  The path to the PEM or DER encoded RSA key file.

• :key_password (String, nil) —

  The optional password to decrypt the encrypted RSA key.

• :padding (:pkcs1_oaep, :pkcs1, :sslv23, nil, false) — default: :pkcs1

Returns:

• (String) —

  The decrypted data.

Raises:

• (ArgumentError) —

  Either the key: or key_file: keyword argument must be given.

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 642

def crypto_rsa_decrypt(data,**kwargs)
  Crypto.rsa_decrypt(data,**kwargs)
end

#crypto_rsa_encrypt(data, **kwargs) ⇒ String Also known as: rsa_encrypt

Encrypts the given data using the given RSA key.

Optional padding mode. nil and false will disable padding.

Parameters:

• data (String) —

  The data to encrypt.

• kwargs (Hash{Symbol => Object}) —

  Additional keyword arguments for Ronin::Support::Crypto.rsa_encrypt.

Options Hash (**kwargs):

• :key (String, nil) —

  The PEM or DER encoded RSA key string.

• :key_file (String, nil) —

  The path to the PEM or DER encoded RSA key file.

• :key_password (String, nil) —

  The optional password to decrypt the encrypted RSA key.

• :padding (:pkcs1_oaep, :pkcs1, :sslv23, nil, false) — default: :pkcs1

Returns:

• (String) —

  The encrypted data.

Raises:

• (ArgumentError) —

  Either the key: or key_file: keyword argument must be given.

Since:

• 1.0.0

# File 'lib/ronin/support/crypto/mixin.rb', line 608

def crypto_rsa_encrypt(data,**kwargs)
  Crypto.rsa_encrypt(data,**kwargs)
end