/
gcpkmsprov.go
450 lines (375 loc) · 12.6 KB
/
gcpkmsprov.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
package gcpkmscrypto
import (
"context"
"crypto"
"crypto/elliptic"
"crypto/x509"
"encoding/pem"
"fmt"
"path"
"strings"
"time"
kms "cloud.google.com/go/kms/apiv1"
kmspb "cloud.google.com/go/kms/apiv1/kmspb"
"github.com/effective-security/x/guid"
"github.com/effective-security/xlog"
"github.com/effective-security/xpki/cryptoprov"
"github.com/effective-security/xpki/metricskey"
"github.com/googleapis/gax-go/v2"
"github.com/pkg/errors"
"google.golang.org/api/iterator"
)
var logger = xlog.NewPackageLogger("github.com/effective-security/xpki/cryptoprov", "gcpkms")
// ProviderName specifies a provider name
const ProviderName = "GCPKMS"
func init() {
_ = cryptoprov.Register(ProviderName, KmsLoader)
}
// KmsClient interface
type KmsClient interface {
ListCryptoKeys(context.Context, *kmspb.ListCryptoKeysRequest, ...gax.CallOption) *kms.CryptoKeyIterator
GetCryptoKey(context.Context, *kmspb.GetCryptoKeyRequest, ...gax.CallOption) (*kmspb.CryptoKey, error)
GetPublicKey(context.Context, *kmspb.GetPublicKeyRequest, ...gax.CallOption) (*kmspb.PublicKey, error)
GetCryptoKeyVersion(context.Context, *kmspb.GetCryptoKeyVersionRequest, ...gax.CallOption) (*kmspb.CryptoKeyVersion, error)
DestroyCryptoKeyVersion(context.Context, *kmspb.DestroyCryptoKeyVersionRequest, ...gax.CallOption) (*kmspb.CryptoKeyVersion, error)
AsymmetricSign(context.Context, *kmspb.AsymmetricSignRequest, ...gax.CallOption) (*kmspb.AsymmetricSignResponse, error)
CreateCryptoKey(context.Context, *kmspb.CreateCryptoKeyRequest, ...gax.CallOption) (*kmspb.CryptoKey, error)
Close() error
}
// KmsClientFactory override for unittest
var KmsClientFactory = func() (KmsClient, error) {
ctx := context.Background()
client, err := kms.NewKeyManagementClient(ctx)
if err != nil {
return nil, errors.WithMessagef(err, "failed to create kms client")
}
return client, nil
}
// Provider implements Provider interface for KMS
type Provider struct {
KmsClient
tc cryptoprov.TokenConfig
endpoint string
keyring string
}
// Init configures Kms based hsm impl
func Init(tc cryptoprov.TokenConfig) (*Provider, error) {
kmsAttributes := parseKmsAttributes(tc.Attributes())
endpoint := kmsAttributes["Endpoint"]
keyring := kmsAttributes["Keyring"]
p := &Provider{
endpoint: endpoint,
keyring: keyring,
tc: tc,
}
var err error
p.KmsClient, err = KmsClientFactory()
if err != nil {
return nil, errors.WithMessagef(err, "failed to create KMS client")
}
return p, nil
}
func parseKmsAttributes(attributes string) map[string]string {
var kmsAttributes = make(map[string]string)
attrs := strings.Split(attributes, ",")
for _, v := range attrs {
kmsAttr := strings.Split(v, "=")
kmsAttributes[strings.TrimSpace(kmsAttr[0])] = strings.TrimSpace(kmsAttr[1])
}
return kmsAttributes
}
// Manufacturer returns manufacturer for the provider
func (p *Provider) Manufacturer() string {
return p.tc.Manufacturer()
}
// Model returns model for the provider
func (p *Provider) Model() string {
return p.tc.Model()
}
// CurrentSlotID returns current slot id. For KMS only one slot is assumed to be available.
func (p *Provider) CurrentSlotID() uint {
return 0
}
// GenerateRSAKey creates signer using randomly generated RSA key
func (p *Provider) GenerateRSAKey(label string, bits int, purpose int) (crypto.PrivateKey, error) {
defer metricskey.PerfCryptoOperation.MeasureSince(time.Now(), ProviderName, "genkey_rsa")
ctx := context.Background()
pbpurpose := kmspb.CryptoKey_ASYMMETRIC_SIGN
if purpose == 2 {
pbpurpose = kmspb.CryptoKey_ASYMMETRIC_DECRYPT
}
var algorithm kmspb.CryptoKeyVersion_CryptoKeyVersionAlgorithm
switch bits {
case 2048:
algorithm = kmspb.CryptoKeyVersion_RSA_SIGN_PKCS1_2048_SHA256
case 3072:
algorithm = kmspb.CryptoKeyVersion_RSA_SIGN_PKCS1_3072_SHA256
case 4096:
algorithm = kmspb.CryptoKeyVersion_RSA_SIGN_PKCS1_4096_SHA512
default:
return nil, errors.Errorf("unsupported key size: %d", bits)
}
label, keyID := KeyLabelAndID(label)
req := &kmspb.CreateCryptoKeyRequest{
Parent: p.keyring,
CryptoKeyId: keyID,
CryptoKey: &kmspb.CryptoKey{
Purpose: pbpurpose,
VersionTemplate: &kmspb.CryptoKeyVersionTemplate{
Algorithm: algorithm,
ProtectionLevel: kmspb.ProtectionLevel_HSM,
},
Labels: map[string]string{
"label": label,
},
},
}
return p.genKey(ctx, req, label)
}
func (p *Provider) genKey(ctx context.Context, req *kmspb.CreateCryptoKeyRequest, label string) (crypto.PrivateKey, error) {
resp, err := p.KmsClient.CreateCryptoKey(ctx, req)
if err != nil {
return nil, errors.WithMessagef(err, "failed to create key")
}
logger.KV(xlog.NOTICE,
"keyID", resp.Name,
"label", label,
)
var pubKeyResp *kmspb.PublicKey
// Retrieve public key from KMS
for i := 0; i < 60; i++ {
pubKeyResp, err = p.KmsClient.GetPublicKey(ctx, &kmspb.GetPublicKeyRequest{Name: resp.Name + "/cryptoKeyVersions/1"})
if err == nil {
break
}
if !strings.Contains(err.Error(), "PENDING_GENERATION") {
return nil, errors.WithMessagef(err, "failed to get public key")
}
time.Sleep(1 * time.Second)
}
pub, err := parseKeyFromPEM([]byte(pubKeyResp.Pem))
if err != nil {
return nil, errors.WithMessagef(err, "failed to parse public key")
}
signer := NewSigner(path.Base(resp.Name), label, pub, p)
return signer, nil
}
func parseKeyFromPEM(bytes []byte) (any, error) {
block, _ := pem.Decode(bytes)
if block == nil || block.Type != "PUBLIC KEY" || len(block.Headers) != 0 {
return nil, errors.Errorf("invalid block type")
}
k, err := x509.ParsePKIXPublicKey(block.Bytes)
if err != nil {
return nil, errors.WithStack(err)
}
return k, nil
}
// GenerateECDSAKey creates signer using randomly generated ECDSA key
func (p *Provider) GenerateECDSAKey(label string, curve elliptic.Curve) (crypto.PrivateKey, error) {
defer metricskey.PerfCryptoOperation.MeasureSince(time.Now(), ProviderName, "genkey_ecdsa")
ctx := context.Background()
pbpurpose := kmspb.CryptoKey_ASYMMETRIC_SIGN
var algorithm kmspb.CryptoKeyVersion_CryptoKeyVersionAlgorithm
switch curve {
case elliptic.P256():
algorithm = kmspb.CryptoKeyVersion_EC_SIGN_P256_SHA256
case elliptic.P384():
algorithm = kmspb.CryptoKeyVersion_EC_SIGN_P384_SHA384
//case elliptic.P521():
// algorithm = CryptoKeyVersion_EC_SIGN_P521_SHA512
default:
return nil, errors.New("unsupported curve")
}
label, keyID := KeyLabelAndID(label)
req := &kmspb.CreateCryptoKeyRequest{
Parent: p.keyring,
CryptoKeyId: keyID,
CryptoKey: &kmspb.CryptoKey{
Purpose: pbpurpose,
VersionTemplate: &kmspb.CryptoKeyVersionTemplate{
Algorithm: algorithm,
ProtectionLevel: kmspb.ProtectionLevel_HSM,
},
Labels: map[string]string{
"label": label,
},
},
}
return p.genKey(ctx, req, label)
}
// IdentifyKey returns key id and label for the given private key
func (p *Provider) IdentifyKey(priv crypto.PrivateKey) (keyID, label string, err error) {
if s, ok := priv.(*Signer); ok {
return s.KeyID(), s.Label(), nil
}
return "", "", errors.New("not supported key")
}
// GetKey returns PrivateKey
func (p *Provider) GetKey(keyID string) (crypto.PrivateKey, error) {
defer metricskey.PerfCryptoOperation.MeasureSince(time.Now(), ProviderName, "getkey")
logger.KV(xlog.INFO, "keyID", keyID)
ctx := context.Background()
name := p.keyName(keyID)
key, err := p.KmsClient.GetCryptoKey(ctx, &kmspb.GetCryptoKeyRequest{Name: name})
if err != nil {
return nil, errors.WithMessagef(err, "failed to get key")
}
pubResponse, err := p.KmsClient.GetPublicKey(ctx, &kmspb.GetPublicKeyRequest{Name: name + "/cryptoKeyVersions/1"})
if err != nil {
return nil, errors.WithMessagef(err, "failed to get public key")
}
pub, err := parseKeyFromPEM([]byte(pubResponse.Pem))
if err != nil {
return nil, errors.WithMessagef(err, "failed to parse public key")
}
signer := NewSigner(keyID, key.Labels["label"], pub, p)
return signer, nil
}
// EnumTokens lists tokens. For KMS currentSlotOnly is ignored and only one slot is assumed to be available.
func (p *Provider) EnumTokens(currentSlotOnly bool) ([]cryptoprov.TokenInfo, error) {
return []cryptoprov.TokenInfo{
{
SlotID: p.CurrentSlotID(),
Manufacturer: p.Manufacturer(),
Model: p.Model(),
},
}, nil
}
// EnumKeys returns list of keys on the slot. For KMS slotID is ignored.
func (p *Provider) EnumKeys(slotID uint, prefix string) ([]cryptoprov.KeyInfo, error) {
logger.KV(xlog.DEBUG, "endpoint", p.endpoint, "slotID", slotID, "prefix", prefix)
iter := p.KmsClient.ListCryptoKeys(
context.Background(),
&kmspb.ListCryptoKeysRequest{
Parent: p.keyring,
},
)
list := make([]cryptoprov.KeyInfo, 0)
for {
key, err := iter.Next()
if err == iterator.Done {
break
}
if err != nil {
return nil, errors.WithStack(err)
}
if key.Primary != nil &&
key.Primary.State != kmspb.CryptoKeyVersion_ENABLED {
logger.KV(xlog.DEBUG, "skip_key", key.Name, "state", key.Primary.State.String())
continue
}
list = append(list, *keyInfo(key))
}
return list, nil
}
func (p *Provider) keyName(keyID string) string {
return p.keyring + "/cryptoKeys/" + keyID
}
func (p *Provider) keyVersionName(keyID string) string {
return p.keyring + "/cryptoKeys/" + keyID + "/cryptoKeyVersions/1"
}
func keyLabelInfo(key *kmspb.CryptoKey) string {
label := "protection=" + key.VersionTemplate.ProtectionLevel.String()
for k, v := range key.Labels {
if label != "" {
label += ","
}
label += k + "=" + v
}
return label
}
// DestroyKeyPairOnSlot destroys key pair on slot. For KMS slotID is ignored and KMS retire API is used to destroy the key.
func (p *Provider) DestroyKeyPairOnSlot(slotID uint, keyID string) error {
logger.KV(xlog.NOTICE, "slot", slotID, "key", keyID)
resp, err := p.KmsClient.DestroyCryptoKeyVersion(context.Background(),
&kmspb.DestroyCryptoKeyVersionRequest{
Name: p.keyVersionName(keyID),
})
if err != nil {
return errors.WithMessagef(err, "failed to schedule key deletion: %s", keyID)
}
logger.KV(xlog.NOTICE, "id", keyID, "deletion_time", resp.DestroyTime.AsTime())
return nil
}
// KeyInfo retrieves info about key with the specified id
func (p *Provider) KeyInfo(slotID uint, keyID string, includePublic bool) (*cryptoprov.KeyInfo, error) {
defer metricskey.PerfCryptoOperation.MeasureSince(time.Now(), ProviderName, "keyinfo")
ctx := context.Background()
name := p.keyName(keyID)
logger.KV(xlog.DEBUG, "key", name)
key, err := p.KmsClient.GetCryptoKey(ctx, &kmspb.GetCryptoKeyRequest{Name: name})
if err != nil {
return nil, errors.WithMessagef(err, "failed to describe key, id=%s", keyID)
}
res := keyInfo(key)
if includePublic {
pub, err := p.KmsClient.GetPublicKey(ctx, &kmspb.GetPublicKeyRequest{Name: name + "/cryptoKeyVersions/1"})
if err != nil {
return nil, errors.WithMessagef(err, "failed to get public key, id=%s", keyID)
}
res.PublicKey = pub.Pem
}
return res, nil
}
func keyInfo(key *kmspb.CryptoKey) *cryptoprov.KeyInfo {
createdAt := key.CreateTime.AsTime()
ki := &cryptoprov.KeyInfo{
ID: path.Base(key.Name),
Label: keyLabelInfo(key),
CurrentVersionID: "1",
CreationTime: &createdAt,
Meta: map[string]string{
"protection": key.VersionTemplate.ProtectionLevel.String(),
"algo": key.VersionTemplate.Algorithm.String(),
"purpose": key.Purpose.String(),
},
}
if key.Primary != nil {
ki.Meta["state"] = key.Primary.State.String()
}
return ki
}
// ExportKey returns PKCS#11 URI for specified key ID.
// It does not return key bytes
func (p *Provider) ExportKey(keyID string) (string, []byte, error) {
uri := fmt.Sprintf("pkcs11:manufacturer=%s;model=%s;id=%s;serial=1;type=private",
p.Manufacturer(),
p.Model(),
keyID,
)
return uri, []byte(uri), nil
}
// FindKeyPairOnSlot retrieves a previously created asymmetric key, using a specified slot.
func (p *Provider) FindKeyPairOnSlot(slotID uint, keyID, label string) (crypto.PrivateKey, error) {
return nil, errors.Errorf("unsupported command for this crypto provider")
}
// Close allocated resources and file reloader
func (p *Provider) Close() error {
if p.KmsClient != nil {
p.KmsClient.Close()
p.KmsClient = nil
}
return nil
}
// KmsLoader provides loader for KMS provider
func KmsLoader(tc cryptoprov.TokenConfig) (cryptoprov.Provider, error) {
p, err := Init(tc)
if err != nil {
return nil, err
}
return p, nil
}
// KeyLabelAndID adds a date suffix to ID of a key
func KeyLabelAndID(val string) (label string, id string) {
g := guid.MustCreate()
label = strings.ToLower(strings.TrimSuffix(val, "*"))
id = label + strings.ToLower(g[:4])
if len(id) > 63 {
id = id[:63]
}
return
}
// Ensure compiles
var _ cryptoprov.Provider = (*Provider)(nil)
var _ cryptoprov.KeyManager = (*Provider)(nil)