This repository has been archived by the owner on Jul 21, 2023. It is now read-only.
/
main.go
481 lines (416 loc) · 16.6 KB
/
main.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
package main
import (
"context"
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/x509"
"encoding/base64"
"encoding/json"
"encoding/pem"
"errors"
"flag"
"fmt"
"log"
"os"
"os/user"
"path"
"time"
k8smetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
k8scorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
"k8s.io/client-go/tools/clientcmd"
"github.com/abetterinternet/prio-server/deploy-tool/key"
"github.com/abetterinternet/prio-server/key-rotator/manifest"
"github.com/abetterinternet/prio-server/key-rotator/storage"
)
// This tool consumes the output of `terraform apply`, generating keys and then
// populating specific manifests and Kubernetes secrets with appropriate values.
// We do this in this tool because if we generated secrets via Terraform
// resources, the secret values would appear in the Terraform state file. The
// struct definitions here MUST be kept in sync with the output variable in
// terraform/modules/facilitator/facilitator.tf and the corresponding structs in
// facilitator/src/manifest.rs.
// SpecificManifestWrapper is a struct that wraps a specific manifest with some
// metadata inserted by Terraform
type SpecificManifestWrapper struct {
IngestorName string `json:"ingestor-name"`
KubernetesNamespace string `json:"kubernetes-namespace"`
CertificateFQDN string `json:"certificate-fqdn"`
SpecificManifest manifest.DataShareProcessorSpecificManifest `json:"specific-manifest"`
}
// TerraformOutput represents the JSON output from `terraform apply` or
// `terraform output --json`. This struct must match the output variables
// defined in terraform/main.tf, though it only need describe the output
// variables this program is interested in.
type TerraformOutput struct {
ManifestBucket struct{ Value Bucket } `json:"manifest_bucket"`
SpecificManifests struct {
Value map[string]SpecificManifestWrapper
} `json:"specific_manifests"`
HasTestEnvironment struct{ Value bool } `json:"has_test_environment"`
SingletonIngestor struct{ Value *SingletonIngestor } `json:"singleton_ingestor"`
}
// Bucket specifies the cloud storage bucket where manifests are stored
type Bucket struct {
// URL is the URL of the bucket, with the scheme "gs" for GCS buckets or
// "s3" for S3 buckets; e.g., "gs://bucket-name" or "s3://bucket-name"
URL string `json:"bucket_url"`
// AWSRegion is the region the bucket is in, if it is an S3 bucket
AWSRegion string `json:"aws_region,omitempty"`
// AWSProfile is the AWS CLI config profile that should be used to
// authenticate to AWS, if the bucket is an S3 bucket
AWSProfile string `json:"aws_profile,omitempty"`
}
// GlobalIngestor defines the structure for the global fake ingestor (apple-like
// ingestor) to create a manifest for
type SingletonIngestor struct {
AwsIamEntity string `json:"aws_iam_entity"`
GcpServiceAccountEmail string `json:"gcp_service_account_email"`
GcpServiceAccountID string `json:"gcp_service_account_id"`
TesterKubernetesNamespace string `json:"tester_kubernetes_namespace"`
BatchSigningKeyName string `json:"batch_signing_key_name"`
}
type privateKeyMarshaler func(*ecdsa.PrivateKey) ([]byte, error)
// marshalX962UncompressedPrivateKey encodes a P-256 private key into the format
// expected by libprio-rs encrypt::PrivateKey, which is the X9.62 uncompressed
// public key concatenated with the secret scalar.
func marshalX962UncompressedPrivateKey(ecdsaKey *ecdsa.PrivateKey) ([]byte, error) {
const (
// P256 uses 256-bit = 32 byte points, and 256-bit = 32 byte private key (D) values.
pubkeyLen = 65 // elliptic.Marshal produces results of 1 + 2*sizeof(point) = 65 bytes in length.
privkeyLen = 32
)
var keyBytes [pubkeyLen + privkeyLen]byte
pubkeyBytes := elliptic.Marshal(elliptic.P256(), ecdsaKey.PublicKey.X, ecdsaKey.PublicKey.Y)
if len(pubkeyBytes) != pubkeyLen {
panic(fmt.Sprintf("Unexpected length from elliptic.Marshal: wanted %d, got %d", pubkeyLen, len(pubkeyBytes)))
}
copy(keyBytes[:pubkeyLen], pubkeyBytes)
ecdsaKey.D.FillBytes(keyBytes[pubkeyLen:])
return keyBytes[:], nil
}
// marshalPKCS8PrivateKey encodes a P-256 private key into a PKCS#8 document.
// This function adapts x509.MarshalPKCS8PrivateKey to the privateKeyMarshaler
// type.
func marshalPKCS8PrivateKey(ecdsaKey *ecdsa.PrivateKey) ([]byte, error) {
return x509.MarshalPKCS8PrivateKey(ecdsaKey)
}
// generateAndDeployKeyPair generates a P-256 key pair and stores the base64
// encoded PKCS#8 encoding of that key in a Kubernetes secret with the provided
// keyName, in the provided namespace. Returns the private key so the caller may
// use it to populate specific manifests.
func generateAndDeployKeyPair(
k8sSecretsClient k8scorev1.SecretInterface,
namespace, keyName string,
keyMarshaler privateKeyMarshaler,
) (*ecdsa.PrivateKey, error) {
p256Key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
return nil, fmt.Errorf("failed to generate P-256 key: %w", err)
}
marshaledPrivateKey, err := keyMarshaler(p256Key)
if err != nil {
return nil, fmt.Errorf("failed to marshal key to PKCS#8 document: %w", err)
}
log.Printf("updating Kubernetes secret %s/%s", namespace, keyName)
secret, err := k8sSecretsClient.Get(context.Background(), keyName, k8smetav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("could not locate kubernetes secret %s/%s: %w", namespace, keyName, err)
}
secret.StringData = map[string]string{
"secret_key": base64.StdEncoding.EncodeToString(marshaledPrivateKey),
}
if _, err := k8sSecretsClient.Update(context.Background(), secret, k8smetav1.UpdateOptions{}); err != nil {
return nil, fmt.Errorf("failed to update kubernetes secret %s/%s: %w", namespace, keyName, err)
}
return p256Key, nil
}
func setupTestEnvironment(
ctx context.Context,
k8sSecretsClientGetter k8scorev1.SecretsGetter,
ingestor *SingletonIngestor,
manifestWriter storage.Manifest,
) error {
batchSigningPublicKey, err := createBatchSigningPublicKey(
k8sSecretsClientGetter.Secrets(ingestor.TesterKubernetesNamespace),
ingestor.TesterKubernetesNamespace,
ingestor.BatchSigningKeyName,
)
if err != nil {
return fmt.Errorf("error when creating the batch signing public key for the test environment")
}
globalManifest := manifest.IngestorGlobalManifest{
Format: 1,
ServerIdentity: manifest.ServerIdentity{
AWSIamEntity: ingestor.AwsIamEntity,
GCPServiceAccountID: ingestor.GcpServiceAccountID,
GCPServiceAccountEmail: ingestor.GcpServiceAccountEmail,
},
BatchSigningPublicKeys: manifest.BatchSigningPublicKeys{
ingestor.BatchSigningKeyName: *batchSigningPublicKey,
},
}
return manifestWriter.PutIngestorGlobalManifest(ctx, globalManifest)
}
func createBatchSigningPublicKey(
k8sSecretsClient k8scorev1.SecretInterface,
kubernetesNamespace, name string,
) (*manifest.BatchSigningPublicKey, error) {
privateKey, err := generateAndDeployKeyPair(k8sSecretsClient, kubernetesNamespace, name, marshalPKCS8PrivateKey)
if err != nil {
return nil, fmt.Errorf("error generating and deploying key pair: %v", err)
}
pkixPublic, err := x509.MarshalPKIXPublicKey(privateKey.Public())
if err != nil {
return nil, fmt.Errorf("failed to marshal ECDSA public key to PKIX: %v", err)
}
block := pem.Block{
Type: "PUBLIC KEY",
Bytes: pkixPublic,
}
expiration := time.
Now().
AddDate(0, 0, 90). // key expires in 90 days
UTC().
Format(time.RFC3339)
return &manifest.BatchSigningPublicKey{
PublicKey: string(pem.EncodeToMemory(&block)),
Expiration: expiration,
}, nil
}
func createManifest(
ctx context.Context,
k8sSecretsClientGetter k8scorev1.SecretsGetter,
dataShareProcessorName string,
manifestWrapper *SpecificManifestWrapper,
manifestWriter storage.Manifest,
packetEncryptionKeyCSRs manifest.PacketEncryptionKeyCSRs,
) error {
k8sSecretsClient := k8sSecretsClientGetter.Secrets(manifestWrapper.KubernetesNamespace)
for name, batchSigningPublicKey := range manifestWrapper.SpecificManifest.BatchSigningPublicKeys {
if batchSigningPublicKey.PublicKey != "" {
// We never create keys in Terraform, so this should never happen
return fmt.Errorf("unexpected batch signing key in Terraform output for name %s", name)
}
log.Printf("generating ECDSA P256 batch signing key %s", name)
batchSigningPublicKey, err := createBatchSigningPublicKey(
k8sSecretsClient,
manifestWrapper.KubernetesNamespace,
name,
)
if err != nil {
return fmt.Errorf("error when creating batch signing public key: %v", err)
}
manifestWrapper.SpecificManifest.BatchSigningPublicKeys[name] = *batchSigningPublicKey
}
for name, packetEncryptionCertificateSigningRequest := range manifestWrapper.SpecificManifest.PacketEncryptionKeyCSRs {
if packetEncryptionCertificateSigningRequest.CertificateSigningRequest != "" {
// We never create CSRs in Terraform, so this should never happen
return fmt.Errorf("unexpected packet encryption key CSR in Terraform output for name %s", name)
}
if packetEncryptionKeyCSR, ok := packetEncryptionKeyCSRs[name]; ok {
log.Printf("packet encryption key %s already exists - skipping generation", name)
manifestWrapper.SpecificManifest.PacketEncryptionKeyCSRs[name] = packetEncryptionKeyCSR
continue
}
log.Printf("generating ECDSA P256 packet encryption key %s", name)
keyMarshaler := marshalX962UncompressedPrivateKey
privKey, err := generateAndDeployKeyPair(
k8sSecretsClient,
manifestWrapper.KubernetesNamespace,
name,
keyMarshaler,
)
if err != nil {
return err
}
prioKey := key.NewPrioKey(privKey)
csrTemplate := key.GetPrioCSRTemplate(manifestWrapper.CertificateFQDN)
pemCSR, err := prioKey.CreatePemEncodedCertificateRequest(rand.Reader, csrTemplate)
if err != nil {
return err
}
packetEncryptionCertificate := manifest.PacketEncryptionCertificate{CertificateSigningRequest: pemCSR}
manifestWrapper.SpecificManifest.PacketEncryptionKeyCSRs[name] = packetEncryptionCertificate
packetEncryptionKeyCSRs[name] = packetEncryptionCertificate
}
// Put the specific manifests into the manifest bucket.
if err := manifestWriter.PutDataShareProcessorSpecificManifest(ctx, dataShareProcessorName, manifestWrapper.SpecificManifest); err != nil {
return fmt.Errorf("could not write data share specific manifest: %s", err)
}
return nil
}
func backupKeys(
k8sSecretsClientGetter k8scorev1.SecretsGetter,
gcpProjectName string,
manifestWrapper *SpecificManifestWrapper,
) error {
context := context.Background()
if gcpProjectName == "" {
log.Printf("no GCP project name -- skipping key backup")
return nil
}
// Build the list of batch signing and packet decryption keys that may need
// to be backed up
keyNames := []string{}
for keyName := range manifestWrapper.SpecificManifest.BatchSigningPublicKeys {
keyNames = append(keyNames, keyName)
}
for keyName := range manifestWrapper.SpecificManifest.PacketEncryptionKeyCSRs {
keyNames = append(keyNames, keyName)
}
k8sSecretsClient := k8sSecretsClientGetter.Secrets(manifestWrapper.KubernetesNamespace)
secretsBackup, err := key.NewGCPSecretManagerBackup(gcpProjectName)
if err != nil {
return fmt.Errorf("failed to create secret backup client: %w", err)
}
for _, keyName := range keyNames {
secret, err := k8sSecretsClient.Get(context, keyName, k8smetav1.GetOptions{})
if err != nil {
return fmt.Errorf(
"could not locate kubernetes secret %s/%s: %w",
manifestWrapper.KubernetesNamespace,
keyName,
err,
)
}
if err := secretsBackup.BackupSecret(context, secret); err != nil {
return fmt.Errorf("failed to backup secret %s: %w", secret.ObjectMeta.Name, err)
}
}
return nil
}
func createManifests(
ctx context.Context,
k8sSecretsClientGetter k8scorev1.SecretsGetter,
specificManifests map[string]SpecificManifestWrapper,
manifestStorage storage.Manifest,
) error {
// Iterate over all specific manifests described by TF output so we can
// record any packet encryption key CSRs that have already been created. We
// assume that the presence of a packet encryption key CSR in any specific
// manifest means that a corresponding private key already exists in
// Kubernetes secrets.
existingManifests := map[string]struct{}{}
packetEncryptionKeyCSRs := manifest.PacketEncryptionKeyCSRs{}
for dataShareProcessorName := range specificManifests {
manifest, err := manifestStorage.GetDataShareProcessorSpecificManifest(ctx, dataShareProcessorName)
if errors.Is(err, storage.ErrObjectNotExist) {
continue
}
if err != nil {
return err
}
existingManifests[dataShareProcessorName] = struct{}{}
for keyName, certificateSigningRequest := range manifest.PacketEncryptionKeyCSRs {
if previouslySeenCsr, ok := packetEncryptionKeyCSRs[keyName]; ok {
if previouslySeenCsr != certificateSigningRequest {
return fmt.Errorf("found two different previously existing certificate signing requests for key name %s", previouslySeenCsr)
}
}
packetEncryptionKeyCSRs[keyName] = certificateSigningRequest
}
}
// Iterate over all specific manifests again, this time creating any that
// don't exist, using the previously recorded packet encryption key CSRs to
// ensure we don't update (destroy) existing keys. e.g. if the us-la-g-enpa
// manifest already exists, but the us-la-apple manifest doesn't, then we
// need to create the latter, but want to reuse the existing us-la packet
// encryption key.
for dataShareProcessorName, manifestWrapperRaw := range specificManifests {
// Avoid a common race (which triggers gosec's G601 error).
manifestWrapper := manifestWrapperRaw
if _, ok := existingManifests[dataShareProcessorName]; !ok {
if err := createManifest(
ctx,
k8sSecretsClientGetter,
dataShareProcessorName,
&manifestWrapper,
manifestStorage,
packetEncryptionKeyCSRs,
); err != nil {
return err
}
} else {
log.Printf("manifest for %s already exists - skipping", dataShareProcessorName)
}
}
return nil
}
func kubernetesClient(kubeConfigPath string) (*kubernetes.Clientset, error) {
config, err := clientcmd.BuildConfigFromFlags("", kubeConfigPath)
if err != nil {
return nil, fmt.Errorf("failed to create Kubernetes client config: %w", err)
}
client, err := kubernetes.NewForConfig(config)
if err != nil {
return nil, fmt.Errorf("failed to create Kubernetes client: %w", err)
}
return client, nil
}
var kubeConfigPath = flag.String("kube-config-path", "", "Path to Kubernetes config file to use for Kubernetes API requests. Default: ~/.kube/config")
var keyBackupGCPProject = flag.String("key-backup-gcp-project", "", "GCP project in which to store key backups.")
func main() {
flag.Parse()
ctx := context.Background()
if *kubeConfigPath == "" {
currentUser, err := user.Current()
if err != nil {
log.Fatalf("failed to lookup current user: %s", err)
}
*kubeConfigPath = path.Join(currentUser.HomeDir, ".kube", "config")
}
var terraformOutput TerraformOutput
if err := json.NewDecoder(os.Stdin).Decode(&terraformOutput); err != nil {
log.Fatalf("failed to parse specific manifests: %v", err)
}
k8sClient, err := kubernetesClient(*kubeConfigPath)
if err != nil {
log.Fatalf("%s", err)
}
manifestStorage, err := storage.NewManifest(ctx, terraformOutput.ManifestBucket.Value.URL,
storage.WithAWSRegion(terraformOutput.ManifestBucket.Value.AWSRegion))
if err != nil {
log.Fatalf("%s", err)
}
if terraformOutput.HasTestEnvironment.Value && terraformOutput.SingletonIngestor.Value != nil {
globalManifestStorage, err := storage.NewManifest(ctx, terraformOutput.ManifestBucket.Value.URL,
storage.WithKeyPrefix("singleton-ingestor"),
storage.WithAWSRegion(terraformOutput.ManifestBucket.Value.AWSRegion))
if err != nil {
log.Fatalf("%s", err)
}
_, err = globalManifestStorage.GetIngestorGlobalManifest(ctx)
if err != nil {
if errors.Is(err, storage.ErrObjectNotExist) {
log.Println("global ingestor manifest exists - skipping creation")
} else {
log.Fatalf("%s", err)
}
} else if err := setupTestEnvironment(
ctx,
k8sClient.CoreV1(),
terraformOutput.SingletonIngestor.Value,
globalManifestStorage,
); err != nil {
log.Fatalf("%s", err)
}
}
if err := createManifests(
ctx,
k8sClient.CoreV1(),
terraformOutput.SpecificManifests.Value,
manifestStorage,
); err != nil {
log.Fatalf("%s", err)
}
for _, manifestWrapperRaw := range terraformOutput.SpecificManifests.Value {
// Avoid a common race (which triggers gosec's G601 error).
manifestWrapper := manifestWrapperRaw
if err := backupKeys(k8sClient.CoreV1(), *keyBackupGCPProject, &manifestWrapper); err != nil {
log.Fatalf("%s", err)
}
}
}