File: signer_test.go

package info (click to toggle)
golang-github-smallstep-crypto 0.63.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 3,800 kB
  • sloc: sh: 66; makefile: 50
file content (375 lines) | stat: -rw-r--r-- 10,753 bytes parent folder | download | duplicates (3)
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
package tss2

import (
	"bytes"
	"crypto"
	"crypto/ecdsa"
	"crypto/elliptic"
	"crypto/rand"
	"crypto/rsa"
	"io"
	"testing"

	"github.com/google/go-tpm/legacy/tpm2"
	"github.com/google/go-tpm/tpmutil"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

var defaultKeyParamsEC = tpm2.Public{
	Type:       tpm2.AlgECC,
	NameAlg:    tpm2.AlgSHA256,
	Attributes: tpm2.FlagSignerDefault ^ tpm2.FlagRestricted,
	ECCParameters: &tpm2.ECCParams{
		Sign: &tpm2.SigScheme{
			Alg:  tpm2.AlgECDSA,
			Hash: tpm2.AlgSHA256,
		},
		CurveID: tpm2.CurveNISTP256,
	},
}

var defaultKeyParamsRSA = tpm2.Public{
	Type:       tpm2.AlgRSA,
	NameAlg:    tpm2.AlgSHA256,
	Attributes: tpm2.FlagSignerDefault ^ tpm2.FlagRestricted,
	RSAParameters: &tpm2.RSAParams{
		Sign: &tpm2.SigScheme{
			Alg:  tpm2.AlgRSASSA,
			Hash: tpm2.AlgSHA256,
		},
		KeyBits: 2048,
	},
}

var defaultKeyParamsRSAPSS = tpm2.Public{
	Type:       tpm2.AlgRSA,
	NameAlg:    tpm2.AlgSHA256,
	Attributes: tpm2.FlagSignerDefault ^ tpm2.FlagRestricted,
	RSAParameters: &tpm2.RSAParams{
		Sign: &tpm2.SigScheme{
			Alg:  tpm2.AlgRSAPSS,
			Hash: tpm2.AlgSHA256,
		},
		KeyBits: 2048,
	},
}

func assertMaybeError(t assert.TestingT, err error, msgAndArgs ...any) bool {
	return true
}

func TestSign(t *testing.T) {
	rw := openTPM(t)
	t.Cleanup(func() {
		assert.NoError(t, rw.Close())
	})

	keyHnd, _, err := tpm2.CreatePrimary(rw, tpm2.HandleOwner, tpm2.PCRSelection{}, "", "", ECCSRKTemplate)
	require.NoError(t, err)
	t.Cleanup(func() {
		assert.NoError(t, tpm2.FlushContext(rw, keyHnd))
	})

	tests := []struct {
		name      string
		params    tpm2.Public
		opts      crypto.SignerOpts
		assertion assert.ErrorAssertionFunc
	}{
		{"ok ECDSA", defaultKeyParamsEC, crypto.SHA256, assert.NoError},
		{"ok RSA", defaultKeyParamsRSA, crypto.SHA256, assert.NoError},
		{"ok RSAPSS PSSSaltLengthAuto", defaultKeyParamsRSAPSS, &rsa.PSSOptions{
			SaltLength: rsa.PSSSaltLengthAuto, Hash: crypto.SHA256,
		}, assert.NoError},
		{"ok RSAPSS PSSSaltLengthEqualsHash", defaultKeyParamsRSAPSS, &rsa.PSSOptions{
			SaltLength: rsa.PSSSaltLengthEqualsHash, Hash: crypto.SHA256,
		}, assert.NoError},
		{"ok RSAPSS SaltLength=32", defaultKeyParamsRSAPSS, &rsa.PSSOptions{
			SaltLength: 32, Hash: crypto.SHA256,
		}, assert.NoError},
		// 222 is the largest salt possible when signing with a 2048 bit key. Go
		// crypto will use this value when rsa.PSSSaltLengthAuto is set.
		//
		// TPM 2.0's TPM_ALG_RSAPSS algorithm, uses the maximum possible salt
		// length. However, as of TPM revision 1.16, TPMs which follow FIPS
		// 186-4 will interpret TPM_ALG_RSAPSS using salt length equal to the
		// digest length.
		{"RSAPSS SaltLength=222", defaultKeyParamsRSAPSS, &rsa.PSSOptions{
			SaltLength: 222, Hash: crypto.SHA256,
		}, assertMaybeError},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			priv, pub, _, _, _, err := tpm2.CreateKey(rw, keyHnd, tpm2.PCRSelection{}, "", "", tt.params)
			require.NoError(t, err)

			signer, err := CreateSigner(rw, New(pub, priv))
			require.NoError(t, err)

			// Set the ECC SRK template used for testing
			signer.SetSRKTemplate(ECCSRKTemplate)

			hash := crypto.SHA256.New()
			hash.Write([]byte("rulingly-quailed-cloacal-indifferentist-roughhoused-self-mad"))
			sum := hash.Sum(nil)

			sig, err := signer.Sign(rand.Reader, sum, tt.opts)
			tt.assertion(t, err)
			if err != nil {
				return
			}

			// Signature validation using Go crypto
			switch pub := signer.Public().(type) {
			case *ecdsa.PublicKey:
				assert.Equal(t, tpm2.AlgECC, tt.params.Type)
				assert.True(t, ecdsa.VerifyASN1(pub, sum, sig))
			case *rsa.PublicKey:
				assert.Equal(t, tpm2.AlgRSA, tt.params.Type)
				switch tt.params.RSAParameters.Sign.Alg {
				case tpm2.AlgRSASSA:
					assert.NoError(t, rsa.VerifyPKCS1v15(pub, tt.opts.HashFunc(), sum, sig))
				case tpm2.AlgRSAPSS:
					opts, ok := tt.opts.(*rsa.PSSOptions)
					require.True(t, ok)
					assert.NoError(t, rsa.VerifyPSS(pub, opts.Hash, sum, sig, opts))
				default:
					t.Errorf("unexpected RSAParameters.Sign.Alg %v", tt.params.RSAParameters.Sign.Alg)
				}
			default:
				t.Errorf("unexpected PublicKey type %T", pub)
			}
		})
	}
}

