File: parameters_test.go

package info (click to toggle)
golang-github-tink-crypto-tink-go 2.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,952 kB
  • sloc: sh: 864; makefile: 6
file content (385 lines) | stat: -rw-r--r-- 13,059 bytes parent folder | download | duplicates (5)
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
// Copyright 2025 Google LLC
//
// 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 ecies_test

import (
	"bytes"
	"fmt"
	"testing"

	"github.com/tink-crypto/tink-go/v2/aead/aesctrhmac"
	"github.com/tink-crypto/tink-go/v2/aead/aesgcm"
	"github.com/tink-crypto/tink-go/v2/aead/xchacha20poly1305"
	"github.com/tink-crypto/tink-go/v2/daead/aessiv"
	"github.com/tink-crypto/tink-go/v2/hybrid/ecies"
	"github.com/tink-crypto/tink-go/v2/key"
)

func mustCreateSupportedDEMPArams(t *testing.T) map[string]key.Parameters {
	aes128GCMParams, err := aesgcm.NewParameters(aesgcm.ParametersOpts{
		KeySizeInBytes: 16,
		IVSizeInBytes:  12,
		TagSizeInBytes: 16,
		Variant:        aesgcm.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("failed to create AES128-GCM parameters: %v", err)
	}
	aes256GCMParams, err := aesgcm.NewParameters(aesgcm.ParametersOpts{
		KeySizeInBytes: 32,
		IVSizeInBytes:  12,
		TagSizeInBytes: 16,
		Variant:        aesgcm.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("failed to create AES256-GCM parameters: %v", err)
	}
	aes256SIVParams, err := aessiv.NewParameters(64, aessiv.VariantNoPrefix)
	if err != nil {
		t.Fatalf("failed to create AES-SIV parameters: %v", err)
	}
	xchacha20poly1305Params, err := xchacha20poly1305.NewParameters(xchacha20poly1305.VariantNoPrefix)
	if err != nil {
		t.Fatalf("failed to create XChaCha20Poly1305 parameters: %v", err)
	}
	aes128CTRHMACSHA256Params, err := aesctrhmac.NewParameters(aesctrhmac.ParametersOpts{
		AESKeySizeInBytes:  16,
		HMACKeySizeInBytes: 32,
		IVSizeInBytes:      16,
		HashType:           aesctrhmac.SHA256,
		TagSizeInBytes:     16,
		Variant:            aesctrhmac.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("failed to create AES-CTR-HMAC parameters: %v", err)
	}
	aes256CTRHMACSHA256Params, err := aesctrhmac.NewParameters(aesctrhmac.ParametersOpts{
		AESKeySizeInBytes:  32,
		HMACKeySizeInBytes: 32,
		IVSizeInBytes:      16,
		HashType:           aesctrhmac.SHA256,
		TagSizeInBytes:     32,
		Variant:            aesctrhmac.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("failed to create AES256-CTR-HMAC parameters: %v", err)
	}
	return map[string]key.Parameters{
		"AES128-GCM-NoPrefix":             aes128GCMParams,
		"AES256-GCM-NoPrefix":             aes256GCMParams,
		"AES256-SIV-NoPrefix":             aes256SIVParams,
		"XChaCha20Poly1305-NoPrefix":      xchacha20poly1305Params,
		"AES128-CTR-HMAC-SHA256-NoPrefix": aes128CTRHMACSHA256Params,
		"AES256-CTR-HMAC-SHA256-NoPrefix": aes256CTRHMACSHA256Params,
	}
}

func TestNewParametersInvalidValues(t *testing.T) {
	demParams := mustCreateSupportedDEMPArams(t)

	// Unsupported DEM parameters.
	unsupportedDEMParams, err := aesgcm.NewParameters(aesgcm.ParametersOpts{
		KeySizeInBytes: 24,
		IVSizeInBytes:  12,
		TagSizeInBytes: 16,
		Variant:        aesgcm.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("failed to create unsupported DEM parameters: %v", err)
	}

	testCases := []struct {
		name string
		opts ecies.ParametersOpts
	}{
		{
			name: "unknown curve type",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.UnknownCurveType,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        demParams["AES128-GCM-NoPrefix"],
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "unusupported DEM",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        unsupportedDEMParams,
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "unspecified point format with NIST curve",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        demParams["AES128-GCM-NoPrefix"],
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "specified point format with X25519 curve",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        demParams["AES128-GCM-NoPrefix"],
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "unknown variant",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        demParams["AES128-GCM-NoPrefix"],
				Variant:              ecies.VariantUnknown,
			},
		},
		{
			name: "unknown hash type",
			opts: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.UnknownHashType,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        demParams["AES128-GCM-NoPrefix"],
				Variant:              ecies.VariantTink,
			},
		},
	}
	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			if _, err := ecies.NewParameters(tc.opts); err == nil {
				t.Errorf("ecies.NewParameters(%v) = nil, want error", tc.opts)
			}
		})
	}
}

type testCase struct {
	name string
	opts ecies.ParametersOpts
}

