-
Notifications
You must be signed in to change notification settings - Fork 649
/
resource_ibm_is_ssh_key.go
501 lines (447 loc) · 13.7 KB
/
resource_ibm_is_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
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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
// Copyright IBM Corp. 2017, 2021 All Rights Reserved.
// Licensed under the Mozilla Public License v2.0
package vpc
import (
"context"
"encoding/base64"
"errors"
"fmt"
"log"
"os"
"strings"
"github.com/IBM-Cloud/terraform-provider-ibm/ibm/flex"
"github.com/IBM-Cloud/terraform-provider-ibm/ibm/validate"
"github.com/IBM/vpc-go-sdk/vpcv1"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"golang.org/x/crypto/ssh"
)
const (
isKeyName = "name"
IsKeyCRN = "crn"
isKeyPublicKey = "public_key"
isKeyType = "type"
isKeyFingerprint = "fingerprint"
isKeyLength = "length"
isKeyTags = "tags"
isKeyResourceGroup = "resource_group"
isKeyAccessTags = "access_tags"
isKeyUserTagType = "user"
isKeyAccessTagType = "access"
)
func ResourceIBMISSSHKey() *schema.Resource {
return &schema.Resource{
Create: resourceIBMISSSHKeyCreate,
Read: resourceIBMISSSHKeyRead,
Update: resourceIBMISSSHKeyUpdate,
Delete: resourceIBMISSSHKeyDelete,
Exists: resourceIBMISSSHKeyExists,
Importer: &schema.ResourceImporter{},
CustomizeDiff: customdiff.All(
customdiff.Sequence(
func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error {
return flex.ResourceTagsCustomizeDiff(diff)
},
),
customdiff.Sequence(
func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error {
return flex.ResourceValidateAccessTags(diff, v)
}),
),
Schema: map[string]*schema.Schema{
isKeyName: {
Type: schema.TypeString,
Required: true,
ForceNew: false,
ValidateFunc: validate.InvokeValidator("ibm_is_security_group", isKeyName),
Description: "SSH Key name",
},
isKeyPublicKey: {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: suppressPublicKeyDiff,
Description: "SSH Public key data",
},
isKeyType: {
Type: schema.TypeString,
Optional: true,
Computed: true,
ValidateFunc: validation.StringInSlice([]string{"ed25519", "rsa"}, false),
Description: "Key type",
},
isKeyFingerprint: {
Type: schema.TypeString,
Computed: true,
Description: "SSH key Fingerprint info",
},
isKeyLength: {
Type: schema.TypeInt,
Computed: true,
Description: "SSH key Length",
},
isKeyTags: {
Type: schema.TypeSet,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString, ValidateFunc: validate.InvokeValidator("ibm_is_ssh_key", "tags")},
Set: flex.ResourceIBMVPCHash,
Description: "List of tags for SSH key",
},
isKeyResourceGroup: {
Type: schema.TypeString,
ForceNew: true,
Optional: true,
Computed: true,
Description: "Resource group ID",
},
flex.ResourceControllerURL: {
Type: schema.TypeString,
Computed: true,
Description: "The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance",
},
flex.ResourceName: {
Type: schema.TypeString,
Computed: true,
Description: "The name of the resource",
},
flex.ResourceCRN: {
Type: schema.TypeString,
Computed: true,
Description: "The crn of the resource",
},
IsKeyCRN: {
Type: schema.TypeString,
Computed: true,
Description: "The crn of the resource",
},
flex.ResourceGroupName: {
Type: schema.TypeString,
Computed: true,
Description: "The resource group name in which resource is provisioned",
},
isKeyAccessTags: {
Type: schema.TypeSet,
Optional: true,
Computed: true,
Elem: &schema.Schema{Type: schema.TypeString, ValidateFunc: validate.InvokeValidator("ibm_is_ssh_key", "accesstag")},
Set: flex.ResourceIBMVPCHash,
Description: "List of access management tags for SSH key",
},
},
}
}
func ResourceIBMISSHKeyValidator() *validate.ResourceValidator {
validateSchema := make([]validate.ValidateSchema, 0)
validateSchema = append(validateSchema,
validate.ValidateSchema{
Identifier: isKeyName,
ValidateFunctionIdentifier: validate.ValidateRegexpLen,
Type: validate.TypeString,
Required: true,
Regexp: `^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$`,
MinValueLength: 1,
MaxValueLength: 63})
validateSchema = append(validateSchema,
validate.ValidateSchema{
Identifier: "tags",
ValidateFunctionIdentifier: validate.ValidateRegexpLen,
Type: validate.TypeString,
Optional: true,
Regexp: `^[A-Za-z0-9:_ .-]+$`,
MinValueLength: 1,
MaxValueLength: 128})
validateSchema = append(validateSchema,
validate.ValidateSchema{
Identifier: "accesstag",
ValidateFunctionIdentifier: validate.ValidateRegexpLen,
Type: validate.TypeString,
Optional: true,
Regexp: `^([A-Za-z0-9_.-]|[A-Za-z0-9_.-][A-Za-z0-9_ .-]*[A-Za-z0-9_.-]):([A-Za-z0-9_.-]|[A-Za-z0-9_.-][A-Za-z0-9_ .-]*[A-Za-z0-9_.-])$`,
MinValueLength: 1,
MaxValueLength: 128})
ibmISSSHKeyResourceValidator := validate.ResourceValidator{ResourceName: "ibm_is_ssh_key", Schema: validateSchema}
return &ibmISSSHKeyResourceValidator
}
func resourceIBMISSSHKeyCreate(d *schema.ResourceData, meta interface{}) error {
log.Printf("[DEBUG] Key create")
name := d.Get(isKeyName).(string)
publickey := d.Get(isKeyPublicKey).(string)
err := keyCreate(d, meta, name, publickey)
if err != nil {
return err
}
return resourceIBMISSSHKeyRead(d, meta)
}
func keyCreate(d *schema.ResourceData, meta interface{}, name, publickey string) error {
sess, err := vpcClient(meta)
if err != nil {
return err
}
options := &vpcv1.CreateKeyOptions{
PublicKey: &publickey,
Name: &name,
}
if rgrp, ok := d.GetOk(isKeyResourceGroup); ok {
rg := rgrp.(string)
options.ResourceGroup = &vpcv1.ResourceGroupIdentity{
ID: &rg,
}
}
if keytype, ok := d.GetOk(isKeyType); ok {
kt := keytype.(string)
options.Type = &kt
}
key, response, err := sess.CreateKey(options)
if err != nil {
return fmt.Errorf("[DEBUG] Create SSH Key %s\n%s", err, response)
}
d.SetId(*key.ID)
log.Printf("[INFO] Key : %s", *key.ID)
v := os.Getenv("IC_ENV_TAGS")
if _, ok := d.GetOk(isKeyTags); ok || v != "" {
oldList, newList := d.GetChange(isKeyTags)
err = flex.UpdateGlobalTagsUsingCRN(oldList, newList, meta, *key.CRN, "", isKeyUserTagType)
if err != nil {
log.Printf(
"Error on create of vpc SSH Key (%s) tags: %s", d.Id(), err)
}
}
if _, ok := d.GetOk(isKeyAccessTags); ok {
oldList, newList := d.GetChange(isKeyAccessTags)
err = flex.UpdateGlobalTagsUsingCRN(oldList, newList, meta, *key.CRN, "", isKeyAccessTagType)
if err != nil {
log.Printf(
"Error on create of vpc SSH Key (%s) access tags: %s", d.Id(), err)
}
}
return nil
}
func resourceIBMISSSHKeyRead(d *schema.ResourceData, meta interface{}) error {
id := d.Id()
err := keyGet(d, meta, id)
if err != nil {
return err
}
return nil
}
func keyGet(d *schema.ResourceData, meta interface{}, id string) error {
sess, err := vpcClient(meta)
if err != nil {
return err
}
options := &vpcv1.GetKeyOptions{
ID: &id,
}
key, response, err := sess.GetKey(options)
if err != nil {
if response != nil && response.StatusCode == 404 {
d.SetId("")
return nil
}
return fmt.Errorf("[ERROR] Error getting SSH Key (%s): %s\n%s", id, err, response)
}
d.Set(isKeyName, *key.Name)
d.Set(isKeyPublicKey, *key.PublicKey)
d.Set(isKeyType, *key.Type)
d.Set(isKeyFingerprint, *key.Fingerprint)
d.Set(isKeyLength, *key.Length)
tags, err := flex.GetGlobalTagsUsingCRN(meta, *key.CRN, "", isKeyUserTagType)
if err != nil {
log.Printf(
"Error on get of vpc SSH Key (%s) tags: %s", d.Id(), err)
}
d.Set(isKeyTags, tags)
accesstags, err := flex.GetGlobalTagsUsingCRN(meta, *key.CRN, "", isKeyAccessTagType)
if err != nil {
log.Printf(
"Error on get of vpc SSH Key (%s) access tags: %s", d.Id(), err)
}
d.Set(isKeyAccessTags, accesstags)
controller, err := flex.GetBaseController(meta)
if err != nil {
return err
}
d.Set(flex.ResourceControllerURL, controller+"/vpc-ext/compute/sshKeys")
d.Set(flex.ResourceName, *key.Name)
d.Set(flex.ResourceCRN, *key.CRN)
d.Set(IsKeyCRN, *key.CRN)
if key.ResourceGroup != nil {
d.Set(flex.ResourceGroupName, *key.ResourceGroup.Name)
d.Set(isKeyResourceGroup, *key.ResourceGroup.ID)
}
return nil
}
func resourceIBMISSSHKeyUpdate(d *schema.ResourceData, meta interface{}) error {
id := d.Id()
name := ""
hasChanged := false
if d.HasChange(isKeyName) {
name = d.Get(isKeyName).(string)
hasChanged = true
}
err := keyUpdate(d, meta, id, name, hasChanged)
if err != nil {
return err
}
return resourceIBMISSSHKeyRead(d, meta)
}
func keyUpdate(d *schema.ResourceData, meta interface{}, id, name string, hasChanged bool) error {
sess, err := vpcClient(meta)
if err != nil {
return err
}
if d.HasChange(isKeyTags) {
options := &vpcv1.GetKeyOptions{
ID: &id,
}
key, response, err := sess.GetKey(options)
if err != nil {
return fmt.Errorf("[ERROR] Error getting SSH Key : %s\n%s", err, response)
}
oldList, newList := d.GetChange(isKeyTags)
err = flex.UpdateGlobalTagsUsingCRN(oldList, newList, meta, *key.CRN, "", isKeyUserTagType)
if err != nil {
log.Printf(
"Error on update of resource vpc SSH Key (%s) tags: %s", id, err)
}
}
if d.HasChange(isKeyAccessTags) {
options := &vpcv1.GetKeyOptions{
ID: &id,
}
key, response, err := sess.GetKey(options)
if err != nil {
return fmt.Errorf("Error getting SSH Key : %s\n%s", err, response)
}
oldList, newList := d.GetChange(isKeyAccessTags)
err = flex.UpdateGlobalTagsUsingCRN(oldList, newList, meta, *key.CRN, "", isKeyAccessTagType)
if err != nil {
log.Printf(
"Error on update of resource vpc SSH Key (%s) access tags: %s", id, err)
}
}
if hasChanged {
options := &vpcv1.UpdateKeyOptions{
ID: &id,
}
keyPatchModel := &vpcv1.KeyPatch{
Name: &name,
}
keyPatch, err := keyPatchModel.AsPatch()
if err != nil {
return fmt.Errorf("[ERROR] Error calling asPatch for KeyPatch: %s", err)
}
options.KeyPatch = keyPatch
_, response, err := sess.UpdateKey(options)
if err != nil {
return fmt.Errorf("[ERROR] Error updating vpc SSH Key: %s\n%s", err, response)
}
}
return nil
}
func resourceIBMISSSHKeyDelete(d *schema.ResourceData, meta interface{}) error {
id := d.Id()
err := keyDelete(d, meta, id)
if err != nil {
return err
}
return nil
}
func keyDelete(d *schema.ResourceData, meta interface{}, id string) error {
sess, err := vpcClient(meta)
if err != nil {
return err
}
getKeyOptions := &vpcv1.GetKeyOptions{
ID: &id,
}
_, response, err := sess.GetKey(getKeyOptions)
if err != nil {
if response != nil && response.StatusCode == 404 {
return nil
}
return fmt.Errorf("[ERROR] Error getting SSH Key (%s): %s\n%s", id, err, response)
}
options := &vpcv1.DeleteKeyOptions{
ID: &id,
}
response, err = sess.DeleteKey(options)
if err != nil {
return fmt.Errorf("[ERROR] Error deleting SSH Key : %s\n%s", err, response)
}
d.SetId("")
return nil
}
func resourceIBMISSSHKeyExists(d *schema.ResourceData, meta interface{}) (bool, error) {
id := d.Id()
exists, err := keyExists(d, meta, id)
return exists, err
}
func keyExists(d *schema.ResourceData, meta interface{}, id string) (bool, error) {
sess, err := vpcClient(meta)
if err != nil {
return false, err
}
options := &vpcv1.GetKeyOptions{
ID: &id,
}
_, response, err := sess.GetKey(options)
if err != nil {
if response != nil && response.StatusCode == 404 {
return false, nil
}
return false, fmt.Errorf("[ERROR] Error getting SSH Key: %s\n%s", err, response)
}
return true, nil
}
// to suppress any change shown when keys are same
func suppressPublicKeyDiff(k, old, new string, d *schema.ResourceData) bool {
// if there are extra spaces or new lines, suppress that change
if strings.Compare(strings.TrimSpace(old), strings.TrimSpace(new)) != 0 {
// if old is empty
if old != "" {
//create a new piblickey object from the string
usePK, error := parseKey(new)
if error != nil {
return false
}
// returns the key in byte format with an extra added new line at the end
newkey := strings.TrimRight(string(ssh.MarshalAuthorizedKey(usePK)), "\n")
// check if both keys are same, if yes suppress the change
return strings.TrimSpace(strings.TrimPrefix(newkey, old)) == ""
} else {
return strings.TrimSpace(strings.TrimPrefix(new, old)) == ""
}
} else {
return true
}
}
// takes a string and returns public key object
func parseKey(s string) (ssh.PublicKey, error) {
keyBytes := []byte(s)
// Accepts formats of PublicKey:
// - <base64 key>
// - ssh-rsa/ssh-ed25519 <base64 key>
// - ssh-rsa/ssh-ed25519 <base64 key> <comment>
// if PublicKey provides other than just base64 key, then first part must be "ssh-rsa" or "ssh-ed25519"
if subStrs := strings.Split(s, " "); len(subStrs) > 1 && subStrs[0] != "ssh-rsa" && subStrs[0] != "ssh-ed25519" {
return nil, errors.New("not an RSA key OR ED25519 key")
}
pk, _, _, _, e := ssh.ParseAuthorizedKey(keyBytes)
if e == nil {
return pk, nil
}
decodedKey := make([]byte, base64.StdEncoding.DecodedLen(len(keyBytes)))
n, e := base64.StdEncoding.Decode(decodedKey, keyBytes)
if e != nil {
return nil, e
}
decodedKey = decodedKey[:n]
pk, e = ssh.ParsePublicKey(decodedKey)
if e == nil {
return pk, nil
}
return nil, e
}