File: bundlesource_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 (215 lines) | stat: -rw-r--r-- 8,009 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
package workloadapi_test

import (
	"context"
	"testing"
	"time"

	"github.com/spiffe/go-spiffe/v2/bundle/spiffebundle"
	"github.com/spiffe/go-spiffe/v2/bundle/x509bundle"
	"github.com/spiffe/go-spiffe/v2/internal/test"
	"github.com/spiffe/go-spiffe/v2/internal/test/fakeworkloadapi"
	"github.com/spiffe/go-spiffe/v2/spiffeid"
	"github.com/spiffe/go-spiffe/v2/svid/x509svid"
	"github.com/spiffe/go-spiffe/v2/workloadapi"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestBundleSourceDoesNotReturnUntilInitialUpdate(t *testing.T) {
	api := fakeworkloadapi.New(t)
	defer api.Stop()

	// Using a timeout here to detect that it doesn't return isn't ideal. Not
	// sure how to deterministically test it otherwise.
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*500)
	defer cancel()

	// Create the source. It will wait for the initial response.
	source, err := workloadapi.NewBundleSource(ctx, withAddr(api))
	if !assert.EqualError(t, err, context.DeadlineExceeded.Error()) {
		source.Close()
	}
}

func TestBundleSourceFailsCallsIfClosed(t *testing.T) {
	// Time out the test after a minute if something goes wrong.
	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()

	api := fakeworkloadapi.New(t)
	defer api.Stop()

	td := spiffeid.RequireTrustDomainFromString("domain.test")
	ca := test.NewCA(t, td)

	// Set the initial response, containing both X.509 and JWT materials.
	svid := ca.CreateX509SVID(spiffeid.RequireFromPath(td, "/workload"))
	api.SetX509SVIDResponse(&fakeworkloadapi.X509SVIDResponse{
		SVIDs:  []*x509svid.SVID{svid},
		Bundle: ca.X509Bundle(),
	})
	api.SetJWTBundles(ca.JWTBundle())

	// Create the source. It will wait for the initial response.
	source, err := workloadapi.NewBundleSource(ctx, withAddr(api))
	require.NoError(t, err)

	// Close the source
	require.NoError(t, source.Close())

	_, err = source.GetBundleForTrustDomain(td)
	require.EqualError(t, err, "bundlesource: source is closed")

	_, err = source.GetX509BundleForTrustDomain(td)
	require.EqualError(t, err, "bundlesource: source is closed")

	_, err = source.GetJWTBundleForTrustDomain(td)
	require.EqualError(t, err, "bundlesource: source is closed")
}

func TestBundleSourceGetsUpdates(t *testing.T) {
	// Time out the test after a minute if something goes wrong.
	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()

	api := fakeworkloadapi.New(t)
	defer api.Stop()

	// Set up the CA for a few trust domains
	domain1TD := spiffeid.RequireTrustDomainFromString("domain1.test")
	domain1CA := test.NewCA(t, domain1TD)
	domain1Bundle := domain1CA.Bundle()
	domain1X509Bundle := domain1CA.X509Bundle()
	domain1JWTBundle := domain1CA.JWTBundle()

	domain2TD := spiffeid.RequireTrustDomainFromString("domain2.test")
	domain2CA := test.NewCA(t, domain2TD)
	domain2Bundle := domain2CA.Bundle()
	domain2X509Bundle := domain2CA.X509Bundle()
	domain2JWTBundle := domain2CA.JWTBundle()

	svids := []*x509svid.SVID{
		domain1CA.CreateX509SVID(spiffeid.RequireFromPath(domain1TD, "/workload")),
	}

	// Set the initial response
	api.SetX509SVIDResponse(&fakeworkloadapi.X509SVIDResponse{
		SVIDs:            svids,
		Bundle:           domain1X509Bundle,
		FederatedBundles: []*x509bundle.Bundle{domain2X509Bundle},
	})
	api.SetJWTBundles(domain1JWTBundle, domain2JWTBundle)

	// Create the source. It will wait for the initial response.
	source, sourceDone := newBundleSource(ctx, t, api)
	defer sourceDone()

	// Assert expected bundle contents.
	requireBundle(t, source, domain1TD, domain1Bundle)
	requireX509Bundle(t, source, domain1TD, domain1X509Bundle)
	requireJWTBundle(t, source, domain1TD, domain1JWTBundle)
	requireBundle(t, source, domain2TD, domain2Bundle)
	requireX509Bundle(t, source, domain2TD, domain2X509Bundle)
	requireJWTBundle(t, source, domain2TD, domain2JWTBundle)

	// Now send an update to both the X.509 context and JWT bundle streams
	// that removes the JWT bundles for each trust domain and no longer
	// provides the X.509 bundle for domain2.test
	api.SetX509SVIDResponse(&fakeworkloadapi.X509SVIDResponse{
		SVIDs:  svids,
		Bundle: domain1X509Bundle,
	})
	require.NoError(t, source.WaitUntilUpdated(ctx))
	api.SetJWTBundles()
	require.NoError(t, source.WaitUntilUpdated(ctx))

	// Assert that:
	// - domain1.test SPIFFE bundle only has the X.509 authorities
	// - domain1.test X.509 bundle is available
	// - domain1.test JWT bundle is not available
	requireBundle(t, source, domain1TD, spiffebundle.FromX509Bundle(domain1X509Bundle))
	requireX509Bundle(t, source, domain1TD, domain1X509Bundle)
	requireNoJWTBundle(t, source, domain1TD, `bundlesource: no JWT bundle for trust domain "domain1.test"`)
	requireNoBundle(t, source, domain2TD, `bundlesource: no SPIFFE bundle for trust domain "domain2.test"`)
	requireNoX509Bundle(t, source, domain2TD, `bundlesource: no X.509 bundle for trust domain "domain2.test"`)
	requireNoJWTBundle(t, source, domain2TD, `bundlesource: no JWT bundle for trust domain "domain2.test"`)
}

