File: note_test.go

package info (click to toggle)
golang-github-transparency-dev-formats 0.0~git20250403.313b830-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 292 kB
  • sloc: sh: 124; makefile: 2
file content (407 lines) | stat: -rw-r--r-- 11,494 bytes parent folder | download
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
// Copyright 2021 Google LLC. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package log_test

import (
	"fmt"
	"testing"

	"github.com/transparency-dev/formats/log"
	"golang.org/x/mod/sumdb/note"
)

var (
	logVK = "Log+2271c621+AemuH5ooBpEPcr+W8onrjA1NfuzBVHdezakU81Ekarvs"
	logSK = "PRIVATE+KEY+Log+2271c621+AdEIq9FLRQni54Wg68T96VJO+iayOaulswav2DUMKgvQ"

	known1VK = "Known+451c786d+AXAQ0T7lbwuY4ABJ9/MYY9bWV3hmSyOGVt2x42NkmdUH"
	known1SK = "PRIVATE+KEY+Known+451c786d+AQPRoE2+Z+Ed1HaHBA9F/FfracvcZ2rDU39kCecMEoci"

	known2VK = "KnownAgain+4893b26c+AQ+LR7BFF/F/dkpIBjBpSvT0crkteizuUkavAoGeaYMj"
	known2SK = "PRIVATE+KEY+KnownAgain+4893b26c+ARhZda/l25zjGZswYLDZsLNRzNpmv5wYTN9IoTr1OJ2+"

	unknownVK = "Unknown+fdbb2e08+AWgRIYZ+8x1Vl+1Q+sR8zciNHiYI1SdlBjNw+RV0rots"
	unknownSK = "PRIVATE+KEY+Unknown+fdbb2e08+Aav2knTC6orbhXX8pMWuNiWgO+Wwk2DB+h1eU2Q1W1nU"

	_ = unknownVK
)

