File: crl.go

package info (click to toggle)
golang-github-notaryproject-notation 1.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,284 kB
  • sloc: sh: 346; makefile: 79; python: 60
file content (315 lines) | stat: -rw-r--r-- 10,656 bytes parent folder | download
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
// Copyright The Notary Project Authors.
// 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 scenario_test

import (
	"context"
	"net/http"
	"os"

	crlcore "github.com/notaryproject/notation-core-go/revocation/crl"
	"github.com/notaryproject/notation-go/verifier/crl"
	. "github.com/notaryproject/notation/test/e2e/internal/notation"
	"github.com/notaryproject/notation/test/e2e/internal/utils"
	. "github.com/notaryproject/notation/test/e2e/suite/common"
	. "github.com/onsi/ginkgo/v2"
)

var _ = Describe("notation CRL revocation check", Serial, func() {
	It("successfully completed with cache", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLUnrevoke()
			utils.IntermediateCRLUnrevoke()

			// verify without cache
			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchKeyWords(
					VerifySuccessfully,
				).
				MatchErrKeyWords(
					"CRL file cache miss",
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"is revoked",
				)

			// verify with cache
			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchKeyWords(
					VerifySuccessfully,
				).
				MatchErrKeyWords(
					"Retrieving crl bundle from file cache with key",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"CRL file cache miss",
					"Storing crl bundle to file cache with key",
					"is revoked",
				)
		})
	})

	It("failed with revoked leaf certificate", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLRevoke()
			utils.IntermediateCRLUnrevoke()

			// verify without cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"CRL file cache miss",
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"is revoked",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				)

			// verify with cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"Retrieving crl bundle from file cache with key",
					"is revoked",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"CRL file cache miss",
					"Storing crl bundle to file cache with key",
				)
		})
	})

	It("failed with revoked intermediate certificate", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLUnrevoke()
			utils.IntermediateCRLRevoke()

			// verify without cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"CRL file cache miss",
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"is revoked",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				)

			// verify with cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"Retrieving crl bundle from file cache with key",
					"is revoked",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"CRL file cache miss",
					"Storing crl bundle to file cache with key",
				)
		})
	})

	It("successfully completed with cache creation error in warning message", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLUnrevoke()
			utils.IntermediateCRLUnrevoke()

			if err := os.MkdirAll(vhost.AbsolutePath(".cache"), 0500); err != nil {
				Fail(err.Error())
			}
			defer os.Chmod(vhost.AbsolutePath(".cache"), 0700)

			// verify without cache
			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchKeyWords(
					VerifySuccessfully,
				).
				MatchErrKeyWords(
					"Warning: failed to create crl file cache",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
					`"GET" "http://localhost:10086/intermediate.crl"`,
					`"GET" "http://localhost:10086/leaf.crl"`,
				).
				NoMatchErrKeyWords(
					"is revoked",
				)
		})
	})

	It("failed with revoked leaf certificate and cache creation error in warning message", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLRevoke()
			utils.IntermediateCRLUnrevoke()

			if err := os.MkdirAll(vhost.AbsolutePath(".cache"), 0500); err != nil {
				Fail(err.Error())
			}
			defer os.Chmod(vhost.AbsolutePath(".cache"), 0700)

			// verify without cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"Warning: failed to create crl file cache",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
					`"GET" "http://localhost:10086/intermediate.crl"`,
					`"GET" "http://localhost:10086/leaf.crl"`,
					"is revoked",
				)
		})
	})

	It("successfully completed with cache get and set error in debug log", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLUnrevoke()
			utils.IntermediateCRLUnrevoke()

			// verify without cache
			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchKeyWords(
					VerifySuccessfully,
				).
				MatchErrKeyWords(
					"CRL file cache miss",
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"is revoked",
				)

			utils.LeafCRLRevoke()
			if err := os.Chmod(vhost.AbsolutePath(".cache", "crl"), 0000); err != nil {
				Fail(err.Error())
			}
			defer os.Chmod(vhost.AbsolutePath(".cache", "crl"), 0700)

			// verify with cache error
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"failed to get crl bundle from file cache with key",
					"failed to store crl bundle in file cache",
					"/.cache/crl/eaf8bbfe35f6c2c8b136081de9a994f9515752b2e30b9a6889ae3128ea97656c: permission denied",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
					`"GET" "http://localhost:10086/intermediate.crl"`,
					`"GET" "http://localhost:10086/leaf.crl"`,
					"is revoked",
				)
		})
	})

	It("succesfully completed with the crl in the cache expired and a roundtrip", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			ctx := context.Background()
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLExpired()
			// write expired CRL cache
			fetcher, err := crlcore.NewHTTPFetcher(http.DefaultClient)
			if err != nil {
				Fail(err.Error())
			}
			fetcher.Cache, err = crl.NewFileCache(vhost.AbsolutePath(".cache", "crl"))
			if err != nil {
				Fail(err.Error())
			}
			_, err = fetcher.Fetch(ctx, "http://localhost:10086/leaf.crl")
			if err != nil {
				Fail(err.Error())
			}

			utils.LeafCRLUnrevoke()
			utils.IntermediateCRLUnrevoke()
			// verify without cache
			notation.Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchKeyWords(
					VerifySuccessfully,
				).
				MatchErrKeyWords(
					"CRL bundle retrieved from file cache has expired at 2023-12-25",
					`"GET" "http://localhost:10086/leaf.crl"`,
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
				).
				NoMatchErrKeyWords(
					"is revoked",
				)
		})
	})

	It("failed with crl in the cache expired and a roundtrip to download a revoked crl", func() {
		Host(CRLOptions(), func(notation *utils.ExecOpts, artifact *Artifact, vhost *utils.VirtualHost) {
			ctx := context.Background()
			notation.Exec("sign", artifact.ReferenceWithDigest()).
				MatchKeyWords(SignSuccessfully)

			utils.LeafCRLExpired()
			// write expired CRL cache
			fetcher, err := crlcore.NewHTTPFetcher(http.DefaultClient)
			if err != nil {
				Fail(err.Error())
			}
			fetcher.Cache, err = crl.NewFileCache(vhost.AbsolutePath(".cache", "crl"))
			if err != nil {
				Fail(err.Error())
			}
			_, err = fetcher.Fetch(ctx, "http://localhost:10086/leaf.crl")
			if err != nil {
				Fail(err.Error())
			}

			utils.LeafCRLRevoke()
			utils.IntermediateCRLUnrevoke()
			// verify without cache
			notation.ExpectFailure().Exec("verify", artifact.ReferenceWithDigest(), "-d").
				MatchErrKeyWords(
					VerifyFailed,
					"CRL bundle retrieved from file cache has expired at 2023-12-25",
					`"GET" "http://localhost:10086/leaf.crl"`,
					"Retrieving crl bundle from file cache with key",
					"Storing crl bundle to file cache with key",
					"OCSP check failed with unknown error and fallback to CRL check for certificate #2",
					"is revoked",
				)
		})
	})
})