class OpenSSL::Cipher

Overview

A class which can be used to encrypt and decrypt data using a specified cipher.

require "random/secure"

key = Random::Secure.random_bytes(64) # You can also use OpenSSL::Cipher#random_key to do this same thing
iv = Random::Secure.random_bytes(32)  # You can also use OpenSSL::Cipher#random_iv to do this same thing

def encrypt(data)
  cipher = OpenSSL::Cipher.new("aes-256-cbc")
  cipher.encrypt
  cipher.key = key
  cipher.iv = iv

  io = IO::Memory.new
  io.write(cipher.update(data))
  io.write(cipher.final)
  io.rewind

  io.to_slice
end

def decrypt(data)
  cipher = OpenSSL::Cipher.new("aes-256-cbc")
  cipher.decrypt
  cipher.key = key
  cipher.iv = iv

  io = IO::Memory.new
  io.write(cipher.update(data))
  io.write(cipher.final)
  io.rewind

  io.gets_to_end
end

Defined in:

openssl/cipher.cr

Constructors

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, initialize initialize, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil!(message = nil) not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io, root : String)
from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml

Constructor Detail

def self.new(name) #

[View source]

Instance Method Detail

def authenticated? : Bool #

[View source]
def block_size : Int32 #

[View source]
def decrypt : Nil #

Sets this cipher to decryption mode.


[View source]
def encrypt : Nil #

Sets this cipher to encryption mode.


[View source]
def final : Bytes #

Outputs the decrypted or encrypted buffer.


[View source]
def finalize #

[View source]
def iv=(iv) #

[View source]
def iv_len : Int32 #

How many bytes the iv should be.


[View source]
def key=(key) #

[View source]
def key_len : Int32 #

How many bytes the key should be.


[View source]
def name : String #

[View source]
def padding=(pad : Bool) #

[View source]
def random_iv #

Sets the iv using Random::Secure.


[View source]
def random_key #

Sets the key using Random::Secure.


[View source]
def reset #

Resets the encrypt/decrypt mode.


[View source]
def update(data) #

Add the data to be encrypted or decrypted to this cipher's buffer.


[View source]