File: kmsfs_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 (335 lines) | stat: -rw-r--r-- 7,828 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
package kms

import (
	"context"
	"crypto"
	"crypto/x509"
	"crypto/x509/pkix"
	"errors"
	"io/fs"
	"os"
	"reflect"
	"testing"

	"github.com/stretchr/testify/assert"

	"go.step.sm/crypto/kms/apiv1"
	"go.step.sm/crypto/kms/softkms"
	"go.step.sm/crypto/kms/tpmkms"
)

type fakeCM struct {
	softkms.SoftKMS
}

func (f *fakeCM) GetPublicKey(req *apiv1.GetPublicKeyRequest) (crypto.PublicKey, error) {
	if req.Name == "fail" {
		return nil, errors.New("an error")
	}
	return []byte(req.Name), nil
}

func (f *fakeCM) LoadCertificate(req *apiv1.LoadCertificateRequest) (*x509.Certificate, error) {
	if req.Name == "fail" {
		return nil, errors.New("an error")
	}

	return &x509.Certificate{Subject: pkix.Name{CommonName: req.Name}}, nil
}

func (f *fakeCM) StoreCertificate(req *apiv1.StoreCertificateRequest) error {
	if req.Name == "fail" {
		return errors.New("an error")
	}

	return nil
}

var _ apiv1.CertificateManager = (*fakeCM)(nil)

func TestMain(m *testing.M) {
	apiv1.Register(apiv1.Type("fake"), func(ctx context.Context, opts apiv1.Options) (apiv1.KeyManager, error) {
		return &fakeCM{}, nil
	})
	os.Exit(m.Run())
}

func Test_new(t *testing.T) {
	ctx := context.TODO()
	type args struct {
		ctx    context.Context
		kmsuri string
	}
	tests := []struct {
		name    string
		args    args
		want    *kmsfs
		wantErr bool
	}{
		{"ok empty", args{ctx, ""}, &kmsfs{}, false},
		{"ok softkms", args{ctx, "softkms:"}, &kmsfs{
			KeyManager: &softkms.SoftKMS{},
		}, false},
		{"ok tpmkms", args{ctx, "tpmkms:"}, &kmsfs{
			KeyManager: &tpmkms.TPMKMS{},
		}, false},
		{"fail", args{ctx, "fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := newFS(tt.args.ctx, tt.args.kmsuri)
			if tt.wantErr {
				assert.Error(t, err)
				assert.Nil(t, got)
				return
			}

			assert.NoError(t, err)
			if assert.NotNil(t, got) {
				assert.IsType(t, tt.want, got)
			}

			err = got.Close()
			assert.NoError(t, err)
		})
	}
}

func Test_kmsfs_getKMS(t *testing.T) {
	type fields struct {
		KeyManager apiv1.KeyManager
	}
	type args struct {
		kmsuri string
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		want    apiv1.KeyManager
		wantErr bool
	}{
		{"ok empty", fields{nil}, args{""}, &softkms.SoftKMS{}, false},
		{"ok softkms", fields{&softkms.SoftKMS{}}, args{""}, &softkms.SoftKMS{}, false},
		{"ok softkms with uri", fields{nil}, args{"softkms:"}, &softkms.SoftKMS{}, false},
		{"ok tpmkms", fields{&tpmkms.TPMKMS{}}, args{""}, &tpmkms.TPMKMS{}, false},
		{"ok tpmkms with uri", fields{nil}, args{"tpmkms:"}, &tpmkms.TPMKMS{}, false},
		{"fail", fields{nil}, args{"fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f := &kmsfs{
				KeyManager: tt.fields.KeyManager,
			}
			got, err := f.getKMS(tt.args.kmsuri)
			if tt.wantErr {
				assert.Error(t, err)
				assert.Nil(t, got)
				return
			}

			assert.NoError(t, err)
			if assert.NotNil(t, got) {
				assert.IsType(t, tt.want, got)
			}
		})
	}
}