func TestParseCheckpoint(t *testing.T) {
	logVerifier, err := note.NewVerifier(logVK)
	if err != nil {
		t.Fatalf("NewVerifier: %v", err)
	}
	known1Verifier, err := note.NewVerifier(known1VK)
	if err != nil {
		t.Fatalf("NewVerifier: %v", err)
	}
	known2Verifier, err := note.NewVerifier(known2VK)
	if err != nil {
		t.Fatalf("NewVerifier: %v", err)
	}
	cp := log.Checkpoint{
		Origin: "TestParseCheckpoint",
		Size:   42,
		Hash:   []byte("abcdef"),
	}
	noteBody := string(cp.Marshal())

	lns, err := note.NewSigner(logSK)
	if err != nil {
		t.Fatalf("couldn't create log signer: %v", err)
	}
	k1ns, err := note.NewSigner(known1SK)
	if err != nil {
		t.Fatalf("couldn't create known signer: %v", err)
	}
	k2ns, err := note.NewSigner(known2SK)
	if err != nil {
		t.Fatalf("couldn't create known signer: %v", err)
	}
	uns, err := note.NewSigner(unknownSK)
	if err != nil {
		t.Fatalf("couldn't create unknown signer: %v", err)
	}

	for _, test := range []struct {
		desc     string
		logID    string
		noteBody string
		sigs     []note.Signer
		wantErr  bool
		wantSigs int
	}{
		{
			desc:     "no sigs",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{},
			wantErr:  true,
			wantSigs: 0,
		},
		{
			desc:     "just log sig",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns},
			wantErr:  false,
			wantSigs: 1,
		},
		{
			desc:     "bad body good sigs",
			logID:    "TestParseCheckpoint",
			noteBody: "if this is a valid checkpoint then I'll eat my hat\n",
			sigs:     []note.Signer{lns},
			wantErr:  true,
			wantSigs: 1,
		},
		{
			desc:     "log and known1 sig",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns},
			wantErr:  false,
			wantSigs: 2,
		},
		{
			desc:     "log and known2 sig",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns},
			wantErr:  false,
			wantSigs: 2,
		},
		{
			desc:     "log, known1, and unknown sig",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns, uns},
			wantErr:  false,
			wantSigs: 2,
		},
		{
			desc:     "just required sigs",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns, k2ns},
			wantErr:  false,
			wantSigs: 3,
		},
		{
			desc:     "one verifier signs twice",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns, k1ns},
			wantErr:  false,
			wantSigs: 2,
		},
		{
			desc:     "just required sigs in mixed order",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{k2ns, lns, k1ns},
			wantErr:  false,
			wantSigs: 3,
		}, {
			desc:     "all sigs",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns, k2ns, uns},
			wantErr:  false,
			wantSigs: 3,
		}, {
			desc:     "just known",
			logID:    "TestParseCheckpoint",
			noteBody: noteBody,
			sigs:     []note.Signer{k1ns, k2ns},
			wantErr:  true,
			wantSigs: 2,
		}, {
			desc:     "all sigs but wrong logID",
			logID:    "this is not the logID you are looking for",
			noteBody: noteBody,
			sigs:     []note.Signer{lns, k1ns, k2ns, uns},
			wantErr:  true,
			wantSigs: 3,
		},
	} {
		t.Run(test.desc, func(t *testing.T) {
			nBs, err := note.Sign(&note.Note{Text: test.noteBody}, test.sigs...)
			if err != nil {
				t.Fatalf("Failed to sign note: %v", err)
			}

			// Now parse what we have created.
			_, _, n, err := log.ParseCheckpoint(nBs, test.logID, logVerifier, known1Verifier, known2Verifier)
			if gotErr := err != nil; gotErr != test.wantErr {
				t.Errorf("gotErr %t != wantErr %t (%v)", gotErr, test.wantErr, err)
			}
			gotSigs := 0
			if n != nil {
				gotSigs = len(n.Sigs)
			}
			if gotSigs != test.wantSigs {
				t.Errorf("got %d signatures but wanted %d", gotSigs, test.wantSigs)
			}
		})
	}
}

func TestSumDBNoteParsing(t *testing.T) {
	logVerifier, err := note.NewVerifier("sum.golang.org+033de0ae+Ac4zctda0e5eza+HJyk9SxEdh+s3Ux18htTTAD8OuAn8")
	if err != nil {
		t.Fatalf("NewVerifier: %v", err)
	}
	noteString := `go.sum database tree
6476701
mb8QLQIs0Z0yP5Cstq6guj87oXWeC9gEM8oVikmm9Wk=

— sum.golang.org Az3grsLX85Gz+s1SiTbgkuqxgItqFq7gsMUEyVnrsa9LM7Us9S+1xbFIGu95949rj4nPRYfvimWEPWL+o3GeoWwOoAw=
`

	for _, test := range []struct {
		desc    string
		logID   string
		wantErr bool
	}{
		{
			desc:    "hunky dory",
			logID:   "go.sum database tree",
			wantErr: false,
		},
		{
			desc:    "wrong logID",
			logID:   "Go rocks but I might have the wrong ID",
			wantErr: true,
		},
	} {
		t.Run(test.desc, func(t *testing.T) {
			cp, _, _, err := log.ParseCheckpoint([]byte(noteString), test.logID, logVerifier)
			if err != nil {
				if !test.wantErr {
					t.Fatalf("Failed to parse checkpoint note: %v", err)
				}
				if cp != nil {
					t.Errorf("Expected empty checkpoint because of error but got %+v", cp)
				}
				// Always return after error because remaining checks are for cp, which is nil.
				return
			}
			if test.wantErr {
				t.Fatal("Expected error but didn't get it")
			}
			if got, want := cp.Size, uint64(6476701); got != want {
				t.Errorf("expected size %d but got %d", want, got)
			}
			if got, want := cp.Origin, "go.sum database tree"; got != want {
				t.Errorf("expected log ID %q but got %q", want, got)
			}
		})
	}
}

