-
Notifications
You must be signed in to change notification settings - Fork 8
/
secret.go
405 lines (345 loc) · 11 KB
/
secret.go
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
/*
Copyright 2020 The cert-manager 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 secret
import (
"bytes"
"context"
"crypto/x509"
"errors"
"fmt"
"io"
"net/url"
"strings"
"text/template"
"time"
apiutil "github.com/cert-manager/cert-manager/pkg/api/util"
cmapi "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
"github.com/cert-manager/cert-manager/pkg/util/pki"
"github.com/spf13/cobra"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/kubectl/pkg/util/templates"
k8sclock "k8s.io/utils/clock"
"github.com/cert-manager/cmctl/v2/pkg/build"
"github.com/cert-manager/cmctl/v2/pkg/factory"
)
var clock k8sclock.Clock = k8sclock.RealClock{}
const validForTemplate = `Valid for:
DNS Names: {{ .DNSNames }}
URIs: {{ .URIs }}
IP Addresses: {{ .IPAddresses }}
Email Addresses: {{ .EmailAddresses }}
Usages: {{ .KeyUsage }}`
const validityPeriodTemplate = `Validity period:
Not Before: {{ .NotBefore }}
Not After: {{ .NotAfter }}`
const issuedByTemplate = `Issued By:
Common Name: {{ .CommonName }}
Organization: {{ .Organization }}
OrganizationalUnit: {{ .OrganizationalUnit }}
Country: {{ .Country }}`
const issuedForTemplate = `Issued For:
Common Name: {{ .CommonName }}
Organization: {{ .Organization }}
OrganizationalUnit: {{ .OrganizationalUnit }}
Country: {{ .Country }}`
const certificateTemplate = `Certificate:
Signing Algorithm: {{ .SigningAlgorithm }}
Public Key Algorithm: {{ .PublicKeyAlgorithm }}
Serial Number: {{ .SerialNumber }}
Fingerprints: {{ .Fingerprints }}
Is a CA certificate: {{ .IsCACertificate }}
CRL: {{ .CRL }}
OCSP: {{ .OCSP }}`
const debuggingTemplate = `Debugging:
Trusted by this computer: {{ .TrustedByThisComputer }}
CRL Status: {{ .CRLStatus }}
OCSP Status: {{ .OCSPStatus }}`
// Options is a struct to support status certificate command
type Options struct {
genericclioptions.IOStreams
*factory.Factory
}
// NewOptions returns initialized Options
func NewOptions(ioStreams genericclioptions.IOStreams) *Options {
return &Options{
IOStreams: ioStreams,
}
}
// NewCmdInspectSecret returns a cobra command for status certificate
func NewCmdInspectSecret(setupCtx context.Context, ioStreams genericclioptions.IOStreams) *cobra.Command {
o := NewOptions(ioStreams)
cmd := &cobra.Command{
Use: "secret",
Short: "Get details about a kubernetes.io/tls typed secret",
Long: templates.LongDesc(`
Get details about a kubernetes.io/tls typed secret`),
Example: templates.Examples(build.WithTemplate(setupCtx, `
# Query information about a secret with name 'my-crt' in namespace 'my-namespace'
{{.BuildName}} inspect secret my-crt --namespace my-namespace
`)),
ValidArgsFunction: factory.ValidArgsListSecrets(&o.Factory),
PreRunE: func(cmd *cobra.Command, args []string) error {
return o.Validate(args)
},
// nolint:contextcheck // False positive
RunE: func(cmd *cobra.Command, args []string) error {
return o.Run(cmd.Context(), args, ioStreams.Out)
},
}
o.Factory = factory.New(cmd)
return cmd
}
// Validate validates the provided options
func (o *Options) Validate(args []string) error {
if len(args) < 1 {
return errors.New("the name of the Secret has to be provided as argument")
}
if len(args) > 1 {
return errors.New("only one argument can be passed in: the name of the Secret")
}
return nil
}
// Run executes status certificate command
func (o *Options) Run(ctx context.Context, args []string, stdout io.Writer) error {
secret, err := o.KubeClient.CoreV1().Secrets(o.Namespace).Get(ctx, args[0], metav1.GetOptions{})
if err != nil {
return fmt.Errorf("error when finding Secret %q: %w\n", args[0], err)
}
certData := secret.Data[corev1.TLSCertKey]
certs, err := splitPEMs(certData)
if err != nil {
return err
}
if len(certs) < 1 {
return errors.New("no PEM data found in secret")
}
intermediates := [][]byte(nil)
if len(certs) > 1 {
intermediates = certs[1:]
}
// we only want to inspect the leaf certificate
x509Cert, err := pki.DecodeX509CertificateBytes(certs[0])
if err != nil {
return fmt.Errorf("error when parsing 'tls.crt': %w", err)
}
var out []string
for _, describeFn := range []func(*x509.Certificate) (string, error){
describeValidFor,
describeValidityPeriod,
describeIssuedBy,
describeIssuedFor,
describeCertificate,
} {
desc, err := describeFn(x509Cert)
if err != nil {
return err
}
out = append(out, desc)
}
if desc, err := describeDebugging(ctx, x509Cert, intermediates, secret.Data[cmmeta.TLSCAKey]); err != nil {
return err
} else {
out = append(out, desc)
}
fmt.Fprintln(stdout, strings.Join(out, "\n\n"))
return nil
}
func describeValidFor(cert *x509.Certificate) (string, error) {
tmpl, err := template.New("validForTemplate").Parse(validForTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
DNSNames string
URIs string
IPAddresses string
EmailAddresses string
KeyUsage string
}{
DNSNames: printSlice(cert.DNSNames),
URIs: printSlice(pki.URLsToString(cert.URIs)),
IPAddresses: printSlice(pki.IPAddressesToString(cert.IPAddresses)),
EmailAddresses: printSlice(cert.EmailAddresses),
KeyUsage: printKeyUsage(buildCertManagerKeyUsages(cert.KeyUsage, cert.ExtKeyUsage)),
})
return b.String(), err
}
func buildCertManagerKeyUsages(ku x509.KeyUsage, eku []x509.ExtKeyUsage) []cmapi.KeyUsage {
var usages []cmapi.KeyUsage
usages = append(usages, apiutil.KeyUsageStrings(ku)...)
usages = append(usages, apiutil.ExtKeyUsageStrings(eku)...)
return usages
}
func describeValidityPeriod(cert *x509.Certificate) (string, error) {
tmpl, err := template.New("validityPeriodTemplate").Parse(validityPeriodTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
NotBefore string
NotAfter string
}{
NotBefore: cert.NotBefore.Format(time.RFC1123),
NotAfter: cert.NotAfter.Format(time.RFC1123),
})
return b.String(), err
}
func describeIssuedBy(cert *x509.Certificate) (string, error) {
tmpl, err := template.New("issuedByTemplate").Parse(issuedByTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
CommonName string
Organization string
OrganizationalUnit string
Country string
}{
CommonName: printOrNone(cert.Issuer.CommonName),
Organization: printSliceOrOne(cert.Issuer.Organization),
OrganizationalUnit: printSliceOrOne(cert.Issuer.OrganizationalUnit),
Country: printSliceOrOne(cert.Issuer.Country),
})
return b.String(), err
}
func describeIssuedFor(cert *x509.Certificate) (string, error) {
tmpl, err := template.New("issuedForTemplate").Parse(issuedForTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
CommonName string
Organization string
OrganizationalUnit string
Country string
}{
CommonName: printOrNone(cert.Subject.CommonName),
Organization: printSliceOrOne(cert.Subject.Organization),
OrganizationalUnit: printSliceOrOne(cert.Subject.OrganizationalUnit),
Country: printSliceOrOne(cert.Subject.Country),
})
return b.String(), err
}
func describeCertificate(cert *x509.Certificate) (string, error) {
tmpl, err := template.New("certificateTemplate").Parse(certificateTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
SigningAlgorithm string
PublicKeyAlgorithm string
SerialNumber string
Fingerprints string
IsCACertificate bool
CRL string
OCSP string
}{
SigningAlgorithm: cert.SignatureAlgorithm.String(),
PublicKeyAlgorithm: cert.PublicKeyAlgorithm.String(),
SerialNumber: cert.SerialNumber.String(),
Fingerprints: fingerprintCert(cert),
IsCACertificate: cert.IsCA,
CRL: printSliceOrOne(cert.CRLDistributionPoints),
OCSP: printSliceOrOne(cert.OCSPServer),
})
return b.String(), err
}
func describeDebugging(ctx context.Context, cert *x509.Certificate, intermediates [][]byte, ca []byte) (string, error) {
tmpl, err := template.New("debuggingTemplate").Parse(debuggingTemplate)
if err != nil {
return "", err
}
var b bytes.Buffer
err = tmpl.Execute(&b, struct {
TrustedByThisComputer string
CRLStatus string
OCSPStatus string
}{
TrustedByThisComputer: describeTrusted(cert, intermediates),
CRLStatus: describeCRL(ctx, cert),
OCSPStatus: describeOCSP(ctx, cert, intermediates, ca),
})
return b.String(), err
}
func describeCRL(ctx context.Context, cert *x509.Certificate) string {
if len(cert.CRLDistributionPoints) < 1 {
return "No CRL endpoints set"
}
hasChecked := false
for _, crlURL := range cert.CRLDistributionPoints {
u, err := url.Parse(crlURL)
if err != nil {
return fmt.Sprintf("Invalid CRL URL: %v", err)
}
if u.Scheme != "ldap" && u.Scheme != "https" {
continue
}
hasChecked = true
valid, err := checkCRLValidCert(ctx, cert, crlURL)
if err != nil {
return fmt.Sprintf("Cannot check CRL: %s", err.Error())
}
if !valid {
return fmt.Sprintf("Revoked by %s", crlURL)
}
}
if !hasChecked {
return "No CRL endpoints we support found"
}
return "Valid"
}
func describeOCSP(ctx context.Context, cert *x509.Certificate, intermediates [][]byte, ca []byte) string {
if len(ca) > 1 {
intermediates = append([][]byte{ca}, intermediates...)
}
if len(intermediates) < 1 {
return "Cannot check OCSP, does not have a CA or intermediate certificate provided"
}
issuerCert, err := pki.DecodeX509CertificateBytes(intermediates[len(intermediates)-1])
if err != nil {
return fmt.Sprintf("Cannot parse intermediate certificate: %s", err.Error())
}
valid, err := checkOCSPValidCert(ctx, cert, issuerCert)
if err != nil {
return fmt.Sprintf("Cannot check OCSP: %s", err.Error())
}
if !valid {
return "Marked as revoked"
}
return "valid"
}
func describeTrusted(cert *x509.Certificate, intermediates [][]byte) string {
systemPool, err := x509.SystemCertPool()
if err != nil {
return fmt.Sprintf("Error getting system CA store: %s", err.Error())
}
for _, intermediate := range intermediates {
systemPool.AppendCertsFromPEM(intermediate)
}
_, err = cert.Verify(x509.VerifyOptions{
Roots: systemPool,
CurrentTime: clock.Now(),
})
if err == nil {
return "yes"
}
return fmt.Sprintf("no: %s", err.Error())
}