forked from gravitational/teleport
/
output_identity.go
159 lines (135 loc) · 4.59 KB
/
output_identity.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
/*
* Teleport
* Copyright (C) 2023 Gravitational, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package config
import (
"context"
"fmt"
"os"
"github.com/gravitational/trace"
"gopkg.in/yaml.v3"
"github.com/gravitational/teleport/lib/config/openssh"
"github.com/gravitational/teleport/lib/tbot/bot"
"github.com/gravitational/teleport/lib/tbot/identity"
)
const IdentityOutputType = "identity"
// IdentityOutput produces credentials which can be used with `tsh`, `tctl`,
// `openssh` and most SSH compatible tooling. It can also be used with the
// Teleport API and things which use the API client (e.g the terraform provider)
//
// It cannot be used to connect to Applications, Databases or Kubernetes
// Clusters.
type IdentityOutput struct {
// Destination is where the credentials should be written to.
Destination bot.Destination `yaml:"destination"`
// Roles is the list of roles to request for the generated credentials.
// If empty, it defaults to all the bot's roles.
Roles []string `yaml:"roles,omitempty"`
// Cluster allows certificates to be generated for a leaf cluster of the
// cluster that the bot is connected to. These certificates can be used
// to directly connect to a Teleport proxy of that leaf cluster, or used
// with the root cluster's proxy which will forward the request to the
// leaf cluster.
// For now, only SSH is supported.
Cluster string `yaml:"cluster,omitempty"`
destPath string
}
func (o *IdentityOutput) templates() []template {
return []template{
&templateTLSCAs{},
&templateSSHClient{
getSSHVersion: openssh.GetSystemSSHVersion,
executablePathGetter: os.Executable,
destPath: o.destPath,
},
&templateIdentity{},
}
}
func (o *IdentityOutput) Render(ctx context.Context, p provider, ident *identity.Identity) error {
ctx, span := tracer.Start(
ctx,
"IdentityOutput/Render",
)
defer span.End()
dest := o.GetDestination()
if err := identity.SaveIdentity(ctx, ident, dest, identity.DestinationKinds()...); err != nil {
return trace.Wrap(err, "persisting identity")
}
for _, t := range o.templates() {
if err := t.render(ctx, p, ident, dest); err != nil {
return trace.Wrap(err, "rendering template %s", t.name())
}
}
return nil
}
func (o *IdentityOutput) Init(ctx context.Context) error {
subDirs, err := listSubdirectories(o.templates())
if err != nil {
return trace.Wrap(err)
}
return trace.Wrap(o.Destination.Init(ctx, subDirs))
}
func (o *IdentityOutput) GetDestination() bot.Destination {
return o.Destination
}
func (o *IdentityOutput) GetRoles() []string {
return o.Roles
}
func (o *IdentityOutput) CheckAndSetDefaults() error {
if err := validateOutputDestination(o.Destination); err != nil {
return trace.Wrap(err)
}
dest, ok := o.Destination.(*DestinationDirectory)
if ok {
o.destPath = dest.Path
} else {
// If destDir is unset, we're not using a filesystem destination and
// ssh_config will not be sensible. Log a note and bail early without
// writing ssh_config. (Future users of k8s secrets will need to bring
// their own config, we can't predict where paths will be in practice.)
log.Infof("Note: no ssh_config will be written for non-filesystem "+
"destination %q.", o.Destination)
}
return nil
}
func (o *IdentityOutput) Describe() []FileDescription {
var fds []FileDescription
for _, t := range o.templates() {
fds = append(fds, t.describe()...)
}
return fds
}
func (o *IdentityOutput) MarshalYAML() (interface{}, error) {
type raw IdentityOutput
return withTypeHeader((*raw)(o), IdentityOutputType)
}
func (o *IdentityOutput) UnmarshalYAML(node *yaml.Node) error {
dest, err := extractOutputDestination(node)
if err != nil {
return trace.Wrap(err)
}
// Alias type to remove UnmarshalYAML to avoid recursion
type raw IdentityOutput
if err := node.Decode((*raw)(o)); err != nil {
return trace.Wrap(err)
}
o.Destination = dest
return nil
}
func (o *IdentityOutput) String() string {
return fmt.Sprintf("%s (%s)", IdentityOutputType, o.GetDestination())
}