File: bundle_test.go

package info (click to toggle)
golang-github-spiffe-go-spiffe 2.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,116 kB
  • sloc: makefile: 157
file content (329 lines) | stat: -rw-r--r-- 9,175 bytes parent folder | download | duplicates (2)
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
package x509bundle_test

import (
	"crypto/x509"
	"os"
	"testing"

	"github.com/spiffe/go-spiffe/v2/bundle/x509bundle"
	"github.com/spiffe/go-spiffe/v2/internal/pemutil"
	"github.com/spiffe/go-spiffe/v2/internal/test"
	"github.com/spiffe/go-spiffe/v2/spiffeid"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

var (
	td  = spiffeid.RequireTrustDomainFromString("domain.test")
	td2 = spiffeid.RequireTrustDomainFromString("domain2.test")
)

func TestNew(t *testing.T) {
	bundle := x509bundle.New(td)
	require.NotNil(t, bundle)
	assert.Len(t, bundle.X509Authorities(), 0)
	assert.Equal(t, td, bundle.TrustDomain())
}

func TestFromX509Authorities(t *testing.T) {
	x509Cert1 := &x509.Certificate{
		Raw: []byte("CERT 1"),
	}
	x509Cert2 := &x509.Certificate{
		Raw: []byte("CERT 2"),
	}

	x509Authorities := []*x509.Certificate{x509Cert1, x509Cert2}
	b := x509bundle.FromX509Authorities(td, x509Authorities)
	require.NotNil(t, b)
	assert.Equal(t, b.X509Authorities(), x509Authorities)
}

func TestLoad_Succeeds(t *testing.T) {
	bundle, err := x509bundle.Load(td, "testdata/certs.pem")
	require.NoError(t, err)
	require.NotNil(t, bundle)
	assert.Len(t, bundle.X509Authorities(), 2)
}

func TestLoad_Fails(t *testing.T) {
	bundle, err := x509bundle.Load(td, "testdata/non-existent-file.pem")
	require.Error(t, err)
	require.Contains(t, err.Error(), "x509bundle: unable to load X.509 bundle file")
	assert.Nil(t, bundle)
}

func TestRead_Succeeds(t *testing.T) {
	file, err := os.Open("testdata/certs.pem")
	require.NoError(t, err)
	defer file.Close()

	bundle, err := x509bundle.Read(td, file)
	require.NoError(t, err)
	require.NotNil(t, bundle)
	assert.Len(t, bundle.X509Authorities(), 2)
}

func TestRead_Fails(t *testing.T) {
	file, err := os.Open("testdata/certs.pem")
	require.NoError(t, err)

	// Close file prematurely to cause an error while reading
	file.Close()

	bundle, err := x509bundle.Read(td, file)
	require.Error(t, err)
	require.Contains(t, err.Error(), "x509bundle: unable to read")
	assert.Nil(t, bundle)
}

func TestParse(t *testing.T) {
	tests := []struct {
		name              string
		trustDomain       spiffeid.TrustDomain
		path              string
		expNumAuthorities int
		expErrContains    string
	}{
		{
			name:              "Parse multiple certificates should succeed",
			path:              "testdata/certs.pem",
			expNumAuthorities: 2,
		},
		{
			name:              "Parse single certificate should succeed",
			path:              "testdata/cert.pem",
			expNumAuthorities: 1,
		},
		{
			name:              "Parse empty bytes should result in empty bundle",
			path:              "testdata/empty.pem",
			expNumAuthorities: 0,
		},
		{
			name:           "Parse non-PEM bytes should fail",
			path:           "testdata/not-pem.pem",
			expErrContains: "x509bundle: cannot parse certificate: no PEM blocks found",
		},
		{
			name:           "Parse a corrupted certificate should fail",
			path:           "testdata/corrupted.pem",
			expErrContains: "x509bundle: cannot parse certificate",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			fileBytes, err := os.ReadFile(test.path)
			require.NoError(t, err)

			bundle, err := x509bundle.Parse(td, fileBytes)
			if test.expErrContains != "" {
				require.Error(t, err)
				assert.Contains(t, err.Error(), test.expErrContains)
				return
			}
			require.NoError(t, err)
			assert.NotNil(t, bundle)
			assert.Len(t, bundle.X509Authorities(), test.expNumAuthorities)
		})
	}
}

func TestParseRaw(t *testing.T) {
	tests := []struct {
		name              string
		trustDomain       spiffeid.TrustDomain
		path              string
		expNumAuthorities int
		expErrContains    string
	}{
		{
			name:              "Parse multiple certificates should succeed",
			path:              "testdata/certs.pem",
			expNumAuthorities: 2,
		},
		{
			name:              "Parse single certificate should succeed",
			path:              "testdata/cert.pem",
			expNumAuthorities: 1,
		},
		{
			name:              "Parse should not fail if no certificate block is is found",
			path:              "testdata/empty.pem",
			expNumAuthorities: 0,
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			certsBytes := loadRawCertificates(t, test.path)
			bundle, err := x509bundle.ParseRaw(td, certsBytes)

			if test.expErrContains != "" {
				require.Error(t, err)
				assert.Contains(t, err.Error(), test.expErrContains)
				return
			}
			require.NoError(t, err)
			assert.NotNil(t, bundle)
			assert.Len(t, bundle.X509Authorities(), test.expNumAuthorities)
		})
	}
}

