Struct BareIdKey 

pub struct BareIdKey { /* private fields */ }

A self-contained implementor of SignInterface. It’s expected this will be used unless the key is being managed by the OS or a hardware module.

In general, you do not want to use this directly - IdentityKey is strongly preferred. This exists only so raw signing keys can be passed out without having a target LockKey or StreamKey - a specialized requirement needed to implement things like invite tokens.

Implementations

impl BareIdKey

pub fn new() -> BareIdKey

Generate a new self-contained Identity key.

pub fn with_rng<R>(csprng: &mut R) -> BareIdKey

where R: CryptoRng + RngCore,

Generate a new key given a cryptographic random number generator.

pub fn with_rng_and_version<R>( csprng: &mut R, version: u8, ) -> Result<BareIdKey, CryptoError>

where R: CryptoRng + RngCore,

Generate a new key with a specific version, given a cryptographic random number generator. Fails if the version isn’t supported.

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

Attempt to parse a base58-encoded BareIdKey.

pub fn to_base58(&self) -> String

Convert into a base58-encoded BareIdKey.

pub fn size(&self) -> usize

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

Encode the raw key, prepended with the version byte. The output vector must be either zeroized or encrypted before being dropped.

Trait Implementations

impl Clone for BareIdKey

fn clone(&self) -> BareIdKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BareIdKey

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

Formats the value using the given formatter.

impl Default for BareIdKey

fn default() -> BareIdKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BareIdKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BareIdKey

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

Display as a base58-encoded string.

impl From<BareIdKey> for Value

fn from(value: BareIdKey) -> Self

Converts to this type from the input type.

impl<'a> From<BareIdKey> for ValueRef<'a>

fn from(value: BareIdKey) -> Self

Converts to this type from the input type.

impl Hash for BareIdKey

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for BareIdKey

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

Formats the value using the given formatter.

impl PartialEq for BareIdKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BareIdKey

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SignInterface for BareIdKey

fn sign(&self, hash: &Hash) -> Signature

Sign a hash.

fn id(&self) -> &Identity

Get the corresponding Identity for the private key.

fn self_export_lock( &self, csprng: &mut dyn CryptoSrc, receive_lock: &LockId, ) -> Option<IdentityLockbox>

Export the signing key in an IdentityLockbox, with receive_lock as the recipient. If the key cannot be exported, this should return None.

fn self_export_stream( &self, csprng: &mut dyn CryptoSrc, receive_stream: &StreamKey, ) -> Option<IdentityLockbox>

Export the signing key in an IdentityLockbox, with receive_stream as the recipient. If the key cannot be exported, this should return None. Additionally, if the underlying implementation does not allow moving the raw key into memory (i.e. it cannot call StreamInterface::encrypt or lock_id_encrypt) then None can also be returned.

impl TryFrom<&[u8]> for BareIdKey

type Error = CryptoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for BareIdKey

type Error = Value

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ValueRef<'a>> for BareIdKey

type Error = ValueRef<'a>

The type returned in the event of a conversion error.

fn try_from(v: ValueRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for BareIdKey

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

Formats the value using the given formatter.

impl Eq for BareIdKey