func Test_loadKMS(t *testing.T) {
	ctx := context.TODO()
	type args struct {
		ctx    context.Context
		kmsuri string
	}
	tests := []struct {
		name    string
		args    args
		want    apiv1.KeyManager
		wantErr bool
	}{
		{"ok", args{ctx, "softkms:"}, &softkms.SoftKMS{}, false},
		{"ok empty", args{ctx, ""}, &softkms.SoftKMS{}, false},
		{"fail", args{ctx, "fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := loadKMS(tt.args.ctx, tt.args.kmsuri)
			if (err != nil) != tt.wantErr {
				t.Errorf("loadKMS() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("loadKMS() = %v, want %v", got, tt.want)
			}
		})
	}
}

func Test_openError(t *testing.T) {
	type args struct {
		name string
		err  error
	}
	tests := []struct {
		name string
		args args
		want *fs.PathError
	}{
		{"ok", args{"name", errors.New("an error")}, &fs.PathError{
			Path: "name", Op: "open", Err: errors.New("an error"),
		}},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			if got := openError(tt.args.name, tt.args.err); !reflect.DeepEqual(got, tt.want) { //nolint:govet // variable names match crypto formulae docs
				t.Errorf("openError() = %v, want %v", got, tt.want)
			}
		})
	}
}

func TestCertFS(t *testing.T) {
	ctx := context.TODO()
	type args struct {
		ctx    context.Context
		kmsuri string
	}
	tests := []struct {
		name    string
		args    args
		want    fs.FS
		wantErr bool
	}{
		{"ok", args{ctx, "fake:"}, &certFS{kmsfs: &kmsfs{KeyManager: &fakeCM{}}}, false},
		{"fail", args{ctx, "fail:"}, nil, true},
		{"fail not implemented", args{ctx, "softkms:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := CertFS(tt.args.ctx, tt.args.kmsuri)
			if (err != nil) != tt.wantErr {
				t.Errorf("CertFS() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("CertFS() = %v, want %v", got, tt.want)
			}
		})
	}
}

func Test_certFS_Open(t *testing.T) {
	fake := &kmsfs{KeyManager: &fakeCM{}}
	type fields struct {
		kmsfs *kmsfs
	}
	type args struct {
		name string
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		want    fs.File
		wantErr bool
	}{
		{"ok", fields{fake}, args{"foo"}, &object{
			Path:   "foo",
			Object: &x509.Certificate{Subject: pkix.Name{CommonName: "foo"}},
		}, false},
		{"ok load", fields{&kmsfs{}}, args{"fake:foo"}, &object{
			Path:   "fake:foo",
			Object: &x509.Certificate{Subject: pkix.Name{CommonName: "fake:foo"}},
		}, false},
		{"fail fake", fields{fake}, args{"fail"}, nil, true},
		{"fail unregistered", fields{&kmsfs{}}, args{"fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f := &certFS{
				kmsfs: tt.fields.kmsfs,
			}
			got, err := f.Open(tt.args.name)
			if (err != nil) != tt.wantErr {
				t.Errorf("certFS.Open() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("certFS.Open() = %v, want %v", got, tt.want)
			}
		})
	}
}

func TestKeyFS(t *testing.T) {
	ctx := context.TODO()
	type args struct {
		ctx    context.Context
		kmsuri string
	}
	tests := []struct {
		name    string
		args    args
		want    fs.FS
		wantErr bool
	}{
		{"ok", args{ctx, "fake:"}, &keyFS{kmsfs: &kmsfs{KeyManager: &fakeCM{}}}, false},
		{"fail", args{ctx, "fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := KeyFS(tt.args.ctx, tt.args.kmsuri)
			if (err != nil) != tt.wantErr {
				t.Errorf("KeyFS() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("KeyFS() = %v, want %v", got, tt.want)
			}
		})
	}
}

func Test_keyFS_Open(t *testing.T) {
	fake := &kmsfs{KeyManager: &fakeCM{}}
	type fields struct {
		kmsfs *kmsfs
	}
	type args struct {
		name string
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		want    fs.File
		wantErr bool
	}{
		{"ok", fields{fake}, args{"foo"}, &object{
			Path:   "foo",
			Object: []byte("foo"),
		}, false},
		{"ok load", fields{&kmsfs{}}, args{"fake:foo"}, &object{
			Path:   "fake:foo",
			Object: []byte("fake:foo"),
		}, false},
		{"fail fake", fields{fake}, args{"fail"}, nil, true},
		{"fail unregistered", fields{&kmsfs{}}, args{"fail:"}, nil, true},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f := &keyFS{
				kmsfs: tt.fields.kmsfs,
			}
			got, err := f.Open(tt.args.name)
			if (err != nil) != tt.wantErr {
				t.Errorf("keyFS.Open() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("keyFS.Open() = %v, want %v", got, tt.want)
			}
		})
	}
}