Struct ssb_common::keys::PublicKey

pub struct PublicKey(_);

An ssb public key. This type abstracts over the fact that ssb can support multiple cryptographic primitives.

Methods

impl PublicKey

fn len(&self) -> usize

Return the length (in bytes) of the key.

fn verify(&self, signed_message: &[u8]) -> Result<Vec<u8>, ()>

Verify the given signed message with this PublicKey. On success, return a Vec<u8> containing the message without the signature.

fn verify_detached(&self, signature: &Signature, signed_message: &[u8]) -> bool

Verify the given message with this PublicKey and the given Signature.

Panics

Panics if this PublicKey and the Signature use different cryptographic primitives.

fn try_verify_detached(
    &self,
    signature: &Signature,
    signed_message: &[u8]
) -> Option<bool>

Verify the given message with this PublicKey and the given Signature. Return None if this PublicKey and the Signature use different cryptographic primitives.

fn is_ed25519(&self) -> bool

Return whether this PublicKey uses the ed25519 cryptographic primitive.

fn is_considered_secure(&self) -> bool

Return whether this PublicKey uses a cryptographic primitive that is currently considered secure.

The return value of this method may change as new versions of this module are released.

fn matches_secret_key(&self, secret_key: &SecretKey) -> bool

Return whether this PublicKey uses the same cryptographic primitive as the given SecretKey.

fn matches_signature(&self, signature: &Signature) -> bool

Return whether this PublicKey uses the same cryptographic primitive as the given Signature.

fn from_encoding(enc: &PublicKeyEnc) -> PublicKey

Create a PublicKey from a PublicKeyEnc.

Prefer to directly use the FromStr impl.

Trait Implementations

impl Copy for PublicKey

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for PublicKey

fn eq(&self, __arg_0: &PublicKey) -> bool

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

fn ne(&self, __arg_0: &PublicKey) -> bool

This method tests for !=.

impl Eq for PublicKey

impl PartialOrd for PublicKey

fn partial_cmp(&self, __arg_0: &PublicKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &PublicKey) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &PublicKey) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &PublicKey) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &PublicKey) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for PublicKey

fn cmp(&self, __arg_0: &PublicKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for PublicKey

fn hash<__H: Hasher>(&self, __arg_0: &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 Debug for PublicKey

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

Formats the value using the given formatter.

impl From<PublicKey> for PublicKey

fn from(ed25519_pk: PublicKey) -> PublicKey

Performs the conversion.

impl TryInto<PublicKey> for PublicKey

type Error = ()

🔬 This is a nightly-only experimental API. (try_from)

Fails if the underlying cryptographic primitive is not ed25519.

fn try_into(self) -> Result<PublicKey, Self::Error>

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl AsRef<[u8]> for PublicKey

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

Performs the conversion.

impl Index<Range<usize>> for PublicKey

Allows to access the byte contents of a PublicKey as a slice.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for PublicKey

Allows to access the byte contents of a PublicKey as a slice.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for PublicKey

Allows to access the byte contents of a PublicKey as a slice.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for PublicKey

Allows to access the byte contents of a PublicKey as a slice.

type Output = [u8]

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl From<PublicKeyEncBuf> for PublicKey

fn from(enc: PublicKeyEncBuf) -> PublicKey

Performs the conversion.

impl FromStr for PublicKey

This can be used to parse an encoded PublicKey.

type Err = ()

Fails if the given string does not contain an encoding of a PublicKey.

fn from_str(enc: &str) -> Result<PublicKey, ()>

Parses a string s to return a value of this type.