pqcrypto-compat 0.2.0

A convenience crate which implements RustCrypto traits for pqcrypto primitives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

use core::fmt;
use doc_comment::doc_comment;
use pqcrypto_traits::sign::DetachedSignature as DetachedSignatureTrait;
use signature::{Error, Signature as SignatureTrait, Signer, Verifier};

pub use pqcrypto_traits::sign::{PublicKey as PublicKeyTrait, SecretKey as SecretKeyTrait};

macro_rules! impl_sign_verify {
    ($mod_name:ident, $comment:literal) => {
        doc_comment! {
            concat!(
                $comment,
                "\n# Example\n",
                "```\n",
                "use pqcrypto_compat::sign::",
                stringify!($mod_name),
                "::{keypair, Signature};",
                "
use signature::{Signer, Verifier};

let message: Vec<u8> = vec![0, 1, 2, 3, 4, 5];
let (pk, sk) = keypair();
let sig = sk.sign(&message);
pk.verify(&message, &sig).unwrap();
```"
            ),
            pub mod $mod_name {
                use super::*;
                use pqcrypto::sign::$mod_name::{
                    detached_sign, public_key_bytes, secret_key_bytes, signature_bytes,
                    verify_detached_signature, DetachedSignature,
                };
                pub use pqcrypto::sign::$mod_name::{keypair, PublicKey, SecretKey};

                /// Number of bytes in a public key
                pub const PUBLIC_KEY_SIZE: usize = public_key_bytes();
                /// Number of bytes in a secret key
                pub const SECRET_KEY_SIZE: usize = secret_key_bytes();
                /// Number of bytes in a signature
                pub const SIGNATURE_SIZE: usize = signature_bytes();

                // We implement the bare minimum in order to make this compatible with
                // RustCrypto's traits

                #[derive(Copy, Clone)]
                pub struct Signature(DetachedSignature);

                impl AsRef<[u8]> for Signature {
                    fn as_ref(&self) -> &[u8] {
                        self.as_bytes()
                    }
                }

                impl fmt::Debug for Signature {
                    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
                        f.debug_tuple("Signature").field(&self.as_bytes()).finish()
                    }
                }

                impl SignatureTrait for Signature {
                    fn from_bytes(bytes: &[u8]) -> Result<Self, Error> {
                        DetachedSignature::from_bytes(bytes)
                            .map_err(|_| Error::default())
                            .map(Signature)
                    }
                }

                impl Signer<Signature> for SecretKey {
                    fn try_sign(&self, msg: &[u8]) -> Result<Signature, Error> {
                        Ok(Signature(detached_sign(msg, self)))
                    }
                }

                impl Verifier<Signature> for PublicKey {
                    fn verify(&self, msg: &[u8], signature: &Signature) -> Result<(), Error> {
                        verify_detached_signature(&signature.0, msg, &self)
                            .map_err(|_| Error::default())
                    }
                }
            }
        }
    };
}

#[cfg(feature = "pqcrypto-dilithium")]
impl_sign_verify!(dilithium2, "dilithium2");
#[cfg(feature = "pqcrypto-dilithium")]
impl_sign_verify!(dilithium3, "dilithium3");
#[cfg(feature = "pqcrypto-dilithium")]
impl_sign_verify!(dilithium5, "dilithium5");

#[cfg(feature = "pqcrypto-falcon")]
impl_sign_verify!(falcon512, "falcon-512");
#[cfg(feature = "pqcrypto-falcon")]
impl_sign_verify!(falcon1024, "falcon-1024");

// TODO: Figure out what to do with Rainbow. Right now, this produces compiler warnings because
// Rainbow is not secure with the current parameter sets.
/*
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowicircumzenithal, "rainbowI-circumzenithal");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowiclassic, "rainbowI-classic");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowicompressed, "rainbowI-compressed");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowiiicircumzenithal, "rainbowIII-circumzenithal");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowiiiclassic, "rainbowIII-classic");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowiiicompressed, "rainbowIII-compressed");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowvcircumzenithal, "rainbowV-circumzenithal");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowvclassic, "rainbowV-classic");
#[cfg(feature = "pqcrypto-rainbow")]
impl_sign_verify!(rainbowvcompressed, "rainbowV-compressed");
*/

#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka128frobust, "sphincs-haraka-128f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka128fsimple, "sphincs-haraka-128f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka128srobust, "sphincs-haraka-128s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka128ssimple, "sphincs-haraka-128s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka192frobust, "sphincs-haraka-192f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka192fsimple, "sphincs-haraka-192f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka192srobust, "sphincs-haraka-192s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka192ssimple, "sphincs-haraka-192s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka256frobust, "sphincs-haraka-256f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka256fsimple, "sphincs-haraka-256f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka256srobust, "sphincs-haraka-256s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsharaka256ssimple, "sphincs-haraka-256s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256128frobust, "sphincs-sha256-128f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256128fsimple, "sphincs-sha256-128f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256128srobust, "sphincs-sha256-128s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256128ssimple, "sphincs-sha256-128s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256192frobust, "sphincs-sha256-192f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256192fsimple, "sphincs-sha256-192f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256192srobust, "sphincs-sha256-192s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256192ssimple, "sphincs-sha256-192s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256256frobust, "sphincs-sha256-256f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256256fsimple, "sphincs-sha256-256f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256256srobust, "sphincs-sha256-256s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincssha256256ssimple, "sphincs-sha256-256s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256128frobust, "sphincs-shake256-128f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256128fsimple, "sphincs-shake256-128f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256128srobust, "sphincs-shake256-128s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256128ssimple, "sphincs-shake256-128s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256192frobust, "sphincs-shake256-192f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256192fsimple, "sphincs-shake256-192f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256192srobust, "sphincs-shake256-192s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256192ssimple, "sphincs-shake256-192s-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256256frobust, "sphincs-shake256-256f-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256256fsimple, "sphincs-shake256-256f-simple");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256256srobust, "sphincs-shake256-256s-robust");
#[cfg(feature = "pqcrypto-sphincsplus")]
impl_sign_verify!(sphincsshake256256ssimple, "sphincs-shake256-256s-simple");