func BenchmarkParse(b *testing.B) {
	logVerifier, err := note.NewVerifier("sum.golang.org+033de0ae+Ac4zctda0e5eza+HJyk9SxEdh+s3Ux18htTTAD8OuAn8")
	if err != nil {
		b.Fatalf("NewVerifier: %v", err)
	}
	baseNote := `go.sum database tree
6476701
mb8QLQIs0Z0yP5Cstq6guj87oXWeC9gEM8oVikmm9Wk=

— sum.golang.org Az3grsLX85Gz+s1SiTbgkuqxgItqFq7gsMUEyVnrsa9LM7Us9S+1xbFIGu95949rj4nPRYfvimWEPWL+o3GeoWwOoAw=
`
	for _, test := range []struct {
		desc      string
		verifiers []string
		sigs      []string
	}{
		{
			desc: "bare minimum",
		},
		{
			desc: "one verifier",
			verifiers: []string{
				"monkeys+db4d9f7e+AULaJMvTtDLHPUcUrjdDad9vDlh/PTfC2VV60JUtCfWT",
			},
			sigs: []string{
				"— monkeys 202ffh9ve46Mqbhuyb4wnC2Pwdan5EsXQym/tF1ggXJqhjGosU4T5intH4iKMRgDLxrnXuIjRaU2NbvAnaepM6Y+8ww=",
			},
		},
		{
			desc: "many verifiers",
			verifiers: []string{
				"monkeys+db4d9f7e+AULaJMvTtDLHPUcUrjdDad9vDlh/PTfC2VV60JUtCfWT",
				"bananas+cf639f13+AaPjhFnPCQnid/Ql32KWhmh+uk72FVRfK+2DLmO3BI3M",
				"witness+f13a86db+AdYV1Ztajd9BvyjP2HgpwrqYL6TjOwIjGMOq8Bu42xbN",
			},
			sigs: []string{
				"— monkeys 202ffh9ve46Mqbhuyb4wnC2Pwdan5EsXQym/tF1ggXJqhjGosU4T5intH4iKMRgDLxrnXuIjRaU2NbvAnaepM6Y+8ww=",
				"— bananas z2OfE+2bbsBZ7NLgfuslc0v7NFW2QyexJ7fhePpoL2N/P7N/COd5S+JNHbQEAlYzz2C5sg0E+x/MggS1mDR6t3/9rQw=",
				"— witness 8TqG25yWGFLdT7WPf/WoyeG3LwqtkXP+8S3yykOVm6EMh4hPgCke6eSVPU4BdtXNMPJBXKF+UpDbGgCdcpR8SVSoqAU=",
			},
		},
		{
			desc: "many sigs, 1 verifier",
			verifiers: []string{
				"monkeys+db4d9f7e+AULaJMvTtDLHPUcUrjdDad9vDlh/PTfC2VV60JUtCfWT",
			},
			sigs: []string{
				"— monkeys 202ffh9ve46Mqbhuyb4wnC2Pwdan5EsXQym/tF1ggXJqhjGosU4T5intH4iKMRgDLxrnXuIjRaU2NbvAnaepM6Y+8ww=",
				"— bananas z2OfE+2bbsBZ7NLgfuslc0v7NFW2QyexJ7fhePpoL2N/P7N/COd5S+JNHbQEAlYzz2C5sg0E+x/MggS1mDR6t3/9rQw=",
				"— witness 8TqG25yWGFLdT7WPf/WoyeG3LwqtkXP+8S3yykOVm6EMh4hPgCke6eSVPU4BdtXNMPJBXKF+UpDbGgCdcpR8SVSoqAU=",
				"— random1 8TqG25yWGFLdT7WPf/WoyeG3LwqtkXP+8S3yykOVm6EMh4hPgCke6eSVPU4BdtXNMPJBXKF+UpDbGgCdcpR8SVSoqAU=",
				"— random2 8TqG25yWGFLdT7WPf/WoyeG3LwqtkXP+8S3yykOVm6EMh4hPgCke6eSVPU4BdtXNMPJBXKF+UpDbGgCdcpR8SVSoqAU=",
			},
		},
	} {
		b.Run(test.desc, func(b *testing.B) {
			vs := make([]note.Verifier, len(test.verifiers))
			for i, v := range test.verifiers {
				vs[i], err = note.NewVerifier(v)
				if err != nil {
					if err != nil {
						b.Fatalf("NewVerifier: %v", err)
					}
				}
			}
			note := baseNote
			for _, s := range test.sigs {
				note = fmt.Sprintf("%s%s\n", note, s)
			}
			for n := 0; n < b.N; n++ {
				if _, _, _, err := log.ParseCheckpoint([]byte(note), "go.sum database tree", logVerifier, vs...); err != nil {
					b.Fatalf("Failed to parse: %v", err)
				}
			}
		})
	}
}

