Struct tor_hsservice::internal_prelude::ed25519::PublicKey
pub struct PublicKey {
pub(crate) compressed: CompressedEdwardsY,
pub(crate) point: EdwardsPoint,
}
Expand description
An ed25519 public key.
§Note
The Eq
and Hash
impls here use the compressed Edwards y encoding, not the algebraic
representation. This means if this VerifyingKey
is non-canonically encoded, it will be
considered unequal to the other equivalent encoding, despite the two representing the same
point. More encoding details can be found
here.
If you want to make sure that signatures produced with respect to those sorts of public keys
are rejected, use VerifyingKey::verify_strict
.
Fields§
§compressed: CompressedEdwardsY
§point: EdwardsPoint
Implementations§
§impl VerifyingKey
impl VerifyingKey
pub fn from_bytes(bytes: &[u8; 32]) -> Result<VerifyingKey, Error>
pub fn from_bytes(bytes: &[u8; 32]) -> Result<VerifyingKey, Error>
Construct a VerifyingKey
from a slice of bytes.
§Warning
The caller is responsible for ensuring that the bytes passed into this
method actually represent a curve25519_dalek::curve::CompressedEdwardsY
and that said compressed point is actually a point on the curve.
§Example
use ed25519_dalek::VerifyingKey;
use ed25519_dalek::PUBLIC_KEY_LENGTH;
use ed25519_dalek::SignatureError;
let public_key_bytes: [u8; PUBLIC_KEY_LENGTH] = [
215, 90, 152, 1, 130, 177, 10, 183, 213, 75, 254, 211, 201, 100, 7, 58,
14, 225, 114, 243, 218, 166, 35, 37, 175, 2, 26, 104, 247, 7, 81, 26];
let public_key = VerifyingKey::from_bytes(&public_key_bytes)?;
§Returns
A Result
whose okay value is an EdDSA VerifyingKey
or whose error value
is a SignatureError
describing the error that occurred.
pub fn is_weak(&self) -> bool
pub fn is_weak(&self) -> bool
Returns whether this is a weak public key, i.e., if this public key has low order.
A weak public key can be used to generate a signature that’s valid for almost every
message. Self::verify_strict
denies weak keys, but if you want to check for this
property before verification, then use this method.
pub fn verify_strict(
&self,
message: &[u8],
signature: &Signature
) -> Result<(), Error>
pub fn verify_strict( &self, message: &[u8], signature: &Signature ) -> Result<(), Error>
Strictly verify a signature on a message with this keypair’s public key.
§On The (Multiple) Sources of Malleability in Ed25519 Signatures
This version of verification is technically non-RFC8032 compliant. The following explains why.
- Scalar Malleability
The authors of the RFC explicitly stated that verification of an ed25519
signature must fail if the scalar s
is not properly reduced mod $\ell$:
To verify a signature on a message M using public key A, with F being 0 for Ed25519ctx, 1 for Ed25519ph, and if Ed25519ctx or Ed25519ph is being used, C being the context, first split the signature into two 32-octet halves. Decode the first half as a point R, and the second half as an integer S, in the range 0 <= s < L. Decode the public key A as point A’. If any of the decodings fail (including S being out of range), the signature is invalid.)
All verify_*()
functions within ed25519-dalek perform this check.
- Point malleability
The authors of the RFC added in a malleability check to step #3 in
§5.1.7, for small torsion components in the R
value of the signature,
which is not strictly required, as they state:
Check the group equation [8][S]B = [8]R + [8][k]A’. It’s sufficient, but not required, to instead check [S]B = R + [k]A’.
§History of Malleability Checks
As originally defined (cf. the “Malleability” section in the README of this repo), ed25519 signatures didn’t consider any form of malleability to be an issue. Later the scalar malleability was considered important. Still later, particularly with interests in cryptocurrency design and in unique identities (e.g. for Signal users, Tor onion services, etc.), the group element malleability became a concern.
However, libraries had already been created to conform to the original definition. One well-used library in particular even implemented the group element malleability check, but only for batch verification! Which meant that even using the same library, a single signature could verify fine individually, but suddenly, when verifying it with a bunch of other signatures, the whole batch would fail!
§“Strict” Verification
This method performs both of the above signature malleability checks.
It must be done as a separate method because one doesn’t simply get to change the definition of a cryptographic primitive ten years after-the-fact with zero consideration for backwards compatibility in hardware and protocols which have it already have the older definition baked in.
§Return
Returns Ok(())
if the signature is valid, and Err
otherwise.
pub fn to_montgomery(&self) -> MontgomeryPoint
pub fn to_montgomery(&self) -> MontgomeryPoint
Convert this verifying key into Montgomery form.
This can be used for performing X25519 Diffie-Hellman using Ed25519 keys. The output of
this function is a valid X25519 public key whose secret key is sk.to_scalar_bytes()
,
where sk
is a valid signing key for this VerifyingKey
.
§Note
We do NOT recommend this usage of a signing/verifying key. Signing keys are usually long-term keys, while keys used for key exchange should rather be ephemeral. If you can help it, use a separate key for encryption.
For more information on the security of systems which use the same keys for both signing and Diffie-Hellman, see the paper On using the same key pair for Ed25519 and an X25519 based KEM.
Trait Implementations§
§impl AsRef<[u8]> for VerifyingKey
impl AsRef<[u8]> for VerifyingKey
§impl AsRef<VerifyingKey> for HsBlindIdKey
impl AsRef<VerifyingKey> for HsBlindIdKey
§fn as_ref(&self) -> &VerifyingKey
fn as_ref(&self) -> &VerifyingKey
§impl AsRef<VerifyingKey> for HsIdKey
impl AsRef<VerifyingKey> for HsIdKey
§fn as_ref(&self) -> &VerifyingKey
fn as_ref(&self) -> &VerifyingKey
§impl AsRef<VerifyingKey> for HsIntroPtSessionIdKey
impl AsRef<VerifyingKey> for HsIntroPtSessionIdKey
§fn as_ref(&self) -> &VerifyingKey
fn as_ref(&self) -> &VerifyingKey
§impl AsRef<VerifyingKey> for SigningKey
impl AsRef<VerifyingKey> for SigningKey
§fn as_ref(&self) -> &VerifyingKey
fn as_ref(&self) -> &VerifyingKey
§impl Clone for VerifyingKey
impl Clone for VerifyingKey
§fn clone(&self) -> VerifyingKey
fn clone(&self) -> VerifyingKey
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for VerifyingKey
impl Debug for VerifyingKey
§impl Default for VerifyingKey
impl Default for VerifyingKey
§fn default() -> VerifyingKey
fn default() -> VerifyingKey
source§impl EncodableKey for VerifyingKey
impl EncodableKey for VerifyingKey
source§fn as_ssh_key_data(&self) -> Result<SshKeyData, Error>
fn as_ssh_key_data(&self) -> Result<SshKeyData, Error>
SshKeyData
of this key.§impl From<&ExpandedSecretKey> for VerifyingKey
impl From<&ExpandedSecretKey> for VerifyingKey
§fn from(expanded_secret_key: &ExpandedSecretKey) -> VerifyingKey
fn from(expanded_secret_key: &ExpandedSecretKey) -> VerifyingKey
Derive this public key from its corresponding ExpandedSecretKey
.
§impl From<&SigningKey> for VerifyingKey
impl From<&SigningKey> for VerifyingKey
§fn from(signing_key: &SigningKey) -> VerifyingKey
fn from(signing_key: &SigningKey) -> VerifyingKey
§impl From<&VerifyingKey> for Ed25519Identity
impl From<&VerifyingKey> for Ed25519Identity
§fn from(pk: &VerifyingKey) -> Ed25519Identity
fn from(pk: &VerifyingKey) -> Ed25519Identity
§impl From<EdwardsPoint> for VerifyingKey
impl From<EdwardsPoint> for VerifyingKey
§fn from(point: EdwardsPoint) -> VerifyingKey
fn from(point: EdwardsPoint) -> VerifyingKey
§impl From<HsBlindIdKey> for VerifyingKey
impl From<HsBlindIdKey> for VerifyingKey
§fn from(original: HsBlindIdKey) -> VerifyingKey
fn from(original: HsBlindIdKey) -> VerifyingKey
§impl From<HsClientIntroAuthKey> for VerifyingKey
impl From<HsClientIntroAuthKey> for VerifyingKey
§fn from(original: HsClientIntroAuthKey) -> VerifyingKey
fn from(original: HsClientIntroAuthKey) -> VerifyingKey
§impl From<HsDescSigningKey> for VerifyingKey
impl From<HsDescSigningKey> for VerifyingKey
§fn from(original: HsDescSigningKey) -> VerifyingKey
fn from(original: HsDescSigningKey) -> VerifyingKey
§impl From<HsIdKey> for VerifyingKey
impl From<HsIdKey> for VerifyingKey
§fn from(original: HsIdKey) -> VerifyingKey
fn from(original: HsIdKey) -> VerifyingKey
§impl From<HsIntroPtSessionIdKey> for VerifyingKey
impl From<HsIntroPtSessionIdKey> for VerifyingKey
§fn from(original: HsIntroPtSessionIdKey) -> VerifyingKey
fn from(original: HsIntroPtSessionIdKey) -> VerifyingKey
§impl From<VerifyingKey> for Ed25519Identity
impl From<VerifyingKey> for Ed25519Identity
§fn from(pk: VerifyingKey) -> Ed25519Identity
fn from(pk: VerifyingKey) -> Ed25519Identity
§impl From<VerifyingKey> for HsBlindIdKey
impl From<VerifyingKey> for HsBlindIdKey
§fn from(original: VerifyingKey) -> HsBlindIdKey
fn from(original: VerifyingKey) -> HsBlindIdKey
§impl From<VerifyingKey> for HsIdKey
impl From<VerifyingKey> for HsIdKey
§fn from(original: VerifyingKey) -> HsIdKey
fn from(original: VerifyingKey) -> HsIdKey
§impl From<VerifyingKey> for HsIntroPtSessionIdKey
impl From<VerifyingKey> for HsIntroPtSessionIdKey
§fn from(original: VerifyingKey) -> HsIntroPtSessionIdKey
fn from(original: VerifyingKey) -> HsIntroPtSessionIdKey
§impl Hash for VerifyingKey
impl Hash for VerifyingKey
§impl PartialEq for VerifyingKey
impl PartialEq for VerifyingKey
§fn eq(&self, other: &VerifyingKey) -> bool
fn eq(&self, other: &VerifyingKey) -> bool
self
and other
values to be equal, and is used
by ==
.§impl Readable for VerifyingKey
impl Readable for VerifyingKey
§fn take_from(b: &mut Reader<'_>) -> Result<VerifyingKey, Error>
fn take_from(b: &mut Reader<'_>) -> Result<VerifyingKey, Error>
§impl TryFrom<&[u8]> for VerifyingKey
impl TryFrom<&[u8]> for VerifyingKey
§impl TryFrom<&Ed25519Identity> for VerifyingKey
impl TryFrom<&Ed25519Identity> for VerifyingKey
§fn try_from(
id: &Ed25519Identity
) -> Result<VerifyingKey, <VerifyingKey as TryFrom<&Ed25519Identity>>::Error>
fn try_from( id: &Ed25519Identity ) -> Result<VerifyingKey, <VerifyingKey as TryFrom<&Ed25519Identity>>::Error>
§impl TryFrom<Ed25519Identity> for VerifyingKey
impl TryFrom<Ed25519Identity> for VerifyingKey
§fn try_from(
id: Ed25519Identity
) -> Result<VerifyingKey, <VerifyingKey as TryFrom<Ed25519Identity>>::Error>
fn try_from( id: Ed25519Identity ) -> Result<VerifyingKey, <VerifyingKey as TryFrom<Ed25519Identity>>::Error>
§impl Verifier<Signature> for VerifyingKey
impl Verifier<Signature> for VerifyingKey
§impl Writeable for VerifyingKey
impl Writeable for VerifyingKey
impl Copy for VerifyingKey
impl Eq for VerifyingKey
Auto Trait Implementations§
impl Freeze for VerifyingKey
impl RefUnwindSafe for VerifyingKey
impl Send for VerifyingKey
impl Sync for VerifyingKey
impl Unpin for VerifyingKey
impl UnwindSafe for VerifyingKey
Blanket Implementations§
§impl<A, T> AsBits<T> for A
impl<A, T> AsBits<T> for A
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.source§impl<T> ToHex for T
impl<T> ToHex for T
source§fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex<U>(&self) -> Uwhere
U: FromIterator<char>,
self
into the result. Lower case
letters are used (e.g. f9b4ca
)source§fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
fn encode_hex_upper<U>(&self) -> Uwhere
U: FromIterator<char>,
self
into the result. Upper case
letters are used (e.g. F9B4CA
)