Struct Key 

pub struct Key { /* private fields */ }

Implementations

impl Key

pub fn new(public_keys: impl AsRef<PublicKeys>) -> Self

pub fn new_allow_all(public_keys: impl AsRef<PublicKeys>) -> Self

pub fn new_with_private_keys( private_keys: PrivateKeys, public_keys: PublicKeys, ) -> Self

pub fn new_with_private_key_base(private_key_base: PrivateKeyBase) -> Self

pub fn public_keys(&self) -> &PublicKeys

pub fn private_keys(&self) -> Option<&PrivateKeys>

pub fn has_private_keys(&self) -> bool

pub fn has_encrypted_private_keys(&self) -> bool

pub fn private_key_salt(&self) -> Option<&Salt>

pub fn private_key_envelope( &self, password: Option<&str>, ) -> Result<Option<Envelope>>

Extract the private key data as an Envelope, optionally decrypting it.

Returns

• Ok(None) if no private key is present
• Ok(Some(Envelope)) containing:
  • Decrypted PrivateKeys if unencrypted
  • Decrypted PrivateKeys if encrypted and correct password provided
  • Encrypted envelope if encrypted and no password provided
• Err(...) if encrypted and wrong password provided

Examples

use bc_components::PrivateKeyBase;
use bc_envelope::prelude::*;
use bc_xid::Key;

// Unencrypted key
let prvkey_base = PrivateKeyBase::new();
let key = Key::new_with_private_key_base(prvkey_base.clone());
let envelope = key.private_key_envelope(None).unwrap().unwrap();
// Returns envelope containing PrivateKeys

// Encrypted key without password
// Returns the encrypted envelope as-is

// Encrypted key with correct password
// Returns envelope containing decrypted PrivateKeys

pub fn signing_public_key(&self) -> &SigningPublicKey

pub fn encapsulation_public_key(&self) -> &EncapsulationPublicKey

pub fn endpoints(&self) -> &HashSet<URI>

pub fn endpoints_mut(&mut self) -> &mut HashSet<URI>

pub fn add_endpoint(&mut self, endpoint: URI)

pub fn permissions(&self) -> &Permissions

pub fn permissions_mut(&mut self) -> &mut Permissions

pub fn add_permission(&mut self, privilege: Privilege)

impl Key

pub fn into_envelope_opt( self, private_key_options: XIDPrivateKeyOptions, ) -> Envelope

impl Key

pub fn try_from_envelope( envelope: &Envelope, password: Option<&[u8]>, ) -> Result<Self>

Try to extract a Key from an envelope, optionally providing a password to decrypt an encrypted private key.

If the private key is encrypted and no password is provided, the Key will be created without the private key (it will be None).

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl EnvelopeEncodable for Key

fn into_envelope(self) -> Envelope

Converts this value into a Gordian Envelope.

fn to_envelope(&self) -> Envelope

where Self: Clone,

Converts a reference to this value into a Gordian Envelope.

impl HasNickname for Key

fn nickname(&self) -> &str

fn set_nickname(&mut self, nickname: impl Into<String>)

fn add_nickname(&mut self, name: &str) -> Result<()>

impl HasPermissions for Key

fn permissions(&self) -> &Permissions

fn permissions_mut(&mut self) -> &mut Permissions

fn allow(&self) -> &HashSet<Privilege>

fn deny(&self) -> &HashSet<Privilege>

fn allow_mut(&mut self) -> &mut HashSet<Privilege>

fn deny_mut(&mut self) -> &mut HashSet<Privilege>

fn add_allow(&mut self, privilege: Privilege)

fn add_deny(&mut self, privilege: Privilege)

fn remove_allow(&mut self, privilege: &Privilege)

fn remove_deny(&mut self, privilege: &Privilege)

fn clear_all_permissions(&mut self)

impl Hash for Key

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Key

fn eq(&self, other: &Key) -> 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 PublicKeysProvider for Key

fn public_keys(&self) -> PublicKeys

Returns a complete set of public keys for cryptographic operations.

impl ReferenceProvider for &Key

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object.

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string.

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference.

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string.

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords.

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji.

impl TryFrom<&Envelope> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: &Envelope) -> Result<Self>

Performs the conversion.

impl TryFrom<Envelope> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self>

Performs the conversion.

impl Verifier for Key

fn verify(&self, signature: &Signature, message: &dyn AsRef<[u8]>) -> bool

Verifies a signature against a message.

impl Eq for Key

impl StructuralPartialEq for Key