-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
kubectl_auth.go
277 lines (232 loc) · 7.55 KB
/
kubectl_auth.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
/*
Copyright 2020 The Kubernetes 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 helpers
import (
"bytes"
"context"
"crypto/sha256"
"crypto/x509/pkix"
"encoding/json"
"fmt"
"io"
"os"
"os/user"
"path/filepath"
"strings"
"time"
"github.com/spf13/cobra"
"k8s.io/client-go/util/homedir"
"k8s.io/klog/v2"
"k8s.io/kops/cmd/kops/util"
"k8s.io/kops/pkg/commands/commandutils"
"k8s.io/kops/pkg/pki"
"k8s.io/kops/pkg/rbac"
"k8s.io/kops/upup/pkg/fi"
"k8s.io/kubectl/pkg/util/i18n"
)
var kubectlAuthShort = i18n.T(`kubectl authentication plugin`)
// HelperKubectlAuthOptions holds the options for generating an authentication token
type HelperKubectlAuthOptions struct {
// ClusterName is the name of the cluster we are targeting
ClusterName string
// Lifetime specifies the desired duration of the credential
Lifetime time.Duration
// APIVersion specifies the version of the client.authentication.k8s.io schema in use
APIVersion string
}
// InitDefaults populates the default values of options
func (o *HelperKubectlAuthOptions) InitDefaults() {
o.Lifetime = 1 * time.Hour
o.APIVersion = "v1beta1"
}
// NewCmdHelperKubectlAuth builds a cobra command for the kubectl-auth command
func NewCmdHelperKubectlAuth(f *util.Factory, out io.Writer) *cobra.Command {
options := &HelperKubectlAuthOptions{}
options.InitDefaults()
cmd := &cobra.Command{
Use: "kubectl-auth",
Short: kubectlAuthShort,
Run: func(cmd *cobra.Command, args []string) {
ctx := context.TODO()
err := RunKubectlAuthHelper(ctx, f, out, options)
if err != nil {
commandutils.ExitWithError(err)
}
},
}
cmd.Flags().StringVar(&options.APIVersion, "api-version", options.APIVersion, "version of client.authentication.k8s.io schema in use")
cmd.Flags().StringVar(&options.ClusterName, "cluster", options.ClusterName, "cluster to target")
cmd.Flags().DurationVar(&options.Lifetime, "lifetime", options.Lifetime, "lifetime of the credential to issue")
return cmd
}
// RunKubectlAuthHelper implements the kubectl auth helper, which creates an authentication token
func RunKubectlAuthHelper(ctx context.Context, f *util.Factory, out io.Writer, options *HelperKubectlAuthOptions) error {
if options.ClusterName == "" {
return fmt.Errorf("ClusterName is required")
}
execCredential := &ExecCredential{
Kind: "ExecCredential",
}
switch options.APIVersion {
case "":
return fmt.Errorf("api-version must be specified")
case "v1alpha1":
execCredential.APIVersion = "client.authentication.k8s.io/v1alpha1"
case "v1beta1":
execCredential.APIVersion = "client.authentication.k8s.io/v1beta1"
default:
return fmt.Errorf("api-version %q is not supported", options.APIVersion)
}
cacheFilePath := cacheFilePath(f.KopsStateStore(), options.ClusterName)
cached, err := loadCachedExecCredential(cacheFilePath)
if err != nil {
klog.Infof("cached credential %q was not valid: %v", cacheFilePath, err)
cached = nil
}
if cached != nil && cached.APIVersion != execCredential.APIVersion {
klog.Infof("cached credential had wrong api version")
cached = nil
}
isCached := false
if cached != nil {
execCredential = cached
isCached = true
} else {
status, err := buildCredentials(ctx, f, options)
if err != nil {
return err
}
execCredential.Status = *status
}
b, err := json.MarshalIndent(execCredential, "", " ")
if err != nil {
return fmt.Errorf("error marshaling json: %v", err)
}
_, err = out.Write(b)
if err != nil {
return fmt.Errorf("error writing to stdout: %v", err)
}
if !isCached {
if err := os.MkdirAll(filepath.Dir(cacheFilePath), 0o755); err != nil {
klog.Warningf("failed to make cache directory for %q: %v", cacheFilePath, err)
}
if err := os.WriteFile(cacheFilePath, b, 0o600); err != nil {
klog.Warningf("failed to write cache file %q: %v", cacheFilePath, err)
}
}
return nil
}
// ExecCredential specifies the client.authentication.k8s.io ExecCredential object
type ExecCredential struct {
APIVersion string `json:"apiVersion,omitempty"`
Kind string `json:"kind,omitempty"`
Status ExecCredentialStatus `json:"status"`
}
// ExecCredentialStatus specifies the status of the client.authentication.k8s.io ExecCredential object
type ExecCredentialStatus struct {
ClientCertificateData string `json:"clientCertificateData,omitempty"`
ClientKeyData string `json:"clientKeyData,omitempty"`
ExpirationTimestamp time.Time `json:"expirationTimestamp,omitempty"`
}
func cacheFilePath(kopsStateStore string, clusterName string) string {
var b bytes.Buffer
b.WriteString(kopsStateStore)
b.WriteByte(0)
b.WriteString(clusterName)
b.WriteByte(0)
hash := fmt.Sprintf("%x", sha256.New().Sum(b.Bytes()))
sanitizedName := strings.Map(func(r rune) rune {
switch {
case r >= 'a' && r <= 'z':
return r
case r >= 'A' && r <= 'Z':
return r
case r >= '0' && r <= '9':
return r
default:
return '_'
}
}, clusterName)
return filepath.Join(homedir.HomeDir(), ".kube", "cache", "kops-authentication", sanitizedName+"_"+hash)
}
func loadCachedExecCredential(cacheFilePath string) (*ExecCredential, error) {
b, err := os.ReadFile(cacheFilePath)
if err != nil {
if os.IsNotExist(err) {
// expected - a cache miss
return nil, nil
} else {
return nil, err
}
}
execCredential := &ExecCredential{}
if err := json.Unmarshal(b, execCredential); err != nil {
return nil, fmt.Errorf("error parsing: %v", err)
}
if execCredential.Status.ExpirationTimestamp.Before(time.Now()) {
return nil, nil
}
if execCredential.Status.ClientCertificateData == "" || execCredential.Status.ClientKeyData == "" {
return nil, fmt.Errorf("no credentials in cached file")
}
return execCredential, nil
}
func buildCredentials(ctx context.Context, f *util.Factory, options *HelperKubectlAuthOptions) (*ExecCredentialStatus, error) {
clientset, err := f.KopsClient()
if err != nil {
return nil, err
}
cluster, err := clientset.GetCluster(ctx, options.ClusterName)
if err != nil {
return nil, err
}
if cluster == nil {
return nil, fmt.Errorf("cluster not found %q", options.ClusterName)
}
keyStore, err := clientset.KeyStore(cluster)
if err != nil {
return nil, fmt.Errorf("unable to get cluster keystore: %v", err)
}
cn := "kubecfg"
user, err := user.Current()
if err != nil || user == nil {
klog.Infof("unable to get user: %v", err)
} else {
cn += "-" + user.Name
}
req := pki.IssueCertRequest{
Signer: fi.CertificateIDCA,
Type: "client",
Subject: pkix.Name{
CommonName: cn,
Organization: []string{rbac.SystemPrivilegedGroup},
},
Validity: options.Lifetime,
}
cert, privateKey, _, err := pki.IssueCert(ctx, &req, fi.NewPKIKeystoreAdapter(keyStore))
if err != nil {
return nil, fmt.Errorf("unable to issue certificate: %v", err)
}
status := &ExecCredentialStatus{}
status.ClientCertificateData, err = cert.AsString()
if err != nil {
return nil, err
}
status.ClientKeyData, err = privateKey.AsString()
if err != nil {
return nil, err
}
// Subtract a few minutes from the validity for clock skew
status.ExpirationTimestamp = cert.Certificate.NotAfter.Add(-5 * time.Minute)
return status, nil
}