func BenchmarkLotsOfIDs(b *testing.B) {
	for _, t := range []struct {
		numSigners   int
		numVerifiers int
	}{
		{numSigners: 2, numVerifiers: 2},
		{numSigners: 2, numVerifiers: 99},
		{numSigners: 99, numVerifiers: 2},
		{numSigners: 99, numVerifiers: 99},
	} {
		b.Run(fmt.Sprintf("%d verifiers, %d signers", t.numVerifiers, t.numSigners), func(b *testing.B) {
			benchmarkLotsOfIDs(b, t.numSigners, t.numVerifiers, b.N)
		})
	}
}

func benchmarkLotsOfIDs(b *testing.B, ns int, nv int, count int) {
	lv, err := note.NewVerifier("sum.golang.org+033de0ae+Ac4zctda0e5eza+HJyk9SxEdh+s3Ux18htTTAD8OuAn8")
	if err != nil {
		b.Fatalf("NewVerifier: %v", err)
	}
	baseNote := []byte(`go.sum database tree
6476701
mb8QLQIs0Z0yP5Cstq6guj87oXWeC9gEM8oVikmm9Wk=

— sum.golang.org Az3grsLX85Gz+s1SiTbgkuqxgItqFq7gsMUEyVnrsa9LM7Us9S+1xbFIGu95949rj4nPRYfvimWEPWL+o3GeoWwOoAw=
`)

	n, err := note.Open(baseNote, note.VerifierList(lv))
	if err != nil {
		b.Fatalf("Unable to open baseNote: %v", err)
	}

	ss, vs := makeIDs(b, ns, nv)

	if baseNote, err = note.Sign(n, ss...); err != nil {
		b.Fatalf("Failed to sign note: %v", err)
	}

	b.ResetTimer()
	for i := 0; i < count; i++ {
		_, err := note.Open(baseNote, note.VerifierList(vs...))
		if err != nil {
			b.Fatalf("Failed to verify note: %v", err)
		}
	}
}

func makeIDs(t testing.TB, ns int, nv int) ([]note.Signer, []note.Verifier) {
	t.Helper()
	vs := []note.Verifier{}
	ss := []note.Signer{}

	m := ns
	if nv > m {
		m = nv
	}

	for i := 0; i < m; i++ {
		sk, vk, err := note.GenerateKey(nil, fmt.Sprintf("Señor-%d", i))
		if err != nil {
			t.Fatalf("Failed to generate key %d: %v", i, err)
		}
		s, err := note.NewSigner(sk)
		if err != nil {
			t.Fatalf("Failed to create signer %d: %v", i, err)
		}
		v, err := note.NewVerifier(vk)
		if err != nil {
			t.Fatalf("Failed to create verifier %d: %v", i, err)
		}
		vs, ss = append(vs, v), append(ss, s)
	}
	return ss[:ns], vs[:nv]
}