123456789_123456789_123456789_123456789_123456789_

Class: OpenSSL::Cipher::Cipher

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::OpenSSL::Cipher
Instance Chain:
self, ::OpenSSL::Cipher
Inherits: OpenSSL::Cipher
Defined in: ext/openssl/lib/openssl/cipher.rb

Overview

This class is only provided for backwards compatibility. Use ::OpenSSL::Cipher in the future.

Class Method Summary

::OpenSSL::Cipher - Inherited

.new

The string must contain a valid cipher name like “AES-128-CBC” or “3DES”.
.ciphers

Returns the names of all available ciphers in an array.

Instance Attribute Summary

::OpenSSL::Cipher - Inherited

#auth_tag

Gets the authentication tag generated by Authenticated Encryption Cipher modes (GCM for example).
#auth_tag=

Sets the authentication tag to verify the contents of the ciphertext.
#key_len,
#key_len=

Sets the key length of the cipher.
#authenticated?

Indicated whether this Cipher instance uses an Authenticated Encryption mode.
#auth_data=

Sets the cipher's additional authenticated data.
#iv=

Sets the cipher IV.
#key=

Sets the cipher key.
#padding=

Enables or disables padding.

Instance Method Summary

::OpenSSL::Cipher - Inherited

#block_size,
#decrypt

Initializes the Cipher for decryption.
#encrypt

Initializes the Cipher for encryption.
#final

Returns the remaining data held in the cipher object.
#iv_len,
#name

Returns the name of the cipher which may differ slightly from the original name provided.
#pkcs5_keyivgen

Generates and sets the key/IV based on a password.
#random_iv

Generate, set, and return a random iv.
#random_key

Generate, set, and return a random key.
#reset

Fully resets the internal state of the Cipher.
#update

Encrypts data in a streaming fashion.
#ciphers

Returns the names of all available ciphers in an array.

Constructor Details

This class inherits a constructor from OpenSSL::Cipher