/
root.go
375 lines (312 loc) · 10.3 KB
/
root.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
package main
import (
"context"
"encoding/json"
"errors"
"flag"
"fmt"
"os"
"time"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/lmolas/kubectl-view-cert/internal/parse"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/client-go/dynamic"
_ "k8s.io/client-go/plugin/pkg/client/auth" // combined authprovider import
"k8s.io/klog"
)
const (
allNamespacesFlag = "all-namespaces"
expiredFlag = "expired"
showCaCertFlag = "show-ca"
expiredDaysFromNowFlag = "expired-days-from-now"
)
type parsedFlags struct {
allNs bool
expired bool
showCaCert bool
expiredInDays int
secretName string
secretKey string
}
var cf *genericclioptions.ConfigFlags
// This variable is populated by goreleaser
var version string
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "kubectl view-cert [flags] [secret-name [secret-key]]",
SilenceUsage: true, // for when RunE returns an error
Short: "View certificate information stored in secrets",
Example: "# List certificates from secrets in current namespace \n" +
"kubectl view-cert \n" +
"\n" +
"# List certificates from secrets in all namespaces \n" +
"kubectl view-cert -A \n" +
"\n" +
"# List expired certificates from secrets in all namespaces \n" +
"kubectl view-cert -A -E \n" +
"\n" +
"# List certificates that will expire in 90 days in all namespaces \n" +
"kubectl view-cert -A -D 90 \n" +
"\n" +
"# If you want to include CA certificate informations you can use -S flag \n" +
"\n" +
"# View certificate from a specific secret (secret is directly parsed if its type is kubernetes.io.tls otherwise an output of all keys in the secret is displayed) \n" +
"kubectl view-cert mysecret \n" +
"\n" +
"# View certificate from a specific key in a specific secret (secret type could be anything as long as secret key contains base64 pem encoded data) \n" +
"kubectl view-cert mysecret mykey \n",
RunE: run,
Version: versionString(),
}
// versionString returns the version prefixed by 'v'
// or an empty string if no version has been populated by goreleaser.
// In this case, the --version flag will not be added by cobra.
func versionString() string {
if version == "" {
return ""
}
return "v" + version
}
func init() {
klog.InitFlags(nil)
pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
// hide all glog flags except for -v
flag.CommandLine.VisitAll(func(f *flag.Flag) {
if f.Name != "v" {
pflag.Lookup(f.Name).Hidden = true
}
})
cf = genericclioptions.NewConfigFlags(true)
rootCmd.Flags().BoolP(allNamespacesFlag, "A", false, "Query all objects in all API groups, both namespaced and non-namespaced")
rootCmd.Flags().BoolP(expiredFlag, "E", false, "Show only expired certificates")
rootCmd.Flags().BoolP(showCaCertFlag, "S", false, "Show CA certificates")
rootCmd.Flags().IntP(expiredDaysFromNowFlag, "D", 0, "Show expired certificates at date in future (now plus number of days)")
cf.AddFlags(rootCmd.Flags())
if err := flag.Set("logtostderr", "true"); err != nil {
fmt.Fprintf(os.Stderr, "failed to set logtostderr flag: %v\n", err)
os.Exit(1)
}
}
func getNamespace() string {
if v := *cf.Namespace; v != "" {
return v
}
clientConfig := cf.ToRawKubeConfigLoader()
defaultNamespace, _, err := clientConfig.Namespace()
if err != nil {
defaultNamespace = "default"
}
return defaultNamespace
}
func main() {
defer klog.Flush()
if err := rootCmd.Execute(); err != nil {
return
}
}
func parseFlagsAndArguments(command *cobra.Command, args []string) parsedFlags {
allNs, err := command.Flags().GetBool(allNamespacesFlag)
if err != nil {
allNs = false
}
expired, err := command.Flags().GetBool(expiredFlag)
if err != nil {
expired = false
}
showCaCert, err := command.Flags().GetBool(showCaCertFlag)
if err != nil {
showCaCert = false
}
expiredInDays, err := command.Flags().GetInt(expiredDaysFromNowFlag)
if err != nil {
expiredInDays = 0
}
var secretName, secretKey string
if len(args) > 0 {
secretName = args[0]
}
if len(args) > 1 {
secretKey = args[1]
}
return parsedFlags{allNs, expired, showCaCert, expiredInDays, secretName, secretKey}
}
// nolint gocognit // Better readability in one block
func run(command *cobra.Command, args []string) error {
ctx := context.Background()
// Parse flags and arguments
parsedFlags := parseFlagsAndArguments(command, args)
// Validate inputs
if parsedFlags.allNs && parsedFlags.secretName != "" {
return errors.New("a resource cannot be retrieved by name across all namespaces")
}
if parsedFlags.secretName != "" && (parsedFlags.expired || parsedFlags.expiredInDays != 0 || parsedFlags.showCaCert) {
return errors.New("when specifying secret name, no flags are allowed, only a second argument with secret key is allowed")
}
// Prepare clients to interact with kubernetes api
ns, ri, err := getResourceInterface(parsedFlags.allNs, parsedFlags.secretName)
if err != nil {
return err
}
if parsedFlags.secretName != "" {
datas, secretKeys, err := getData(ctx, parsedFlags.secretName, ns, parsedFlags.secretKey, ri)
if err != nil {
return err
}
if secretKeys != nil && len(*secretKeys) > 0 {
fmt.Println("Specify another argument, one of:")
for _, key := range *secretKeys {
fmt.Printf("-> %s\n", key)
}
} else {
// Display
err = displayDatas(datas)
if err != nil {
return err
}
}
} else {
datas, err := getDatas(ctx, ri)
if err != nil {
return err
}
// Filter Datas
filteredDatas := datas
if parsedFlags.expired && parsedFlags.expiredInDays == 0 {
filteredDatas = filterWithDate(datas, time.Now().UTC(), dateAfterFilter)
} else if parsedFlags.expiredInDays > 0 {
filteredDatas = filterWithDate(datas, time.Now().AddDate(0, 0, parsedFlags.expiredInDays).UTC(), dateAfterFilter)
}
if !parsedFlags.showCaCert {
filteredDatas = filter(filteredDatas, noCaCertFilter)
}
// Display
err = displayDatas(filteredDatas)
if err != nil {
return err
}
}
return nil
}
func getDatas(ctx context.Context, ri dynamic.ResourceInterface) ([]*Certificate, error) {
datas := make([]*Certificate, 0)
tlsSecrets, err := ri.List(ctx, v1.ListOptions{FieldSelector: "type=kubernetes.io/tls"})
if err != nil {
return datas, fmt.Errorf("failed to get secrets: %w", err)
}
for _, tlsSecret := range tlsSecrets.Items {
certData, caCertData, _, err := parseData(tlsSecret.GetNamespace(), tlsSecret.GetName(), tlsSecret.Object, "", false)
if err != nil {
return datas, err
}
if certData != nil {
datas = append(datas, certData)
}
if caCertData != nil {
datas = append(datas, caCertData)
}
}
return datas, nil
}
func getData(ctx context.Context, secretName, ns, secretKey string, ri dynamic.ResourceInterface) ([]*Certificate, *[]string, error) {
datas := make([]*Certificate, 0)
secret, err := ri.Get(ctx, secretName, v1.GetOptions{})
if err != nil {
return datas, nil, fmt.Errorf("failed to get secret with name %s: %w", secretName, err)
}
certData, caCertData, secretKeys, err := parseData(ns, secretName, secret.Object, secretKey, true)
if err != nil {
return datas, nil, err
}
if secretKeys != nil {
return datas, secretKeys, nil
}
if certData != nil {
datas = append(datas, certData)
}
if caCertData != nil {
datas = append(datas, caCertData)
}
return datas, nil, nil
}
func displayDatas(datas []*Certificate) error {
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(&datas)
}
func getResourceInterface(allNs bool, secretName string) (string, dynamic.ResourceInterface, error) {
restConfig, err := cf.ToRESTConfig()
if err != nil {
return "", nil, err
}
restConfig.QPS = 1000
restConfig.Burst = 1000
dyn, err := dynamic.NewForConfig(restConfig)
if err != nil {
return "", nil, fmt.Errorf("failed to construct dynamic client: %w", err)
}
ns := getNamespace()
// Check arguments
if secretName != "" && ns == "" {
err = errors.New("secretName passed as argument but blank namespace")
return "", nil, err
}
secretGroupVersionResource := schema.GroupVersionResource{
Group: "",
Version: "v1",
Resource: "secrets",
}
var ri dynamic.ResourceInterface
if allNs && secretName == "" {
ri = dyn.Resource(secretGroupVersionResource)
} else {
ri = dyn.Resource(secretGroupVersionResource).Namespace(ns)
}
return ns, ri, nil
}
func parseData(ns, secretName string, data map[string]interface{}, secretKey string, listKeys bool) (certData, caCertData *Certificate, secretKeys *[]string, err error) {
secretCertData, err := parse.NewCertificateData(ns, secretName, data, secretKey, listKeys)
if err != nil {
return nil, nil, nil, fmt.Errorf("failed to parse secret with name %s in namespace %s %v", secretName, ns, err)
}
if len(secretCertData.SecretKeys) > 0 {
return nil, nil, &secretCertData.SecretKeys, nil
}
parsedCerts, err := secretCertData.ParseCertificates()
if err != nil {
return nil, nil, nil, fmt.Errorf("unable to parse certificates for secret %s in namespace %s %v", secretName, ns, err)
}
if parsedCerts.Certificate != nil {
certData = &Certificate{
SecretName: parsedCerts.SecretName,
Namespace: parsedCerts.Namespace,
IsCA: parsedCerts.Certificate.IsCA,
Issuer: parsedCerts.Certificate.Issuer.String(),
SerialNumber: fmt.Sprintf("%x", parsedCerts.Certificate.SerialNumber),
Subject: parsedCerts.Certificate.Subject.String(),
Validity: CertificateValidity{
NotBefore: parsedCerts.Certificate.NotBefore,
NotAfter: parsedCerts.Certificate.NotAfter,
},
Version: parsedCerts.Certificate.Version,
}
}
if parsedCerts.CaCertificate != nil {
caCertData = &Certificate{
SecretName: parsedCerts.SecretName,
Namespace: parsedCerts.Namespace,
IsCA: parsedCerts.CaCertificate.IsCA,
Issuer: parsedCerts.CaCertificate.Issuer.String(),
SerialNumber: fmt.Sprintf("%x", parsedCerts.CaCertificate.SerialNumber),
Subject: parsedCerts.CaCertificate.Subject.String(),
Validity: CertificateValidity{
NotBefore: parsedCerts.CaCertificate.NotBefore,
NotAfter: parsedCerts.CaCertificate.NotAfter,
},
Version: parsedCerts.CaCertificate.Version,
}
}
return certData, caCertData, nil, err
}