-
Notifications
You must be signed in to change notification settings - Fork 152
/
custom_ssh_key.go
312 lines (272 loc) · 7.59 KB
/
custom_ssh_key.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
package instance
import (
"context"
"encoding/base64"
"fmt"
"hash/crc32"
"reflect"
"strings"
"encoding/binary"
"github.com/scaleway/scaleway-cli/v2/internal/core"
"github.com/scaleway/scaleway-cli/v2/internal/human"
"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
"github.com/scaleway/scaleway-sdk-go/scw"
)
const (
sshKeyTagPrefix = "AUTHORIZED_KEY="
)
type SSHKeyFormat struct {
Name string `json:"name"`
Type string `json:"type"`
Key string `json:"key"`
}
func marshalSSHKeys(i interface{}, opts *human.MarshalOpt) (string, error) {
// Custom type to avoid recursion when marshaling
type humanKey struct {
Name string
Type string
Key string
}
keys := i.([]*SSHKeyFormat)
humanKeys := make([]*humanKey, len(keys))
for i, key := range keys {
hKey := &humanKey{
Name: key.Name,
Type: key.Type,
Key: key.Key,
}
if len(hKey.Key) > 16 {
hKey.Key = hKey.Key[:16]
}
humanKeys[i] = hKey
}
return human.Marshal(humanKeys, opts)
}
func instanceSSH() *core.Command {
return &core.Command{
Short: `SSH Utilities`,
Long: `Command utilities around server SSH
- Manage keys per server
- Generate ssh config`,
Namespace: "instance",
Resource: "ssh",
}
}
type sshAddKeyRequest struct {
Zone scw.Zone
ServerID string
PublicKey string
}
func sshAddKeyCommand() *core.Command {
return &core.Command{
Namespace: "instance",
Resource: "ssh",
Verb: "add-key",
Groups: []string{"utility"},
Short: "Add a public key to a server",
Long: `Key will be added to server's tags and added to root user on next restart.
Key is expected in openssh format "(format) (key) (comment)".
The comment will be used as key name or generated
Lookup /root/.ssh/authorized_keys on your server for more information`,
ArgsType: reflect.TypeOf(sshAddKeyRequest{}),
ArgSpecs: core.ArgSpecs{
{
Name: "server-id",
Short: "Server to add your key to",
},
{
Name: "public-key",
Short: "Public key you want to add to your server",
},
core.ZoneArgSpec(((*instance.API)(nil)).Zones()...),
},
Run: func(ctx context.Context, argsI interface{}) (interface{}, error) {
args := argsI.(*sshAddKeyRequest)
api := instance.NewAPI(core.ExtractClient(ctx))
server, err := api.GetServer(&instance.GetServerRequest{
Zone: args.Zone,
ServerID: args.ServerID,
})
if err != nil {
return nil, fmt.Errorf("failed to fetch server: %w", err)
}
formattedKey := FormatSSHKeyToTag(args.PublicKey)
for i, tag := range server.Server.Tags {
if tag == formattedKey {
return nil, fmt.Errorf("key already exists (tags.%d)", i)
}
}
tags := append(server.Server.Tags, formattedKey)
_, err = api.UpdateServer(&instance.UpdateServerRequest{
Zone: args.Zone,
ServerID: args.ServerID,
Tags: &tags,
})
if err != nil {
return nil, fmt.Errorf("failed to update server: %w", err)
}
return &core.SuccessResult{
Resource: "ssh",
Verb: "add-key",
}, nil
},
}
}
type sshListKeysRequest struct {
Zone scw.Zone
ServerID string
}
func sshListKeysCommand() *core.Command {
return &core.Command{
Namespace: "instance",
Resource: "ssh",
Verb: "list-keys",
Groups: []string{"utility"},
Short: "List manually added public keys",
Long: `List only keys added manually to a server using tags.
The key comment is used as key name or generated
Lookup /root/.ssh/authorized_keys on your server for more information`,
ArgsType: reflect.TypeOf(sshListKeysRequest{}),
ArgSpecs: core.ArgSpecs{
{
Name: "server-id",
Short: "Server to add your key to",
Positional: true,
Required: true,
},
core.ZoneArgSpec(((*instance.API)(nil)).Zones()...),
},
Run: func(ctx context.Context, argsI interface{}) (interface{}, error) {
args := argsI.(*sshListKeysRequest)
api := instance.NewAPI(core.ExtractClient(ctx))
server, err := api.GetServer(&instance.GetServerRequest{
Zone: args.Zone,
ServerID: args.ServerID,
})
if err != nil {
return nil, fmt.Errorf("failed to fetch server: %w", err)
}
keys := []*SSHKeyFormat(nil)
for _, tag := range server.Server.Tags {
if !isSSHKeyTag(tag) {
continue
}
keys = append(keys, expandSSHKeyTag(tag))
}
return keys, nil
},
}
}
type sshRemoveKeyRequest struct {
Zone scw.Zone
ServerID string
Name string
PublicKey string
}
func sshRemoveKeyCommand() *core.Command {
return &core.Command{
Namespace: "instance",
Resource: "ssh",
Verb: "remove-key",
Groups: []string{"utility"},
Short: "Remove a manually added public key from a server",
Long: `Key will be remove from server's tags and removed from root user on next restart.
Keys are identified by their comment as in openssh format.
Lookup /root/.ssh/authorized_keys on your server for more information`,
ArgsType: reflect.TypeOf(sshRemoveKeyRequest{}),
ArgSpecs: core.ArgSpecs{
{
Name: "server-id",
Short: "Server to add your key to",
Required: true,
},
{
Name: "name",
Short: "Name of the key you want to remove, has to be the key comment or the index",
OneOfGroup: "identifier",
},
{
Name: "public-key",
Short: "Public key you want to remove",
OneOfGroup: "identifier",
},
core.ZoneArgSpec(((*instance.API)(nil)).Zones()...),
},
Run: func(ctx context.Context, argsI interface{}) (interface{}, error) {
args := argsI.(*sshRemoveKeyRequest)
api := instance.NewAPI(core.ExtractClient(ctx))
server, err := api.GetServer(&instance.GetServerRequest{
Zone: args.Zone,
ServerID: args.ServerID,
})
if err != nil {
return nil, fmt.Errorf("failed to fetch server: %w", err)
}
newTags := make([]string, 0, len(server.Server.Tags))
removedKeys := []*SSHKeyFormat(nil)
for _, tag := range server.Server.Tags {
if !isSSHKeyTag(tag) {
continue
}
key := expandSSHKeyTag(tag)
if key.Name == args.Name || tag == FormatSSHKeyToTag(args.PublicKey) {
removedKeys = append(removedKeys, expandSSHKeyTag(tag))
} else {
newTags = append(newTags, tag)
}
}
if len(removedKeys) == 0 {
return nil, fmt.Errorf("no key found with given filters")
}
_, err = api.UpdateServer(&instance.UpdateServerRequest{
Zone: args.Zone,
ServerID: args.ServerID,
Tags: &newTags,
})
if err != nil {
return nil, fmt.Errorf("failed to update server: %w", err)
}
msg := "Removed keys"
removedKeysMsg, err := human.Marshal(removedKeys, nil)
if err == nil {
msg = msg + "\n" + removedKeysMsg
}
return &core.SuccessResult{
Resource: "ssh",
Verb: "remove-key",
Message: msg,
}, nil
},
}
}
func FormatSSHKeyToTag(publicKey string) string {
return "AUTHORIZED_KEY=" + strings.ReplaceAll(publicKey, " ", "_")
}
func isSSHKeyTag(tag string) bool {
return strings.HasPrefix(tag, sshKeyTagPrefix)
}
func expandSSHKeyTag(tag string) *SSHKeyFormat {
wholeKey := strings.TrimPrefix(tag, sshKeyTagPrefix)
// key should have underscores in place of spaces
wholeKey = strings.ReplaceAll(wholeKey, "_", " ")
elems := strings.Split(wholeKey, " ")
sshKey := &SSHKeyFormat{}
if len(elems) > 0 {
sshKey.Type = elems[0]
}
if len(elems) > 1 {
sshKey.Key = elems[1]
}
if len(elems) > 2 {
sshKey.Name = elems[2]
} else {
sshKey.Name = generateSSHKeyName(strings.Join(elems, ""))
}
return sshKey
}
func generateSSHKeyName(key string) string {
sumBuffer := make([]byte, 4)
sum := crc32.ChecksumIEEE([]byte(key))
binary.BigEndian.PutUint32(sumBuffer, sum)
return base64.RawStdEncoding.EncodeToString(sumBuffer)
}