class Sodium::Kdf

Overview

Included Modules

Defined in:

sodium/kdf.cr

Constant Summary

CONTEXT_SIZE = LibSodium.crypto_kdf_contextbytes
KEY_SIZE = LibSodium.crypto_kdf_keybytes.to_i

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Sodium::Wipe

close close, finalize finalize

Constructor Detail

def self.new(bytes : Bytes, erase = false) #

DEPRECATED use .copy_key_from or .move_key_from


[View source]
def self.new(key : Crypto::Secret) #

Use an existing KDF Crypto::Secret key.


[View source]
def self.new #

DEPRECATED use .random


[View source]

Class Method Detail

def self.copy_key_from(bytes : Bytes) #

Use an existing KDF key.

  • Copies key to a new SecureBuffer

[View source]
def self.move_key_from(bytes : Bytes) #

Use an existing KDF key.

  • Copies key to a new SecureBuffer
  • Erases bytes after copying

[View source]
def self.random #

[View source]

Instance Method Detail

def derive(context, subkey_id, subkey_size) : SecureBuffer #

Derive a consistent subkey based on context and subkey_id.

context and subkey don't need to be secret

  • context must be 8 bytes
  • subkey_size must be 16..64 bytes as of libsodium 1.0.17

Returns a SecureBuffer. May transfer ownership to SecretBox or SecretKey without copying.


[View source]
def derive_aead_xchacha20poly1305_ietf(context, subkey_id) : Cipher::Aead::XChaCha20Poly1305Ietf #

Convenience method to create a new CryptoBox::Aead::XChaCha20Poly1305Ietf without handling the key.

See derive() for further information on context and subkey_id.


[View source]
def derive_cryptobox(context, subkey_id) : CryptoBox::SecretKey #

Convenience method to create a new CryptoBox::Secret without handling the key.

See derive() for further information on context and subkey_id.


[View source]
def derive_secretbox(context, subkey_id) : SecretBox #

Convenience method to create a new SecretBox without handling the key.

See derive() for further information on context and subkey_id.


[View source]
def derive_sign(context, subkey_id) : Sign::SecretKey #

Convenience method to create a new Sign::Secret without handling the key.

See derive() for further information on context and subkey_id.


[View source]
def key : Crypto::Secret #

[View source]
def to_slice : Bytes #

Returns key

DEPRECATED Use .key instead


[View source]