func testCases(t *testing.T) []testCase {
	demParams := mustCreateSupportedDEMPArams(t)
	var testCases []testCase
	for _, hashType := range []ecies.HashType{ecies.SHA256, ecies.SHA384, ecies.SHA512} {
		for _, demID := range []string{"AES128-GCM-NoPrefix", "AES256-GCM-NoPrefix", "AES256-SIV-NoPrefix", "XChaCha20Poly1305-NoPrefix", "AES128-CTR-HMAC-SHA256-NoPrefix", "AES256-CTR-HMAC-SHA256-NoPrefix"} {
			for _, variant := range []ecies.Variant{ecies.VariantTink, ecies.VariantNoPrefix, ecies.VariantCrunchy} {
				for _, salt := range [][]byte{nil, []byte("salt")} {
					for _, curveType := range []ecies.CurveType{ecies.NISTP256, ecies.NISTP384, ecies.NISTP521} {
						for _, pointFormat := range []ecies.PointFormat{ecies.CompressedPointFormat, ecies.UncompressedPointFormat} {
							testCases = append(testCases, testCase{
								name: fmt.Sprintf("%v-%v-%v-%v-%v-%v", curveType, hashType, pointFormat, demID, variant, salt),
								opts: ecies.ParametersOpts{
									CurveType:            curveType,
									HashType:             hashType,
									NISTCurvePointFormat: pointFormat,
									DEMParameters:        demParams[demID],
									Salt:                 salt,
									Variant:              variant,
								},
							})
						}
					}
					testCases = append(testCases, testCase{
						name: fmt.Sprintf("%v-%v-%v-%v-%v-%v", ecies.X25519, hashType, ecies.UnspecifiedPointFormat, demID, variant, salt),
						opts: ecies.ParametersOpts{
							CurveType:            ecies.X25519,
							HashType:             hashType,
							NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
							DEMParameters:        demParams[demID],
							Salt:                 salt,
							Variant:              variant,
						},
					})
				}
			}
		}
	}
	return testCases
}

func TestNewParameters(t *testing.T) {
	for _, tc := range testCases(t) {
		t.Run(tc.name, func(t *testing.T) {
			params, err := ecies.NewParameters(tc.opts)
			if err != nil {
				t.Fatalf("ecies.NewParameters(%v) = %v, want nil", tc.opts, err)
			}
			if got, want := params.CurveType(), tc.opts.CurveType; got != want {
				t.Errorf("params.CurveType() = %v, want %v", got, want)
			}
			if got, want := params.HashType(), tc.opts.HashType; got != want {
				t.Errorf("params.HashType() = %v, want %v", got, want)
			}
			if got, want := params.NISTCurvePointFormat(), tc.opts.NISTCurvePointFormat; got != want {
				t.Errorf("params.NISTCurvePointFormat() = %v, want %v", got, want)
			}
			if got, want := params.Variant(), tc.opts.Variant; got != want {
				t.Errorf("params.Variant() = %v, want %v", got, want)
			}
			if got, want := params.DEMParameters(), tc.opts.DEMParameters; !got.Equal(want) {
				t.Errorf("params.DEMParameters() = %v, want %v", got, want)
			}
			if got, want := params.Salt(), tc.opts.Salt; !bytes.Equal(got, want) {
				t.Errorf("params.Salt() = %v, want %v", got, want)
			}
			if got, want := params.HasIDRequirement(), tc.opts.Variant != ecies.VariantNoPrefix; got != want {
				t.Errorf("params.HasIDRequirement() = %v, want %v", got, want)
			}
			other, err := ecies.NewParameters(tc.opts)
			if err != nil {
				t.Fatalf("ecies.NewParameters() = %v, want nil", err)
			}
			if !params.Equal(other) {
				t.Errorf("params.Equal(other) = false, want true")
			}
		})
	}
}

func TestParametersNotEqual(t *testing.T) {
	aesGCMDEMParams, err := aesgcm.NewParameters(aesgcm.ParametersOpts{
		KeySizeInBytes: 32,
		IVSizeInBytes:  12,
		TagSizeInBytes: 16,
		Variant:        aesgcm.VariantNoPrefix,
	})
	if err != nil {
		t.Fatalf("aesgcm.NewParameters() err = %v, want nil", err)
	}
	aesGCMSIVDEMParams, err := aessiv.NewParameters(64, aessiv.VariantNoPrefix)
	if err != nil {
		t.Fatalf("aessiv.NewParameters() err = %v, want nil", err)
	}

	type paramsTestCase struct {
		params *ecies.Parameters
	}

	for _, tc := range []struct {
		name        string
		paramsOpts1 ecies.ParametersOpts
		paramsOpts2 ecies.ParametersOpts
	}{
		{
			name: "Different DEM parameters",
			paramsOpts1: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
			paramsOpts2: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        aesGCMSIVDEMParams,
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "Different variant",
			paramsOpts1: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
			paramsOpts2: ecies.ParametersOpts{
				CurveType:            ecies.X25519,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UnspecifiedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantCrunchy,
			},
		},
		{
			name: "Different point format",
			paramsOpts1: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
			paramsOpts2: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.UncompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "Different NIST curve",
			paramsOpts1: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
			paramsOpts2: ecies.ParametersOpts{
				CurveType:            ecies.NISTP384,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
		},
		{
			name: "Different hash",
			paramsOpts1: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA256,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
			paramsOpts2: ecies.ParametersOpts{
				CurveType:            ecies.NISTP256,
				HashType:             ecies.SHA512,
				NISTCurvePointFormat: ecies.CompressedPointFormat,
				DEMParameters:        aesGCMDEMParams,
				Variant:              ecies.VariantTink,
			},
		},
	} {
		t.Run(tc.name, func(t *testing.T) {
			params1, err := ecies.NewParameters(tc.paramsOpts1)
			if err != nil {
				t.Fatalf("ecies.NewParameters(%v) err = %v, want nil", tc.paramsOpts1, err)
			}
			params2, err := ecies.NewParameters(tc.paramsOpts2)
			if err != nil {
				t.Fatalf("ecies.NewParameters(%v) err = %v, want nil", tc.paramsOpts2, err)
			}
			if params1.Equal(params2) {
				t.Errorf("params1.Equal(params2) = true, want false")
			}
		})
	}
}