Skip to content

Commit ad3afa4

Browse files
armfazharmfazh
committed
Adding Stateless Hash-based Digital Signature Algorithm (SLH-DSA)
Passes Test vectors from ACVP for internal functions.
1 parent 45c6608 commit ad3afa4

26 files changed

+2852
-0
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Alternatively, look at the [Cloudflare Go](https://github.com/cloudflare/go/tree
3838
[RFC-9496]: https://doi.org/10.17487/RFC9496
3939
[RFC-9497]: https://doi.org/10.17487/RFC9497
4040
[FIPS 202]: https://doi.org/10.6028/NIST.FIPS.202
41+
[FIPS 205]: https://doi.org/10.6028/NIST.FIPS.205
4142
[FIPS 186-5]: https://doi.org/10.6028/NIST.FIPS.186-5
4243
[BLS12-381]: https://electriccoin.co/blog/new-snark-curve/
4344
[ia.cr/2015/267]: https://ia.cr/2015/267
@@ -92,6 +93,7 @@ Alternatively, look at the [Cloudflare Go](https://github.com/cloudflare/go/tree
9293

9394
- [Dilithium](./sign/dilithium): modes 2, 3, 5 ([Dilithium](https://pq-crystals.org/dilithium/)).
9495
- [ML-DSA](./sign/mldsa): modes 44, 65, 87 ([FIPS 204](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.204.pdf)).
96+
- [SLH-DSA](./sign/slhdsa): twelve parameter sets, pure and pre-hash signing ([FIPS 205]).
9597

9698
### Zero-knowledge Proofs
9799

‎sign/slhdsa/acvp_test.go

+300
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,300 @@
1+
package slhdsa
2+
3+
import (
4+
"archive/zip"
5+
"bytes"
6+
"encoding/hex"
7+
"encoding/json"
8+
"fmt"
9+
"io"
10+
"testing"
11+
12+
"github.com/cloudflare/circl/internal/test"
13+
)
14+
15+
type acvpHeader struct {
16+
VsID int `json:"vsId"`
17+
Algorithm string `json:"algorithm"`
18+
Mode string `json:"mode"`
19+
Revision string `json:"revision"`
20+
IsSample bool `json:"isSample"`
21+
}
22+
23+
type acvpKeygenVector struct {
24+
acvpHeader
25+
TestGroups []struct {
26+
TgID int `json:"tgId"`
27+
TestType string `json:"testType"`
28+
ParameterSet string `json:"parameterSet"`
29+
Tests []keygenInput `json:"tests"`
30+
} `json:"testGroups"`
31+
}
32+
33+
type keygenInput struct {
34+
TcID int `json:"tcId"`
35+
Deferred bool `json:"deferred"`
36+
SkSeed hexBytes `json:"skSeed"`
37+
SkPrf hexBytes `json:"skPrf"`
38+
PkSeed hexBytes `json:"pkSeed"`
39+
Sk hexBytes `json:"sk"`
40+
Pk hexBytes `json:"pk"`
41+
}
42+
43+
type acvpSigGenPrompt struct {
44+
acvpHeader
45+
TestGroups []struct {
46+
TgID int `json:"tgId"`
47+
TestType string `json:"testType"`
48+
ParameterSet string `json:"parameterSet"`
49+
Deterministic bool `json:"deterministic"`
50+
Tests []signInput `json:"tests"`
51+
} `json:"testGroups"`
52+
}
53+
54+
type signInput struct {
55+
TcID int `json:"tcId"`
56+
Sk hexBytes `json:"sk"`
57+
MsgLen int `json:"messageLength"`
58+
Msg hexBytes `json:"message"`
59+
AddRand hexBytes `json:"additionalRandomness,omitempty"`
60+
}
61+
62+
type acvpSigGenResult struct {
63+
acvpHeader
64+
TestGroups []struct {
65+
TgID int `json:"tgId"`
66+
Tests []struct {
67+
TcID int `json:"tcId"`
68+
Signature hexBytes `json:"signature"`
69+
} `json:"tests"`
70+
} `json:"testGroups"`
71+
}
72+
73+
type acvpVerifyInput struct {
74+
acvpHeader
75+
TestGroups []struct {
76+
TgID int `json:"tgId"`
77+
TestType string `json:"testType"`
78+
ParameterSet string `json:"parameterSet"`
79+
Tests []verifyInput `json:"tests"`
80+
} `json:"testGroups"`
81+
}
82+
83+
type verifyInput struct {
84+
TcID int `json:"tcId"`
85+
Pk hexBytes `json:"pk"`
86+
MessageLength int `json:"messageLength"`
87+
Message hexBytes `json:"message"`
88+
Signature hexBytes `json:"signature"`
89+
Reason string `json:"reason"`
90+
}
91+
92+
type acvpVerifyResult struct {
93+
acvpHeader
94+
TestGroups []struct {
95+
TgID int `json:"tgId"`
96+
Tests []struct {
97+
TcID int `json:"tcId"`
98+
TestPassed bool `json:"testPassed"`
99+
} `json:"tests"`
100+
} `json:"testGroups"`
101+
}
102+
103+
func TestACVP(t *testing.T) {
104+
t.Run("Keygen", testKeygen)
105+
t.Run("Sign", testSign)
106+
t.Run("Verify", testVerify)
107+
}
108+
109+
func testKeygen(t *testing.T) {
110+
// https://github.com/usnistgov/ACVP-Server/tree/v1.1.0.35/gen-val/json-files/SLH-DSA-keyGen-FIPS205
111+
inputs := new(acvpKeygenVector)
112+
readVector(t, "testdata/keygen.json.zip", inputs)
113+
114+
for _, group := range inputs.TestGroups {
115+
t.Run(fmt.Sprintf("TgID_%v", group.TgID), func(t *testing.T) {
116+
for ti := range group.Tests {
117+
t.Run(fmt.Sprintf("TcID_%v", group.Tests[ti].TcID), func(t *testing.T) {
118+
acvpKeygen(t, group.ParameterSet, &group.Tests[ti])
119+
})
120+
}
121+
})
122+
}
123+
}
124+
125+
func testSign(t *testing.T) {
126+
// https://github.com/usnistgov/ACVP-Server/tree/v1.1.0.35/gen-val/json-files/SLH-DSA-sigGen-FIPS205
127+
inputs := new(acvpSigGenPrompt)
128+
readVector(t, "testdata/sigGen_prompt.json.zip", inputs)
129+
outputs := new(acvpSigGenResult)
130+
readVector(t, "testdata/sigGen_results.json.zip", outputs)
131+
132+
for gi, group := range inputs.TestGroups {
133+
test.CheckOk(group.TgID == outputs.TestGroups[gi].TgID, "mismatch of TgID", t)
134+
135+
t.Run(fmt.Sprintf("TgID_%v", group.TgID), func(t *testing.T) {
136+
for ti := range group.Tests {
137+
test.CheckOk(
138+
group.Tests[ti].TcID == outputs.TestGroups[gi].Tests[ti].TcID,
139+
"mismatch of TcID", t,
140+
)
141+
142+
t.Run(fmt.Sprintf("TcID_%v", group.Tests[ti].TcID), func(t *testing.T) {
143+
acvpSign(
144+
t, group.ParameterSet, &group.Tests[ti],
145+
outputs.TestGroups[gi].Tests[ti].Signature,
146+
group.Deterministic,
147+
)
148+
})
149+
}
150+
})
151+
}
152+
}
153+
154+
func testVerify(t *testing.T) {
155+
// https://github.com/usnistgov/ACVP-Server/tree/v1.1.0.35/gen-val/json-files/SLH-DSA-sigVer-FIPS205
156+
inputs := new(acvpVerifyInput)
157+
readVector(t, "testdata/verify_prompt.json.zip", inputs)
158+
outputs := new(acvpVerifyResult)
159+
readVector(t, "testdata/verify_results.json.zip", outputs)
160+
161+
for gi, group := range inputs.TestGroups {
162+
test.CheckOk(group.TgID == outputs.TestGroups[gi].TgID, "mismatch of TgID", t)
163+
164+
t.Run(fmt.Sprintf("TgID_%v", group.TgID), func(t *testing.T) {
165+
for ti := range group.Tests {
166+
test.CheckOk(
167+
group.Tests[ti].TcID == outputs.TestGroups[gi].Tests[ti].TcID,
168+
"mismatch of TcID", t,
169+
)
170+
171+
t.Run(fmt.Sprintf("TcID_%v", group.Tests[ti].TcID), func(t *testing.T) {
172+
acvpVerify(
173+
t, group.ParameterSet, &group.Tests[ti],
174+
outputs.TestGroups[gi].Tests[ti].TestPassed,
175+
)
176+
})
177+
}
178+
})
179+
}
180+
}
181+
182+
func acvpKeygen(t *testing.T, paramSet string, in *keygenInput) {
183+
t.Parallel()
184+
185+
id, err := ParamIDByName(paramSet)
186+
test.CheckNoErr(t, err, "invalid param name")
187+
188+
params := id.params()
189+
pk, sk := slhKeyGenInternal(params, in.SkSeed, in.SkPrf, in.PkSeed)
190+
191+
skGot, err := sk.MarshalBinary()
192+
test.CheckNoErr(t, err, "PrivateKey.MarshalBinary failed")
193+
194+
if !bytes.Equal(skGot, in.Sk) {
195+
test.ReportError(t, skGot, in.Sk)
196+
}
197+
198+
skWant := &PrivateKey{ParamID: id}
199+
err = skWant.UnmarshalBinary(in.Sk)
200+
test.CheckNoErr(t, err, "PrivateKey.UnmarshalBinary failed")
201+
202+
if !sk.Equal(skWant) {
203+
test.ReportError(t, sk, skWant)
204+
}
205+
206+
pkGot, err := pk.MarshalBinary()
207+
test.CheckNoErr(t, err, "PublicKey.MarshalBinary failed")
208+
209+
if !bytes.Equal(pkGot, in.Pk) {
210+
test.ReportError(t, pkGot, in.Pk)
211+
}
212+
213+
pkWant := &PublicKey{ParamID: id}
214+
err = pkWant.UnmarshalBinary(in.Pk)
215+
test.CheckNoErr(t, err, "PublicKey.UnmarshalBinary failed")
216+
217+
if !pk.Equal(pkWant) {
218+
test.ReportError(t, pk, pkWant)
219+
}
220+
}
221+
222+
func acvpSign(
223+
t *testing.T,
224+
paramSet string,
225+
in *signInput,
226+
wantSignature []byte,
227+
deterministic bool,
228+
) {
229+
t.Parallel()
230+
231+
id, err := ParamIDByName(paramSet)
232+
test.CheckNoErr(t, err, "invalid param name")
233+
234+
sk := &PrivateKey{ParamID: id}
235+
err = sk.UnmarshalBinary(in.Sk)
236+
test.CheckNoErr(t, err, "PrivateKey.UnmarshalBinary failed")
237+
238+
addRand := sk.publicKey.seed
239+
if !deterministic {
240+
addRand = in.AddRand
241+
}
242+
243+
params := id.params()
244+
gotSignature, err := slhSignInternal(params, sk, in.Msg, addRand)
245+
test.CheckNoErr(t, err, "slhSignInternal failed")
246+
247+
if !bytes.Equal(gotSignature, wantSignature) {
248+
more := " ... (more bytes differ)"
249+
got := hex.EncodeToString(gotSignature[:10]) + more
250+
want := hex.EncodeToString(wantSignature[:10]) + more
251+
test.ReportError(t, got, want)
252+
}
253+
254+
valid := slhVerifyInternal(params, &sk.publicKey, in.Msg, gotSignature)
255+
test.CheckOk(valid, "slhVerifyInternal failed", t)
256+
}
257+
258+
func acvpVerify(t *testing.T, paramSet string, in *verifyInput, want bool) {
259+
id, err := ParamIDByName(paramSet)
260+
test.CheckNoErr(t, err, "invalid param name")
261+
262+
pk := &PublicKey{ParamID: id}
263+
err = pk.UnmarshalBinary(in.Pk)
264+
test.CheckNoErr(t, err, "PublicKey.UnmarshalBinary failed")
265+
266+
params := id.params()
267+
got := slhVerifyInternal(params, pk, in.Message, in.Signature)
268+
269+
if got != want {
270+
test.ReportError(t, got, want)
271+
}
272+
}
273+
274+
type hexBytes []byte
275+
276+
func (b *hexBytes) UnmarshalJSON(data []byte) (err error) {
277+
var s string
278+
err = json.Unmarshal(data, &s)
279+
if err != nil {
280+
return
281+
}
282+
*b, err = hex.DecodeString(s)
283+
return
284+
}
285+
286+
func readVector(t *testing.T, fileName string, vector interface{}) {
287+
zipFile, err := zip.OpenReader(fileName)
288+
test.CheckNoErr(t, err, "error opening file")
289+
defer zipFile.Close()
290+
291+
jsonFile, err := zipFile.File[0].Open()
292+
test.CheckNoErr(t, err, "error opening unzipping file")
293+
defer jsonFile.Close()
294+
295+
input, err := io.ReadAll(jsonFile)
296+
test.CheckNoErr(t, err, "error reading bytes")
297+
298+
err = json.Unmarshal(input, &vector)
299+
test.CheckNoErr(t, err, "error unmarshalling JSON file")
300+
}

0 commit comments

Comments
 (0)