func TestSign_SetTPM(t *testing.T) {
	var signer *Signer

	if t.Run("Setup", func(t *testing.T) {
		rw := openTPM(t)
		t.Cleanup(func() {
			assert.NoError(t, rw.Close())
		})
		keyHnd, _, err := tpm2.CreatePrimary(rw, tpm2.HandleOwner, tpm2.PCRSelection{}, "", "", ECCSRKTemplate)
		require.NoError(t, err)
		t.Cleanup(func() {
			assert.NoError(t, tpm2.FlushContext(rw, keyHnd))
		})

		priv, pub, _, _, _, err := tpm2.CreateKey(rw, keyHnd, tpm2.PCRSelection{}, "", "", defaultKeyParamsEC)
		require.NoError(t, err)

		signer, err = CreateSigner(rw, New(pub, priv))
		require.NoError(t, err)
	}) {
		rw := openTPM(t)
		t.Cleanup(func() {
			assert.NoError(t, rw.Close())
		})
		require.NotNil(t, signer)

		// Set new tpm channel
		signer.SetCommandChannel(rw)

		// Set the ECC SRK template used for testing
		signer.SetSRKTemplate(ECCSRKTemplate)

		hash := crypto.SHA256.New()
		hash.Write([]byte("ungymnastic-theirn-cotwin-Summer-pemphigous-propagate"))
		sum := hash.Sum(nil)

		sig, err := signer.Sign(rand.Reader, sum, crypto.SHA256)
		require.NoError(t, err)

		publicKey, ok := signer.Public().(*ecdsa.PublicKey)
		require.True(t, ok)
		assert.True(t, ecdsa.VerifyASN1(publicKey, sum, sig))
	}
}

func TestCreateSigner(t *testing.T) {
	var rw bytes.Buffer
	key, err := ParsePrivateKey(parsePEM(p256TSS2PEM))
	require.NoError(t, err)

	pub, err := tpm2.DecodePublic(key.PublicKey[2:])
	require.NoError(t, err)
	publicKey, err := pub.Key()
	require.NoError(t, err)

	modKey := func(fn TPMOption) *TPMKey {
		return New(key.PublicKey[2:], key.PrivateKey[2:], fn)
	}

	type args struct {
		rw  io.ReadWriter
		key *TPMKey
	}
	tests := []struct {
		name      string
		args      args
		want      *Signer
		assertion assert.ErrorAssertionFunc
	}{
		{"ok", args{&rw, key}, &Signer{
			rw: &rw, publicKey: publicKey, tpmKey: key, srkTemplate: RSASRKTemplate,
		}, assert.NoError},
		{"fail rw", args{nil, key}, nil, assert.Error},
		{"fail key", args{&rw, nil}, nil, assert.Error},
		{"fail type", args{&rw, modKey(func(k *TPMKey) {
			k.Type = oidSealedKey
		})}, nil, assert.Error},
		{"fail policy", args{&rw, modKey(func(k *TPMKey) {
			k.Policy = []TPMPolicy{{CommandCode: 1, CommandPolicy: []byte("command-policy")}}
		})}, nil, assert.Error},
		{"fail authPolicy", args{&rw, modKey(func(k *TPMKey) {
			k.AuthPolicy = []TPMAuthPolicy{{Name: "auth", Policy: []TPMPolicy{{CommandCode: 1, CommandPolicy: []byte("command-policy")}}}}
		})}, nil, assert.Error},
		{"fail secret", args{&rw, modKey(func(k *TPMKey) {
			k.Secret = []byte("secret")
		})}, nil, assert.Error},
		{"fail parent", args{&rw, modKey(func(k *TPMKey) {
			k.Parent = 0
		})}, nil, assert.Error},
		{"fail publicKey", args{&rw, modKey(func(k *TPMKey) {
			k.PublicKey = key.PublicKey[2:]
		})}, nil, assert.Error},
		{"fail privateKey", args{&rw, modKey(func(k *TPMKey) {
			k.PrivateKey = key.PrivateKey[2:]
		})}, nil, assert.Error},
		{"fail decodePublic", args{&rw, modKey(func(k *TPMKey) {
			k.PublicKey = append([]byte{0, 6}, []byte("public")...)
		})}, nil, assert.Error},
		{"fail type", args{&rw, modKey(func(k *TPMKey) {
			p := tpm2.Public{
				Type:       tpm2.AlgSymCipher,
				NameAlg:    tpm2.AlgAES,
				Attributes: tpm2.FlagSignerDefault ^ tpm2.FlagRestricted,
				SymCipherParameters: &tpm2.SymCipherParams{
					Symmetric: &tpm2.SymScheme{
						Alg:     tpm2.AlgAES,
						KeyBits: 128,
						Mode:    tpm2.AlgCFB,
					},
					Unique: []byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 0},
				},
			}
			b, err := p.Encode()
			if assert.NoError(t, err) {
				k.PublicKey = addPrefixLength(b)
			}
		})}, nil, assert.Error},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := CreateSigner(tt.args.rw, tt.args.key)
			tt.assertion(t, err)
			assert.Equal(t, tt.want, got)
		})
	}
}

