forked from juju/juju
/
credentials.go
378 lines (346 loc) · 11.3 KB
/
credentials.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
// Copyright 2016 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
// +build go1.3
package lxd
import (
"fmt"
"io"
"io/ioutil"
"net"
"net/url"
"os"
"path/filepath"
"github.com/juju/errors"
"github.com/juju/utils"
"github.com/juju/juju/cloud"
"github.com/juju/juju/environs"
"github.com/juju/juju/juju/osenv"
"github.com/juju/juju/tools/lxdclient"
)
const (
credAttrServerCert = "server-cert"
credAttrClientCert = "client-cert"
credAttrClientKey = "client-key"
// interactiveAuthType is a credential auth-type provided as an option to
// "juju add-credential", which takes the user through the process of
// generating a certificate credential.
interactiveAuthType = "interactive"
)
// environProviderCredentials implements environs.ProviderCredentials.
type environProviderCredentials struct {
generateMemCert func(bool) ([]byte, []byte, error)
newLocalRawProvider func() (*rawProvider, error)
lookupHost func(string) ([]string, error)
interfaceAddrs func() ([]net.Addr, error)
}
// CredentialSchemas is part of the environs.ProviderCredentials interface.
func (environProviderCredentials) CredentialSchemas() map[cloud.AuthType]cloud.CredentialSchema {
return map[cloud.AuthType]cloud.CredentialSchema{
interactiveAuthType: {},
cloud.CertificateAuthType: {{
credAttrServerCert,
cloud.CredentialAttr{
Description: "The LXD server certificate, PEM-encoded.",
},
}, {
credAttrClientCert,
cloud.CredentialAttr{
Description: "The LXD client certificate, PEM-encoded.",
},
}, {
credAttrClientKey,
cloud.CredentialAttr{
Description: "The LXD client key, PEM-encoded.",
},
}},
}
}
// DetectCredentials is part of the environs.ProviderCredentials interface.
func (p environProviderCredentials) DetectCredentials() (*cloud.CloudCredential, error) {
raw, err := p.newLocalRawProvider()
if err != nil {
return nil, errors.NewNotFound(err, "failed to connecti to local LXD")
}
nopLogf := func(string, ...interface{}) {}
certPEM, keyPEM, err := p.readOrGenerateCert(nopLogf)
if err != nil {
return nil, errors.Trace(err)
}
const credName = "localhost"
label := fmt.Sprintf("LXD credential %q", credName)
certCredential, err := p.finalizeLocalCertificateCredential(
ioutil.Discard, raw, string(certPEM), string(keyPEM), label,
)
if err != nil {
return nil, errors.Trace(err)
}
return &cloud.CloudCredential{
AuthCredentials: map[string]cloud.Credential{credName: *certCredential},
}, nil
}
func (p environProviderCredentials) readOrGenerateCert(logf func(string, ...interface{})) (certPEM, keyPEM []byte, _ error) {
// First look in the Juju XDG_DATA dir. This allows the user
// to explicitly override the certificates used by the lxc
// client if they wish.
jujuLXDDir := osenv.JujuXDGDataHomePath("lxd")
certPEM, keyPEM, err := readCert(jujuLXDDir)
if err == nil {
logf("Loaded client cert/key from %q", jujuLXDDir)
return certPEM, keyPEM, nil
} else if !os.IsNotExist(err) {
return nil, nil, errors.Trace(err)
}
// Next we look in the LXD config dir, in case the user has
// a client certificate/key pair for use with the "lxc" client
// application.
lxdConfigDir := filepath.Join(utils.Home(), ".config", "lxc")
certPEM, keyPEM, err = readCert(lxdConfigDir)
if err == nil {
logf("Loaded client cert/key from %q", lxdConfigDir)
return certPEM, keyPEM, nil
} else if !os.IsNotExist(err) {
return nil, nil, errors.Trace(err)
}
// No certs were found, so generate one and cache it in the
// Juju XDG_DATA dir. We cache the certificate so that we
// avoid uploading a new certificate each time we bootstrap.
certPEM, keyPEM, err = p.generateMemCert(true)
if err != nil {
return nil, nil, errors.Trace(err)
}
if err := writeCert(jujuLXDDir, certPEM, keyPEM); err != nil {
return nil, nil, errors.Trace(err)
}
logf("Generating client cert/key in %q", jujuLXDDir)
return certPEM, keyPEM, nil
}
func readCert(dir string) (certPEM, keyPEM []byte, _ error) {
clientCertPath := filepath.Join(dir, "client.crt")
clientKeyPath := filepath.Join(dir, "client.key")
certPEM, err := ioutil.ReadFile(clientCertPath)
if err != nil {
return nil, nil, err
}
keyPEM, err = ioutil.ReadFile(clientKeyPath)
if err != nil {
return nil, nil, err
}
return certPEM, keyPEM, nil
}
func writeCert(dir string, certPEM, keyPEM []byte) error {
clientCertPath := filepath.Join(dir, "client.crt")
clientKeyPath := filepath.Join(dir, "client.key")
if err := os.MkdirAll(dir, 0700); err != nil {
return errors.Trace(err)
}
if err := ioutil.WriteFile(clientCertPath, certPEM, 0600); err != nil {
return err
}
if err := ioutil.WriteFile(clientKeyPath, keyPEM, 0600); err != nil {
return err
}
return nil
}
// FinalizeCredential is part of the environs.ProviderCredentials interface.
func (p environProviderCredentials) FinalizeCredential(ctx environs.FinalizeCredentialContext, args environs.FinalizeCredentialParams) (*cloud.Credential, error) {
var interactive bool
switch authType := args.Credential.AuthType(); authType {
case interactiveAuthType:
stderr := ctx.GetStderr()
logf := func(s string, args ...interface{}) {
fmt.Fprintf(stderr, s+"\n", args...)
}
certPEM, keyPEM, err := p.readOrGenerateCert(logf)
if err != nil {
return nil, errors.Trace(err)
}
certCredential := cloud.NewCredential(cloud.CertificateAuthType, map[string]string{
credAttrClientCert: string(certPEM),
credAttrClientKey: string(keyPEM),
})
certCredential.Label = args.Credential.Label
args.Credential = certCredential
interactive = true
fallthrough
case cloud.CertificateAuthType:
return p.finalizeCertificateCredential(ctx, args, interactive)
default:
return &args.Credential, nil
}
}
func (p environProviderCredentials) finalizeCertificateCredential(
ctx environs.FinalizeCredentialContext,
args environs.FinalizeCredentialParams,
interactive bool,
) (*cloud.Credential, error) {
// Credential detection yields a partial certificate containing just
// the client certificate and key. We check if we have a partial
// credential, and fill in the server certificate if we can.
stderr := ctx.GetStderr()
credAttrs := args.Credential.Attributes()
if credAttrs[credAttrServerCert] != "" {
// The credential is fully formed, so we assume the client
// certificate is uploaded to the server already.
return &args.Credential, nil
}
certPEM := credAttrs[credAttrClientCert]
keyPEM := credAttrs[credAttrClientKey]
if certPEM == "" {
return nil, errors.NotValidf("missing or empty %q attribute", credAttrClientCert)
}
if keyPEM == "" {
return nil, errors.NotValidf("missing or empty %q attribute", credAttrClientKey)
}
isLocalEndpoint, err := p.isLocalEndpoint(args.CloudEndpoint)
if err != nil {
return nil, errors.Trace(err)
}
if !isLocalEndpoint {
// The endpoint is not local, so we cannot generate a
// certificate credential.
//
// TODO(axw) we could look in the $HOME/.config/lxc/servercerts
// directory for a server certificate. We would need to read
// $HOME/.config/lxc/config.yml to identify the remote by its
// endpoint.
//
// TODO(axw) for the "interactive" auth-type, we should take
// the user through the server certificate fingerprint
// verification and trust password flow.
prefix := "cannot auto-generate credential for remote LXD"
if interactive {
prefix = "certificate upload for remote LXD unsupported"
}
return nil, errors.Errorf(`%s
Until support is added for verifying and authenticating to remote LXD hosts,
you must generate the credential on the LXD host, and add the credential to
this client using "juju add-credential localhost".
See: https://jujucharms.com/docs/stable/clouds-LXD
`, prefix)
}
raw, err := p.newLocalRawProvider()
if err != nil {
return nil, errors.Trace(err)
}
return p.finalizeLocalCertificateCredential(
stderr, raw, certPEM, keyPEM,
args.Credential.Label,
)
}
func (p environProviderCredentials) finalizeLocalCertificateCredential(
output io.Writer,
raw *rawProvider,
certPEM, keyPEM, label string,
) (*cloud.Credential, error) {
// Upload the certificate to the server if necessary.
clientCert := lxdclient.Cert{
Name: "juju",
CertPEM: []byte(certPEM),
KeyPEM: []byte(keyPEM),
}
fingerprint, err := clientCert.Fingerprint()
if err != nil {
return nil, errors.Trace(err)
}
if _, err := raw.CertByFingerprint(fingerprint); errors.IsNotFound(err) {
if addCertErr := raw.AddCert(clientCert); addCertErr != nil {
// There is no specific error code returned when
// attempting to add a certificate that already
// exists in the database. We can just check
// again to see if another process added the
// certificate concurrently with us checking the
// first time.
if _, err := raw.CertByFingerprint(fingerprint); errors.IsNotFound(err) {
// The cert still isn't there, so report the AddCert error.
return nil, errors.Annotatef(
addCertErr, "adding certificate %q", clientCert.Name,
)
} else if err != nil {
return nil, errors.Annotate(err, "querying certificates")
}
// The certificate is there now, which implies
// there was a concurrent AddCert by another
// process. Carry on.
}
fmt.Fprintln(output, "Uploaded certificate to LXD server.")
} else if err != nil {
return nil, errors.Annotate(err, "querying certificates")
}
// Store the server's certificate in the credential.
serverState, err := raw.ServerStatus()
if err != nil {
return nil, errors.Annotate(err, "getting server status")
}
out := cloud.NewCredential(cloud.CertificateAuthType, map[string]string{
credAttrClientCert: certPEM,
credAttrClientKey: keyPEM,
credAttrServerCert: serverState.Environment.Certificate,
})
out.Label = label
return &out, nil
}
func (p environProviderCredentials) isLocalEndpoint(endpoint string) (bool, error) {
if endpoint == "" {
// No endpoint specified, so assume we're local. This
// will happen, for example, when destroying a 2.0
// LXD controller.
return true, nil
}
endpointURL, err := endpointURL(endpoint)
if err != nil {
return false, errors.Trace(err)
}
host, _, err := net.SplitHostPort(endpointURL.Host)
if err != nil {
host = endpointURL.Host
}
endpointAddrs, err := p.lookupHost(host)
if err != nil {
return false, errors.Trace(err)
}
localAddrs, err := p.interfaceAddrs()
if err != nil {
return false, errors.Trace(err)
}
return addrsContainsAny(localAddrs, endpointAddrs), nil
}
func endpointURL(endpoint string) (*url.URL, error) {
remoteURL, err := url.Parse(endpoint)
if err != nil || remoteURL.Scheme == "" {
remoteURL = &url.URL{
Scheme: "https",
Host: endpoint,
}
} else {
// If the user specifies an endpoint, it must be either
// host:port, or https://host:port. We do not support
// unix:// endpoints at present.
if remoteURL.Scheme != "https" {
return nil, errors.Errorf(
"invalid URL %q: only HTTPS is supported",
endpoint,
)
}
}
return remoteURL, nil
}
func addrsContainsAny(haystack []net.Addr, needles []string) bool {
for _, needle := range needles {
if addrsContains(haystack, needle) {
return true
}
}
return false
}
func addrsContains(haystack []net.Addr, needle string) bool {
ip := net.ParseIP(needle)
if ip == nil {
return false
}
for _, addr := range haystack {
if addr, ok := addr.(*net.IPNet); ok && addr.IP.Equal(ip) {
return true
}
}
return false
}