Struct fog_crypto::lock::LockId

pub struct LockId { /* private fields */ }

An identifier for a corresponding LockKey that can be used to encrypt data for that key.

This contains a cryptographic public encryption key.

Example

// We've been given a LockId that we're sending encrypted data to.
println!("LockId(Base58): {}", key.id());

// Encrypt some data for that LockId
let data = b"I am sensitive information, about to be encrypted";
let lockbox = id.encrypt_data(&mut csprng, data.as_ref());

// The lockbox can be encoded onto a vec or used as raw bytes.
let mut to_send = Vec::new();
to_send.extend_from_slice(lockbox.as_bytes());

Implementations

impl LockId

pub fn encrypt_data<R>(&self, csprng: &mut R, content: &[u8]) -> DataLockbox where
    R: CryptoRng + RngCore, 

Encrypt a byte slice into a DataLockbox. Requires a cryptographic RNG to generate the needed nonce.

pub fn version(&self) -> u8

Get the cryptographic algorithm version used for this ID.

pub fn raw_public_key(&self) -> &[u8]

Get the raw public encryption key contained within.

pub fn as_vec(&self) -> Vec<u8>

Convert into a byte vector. For extending an existing byte vector, see encode_vec.

pub fn from_base58(s: &str) -> Result<Self, CryptoError>

Attempt to parse a base58-encoded LockId.

pub fn to_base58(&self) -> String

Convert into a base58-encoded LockId.

pub fn encode_vec(&self, buf: &mut Vec<u8>)

Encode onto an existing byte vector. Writes out the version followed by the public signing key. It does not include any length information in the encoding.

pub fn size(&self) -> usize

Get the length of this Identity once encoded as bytes.

Trait Implementations

impl Clone for LockId

fn clone(&self) -> LockId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LockId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LockId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for LockId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Display as a base58-encoded string.

impl Hash for LockId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for LockId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<LockId> for LockId

fn eq(&self, other: &LockId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LockId) -> bool

This method tests for !=.

impl Serialize for LockId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ [u8]> for LockId

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for LockId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for LockId

impl StructuralEq for LockId

impl StructuralPartialEq for LockId