func TestX509AuthorityCRUD(t *testing.T) {
	// Load bundle1, which contains a single certificate
	bundle1, err := x509bundle.Load(td, "testdata/cert.pem")
	require.NoError(t, err)
	assert.Len(t, bundle1.X509Authorities(), 1)

	// Load bundle2, which contains 2 certificates
	// The first certificate is the same than the one used in bundle1
	bundle2, err := x509bundle.Load(td2, "testdata/certs.pem")
	require.NoError(t, err)
	assert.Len(t, bundle2.X509Authorities(), 2)
	assert.True(t, bundle2.HasX509Authority(bundle1.X509Authorities()[0]))

	// Adding a new authority increases the x509Authorities slice length
	bundle1.AddX509Authority(bundle2.X509Authorities()[1])
	assert.Len(t, bundle1.X509Authorities(), 2)
	assert.True(t, bundle1.HasX509Authority(bundle2.X509Authorities()[0]))
	assert.True(t, bundle1.HasX509Authority(bundle2.X509Authorities()[1]))

	// If the authority already exist, it should not be added again
	bundle1.AddX509Authority(bundle2.X509Authorities()[0])
	bundle1.AddX509Authority(bundle2.X509Authorities()[1])
	assert.Len(t, bundle1.X509Authorities(), 2)
	assert.True(t, bundle1.HasX509Authority(bundle2.X509Authorities()[0]))
	assert.True(t, bundle1.HasX509Authority(bundle2.X509Authorities()[1]))

	// Removing an authority, decreases the authority slice length
	cert := bundle1.X509Authorities()[0]
	bundle1.RemoveX509Authority(cert)
	assert.Len(t, bundle1.X509Authorities(), 1)
	assert.False(t, bundle1.HasX509Authority(cert))

	// If the authority does not exist, it should keep its size
	bundle1.RemoveX509Authority(cert)
	assert.Len(t, bundle1.X509Authorities(), 1)
	assert.False(t, bundle1.HasX509Authority(cert))
}

func TestMarshal(t *testing.T) {
	// Load a bundle to marshal
	bundle, err := x509bundle.Load(td, "testdata/certs.pem")
	require.NoError(t, err)

	// Marshal the bundle
	pemBytes, err := bundle.Marshal()
	require.NoError(t, err)
	require.NotNil(t, pemBytes)

	// Load original bytes for comparison
	expBytes, err := os.ReadFile("testdata/certs.pem")
	require.NoError(t, err)

	// Assert the marshalled bundle is equal to the one loaded
	assert.Equal(t, expBytes, pemBytes)
}

func TestGetX509BundleForTrustDomain_Succeeds(t *testing.T) {
	bundle, err := x509bundle.Load(td, "testdata/certs.pem")
	require.NoError(t, err)

	b, err := bundle.GetX509BundleForTrustDomain(td)
	require.NoError(t, err)
	require.NotNil(t, b)
	require.Equal(t, bundle, b)
}

func TestGetX509BundleForTrustDomain_Fails(t *testing.T) {
	bundle, err := x509bundle.Load(td, "testdata/certs.pem")
	require.NoError(t, err)

	b, err := bundle.GetX509BundleForTrustDomain(td2)
	require.Error(t, err)
	require.Contains(t, err.Error(), `x509bundle: no X.509 bundle found for trust domain: "domain2.test"`)
	require.Nil(t, b)
}

func TestEqual(t *testing.T) {
	ca1 := test.NewCA(t, td)
	ca2 := test.NewCA(t, td2)

	empty := x509bundle.New(td)
	empty2 := x509bundle.New(td2)

	x509Authorities1 := x509bundle.FromX509Authorities(td, ca1.X509Authorities())
	x509Authorities2 := x509bundle.FromX509Authorities(td, ca2.X509Authorities())

	for _, tt := range []struct {
		name        string
		a           *x509bundle.Bundle
		b           *x509bundle.Bundle
		expectEqual bool
	}{
		{
			name:        "empty equal",
			a:           empty,
			b:           empty,
			expectEqual: true,
		},
		{
			name:        "different trust domains",
			a:           empty,
			b:           empty2,
			expectEqual: false,
		},
		{
			name:        "X509 authorities equal",
			a:           x509Authorities1,
			b:           x509Authorities1,
			expectEqual: true,
		},
		{
			name:        "X509 authorities empty and not empty",
			a:           empty,
			b:           x509Authorities1,
			expectEqual: false,
		},
		{
			name:        "X509 authorities not empty but not equal",
			a:           x509Authorities1,
			b:           x509Authorities2,
			expectEqual: false,
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			require.Equal(t, tt.expectEqual, tt.a.Equal(tt.b))
		})
	}
}

func TestClone(t *testing.T) {
	// Load a bundle to clone
	original, err := x509bundle.Load(td, "testdata/certs.pem")
	require.NoError(t, err)

	cloned := original.Clone()
	require.True(t, original.Equal(cloned))
}

func loadRawCertificates(t *testing.T, path string) []byte {
	certsBytes, err := os.ReadFile(path)
	require.NoError(t, err)

	if len(certsBytes) == 0 {
		return nil
	}

	certs, err := pemutil.ParseCertificates(certsBytes)
	require.NoError(t, err)

	var rawBytes []byte
	for _, cert := range certs {
		rawBytes = append(rawBytes, cert.Raw...)
	}
	return rawBytes
}