Struct PrivateKeyBase

pub struct PrivateKeyBase(/* private fields */);

Holds unique data from which keys for signing and encryption can be derived.

Implementations

impl PrivateKeyBase

pub fn new() -> Self

Generate a new random PrivateKeyBase.

pub fn from_data(data: impl Into<Vec<u8>>) -> Self

Restores a PrivateKeyBase from bytes.

pub fn from_optional_data(data: Option<impl Into<Vec<u8>>>) -> Self

Restores a PrivateKeyBase from an optional reference to an array of bytes.

If the data is None, a new random PrivateKeyBase is generated.

pub fn new_using(rng: &mut impl RandomNumberGenerator) -> Self

Generate a new random PrivateKeyBase using the given random number generator.

pub fn new_with_provider(provider: impl PrivateKeyDataProvider) -> Self

Create a new PrivateKeyBase from the given private keys data provider.

pub fn ecdsa_signing_private_key(&self) -> SigningPrivateKey

Derive a new ECDSA SigningPrivateKey from this PrivateKeyBase.

pub fn schnorr_signing_private_key(&self) -> SigningPrivateKey

Derive a new Schnorr SigningPrivateKey from this PrivateKeyBase.

pub fn ed25519_signing_private_key(&self) -> SigningPrivateKey

Derive a new Ed25519 SigningPrivateKey from this PrivateKeyBase.

pub fn ssh_signing_private_key( &self, algorithm: SSHAlgorithm, comment: impl Into<String>, ) -> Result<SigningPrivateKey>

Derive a new SSH SigningPrivateKey from this PrivateKeyBase.

pub fn agreement_private_key(&self) -> AgreementPrivateKey

Derive a new AgreementPrivateKey from this PrivateKeyBase.

An X25519 key for key agreement and public key encryption.

pub fn schnorr_public_key_base(&self) -> PublicKeyBase

Derive a new PublicKeyBase from this PrivateKeyBase.

• Includes a Schnorr public key for signing.
• Includes an X25519 key for key agreement and public key encryption.

pub fn ecdsa_public_key_base(&self) -> PublicKeyBase

Derive a new PublicKeyBase from this PrivateKeyBase.

• Includes an ECDSA public key for signing.
• Includes an X25519 key for key agreement and public key encryption.

pub fn ssh_public_key_base( &self, algorithm: SSHAlgorithm, comment: impl Into<String>, ) -> Result<PublicKeyBase>

Derive a new PublicKeyBase from this PrivateKeyBase.

• Includes an SSH public key for signing.
• Includes an X25519 key for key agreement and public key encryption.

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

Get the raw data of this PrivateKeyBase.

Trait Implementations

impl AsRef<[u8]> for PrivateKeyBase

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PrivateKeyBase> for PrivateKeyBase

fn as_ref(&self) -> &PrivateKeyBase

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORTagged for PrivateKeyBase

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for PrivateKeyBase

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for PrivateKeyBase

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for PrivateKeyBase

fn clone(&self) -> PrivateKeyBase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKeyBase

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

Formats the value using the given formatter.

impl Default for PrivateKeyBase

fn default() -> Self

Returns the “default value” for a type.

impl Drop for PrivateKeyBase

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a PrivateKeyBase> for &'a [u8]

fn from(value: &'a PrivateKeyBase) -> Self

Converts to this type from the input type.

impl From<&PrivateKeyBase> for XID

fn from(key: &PrivateKeyBase) -> Self

Converts to this type from the input type.

impl From<PrivateKeyBase> for CBOR

fn from(value: PrivateKeyBase) -> Self

Converts to this type from the input type.

impl PartialEq for PrivateKeyBase

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

fn sign_with_options( &self, message: &dyn AsRef<[u8]>, options: Option<SigningOptions>, ) -> Result<Signature>

fn sign(&self, message: &dyn AsRef<[u8]>) -> Result<Signature>

impl TryFrom<CBOR> for PrivateKeyBase

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl Verifier for PrivateKeyBase

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

impl Eq for PrivateKeyBase

impl StructuralPartialEq for PrivateKeyBase