commonware_cryptography/ed25519/
scheme.rs

1#[cfg(feature = "std")]
2use crate::BatchVerifier;
3use crate::Secret;
4#[cfg(not(feature = "std"))]
5use alloc::borrow::{Cow, ToOwned};
6use bytes::{Buf, BufMut};
7use commonware_codec::{Error as CodecError, FixedSize, Read, ReadExt, Write};
8use commonware_math::algebra::Random;
9use commonware_utils::{hex, union_unique, Array, Span};
10use core::{
11    fmt::{Debug, Display},
12    hash::{Hash, Hasher},
13    ops::Deref,
14};
15use ed25519_consensus::{self, VerificationKey};
16use rand_core::CryptoRngCore;
17#[cfg(feature = "std")]
18use std::borrow::{Cow, ToOwned};
19use zeroize::Zeroizing;
20
21const CURVE_NAME: &str = "ed25519";
22const PRIVATE_KEY_LENGTH: usize = 32;
23const PUBLIC_KEY_LENGTH: usize = 32;
24const SIGNATURE_LENGTH: usize = 64;
25
26/// Ed25519 Private Key.
27#[derive(Clone, Debug)]
28pub struct PrivateKey {
29    key: Secret<ed25519_consensus::SigningKey>,
30}
31
32impl crate::PrivateKey for PrivateKey {}
33
34impl crate::Signer for PrivateKey {
35    type Signature = Signature;
36    type PublicKey = PublicKey;
37
38    fn sign(&self, namespace: &[u8], msg: &[u8]) -> Self::Signature {
39        self.sign_inner(Some(namespace), msg)
40    }
41
42    fn public_key(&self) -> Self::PublicKey {
43        self.key.expose(|key| Self::PublicKey {
44            key: key.verification_key().to_owned(),
45        })
46    }
47}
48
49impl PrivateKey {
50    #[inline(always)]
51    fn sign_inner(&self, namespace: Option<&[u8]>, msg: &[u8]) -> Signature {
52        let payload = namespace
53            .map(|namespace| Cow::Owned(union_unique(namespace, msg)))
54            .unwrap_or_else(|| Cow::Borrowed(msg));
55        self.key.expose(|key| Signature::from(key.sign(&payload)))
56    }
57}
58
59impl Random for PrivateKey {
60    fn random(rng: impl CryptoRngCore) -> Self {
61        let key = ed25519_consensus::SigningKey::new(rng);
62        Self {
63            key: Secret::new(key),
64        }
65    }
66}
67
68impl Write for PrivateKey {
69    fn write(&self, buf: &mut impl BufMut) {
70        self.key.expose(|key| key.as_bytes().write(buf));
71    }
72}
73
74impl Read for PrivateKey {
75    type Cfg = ();
76
77    fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, CodecError> {
78        let raw = Zeroizing::new(<[u8; Self::SIZE]>::read(buf)?);
79        let key = ed25519_consensus::SigningKey::from(*raw);
80        Ok(Self {
81            key: Secret::new(key),
82        })
83    }
84}
85
86impl FixedSize for PrivateKey {
87    const SIZE: usize = PRIVATE_KEY_LENGTH;
88}
89
90impl From<ed25519_consensus::SigningKey> for PrivateKey {
91    fn from(key: ed25519_consensus::SigningKey) -> Self {
92        Self {
93            key: Secret::new(key),
94        }
95    }
96}
97
98impl Display for PrivateKey {
99    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
100        write!(f, "{:?}", self)
101    }
102}
103
104#[cfg(feature = "arbitrary")]
105impl arbitrary::Arbitrary<'_> for PrivateKey {
106    fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result<Self> {
107        use rand::{rngs::StdRng, SeedableRng};
108
109        let mut rand = StdRng::from_seed(u.arbitrary::<[u8; 32]>()?);
110        Ok(Self::random(&mut rand))
111    }
112}
113
114#[cfg(test)]
115impl PartialEq for PrivateKey {
116    fn eq(&self, other: &Self) -> bool {
117        self.key
118            .expose(|key1| other.key.expose(|key2| key1.as_bytes() == key2.as_bytes()))
119    }
120}
121
122/// Ed25519 Public Key.
123#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
124pub struct PublicKey {
125    key: ed25519_consensus::VerificationKey,
126}
127
128impl From<PrivateKey> for PublicKey {
129    fn from(value: PrivateKey) -> Self {
130        value.key.expose(|key| Self {
131            key: key.verification_key(),
132        })
133    }
134}
135
136impl crate::PublicKey for PublicKey {}
137
138impl crate::Verifier for PublicKey {
139    type Signature = Signature;
140
141    fn verify(&self, namespace: &[u8], msg: &[u8], sig: &Self::Signature) -> bool {
142        self.verify_inner(Some(namespace), msg, sig)
143    }
144}
145
146impl PublicKey {
147    #[inline(always)]
148    fn verify_inner(&self, namespace: Option<&[u8]>, msg: &[u8], sig: &Signature) -> bool {
149        let payload = namespace
150            .map(|namespace| Cow::Owned(union_unique(namespace, msg)))
151            .unwrap_or_else(|| Cow::Borrowed(msg));
152        self.key
153            .verify(&ed25519_consensus::Signature::from(sig.raw), &payload)
154            .is_ok()
155    }
156}
157
158impl Write for PublicKey {
159    fn write(&self, buf: &mut impl BufMut) {
160        self.key.as_bytes().write(buf);
161    }
162}
163
164impl Read for PublicKey {
165    type Cfg = ();
166
167    fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, CodecError> {
168        let raw = <[u8; Self::SIZE]>::read(buf)?;
169        let result = VerificationKey::try_from(raw);
170        #[cfg(feature = "std")]
171        let key = result.map_err(|e| CodecError::Wrapped(CURVE_NAME, e.into()))?;
172        #[cfg(not(feature = "std"))]
173        let key = result
174            .map_err(|e| CodecError::Wrapped(CURVE_NAME, alloc::format!("{:?}", e).into()))?;
175
176        Ok(Self { key })
177    }
178}
179
180impl FixedSize for PublicKey {
181    const SIZE: usize = PUBLIC_KEY_LENGTH;
182}
183
184impl Span for PublicKey {}
185
186impl Array for PublicKey {}
187
188impl AsRef<[u8]> for PublicKey {
189    fn as_ref(&self) -> &[u8] {
190        self.key.as_ref()
191    }
192}
193
194impl Deref for PublicKey {
195    type Target = [u8];
196    fn deref(&self) -> &[u8] {
197        self.key.as_ref()
198    }
199}
200
201impl From<VerificationKey> for PublicKey {
202    fn from(key: VerificationKey) -> Self {
203        Self { key }
204    }
205}
206
207impl Debug for PublicKey {
208    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
209        write!(f, "{}", hex(self))
210    }
211}
212
213impl Display for PublicKey {
214    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
215        write!(f, "{}", hex(self))
216    }
217}
218
219#[cfg(feature = "arbitrary")]
220impl arbitrary::Arbitrary<'_> for PublicKey {
221    fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result<Self> {
222        use crate::Signer;
223        use commonware_math::algebra::Random;
224        use rand::{rngs::StdRng, SeedableRng};
225
226        let mut rand = StdRng::from_seed(u.arbitrary::<[u8; 32]>()?);
227        let private_key = PrivateKey::random(&mut rand);
228        Ok(private_key.public_key())
229    }
230}
231
232/// Ed25519 Signature.
233///
234/// Signatures from honestly generated keys are *non-malleable*: an adversary
235/// with access to many messages and signatures, verifying against an honestly
236/// generated public key, cannot find a new signature which will verify, even by
237/// tampering or modifying the signatures that it has seen previously.
238///
239/// Like any signature, it's also not possible to have a signature that verifies against
240/// one message also verify against another. This property does not hold for maliciously
241/// generated public keys. In particular, it's possible to craft public keys (which would
242/// otherwise not be honestly generatable) for which a signature will verify against any message.
243#[derive(Clone, Eq, PartialEq)]
244pub struct Signature {
245    /// Because [`ed25519_consensus::Signature`] can be created from this byte array
246    /// with minimal overhead, we only store the raw bytes.
247    raw: [u8; SIGNATURE_LENGTH],
248}
249
250impl crate::Signature for Signature {}
251
252impl Write for Signature {
253    fn write(&self, buf: &mut impl BufMut) {
254        self.raw.write(buf);
255    }
256}
257
258impl Read for Signature {
259    type Cfg = ();
260
261    fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, CodecError> {
262        let raw = <[u8; Self::SIZE]>::read(buf)?;
263        Ok(Self { raw })
264    }
265}
266
267impl FixedSize for Signature {
268    const SIZE: usize = SIGNATURE_LENGTH;
269}
270
271impl Span for Signature {}
272
273impl Array for Signature {}
274
275impl Hash for Signature {
276    fn hash<H: Hasher>(&self, state: &mut H) {
277        self.raw.hash(state);
278    }
279}
280
281impl Ord for Signature {
282    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
283        self.raw.cmp(&other.raw)
284    }
285}
286
287impl PartialOrd for Signature {
288    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
289        Some(self.cmp(other))
290    }
291}
292
293impl AsRef<[u8]> for Signature {
294    fn as_ref(&self) -> &[u8] {
295        &self.raw
296    }
297}
298
299impl Deref for Signature {
300    type Target = [u8];
301    fn deref(&self) -> &[u8] {
302        &self.raw
303    }
304}
305
306impl From<ed25519_consensus::Signature> for Signature {
307    fn from(value: ed25519_consensus::Signature) -> Self {
308        let raw = value.to_bytes();
309        Self { raw }
310    }
311}
312
313impl Debug for Signature {
314    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
315        write!(f, "{}", hex(&self.raw))
316    }
317}
318
319impl Display for Signature {
320    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
321        write!(f, "{}", hex(&self.raw))
322    }
323}
324
325#[cfg(feature = "arbitrary")]
326impl arbitrary::Arbitrary<'_> for Signature {
327    fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result<Self> {
328        use crate::Signer;
329        use commonware_math::algebra::Random;
330        use rand::{rngs::StdRng, SeedableRng};
331
332        let mut rand = StdRng::from_seed(u.arbitrary::<[u8; 32]>()?);
333        let private_key = PrivateKey::random(&mut rand);
334        let len = u.arbitrary::<usize>()? % 256;
335        let message = u
336            .arbitrary_iter()?
337            .take(len)
338            .collect::<Result<Vec<_>, _>>()?;
339
340        Ok(private_key.sign(&[], &message))
341    }
342}
343
344/// Ed25519 Batch Verifier.
345#[cfg(feature = "std")]
346pub struct Batch {
347    verifier: ed25519_consensus::batch::Verifier,
348}
349
350#[cfg(feature = "std")]
351impl BatchVerifier<PublicKey> for Batch {
352    fn new() -> Self {
353        Self {
354            verifier: ed25519_consensus::batch::Verifier::new(),
355        }
356    }
357
358    fn add(
359        &mut self,
360        namespace: &[u8],
361        message: &[u8],
362        public_key: &PublicKey,
363        signature: &Signature,
364    ) -> bool {
365        self.add_inner(Some(namespace), message, public_key, signature)
366    }
367
368    fn verify<R: CryptoRngCore>(self, rng: &mut R) -> bool {
369        self.verifier.verify(rng).is_ok()
370    }
371}
372
373#[cfg(feature = "std")]
374impl Batch {
375    #[inline(always)]
376    fn add_inner(
377        &mut self,
378        namespace: Option<&[u8]>,
379        message: &[u8],
380        public_key: &PublicKey,
381        signature: &Signature,
382    ) -> bool {
383        let payload = namespace
384            .map(|ns| Cow::Owned(union_unique(ns, message)))
385            .unwrap_or_else(|| Cow::Borrowed(message));
386        let item = ed25519_consensus::batch::Item::from((
387            public_key.key.into(),
388            ed25519_consensus::Signature::from(signature.raw),
389            &payload,
390        ));
391        self.verifier.queue(item);
392        true
393    }
394}
395
396/// Test vectors sourced from https://datatracker.ietf.org/doc/html/rfc8032#section-7.1.
397#[cfg(test)]
398mod tests {
399    use super::*;
400    use crate::{ed25519, Signer as _};
401    use commonware_codec::{DecodeExt, Encode};
402    use commonware_math::algebra::Random;
403    use commonware_utils::test_rng;
404
405    fn test_sign_and_verify(
406        private_key: PrivateKey,
407        public_key: PublicKey,
408        message: &[u8],
409        signature: Signature,
410    ) {
411        let computed_signature = private_key.sign_inner(None, message);
412        assert_eq!(computed_signature, signature);
413        assert!(public_key.verify_inner(None, message, &computed_signature));
414    }
415
416    fn parse_private_key(private_key: &str) -> PrivateKey {
417        PrivateKey::decode(
418            commonware_utils::from_hex_formatted(private_key)
419                .unwrap()
420                .as_ref(),
421        )
422        .unwrap()
423    }
424
425    fn parse_public_key(public_key: &str) -> PublicKey {
426        PublicKey::decode(
427            commonware_utils::from_hex_formatted(public_key)
428                .unwrap()
429                .as_ref(),
430        )
431        .unwrap()
432    }
433
434    fn parse_signature(signature: &str) -> Signature {
435        Signature::decode(
436            commonware_utils::from_hex_formatted(signature)
437                .unwrap()
438                .as_ref(),
439        )
440        .unwrap()
441    }
442
443    fn vector_1() -> (PrivateKey, PublicKey, Vec<u8>, Signature) {
444        (
445            // secret key
446            parse_private_key(
447                "
448                9d61b19deffd5a60ba844af492ec2cc4
449                4449c5697b326919703bac031cae7f60
450                ",
451            ),
452            // public key
453            parse_public_key(
454                "
455                d75a980182b10ab7d54bfed3c964073a
456                0ee172f3daa62325af021a68f707511a
457                ",
458            ),
459            // message
460            b"".to_vec(),
461            // signature
462            parse_signature(
463                "
464                e5564300c360ac729086e2cc806e828a
465                84877f1eb8e5d974d873e06522490155
466                5fb8821590a33bacc61e39701cf9b46b
467                d25bf5f0595bbe24655141438e7a100b
468                ",
469            ),
470        )
471    }
472
473    fn vector_2() -> (PrivateKey, PublicKey, Vec<u8>, Signature) {
474        (
475            // secret key
476            parse_private_key(
477                "
478                4ccd089b28ff96da9db6c346ec114e0f
479                5b8a319f35aba624da8cf6ed4fb8a6fb
480                ",
481            ),
482            // public key
483            parse_public_key(
484                "
485                3d4017c3e843895a92b70aa74d1b7ebc
486                9c982ccf2ec4968cc0cd55f12af4660c
487                ",
488            ),
489            // message
490            [0x72].to_vec(),
491            // signature
492            parse_signature(
493                "
494                92a009a9f0d4cab8720e820b5f642540
495                a2b27b5416503f8fb3762223ebdb69da
496                085ac1e43e15996e458f3613d0f11d8c
497                387b2eaeb4302aeeb00d291612bb0c00
498                ",
499            ),
500        )
501    }
502
503    #[test]
504    fn test_codec_private_key() {
505        let private_key = parse_private_key(
506            "
507            9d61b19deffd5a60ba844af492ec2cc4
508            4449c5697b326919703bac031cae7f60
509            ",
510        );
511        let encoded = private_key.encode();
512        assert_eq!(encoded.len(), PRIVATE_KEY_LENGTH);
513        let decoded = PrivateKey::decode(encoded).unwrap();
514        assert_eq!(private_key, decoded);
515    }
516
517    #[test]
518    fn test_codec_public_key() {
519        let public_key = parse_public_key(
520            "
521            d75a980182b10ab7d54bfed3c964073a
522            0ee172f3daa62325af021a68f707511a
523            ",
524        );
525        let encoded = public_key.encode();
526        assert_eq!(encoded.len(), PUBLIC_KEY_LENGTH);
527        let decoded = PublicKey::decode(encoded).unwrap();
528        assert_eq!(public_key, decoded);
529    }
530
531    #[test]
532    fn test_codec_signature() {
533        let signature = parse_signature(
534            "
535            e5564300c360ac729086e2cc806e828a
536            84877f1eb8e5d974d873e06522490155
537            5fb8821590a33bacc61e39701cf9b46b
538            d25bf5f0595bbe24655141438e7a100b
539            ",
540        );
541        let encoded = signature.encode();
542        assert_eq!(encoded.len(), SIGNATURE_LENGTH);
543        let decoded = Signature::decode(encoded).unwrap();
544        assert_eq!(signature, decoded);
545    }
546
547    #[test]
548    fn rfc8032_test_vector_1() {
549        let (private_key, public_key, message, signature) = vector_1();
550        test_sign_and_verify(private_key, public_key, &message, signature)
551    }
552
553    // sanity check the test infra rejects bad signatures
554    #[test]
555    #[should_panic]
556    fn bad_signature() {
557        let (private_key, public_key, message, _) = vector_1();
558        let private_key_2 = PrivateKey::random(&mut test_rng());
559        let bad_signature = private_key_2.sign_inner(None, &message);
560        test_sign_and_verify(private_key, public_key, &message, bad_signature);
561    }
562
563    // sanity check the test infra rejects non-matching messages
564    #[test]
565    #[should_panic]
566    fn different_message() {
567        let (private_key, public_key, _, signature) = vector_1();
568        let different_message = b"this is a different message".to_vec();
569        test_sign_and_verify(private_key, public_key, &different_message, signature);
570    }
571
572    #[test]
573    fn rfc8032_test_vector_2() {
574        let (private_key, public_key, message, signature) = vector_2();
575        test_sign_and_verify(private_key, public_key, &message, signature)
576    }
577
578    #[test]
579    fn rfc8032_test_vector_3() {
580        let private_key = parse_private_key(
581            "
582            c5aa8df43f9f837bedb7442f31dcb7b1
583            66d38535076f094b85ce3a2e0b4458f7
584            ",
585        );
586        let public_key = parse_public_key(
587            "
588            fc51cd8e6218a1a38da47ed00230f058
589            0816ed13ba3303ac5deb911548908025
590            ",
591        );
592        let message = hex!("0xaf82");
593        let signature = parse_signature(
594            "
595            6291d657deec24024827e69c3abe01a3
596            0ce548a284743a445e3680d7db5ac3ac
597            18ff9b538d16f290ae67f760984dc659
598            4a7c15e9716ed28dc027beceea1ec40a
599            ",
600        );
601        test_sign_and_verify(private_key, public_key, &message, signature)
602    }
603
604    #[test]
605    fn rfc8032_test_vector_1024() {
606        let private_key = parse_private_key(
607            "
608            f5e5767cf153319517630f226876b86c
609            8160cc583bc013744c6bf255f5cc0ee5
610            ",
611        );
612        let public_key = parse_public_key(
613            "
614            278117fc144c72340f67d0f2316e8386
615            ceffbf2b2428c9c51fef7c597f1d426e
616            ",
617        );
618        let message = commonware_utils::from_hex_formatted(
619            "
620            08b8b2b733424243760fe426a4b54908
621            632110a66c2f6591eabd3345e3e4eb98
622            fa6e264bf09efe12ee50f8f54e9f77b1
623            e355f6c50544e23fb1433ddf73be84d8
624            79de7c0046dc4996d9e773f4bc9efe57
625            38829adb26c81b37c93a1b270b20329d
626            658675fc6ea534e0810a4432826bf58c
627            941efb65d57a338bbd2e26640f89ffbc
628            1a858efcb8550ee3a5e1998bd177e93a
629            7363c344fe6b199ee5d02e82d522c4fe
630            ba15452f80288a821a579116ec6dad2b
631            3b310da903401aa62100ab5d1a36553e
632            06203b33890cc9b832f79ef80560ccb9
633            a39ce767967ed628c6ad573cb116dbef
634            efd75499da96bd68a8a97b928a8bbc10
635            3b6621fcde2beca1231d206be6cd9ec7
636            aff6f6c94fcd7204ed3455c68c83f4a4
637            1da4af2b74ef5c53f1d8ac70bdcb7ed1
638            85ce81bd84359d44254d95629e9855a9
639            4a7c1958d1f8ada5d0532ed8a5aa3fb2
640            d17ba70eb6248e594e1a2297acbbb39d
641            502f1a8c6eb6f1ce22b3de1a1f40cc24
642            554119a831a9aad6079cad88425de6bd
643            e1a9187ebb6092cf67bf2b13fd65f270
644            88d78b7e883c8759d2c4f5c65adb7553
645            878ad575f9fad878e80a0c9ba63bcbcc
646            2732e69485bbc9c90bfbd62481d9089b
647            eccf80cfe2df16a2cf65bd92dd597b07
648            07e0917af48bbb75fed413d238f5555a
649            7a569d80c3414a8d0859dc65a46128ba
650            b27af87a71314f318c782b23ebfe808b
651            82b0ce26401d2e22f04d83d1255dc51a
652            ddd3b75a2b1ae0784504df543af8969b
653            e3ea7082ff7fc9888c144da2af58429e
654            c96031dbcad3dad9af0dcbaaaf268cb8
655            fcffead94f3c7ca495e056a9b47acdb7
656            51fb73e666c6c655ade8297297d07ad1
657            ba5e43f1bca32301651339e22904cc8c
658            42f58c30c04aafdb038dda0847dd988d
659            cda6f3bfd15c4b4c4525004aa06eeff8
660            ca61783aacec57fb3d1f92b0fe2fd1a8
661            5f6724517b65e614ad6808d6f6ee34df
662            f7310fdc82aebfd904b01e1dc54b2927
663            094b2db68d6f903b68401adebf5a7e08
664            d78ff4ef5d63653a65040cf9bfd4aca7
665            984a74d37145986780fc0b16ac451649
666            de6188a7dbdf191f64b5fc5e2ab47b57
667            f7f7276cd419c17a3ca8e1b939ae49e4
668            88acba6b965610b5480109c8b17b80e1
669            b7b750dfc7598d5d5011fd2dcc5600a3
670            2ef5b52a1ecc820e308aa342721aac09
671            43bf6686b64b2579376504ccc493d97e
672            6aed3fb0f9cd71a43dd497f01f17c0e2
673            cb3797aa2a2f256656168e6c496afc5f
674            b93246f6b1116398a346f1a641f3b041
675            e989f7914f90cc2c7fff357876e506b5
676            0d334ba77c225bc307ba537152f3f161
677            0e4eafe595f6d9d90d11faa933a15ef1
678            369546868a7f3a45a96768d40fd9d034
679            12c091c6315cf4fde7cb68606937380d
680            b2eaaa707b4c4185c32eddcdd306705e
681            4dc1ffc872eeee475a64dfac86aba41c
682            0618983f8741c5ef68d3a101e8a3b8ca
683            c60c905c15fc910840b94c00a0b9d0
684            ",
685        )
686        .unwrap();
687        let signature = parse_signature(
688            "
689            0aab4c900501b3e24d7cdf4663326a3a
690            87df5e4843b2cbdb67cbf6e460fec350
691            aa5371b1508f9f4528ecea23c436d94b
692            5e8fcd4f681e30a6ac00a9704a188a03
693            ",
694        );
695        test_sign_and_verify(private_key, public_key, &message, signature)
696    }
697
698    #[test]
699    fn rfc8032_test_vector_sha() {
700        let private_key = commonware_utils::from_hex_formatted(
701            "
702            833fe62409237b9d62ec77587520911e
703            9a759cec1d19755b7da901b96dca3d42
704            ",
705        )
706        .unwrap();
707        let public_key = commonware_utils::from_hex_formatted(
708            "
709            ec172b93ad5e563bf4932c70e1245034
710            c35467ef2efd4d64ebf819683467e2bf
711            ",
712        )
713        .unwrap();
714        let message = commonware_utils::from_hex_formatted(
715            "
716            ddaf35a193617abacc417349ae204131
717            12e6fa4e89a97ea20a9eeee64b55d39a
718            2192992a274fc1a836ba3c23a3feebbd
719            454d4423643ce80e2a9ac94fa54ca49f
720            ",
721        )
722        .unwrap();
723        let signature = commonware_utils::from_hex_formatted(
724            "
725            dc2a4459e7369633a52b1bf277839a00
726            201009a3efbf3ecb69bea2186c26b589
727            09351fc9ac90b3ecfdfbc7c66431e030
728            3dca179c138ac17ad9bef1177331a704
729            ",
730        )
731        .unwrap();
732        test_sign_and_verify(
733            PrivateKey::decode(private_key.as_ref()).unwrap(),
734            PublicKey::decode(public_key.as_ref()).unwrap(),
735            &message,
736            Signature::decode(signature.as_ref()).unwrap(),
737        )
738    }
739
740    #[test]
741    fn batch_verify_valid() {
742        let v1 = vector_1();
743        let v2 = vector_2();
744        let mut batch = ed25519::Batch::new();
745        assert!(batch.add_inner(None, &v1.2, &v1.1, &v1.3));
746        assert!(batch.add_inner(None, &v2.2, &v2.1, &v2.3));
747        assert!(batch.verify(&mut test_rng()));
748    }
749
750    #[test]
751    fn batch_verify_invalid() {
752        let v1 = vector_1();
753        let v2 = vector_2();
754        let mut bad_signature = v2.3.to_vec();
755        bad_signature[3] = 0xff;
756
757        let mut batch = Batch::new();
758        assert!(batch.add_inner(None, &v1.2, &v1.1, &v1.3));
759        assert!(batch.add_inner(
760            None,
761            &v2.2,
762            &v2.1,
763            &Signature::decode(bad_signature.as_ref()).unwrap()
764        ));
765        assert!(!batch.verify(&mut test_rng()));
766    }
767
768    #[test]
769    fn test_zero_signature_fails() {
770        let (_, public_key, message, _) = vector_1();
771        let zero_sig = Signature::decode(vec![0u8; Signature::SIZE].as_ref()).unwrap();
772        assert!(!public_key.verify_inner(None, &message, &zero_sig));
773    }
774
775    #[test]
776    fn test_high_s_fails() {
777        let (_, public_key, message, signature) = vector_1();
778        let mut bad_signature = signature.to_vec();
779        bad_signature[63] |= 0x80; // make S non-canonical
780        let bad_signature = Signature::decode(bad_signature.as_ref()).unwrap();
781        assert!(!public_key.verify_inner(None, &message, &bad_signature));
782    }
783
784    #[test]
785    fn test_invalid_r_fails() {
786        let (_, public_key, message, signature) = vector_1();
787        let mut bad_signature = signature.to_vec();
788        for b in bad_signature.iter_mut().take(32) {
789            *b = 0xff; // invalid R component
790        }
791        let bad_signature = Signature::decode(bad_signature.as_ref()).unwrap();
792        assert!(!public_key.verify_inner(None, &message, &bad_signature));
793    }
794
795    #[test]
796    fn test_from_signing_key() {
797        let signing_key = ed25519_consensus::SigningKey::new(test_rng());
798        let expected_public = signing_key.verification_key();
799        let private_key = PrivateKey::from(signing_key);
800        assert_eq!(private_key.public_key().key, expected_public);
801    }
802
803    #[test]
804    fn test_private_key_redacted() {
805        let private_key = PrivateKey::random(&mut test_rng());
806        let debug = format!("{:?}", private_key);
807        let display = format!("{}", private_key);
808        assert!(debug.contains("REDACTED"));
809        assert!(display.contains("REDACTED"));
810    }
811
812    #[test]
813    fn test_from_private_key_to_public_key() {
814        let private_key = PrivateKey::random(&mut test_rng());
815        assert_eq!(private_key.public_key(), PublicKey::from(private_key));
816    }
817
818    #[cfg(feature = "arbitrary")]
819    mod conformance {
820        use super::*;
821        use commonware_codec::conformance::CodecConformance;
822
823        commonware_conformance::conformance_tests! {
824            CodecConformance<PrivateKey>,
825            CodecConformance<PublicKey>,
826            CodecConformance<Signature>,
827        }
828    }
829}
commonware_cryptography/ed25519/scheme.rs

commonware_cryptography/ed25519/
scheme.rs
