-
Notifications
You must be signed in to change notification settings - Fork 0
/
keyagent.go
466 lines (401 loc) · 13.2 KB
/
keyagent.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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
/*
Copyright 2017 Gravitational, Inc.
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 client
import (
"bufio"
"crypto/x509"
"fmt"
"io"
"net"
"os"
"strings"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/agent"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/lib/auth"
"github.com/gravitational/teleport/lib/sshutils"
"github.com/gravitational/teleport/lib/utils"
"github.com/gravitational/trace"
"github.com/sirupsen/logrus"
)
// LocalKeyAgent holds Teleport certificates for a user connected to a cluster.
type LocalKeyAgent struct {
// log holds the structured logger.
log *logrus.Entry
// Agent is the teleport agent
agent.Agent
// keyStore is the storage backend for certificates and keys
keyStore LocalKeyStore
// sshAgent is the system ssh agent
sshAgent agent.Agent
// noHosts is a in-memory map used in tests to track which hosts a user has
// manually (via keyboard input) refused connecting to.
noHosts map[string]bool
// function which asks a user to trust host/key combination (during host auth)
hostPromptFunc func(host string, k ssh.PublicKey) error
// username is the Teleport username for who the keys will be loaded in the
// local agent.
username string
// proxyHost is the proxy for the cluster that his key agent holds keys for.
proxyHost string
}
// NewLocalAgent reads all Teleport certificates from disk (using FSLocalKeyStore),
// creates a LocalKeyAgent, loads all certificates into it, and returns the agent.
func NewLocalAgent(keyDir, proxyHost, username string, useLocalSSHAgent bool) (a *LocalKeyAgent, err error) {
keystore, err := NewFSLocalKeyStore(keyDir)
if err != nil {
return nil, trace.Wrap(err)
}
a = &LocalKeyAgent{
log: logrus.WithFields(logrus.Fields{
trace.Component: teleport.ComponentKeyAgent,
}),
Agent: agent.NewKeyring(),
keyStore: keystore,
noHosts: make(map[string]bool),
username: username,
proxyHost: proxyHost,
}
if useLocalSSHAgent {
a.sshAgent = connectToSSHAgent()
} else {
log.Debug("Skipping connection to the local ssh-agent.")
}
// unload all teleport keys from the agent first to ensure
// we don't leave stale keys in the agent
err = a.UnloadKeys()
if err != nil {
return nil, trace.Wrap(err)
}
// read in key for this user in proxy
key, err := a.GetKey()
if err != nil {
if trace.IsNotFound(err) {
return a, nil
}
return nil, trace.Wrap(err)
}
a.log.Infof("Loading key for %q", username)
// load key into the agent
_, err = a.LoadKey(*key)
if err != nil {
return nil, trace.Wrap(err)
}
return a, nil
}
// UpdateProxyHost changes the proxy host that the local agent operates on.
func (a *LocalKeyAgent) UpdateProxyHost(proxyHost string) {
a.proxyHost = proxyHost
}
// LoadKey adds a key into the Teleport ssh agent as well as the system ssh
// agent.
func (a *LocalKeyAgent) LoadKey(key Key) (*agent.AddedKey, error) {
agents := []agent.Agent{a.Agent}
if a.sshAgent != nil {
agents = append(agents, a.sshAgent)
}
// convert keys into a format understood by the ssh agent
agentKeys, err := key.AsAgentKeys()
if err != nil {
return nil, trace.Wrap(err)
}
// remove any keys that the user may already have loaded
err = a.UnloadKey()
if err != nil {
return nil, trace.Wrap(err)
}
// iterate over all teleport and system agent and load key
for _, agent := range agents {
for _, agentKey := range agentKeys {
err = agent.Add(agentKey)
if err != nil {
a.log.Warnf("Unable to communicate with agent and add key: %v", err)
}
}
}
// return the first key because it has the embedded private key in it.
// see docs for AsAgentKeys for more details.
return &agentKeys[0], nil
}
// UnloadKey will unload key for user from the teleport ssh agent as well as
// the system agent.
func (a *LocalKeyAgent) UnloadKey() error {
agents := []agent.Agent{a.Agent}
if a.sshAgent != nil {
agents = append(agents, a.sshAgent)
}
// iterate over all agents we have and unload keys for this user
for _, agent := range agents {
// get a list of all keys in the agent
keyList, err := agent.List()
if err != nil {
a.log.Warnf("Unable to communicate with agent and list keys: %v", err)
}
// remove any teleport keys we currently have loaded in the agent for this user
for _, key := range keyList {
if key.Comment == fmt.Sprintf("teleport:%v", a.username) {
err = agent.Remove(key)
if err != nil {
a.log.Warnf("Unable to communicate with agent and remove key: %v", err)
}
}
}
}
return nil
}
// UnloadKeys will unload all Teleport keys from the teleport agent as well as
// the system agent.
func (a *LocalKeyAgent) UnloadKeys() error {
agents := []agent.Agent{a.Agent}
if a.sshAgent != nil {
agents = append(agents, a.sshAgent)
}
// iterate over all agents we have
for _, agent := range agents {
// get a list of all keys in the agent
keyList, err := agent.List()
if err != nil {
a.log.Warnf("Unable to communicate with agent and list keys: %v", err)
}
// remove any teleport keys we currently have loaded in the agent
for _, key := range keyList {
if strings.HasPrefix(key.Comment, "teleport:") {
err = agent.Remove(key)
if err != nil {
a.log.Warnf("Unable to communicate with agent and remove key: %v", err)
}
}
}
}
return nil
}
// GetKey returns the key for this user in a proxy from the filesystem keystore
// at ~/.tsh.
func (a *LocalKeyAgent) GetKey() (*Key, error) {
return a.keyStore.GetKey(a.proxyHost, a.username)
}
// AddHostSignersToCache takes a list of CAs whom we trust. This list is added to a database
// of "seen" CAs.
//
// Every time we connect to a new host, we'll request its certificaate to be signed by one
// of these trusted CAs.
//
// Why do we trust these CAs? Because we received them from a trusted Teleport Proxy.
// Why do we trust the proxy? Because we've connected to it via HTTPS + username + Password + HOTP.
func (a *LocalKeyAgent) AddHostSignersToCache(certAuthorities []auth.TrustedCerts) error {
for _, ca := range certAuthorities {
publicKeys, err := ca.SSHCertPublicKeys()
if err != nil {
a.log.Error(err)
return trace.Wrap(err)
}
a.log.Debugf("Adding CA key for %s", ca.ClusterName)
err = a.keyStore.AddKnownHostKeys(ca.ClusterName, publicKeys)
if err != nil {
return trace.Wrap(err)
}
}
return nil
}
func (a *LocalKeyAgent) SaveCerts(certAuthorities []auth.TrustedCerts) error {
return a.keyStore.SaveCerts(a.proxyHost, certAuthorities)
}
func (a *LocalKeyAgent) GetCerts() (*x509.CertPool, error) {
return a.keyStore.GetCerts(a.proxyHost)
}
func (a *LocalKeyAgent) GetCertsPEM() ([][]byte, error) {
return a.keyStore.GetCertsPEM(a.proxyHost)
}
// UserRefusedHosts returns 'true' if a user refuses connecting to remote hosts
// when prompted during host authorization
func (a *LocalKeyAgent) UserRefusedHosts() bool {
return len(a.noHosts) > 0
}
// CheckHostSignature checks if the given host key was signed by a Teleport
// certificate authority (CA) or a host certificate the user has seen before.
func (a *LocalKeyAgent) CheckHostSignature(addr string, remote net.Addr, key ssh.PublicKey) error {
certChecker := utils.CertChecker{
CertChecker: ssh.CertChecker{
IsHostAuthority: a.checkHostCertificate,
HostKeyFallback: a.checkHostKey,
},
FIPS: isFIPS(),
}
err := certChecker.CheckHostKey(addr, remote, key)
if err != nil {
a.log.Debugf("Host validation failed: %v.", err)
return trace.Wrap(err)
}
a.log.Debugf("Validated host %v.", addr)
return nil
}
// checkHostCertificate validates a host certificate. First checks the
// ~/.tsh/known_hosts cache and if not found, prompts the user to accept
// or reject.
func (a *LocalKeyAgent) checkHostCertificate(key ssh.PublicKey, addr string) bool {
// Check the local cache (where all Teleport CAs are placed upon login) to
// see if any of them match.
keys, err := a.keyStore.GetKnownHostKeys("")
if err != nil {
a.log.Errorf("Unable to fetch certificate authorities: %v.", err)
return false
}
for i := range keys {
if sshutils.KeysEqual(key, keys[i]) {
return true
}
}
// If this certificate was not seen before, prompt the user essentially
// treating it like a key.
err = a.checkHostKey(addr, nil, key)
return err == nil
}
// checkHostKey validates a host key. First checks the
// ~/.tsh/known_hosts cache and if not found, prompts the user to accept
// or reject.
func (a *LocalKeyAgent) checkHostKey(addr string, remote net.Addr, key ssh.PublicKey) error {
var err error
// Check if this exact host is in the local cache.
keys, _ := a.keyStore.GetKnownHostKeys(addr)
if len(keys) > 0 && sshutils.KeysEqual(key, keys[0]) {
a.log.Debugf("Verified host %s.", addr)
return nil
}
// If this key was not seen before, prompt the user with a fingerprint.
if a.hostPromptFunc != nil {
err = a.hostPromptFunc(addr, key)
} else {
err = a.defaultHostPromptFunc(addr, key, os.Stdout, os.Stdin)
}
if err != nil {
a.noHosts[addr] = true
return trace.Wrap(err)
}
// If the user trusts the key, store the key in the local known hosts
// cache ~/.tsh/known_hosts.
err = a.keyStore.AddKnownHostKeys(addr, []ssh.PublicKey{key})
if err != nil {
a.log.Warnf("Failed to save the host key: %v.", err)
return trace.Wrap(err)
}
return nil
}
// defaultHostPromptFunc is the default host key/certificates prompt.
func (a *LocalKeyAgent) defaultHostPromptFunc(host string, key ssh.PublicKey, writer io.Writer, reader io.Reader) error {
var err error
userAnswer := "no"
if !a.noHosts[host] {
fmt.Fprintf(writer, "The authenticity of host '%s' can't be established. "+
"Its public key is:\n%s\nAre you sure you want to continue (yes/no)? ",
host, ssh.MarshalAuthorizedKey(key))
userAnswer, err = bufio.NewReader(reader).ReadString('\n')
if err != nil {
return trace.Wrap(err)
}
userAnswer = strings.TrimSpace(strings.ToLower(userAnswer))
}
ok, err := utils.ParseBool(userAnswer)
if err != nil {
return trace.Wrap(err)
}
if !ok {
return trace.BadParameter("not trusted")
}
return nil
}
// AddKey activates a new signed session key by adding it into the keystore and also
// by loading it into the SSH agent
func (a *LocalKeyAgent) AddKey(key *Key) (*agent.AddedKey, error) {
// save it to disk (usually into ~/.tsh)
err := a.keyStore.AddKey(a.proxyHost, a.username, key)
if err != nil {
return nil, trace.Wrap(err)
}
// load key into the teleport agent and system agent
return a.LoadKey(*key)
}
// DeleteKey removes the key from the key store as well as unloading the key
// from the agent.
func (a *LocalKeyAgent) DeleteKey() error {
// remove key from key store
err := a.keyStore.DeleteKey(a.proxyHost, a.username)
if err != nil {
return trace.Wrap(err)
}
// remove any keys that are loaded for this user from the teleport and
// system agents
err = a.UnloadKey()
if err != nil {
return trace.Wrap(err)
}
return nil
}
// DeleteKeys removes all keys from the keystore as well as unloads keys
// from the agent.
func (a *LocalKeyAgent) DeleteKeys() error {
// Remove keys from the filesystem.
err := a.keyStore.DeleteKeys()
if err != nil {
return trace.Wrap(err)
}
// Remove all keys from the Teleport and system agents.
err = a.UnloadKeys()
if err != nil {
return trace.Wrap(err)
}
return nil
}
// AuthMethods returns the list of different authentication methods this agent supports
// It returns two:
// 1. First to try is the external SSH agent
// 2. Itself (disk-based local agent)
func (a *LocalKeyAgent) AuthMethods() (m []ssh.AuthMethod) {
// combine our certificates with external SSH agent's:
var signers []ssh.Signer
if ourCerts, _ := a.Signers(); ourCerts != nil {
signers = append(signers, ourCerts...)
}
if a.sshAgent != nil {
if sshAgentCerts, _ := a.sshAgent.Signers(); sshAgentCerts != nil {
signers = append(signers, sshAgentCerts...)
}
}
// for every certificate create a new "auth method" and return them
m = make([]ssh.AuthMethod, 0)
for i := range signers {
// filter out non-certificates (like regular public SSH keys stored in the SSH agent):
_, ok := signers[i].PublicKey().(*ssh.Certificate)
if ok {
m = append(m, NewAuthMethodForCert(signers[i]))
}
}
return m
}
// CertAuthMethod is a wrapper around ssh.Signer (certificate signer) object.
// CertAuthMethod then implements ssh.Authmethod interface around this one certificate signer.
//
// We need this wrapper because Golang's SSH library's unfortunate API design. It uses
// callbacks with 'authMethod' interfaces and without this wrapper it is impossible to
// tell which certificate an 'authMethod' passed via a callback had succeeded authenticating with.
type CertAuthMethod struct {
ssh.AuthMethod
Cert ssh.Signer
}
func NewAuthMethodForCert(cert ssh.Signer) *CertAuthMethod {
return &CertAuthMethod{
Cert: cert,
AuthMethod: ssh.PublicKeysCallback(func() ([]ssh.Signer, error) {
return []ssh.Signer{cert}, nil
}),
}
}