-
-
Notifications
You must be signed in to change notification settings - Fork 33
/
server.go
363 lines (336 loc) · 10.8 KB
/
server.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
// Copyright (C) 2022 The Flux authors
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
package keyservice
import (
"fmt"
"github.com/getsops/sops/v3/age"
"github.com/getsops/sops/v3/azkv"
"github.com/getsops/sops/v3/gcpkms"
"github.com/getsops/sops/v3/hcvault"
"github.com/getsops/sops/v3/keyservice"
"github.com/getsops/sops/v3/kms"
"github.com/getsops/sops/v3/pgp"
"golang.org/x/net/context"
)
// Server is a key service server that uses SOPS MasterKeys to fulfill
// requests. It intercepts Encrypt and Decrypt requests made for key types
// that need to run in a contained environment, instead of the default
// implementation which heavily utilizes environment variables or the runtime
// environment. Any request not handled by the Server is forwarded to the
// embedded default server.
type Server struct {
// gnuPGHome is the GnuPG home directory used for the Encrypt and Decrypt
// operations for PGP key types.
// When empty, the requests will be handled using the systems' runtime
// keyring.
gnuPGHome pgp.GnuPGHome
// ageIdentities are the parsed age identities used for Decrypt
// operations for age key types.
ageIdentities age.ParsedIdentities
// vaultToken is the token used for Encrypt and Decrypt operations of
// Hashicorp Vault requests.
// When empty, the request will be handled by defaultServer.
vaultToken hcvault.Token
// azureToken is the credential token used for Encrypt and Decrypt
// operations of Azure Key Vault requests.
// When nil, the request will be handled by defaultServer.
azureToken *azkv.TokenCredential
// awsCredsProvider is the Credentials object used for Encrypt and Decrypt
// operations of AWS KMS requests.
// When nil, the request will be handled by defaultServer.
awsCredsProvider *kms.CredentialsProvider
// gcpCredsJSON is the JSON credentials used for Decrypt and Encrypt
// operations of GCP KMS requests. When nil, a default client with
// environmental runtime settings will be used.
gcpCredsJSON gcpkms.CredentialJSON
// defaultServer is the fallback server, used to handle any request that
// is not eligible to be handled by this Server.
defaultServer keyservice.KeyServiceServer
}
// NewServer constructs a new Server, configuring it with the provided options
// before returning the result.
// When WithDefaultServer() is not provided as an option, the SOPS server
// implementation is configured as default.
func NewServer(options ...ServerOption) keyservice.KeyServiceServer {
s := &Server{}
for _, opt := range options {
opt.ApplyToServer(s)
}
if s.defaultServer == nil {
s.defaultServer = &keyservice.Server{
Prompt: false,
}
}
return s
}
// Encrypt takes an encrypt request and encrypts the provided plaintext with
// the provided key, returning the encrypted result.
func (ks Server) Encrypt(ctx context.Context, req *keyservice.EncryptRequest) (*keyservice.EncryptResponse, error) {
key := req.Key
switch k := key.KeyType.(type) {
case *keyservice.Key_PgpKey:
ciphertext, err := ks.encryptWithPgp(k.PgpKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: ciphertext,
}, nil
case *keyservice.Key_AgeKey:
ciphertext, err := ks.encryptWithAge(k.AgeKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: ciphertext,
}, nil
case *keyservice.Key_VaultKey:
if ks.vaultToken != "" {
ciphertext, err := ks.encryptWithHCVault(k.VaultKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: ciphertext,
}, nil
}
case *keyservice.Key_KmsKey:
cipherText, err := ks.encryptWithAWSKMS(k.KmsKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: cipherText,
}, nil
case *keyservice.Key_AzureKeyvaultKey:
if ks.azureToken != nil {
ciphertext, err := ks.encryptWithAzureKeyVault(k.AzureKeyvaultKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: ciphertext,
}, nil
}
case *keyservice.Key_GcpKmsKey:
ciphertext, err := ks.encryptWithGCPKMS(k.GcpKmsKey, req.Plaintext)
if err != nil {
return nil, err
}
return &keyservice.EncryptResponse{
Ciphertext: ciphertext,
}, nil
case nil:
return nil, fmt.Errorf("must provide a key")
}
// Fallback to default server for any other request.
return ks.defaultServer.Encrypt(ctx, req)
}
// Decrypt takes a decrypt request and decrypts the provided ciphertext with
// the provided key, returning the decrypted result.
func (ks Server) Decrypt(ctx context.Context, req *keyservice.DecryptRequest) (*keyservice.DecryptResponse, error) {
key := req.Key
switch k := key.KeyType.(type) {
case *keyservice.Key_PgpKey:
plaintext, err := ks.decryptWithPgp(k.PgpKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
case *keyservice.Key_AgeKey:
plaintext, err := ks.decryptWithAge(k.AgeKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
case *keyservice.Key_VaultKey:
if ks.vaultToken != "" {
plaintext, err := ks.decryptWithHCVault(k.VaultKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
}
case *keyservice.Key_KmsKey:
plaintext, err := ks.decryptWithAWSKMS(k.KmsKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
case *keyservice.Key_AzureKeyvaultKey:
if ks.azureToken != nil {
plaintext, err := ks.decryptWithAzureKeyVault(k.AzureKeyvaultKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
}
case *keyservice.Key_GcpKmsKey:
plaintext, err := ks.decryptWithGCPKMS(k.GcpKmsKey, req.Ciphertext)
if err != nil {
return nil, err
}
return &keyservice.DecryptResponse{
Plaintext: plaintext,
}, nil
case nil:
return nil, fmt.Errorf("must provide a key")
}
// Fallback to default server for any other request.
return ks.defaultServer.Decrypt(ctx, req)
}
func (ks *Server) encryptWithPgp(key *keyservice.PgpKey, plaintext []byte) ([]byte, error) {
pgpKey := pgp.NewMasterKeyFromFingerprint(key.Fingerprint)
if ks.gnuPGHome != "" {
ks.gnuPGHome.ApplyToMasterKey(pgpKey)
}
err := pgpKey.Encrypt(plaintext)
if err != nil {
return nil, err
}
return []byte(pgpKey.EncryptedKey), nil
}
func (ks *Server) decryptWithPgp(key *keyservice.PgpKey, ciphertext []byte) ([]byte, error) {
pgpKey := pgp.NewMasterKeyFromFingerprint(key.Fingerprint)
if ks.gnuPGHome != "" {
ks.gnuPGHome.ApplyToMasterKey(pgpKey)
}
pgpKey.EncryptedKey = string(ciphertext)
plaintext, err := pgpKey.Decrypt()
return plaintext, err
}
func (ks Server) encryptWithAge(key *keyservice.AgeKey, plaintext []byte) ([]byte, error) {
// Unlike the other encrypt and decrypt methods, validation of configuration
// is not required here. As the encryption happens purely based on the
// Recipient from the key.
ageKey := age.MasterKey{
Recipient: key.Recipient,
}
if err := ageKey.Encrypt(plaintext); err != nil {
return nil, err
}
return []byte(ageKey.EncryptedKey), nil
}
func (ks *Server) decryptWithAge(key *keyservice.AgeKey, ciphertext []byte) ([]byte, error) {
ageKey := age.MasterKey{
Recipient: key.Recipient,
}
ks.ageIdentities.ApplyToMasterKey(&ageKey)
ageKey.EncryptedKey = string(ciphertext)
plaintext, err := ageKey.Decrypt()
return plaintext, err
}
func (ks *Server) encryptWithHCVault(key *keyservice.VaultKey, plaintext []byte) ([]byte, error) {
vaultKey := hcvault.MasterKey{
VaultAddress: key.VaultAddress,
EnginePath: key.EnginePath,
KeyName: key.KeyName,
}
ks.vaultToken.ApplyToMasterKey(&vaultKey)
if err := vaultKey.Encrypt(plaintext); err != nil {
return nil, err
}
return []byte(vaultKey.EncryptedKey), nil
}
func (ks *Server) decryptWithHCVault(key *keyservice.VaultKey, ciphertext []byte) ([]byte, error) {
vaultKey := hcvault.MasterKey{
VaultAddress: key.VaultAddress,
EnginePath: key.EnginePath,
KeyName: key.KeyName,
}
vaultKey.EncryptedKey = string(ciphertext)
ks.vaultToken.ApplyToMasterKey(&vaultKey)
plaintext, err := vaultKey.Decrypt()
return plaintext, err
}
func (ks *Server) encryptWithAWSKMS(key *keyservice.KmsKey, plaintext []byte) ([]byte, error) {
context := make(map[string]*string)
for key, val := range key.Context {
val := val
context[key] = &val
}
awsKey := kms.MasterKey{
Arn: key.Arn,
Role: key.Role,
EncryptionContext: context,
}
if ks.awsCredsProvider != nil {
ks.awsCredsProvider.ApplyToMasterKey(&awsKey)
}
if err := awsKey.Encrypt(plaintext); err != nil {
return nil, err
}
return []byte(awsKey.EncryptedKey), nil
}
func (ks *Server) decryptWithAWSKMS(key *keyservice.KmsKey, cipherText []byte) ([]byte, error) {
context := make(map[string]*string)
for key, val := range key.Context {
val := val
context[key] = &val
}
awsKey := kms.MasterKey{
Arn: key.Arn,
Role: key.Role,
EncryptionContext: context,
}
awsKey.EncryptedKey = string(cipherText)
if ks.awsCredsProvider != nil {
ks.awsCredsProvider.ApplyToMasterKey(&awsKey)
}
return awsKey.Decrypt()
}
func (ks *Server) encryptWithAzureKeyVault(key *keyservice.AzureKeyVaultKey, plaintext []byte) ([]byte, error) {
azureKey := azkv.MasterKey{
VaultURL: key.VaultUrl,
Name: key.Name,
Version: key.Version,
}
ks.azureToken.ApplyToMasterKey(&azureKey)
if err := azureKey.Encrypt(plaintext); err != nil {
return nil, err
}
return []byte(azureKey.EncryptedKey), nil
}
func (ks *Server) decryptWithAzureKeyVault(key *keyservice.AzureKeyVaultKey, ciphertext []byte) ([]byte, error) {
azureKey := azkv.MasterKey{
VaultURL: key.VaultUrl,
Name: key.Name,
Version: key.Version,
}
ks.azureToken.ApplyToMasterKey(&azureKey)
azureKey.EncryptedKey = string(ciphertext)
plaintext, err := azureKey.Decrypt()
return plaintext, err
}
func (ks *Server) encryptWithGCPKMS(key *keyservice.GcpKmsKey, plaintext []byte) ([]byte, error) {
gcpKey := gcpkms.MasterKey{
ResourceID: key.ResourceId,
}
ks.gcpCredsJSON.ApplyToMasterKey(&gcpKey)
if err := gcpKey.Encrypt(plaintext); err != nil {
return nil, err
}
return gcpKey.EncryptedDataKey(), nil
}
func (ks *Server) decryptWithGCPKMS(key *keyservice.GcpKmsKey, ciphertext []byte) ([]byte, error) {
gcpKey := gcpkms.MasterKey{
ResourceID: key.ResourceId,
}
ks.gcpCredsJSON.ApplyToMasterKey(&gcpKey)
gcpKey.EncryptedKey = string(ciphertext)
plaintext, err := gcpKey.Decrypt()
return plaintext, err
}