secretsmanager.go 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package secretmanager
  13. import (
  14. "context"
  15. "fmt"
  16. "log"
  17. secretmanager "cloud.google.com/go/secretmanager/apiv1"
  18. "github.com/googleapis/gax-go"
  19. "golang.org/x/oauth2/google"
  20. "google.golang.org/api/option"
  21. secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1"
  22. corev1 "k8s.io/api/core/v1"
  23. "k8s.io/apimachinery/pkg/types"
  24. "sigs.k8s.io/controller-runtime/pkg/client"
  25. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  26. "github.com/external-secrets/external-secrets/pkg/provider"
  27. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  28. )
  29. const (
  30. cloudPlatformRole = "https://www.googleapis.com/auth/cloud-platform"
  31. defaultVersion = "latest"
  32. )
  33. type GoogleSecretManagerClient interface {
  34. AccessSecretVersion(ctx context.Context, req *secretmanagerpb.AccessSecretVersionRequest, opts ...gax.CallOption) (*secretmanagerpb.AccessSecretVersionResponse, error)
  35. Close() error
  36. }
  37. // ProviderGCP is a provider for GCP Secret Manager.
  38. type ProviderGCP struct {
  39. projectID string
  40. SecretManagerClient GoogleSecretManagerClient
  41. }
  42. // NewClient constructs a GCP Provider.
  43. func (sm *ProviderGCP) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube client.Client, namespace string) (provider.SecretsClient, error) {
  44. // Fetch credential Secret
  45. credentialsSecret := &corev1.Secret{}
  46. credentialsSecretName := store.GetSpec().Provider.GCPSM.Auth.SecretRef.SecretAccessKey.Name
  47. objectKey := types.NamespacedName{Name: credentialsSecretName, Namespace: store.GetNamespace()}
  48. err := kube.Get(ctx, objectKey, credentialsSecret)
  49. if err != nil {
  50. log.Panicf(err.Error(), "Failed to get credentials Secret")
  51. return nil, err
  52. }
  53. credentials := credentialsSecret.Data[store.GetSpec().Provider.GCPSM.Auth.SecretRef.SecretAccessKey.Key]
  54. if len(credentials) == 0 {
  55. return nil, fmt.Errorf("credentials GCP invalid/not provided")
  56. }
  57. projectID := store.GetSpec().Provider.GCPSM.ProjectID
  58. sm.projectID = projectID
  59. config, err := google.JWTConfigFromJSON(credentials, cloudPlatformRole)
  60. if err != nil {
  61. log.Panicf(err.Error(), "Failed to process the provided JSON credentials")
  62. return nil, err
  63. }
  64. ts := config.TokenSource(ctx)
  65. client, err := secretmanager.NewClient(ctx, option.WithTokenSource(ts))
  66. if err != nil {
  67. return nil, fmt.Errorf("failed to create GCP secretmanager client: %w", err)
  68. }
  69. sm.SecretManagerClient = client
  70. return sm, nil
  71. }
  72. // GetSecret returns a single secret from the provider.
  73. func (sm *ProviderGCP) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  74. if sm.SecretManagerClient == nil || sm.projectID == "" {
  75. return nil, fmt.Errorf("provider GCP is not initialized")
  76. }
  77. version := ref.Version
  78. if version == "" {
  79. version = defaultVersion
  80. }
  81. resourceName := fmt.Sprintf("projects/%s/secrets/%s/versions/%s", sm.projectID, ref.Key, version)
  82. req := &secretmanagerpb.AccessSecretVersionRequest{
  83. Name: resourceName,
  84. }
  85. result, err := sm.SecretManagerClient.AccessSecretVersion(ctx, req)
  86. if err != nil {
  87. return nil, err
  88. }
  89. err = sm.SecretManagerClient.Close()
  90. if err != nil {
  91. return nil, err
  92. }
  93. return []byte(string(result.Payload.Data)), nil
  94. }
  95. // GetSecretMap returns multiple k/v pairs from the provider.
  96. func (sm *ProviderGCP) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  97. if sm.SecretManagerClient == nil || sm.projectID == "" {
  98. return nil, fmt.Errorf("provider GCP is not initialized")
  99. }
  100. return map[string][]byte{
  101. "noop": []byte("NOOP"),
  102. }, nil
  103. }
  104. func init() {
  105. schema.Register(&ProviderGCP{}, &esv1alpha1.SecretStoreProvider{
  106. GCPSM: &esv1alpha1.GCPSMProvider{},
  107. })
  108. }