Module ockam_core::vault

Core types and traits of the Ockam vault.

This module contains the core types and traits of the Ockam vault and is intended for use by other crates that either provide implementations for those traits, or use traits and types as an abstract dependency.

Examples

See the ockam_vault crate for usage examples.

Modules

storage

Storage

test_support

Various functions to help with testing implementations of the traits in ockam_core::vault.

Structs

KeyPair

A public key

PublicKey

A public key.

SecretAttributes

Attributes for a specific vault.

SecretKey

Binary representation of a Secret.

Signature

Binary representation of Signature.

VaultEntry

Secret stored in a Vault Storage

Enums

SecretPersistence

All possible SecretKey persistence types

SecretType

All possible SecretTypes

Constants

AES128_SECRET_LENGTH

AES128 private key length.

AES256_SECRET_LENGTH

AES256 private key length.

CURVE25519_PUBLIC_LENGTH

Curve25519 public key length.

CURVE25519_SECRET_LENGTH

Curve25519 private key length.

Traits

AsymmetricVault

Defines the Vault interface for asymmetric encryption.

Hasher

A trait for hashing input data into a fixed length output.

SecretVault

Defines the Secret management interface for Ockam Vaults.

Signer

Defines the Vault interface for Signing.

SymmetricVault

Defines the Vault interface for symmetric encryption.

Verifier

Defines the Vault interface for Signature verification.

Type Definitions

Buffer

Buffer for large binaries. (e.g. encrypted data)

KeyId

ID of a Key.

PublicKeyVec

Public Key Vector.

SecretKeyVec

Secret Key Vector.

SignatureVec

Signature Vector.

SmallBuffer

Buffer for small vectors. (e.g. an array of attributes)