func Test_curveSigScheme(t *testing.T) {
	type args struct {
		curve elliptic.Curve
	}
	tests := []struct {
		name      string
		args      args
		want      *tpm2.SigScheme
		assertion assert.ErrorAssertionFunc
	}{
		{"ok P-256", args{elliptic.P256()}, &tpm2.SigScheme{
			Alg: tpm2.AlgECDSA, Hash: tpm2.AlgSHA256,
		}, assert.NoError},
		{"ok P-2384", args{elliptic.P384()}, &tpm2.SigScheme{
			Alg: tpm2.AlgECDSA, Hash: tpm2.AlgSHA384,
		}, assert.NoError},
		{"ok P-521", args{elliptic.P521()}, &tpm2.SigScheme{
			Alg: tpm2.AlgECDSA, Hash: tpm2.AlgSHA512,
		}, assert.NoError},
		{"fail P-224", args{elliptic.P224()}, nil, assert.Error},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := curveSigScheme(tt.args.curve)
			tt.assertion(t, err)
			assert.Equal(t, tt.want, got)
		})
	}
}

func Test_signECDSA_fail(t *testing.T) {
	rw := openTPM(t)
	t.Cleanup(func() {
		assert.NoError(t, rw.Close())
	})

	digest := func(h crypto.Hash) []byte {
		hh := h.New()
		hh.Write([]byte("Subotica-chronique-radiancy-inspirationally-transuming-Melbeta"))
		return hh.Sum(nil)
	}

	type args struct {
		rw     io.ReadWriter
		key    tpmutil.Handle
		digest []byte
		curve  elliptic.Curve
	}
	tests := []struct {
		name      string
		args      args
		want      []byte
		assertion assert.ErrorAssertionFunc
	}{
		{"fail curve", args{rw, handleOwner, digest(crypto.SHA224), elliptic.P224()}, nil, assert.Error},
		{"fail sign", args{nil, handleOwner, digest(crypto.SHA256), elliptic.P256()}, nil, assert.Error},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := signECDSA(tt.args.rw, tt.args.key, tt.args.digest, tt.args.curve)
			tt.assertion(t, err)
			assert.Equal(t, tt.want, got)
		})
	}
}

func Test_signRSA_fail(t *testing.T) {
	rw := openTPM(t)
	t.Cleanup(func() {
		assert.NoError(t, rw.Close())
	})

	h := crypto.SHA256.New()
	h.Write([]byte("murmur-squinance-hoghide-jubilation-enteraden-samadh"))
	digest := h.Sum(nil)

	type args struct {
		rw     io.ReadWriter
		key    tpmutil.Handle
		digest []byte
		opts   crypto.SignerOpts
	}
	tests := []struct {
		name      string
		args      args
		want      []byte
		assertion assert.ErrorAssertionFunc
	}{
		{"fail HashToAlgorithm", args{rw, handleOwner, digest, crypto.SHA224}, nil, assert.Error},
		{"fail PSSOptions", args{rw, handleOwner, digest, &rsa.PSSOptions{
			Hash: crypto.SHA256, SaltLength: 222,
		}}, nil, assert.Error},
		{"fail sign", args{nil, handleOwner, digest, crypto.SHA256}, nil, assert.Error},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := signRSA(tt.args.rw, tt.args.key, tt.args.digest, tt.args.opts)
			tt.assertion(t, err)
			assert.Equal(t, tt.want, got)
		})
	}
}