func TestBundleSourceDoesNotReturnX509BundleIfMissingFromX509Response(t *testing.T) {
	// Time out the test after a minute if something goes wrong.
	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()

	api := fakeworkloadapi.New(t)
	defer api.Stop()

	domain1TD := spiffeid.RequireTrustDomainFromString("domain1.test")
	domain1CA := test.NewCA(t, domain1TD)
	domain1X509Bundle := domain1CA.X509Bundle()

	domain2TD := spiffeid.RequireTrustDomainFromString("domain2.test")
	domain2CA := test.NewCA(t, domain2TD)
	domain2JWTBundle := domain2CA.JWTBundle()

	// X509SVIDResponse's are rejected if there is no bundle, so we'll use
	// two trust domains for the test and just not set an X.509 bundle
	// for the domain2.test domain.
	api.SetX509SVIDResponse(&fakeworkloadapi.X509SVIDResponse{
		SVIDs:  []*x509svid.SVID{domain1CA.CreateX509SVID(spiffeid.RequireFromPath(domain1TD, "/workload"))},
		Bundle: domain1X509Bundle,
	})
	api.SetJWTBundles(domain2JWTBundle)

	// Create the source. It will wait for the initial response.
	source, sourceDone := newBundleSource(ctx, t, api)
	defer sourceDone()

	// Assert that the domain2.test:
	// - SPIFFE bundle exists with only JWT authorities
	// - X.509 bundle does not exist
	// - JWT bundle exists
	requireBundle(t, source, domain2TD, spiffebundle.FromJWTBundle(domain2JWTBundle))
	requireNoX509Bundle(t, source, domain2TD, `bundlesource: no X.509 bundle for trust domain "domain2.test"`)
	requireJWTBundle(t, source, domain2TD, domain2JWTBundle)
}

func TestBundleSourceDoesNotReturnJWTBundleIfMissingFromJWTBundlesResponse(t *testing.T) {
	// Time out the test after a minute if something goes wrong.
	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()

	api := fakeworkloadapi.New(t)
	defer api.Stop()

	td := spiffeid.RequireTrustDomainFromString("domain.test")
	ca := test.NewCA(t, td)
	x509Bundle := ca.X509Bundle()

	// Set the initial X509SVID  response
	api.SetX509SVIDResponse(&fakeworkloadapi.X509SVIDResponse{
		SVIDs:  []*x509svid.SVID{ca.CreateX509SVID(spiffeid.RequireFromPath(td, "/workload"))},
		Bundle: x509Bundle,
	})
	api.SetJWTBundles()

	// Create the source. It will wait for the initial response.
	source, sourceDone := newBundleSource(ctx, t, api)
	defer sourceDone()

	// Assert that:
	// - SPIFFE bundle exists with only JWT authorities
	// - X.509 bundle does not exist
	// - JWT bundle exists
	requireBundle(t, source, td, spiffebundle.FromX509Bundle(x509Bundle))
	requireX509Bundle(t, source, td, x509Bundle)
	requireNoJWTBundle(t, source, td, `bundlesource: no JWT bundle for trust domain "domain.test"`)
}

func newBundleSource(ctx context.Context, tb testing.TB, api *fakeworkloadapi.WorkloadAPI) (*workloadapi.BundleSource, func()) {
	source, err := workloadapi.NewBundleSource(ctx, withAddr(api))
	require.NoError(tb, err)
	return source, func() {
		assert.NoError(tb, source.Close())
	}
}