client.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package secretmanager
  14. import (
  15. "context"
  16. "encoding/json"
  17. "errors"
  18. "fmt"
  19. "maps"
  20. "slices"
  21. "strconv"
  22. "strings"
  23. "time"
  24. secretmanager "cloud.google.com/go/secretmanager/apiv1"
  25. "cloud.google.com/go/secretmanager/apiv1/secretmanagerpb"
  26. "github.com/googleapis/gax-go/v2"
  27. "github.com/googleapis/gax-go/v2/apierror"
  28. "github.com/tidwall/gjson"
  29. "google.golang.org/api/iterator"
  30. "google.golang.org/genproto/protobuf/field_mask"
  31. "google.golang.org/grpc/codes"
  32. "google.golang.org/grpc/status"
  33. corev1 "k8s.io/api/core/v1"
  34. ctrl "sigs.k8s.io/controller-runtime"
  35. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  36. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  37. "github.com/external-secrets/external-secrets/runtime/constants"
  38. "github.com/external-secrets/external-secrets/runtime/esutils"
  39. "github.com/external-secrets/external-secrets/runtime/esutils/metadata"
  40. "github.com/external-secrets/external-secrets/runtime/find"
  41. "github.com/external-secrets/external-secrets/runtime/metrics"
  42. "github.com/external-secrets/external-secrets/runtime/util/locks"
  43. )
  44. const (
  45. // CloudPlatformRole is the OAuth2 scope required for GCP Cloud Platform access.
  46. CloudPlatformRole = "https://www.googleapis.com/auth/cloud-platform"
  47. defaultVersion = "latest"
  48. errGCPSMStore = "received invalid GCPSM SecretStore resource"
  49. errUnableGetCredentials = "unable to get credentials: %w"
  50. errClientClose = "unable to close SecretManager client: %w"
  51. errUnableProcessJSONCredentials = "failed to process the provided JSON credentials: %w"
  52. errUnableCreateGCPSMClient = "failed to create GCP secretmanager client: %w"
  53. errUninitalizedGCPProvider = "provider GCP is not initialized"
  54. errClientGetSecretAccess = "unable to access Secret from SecretManager Client: %w"
  55. errJSONSecretUnmarshal = "unable to unmarshal secret from JSON: %w"
  56. errInvalidStore = "invalid store"
  57. errInvalidStoreSpec = "invalid store spec"
  58. errInvalidStoreProv = "invalid store provider"
  59. errInvalidGCPProv = "invalid gcp secrets manager provider"
  60. errInvalidAuthSecretRef = "invalid auth secret data: %w"
  61. errInvalidWISARef = "invalid workload identity service account reference: %w"
  62. errUnexpectedFindOperator = "unexpected find operator"
  63. managedByKey = "managed-by"
  64. managedByValue = "external-secrets"
  65. providerName = "GCPSecretManager"
  66. topicsKey = "topics"
  67. globalSecretPath = "projects/%s/secrets/%s"
  68. globalSecretParentPath = "projects/%s"
  69. regionalSecretParentPath = "projects/%s/locations/%s"
  70. regionalSecretPath = "projects/%s/locations/%s/secrets/%s"
  71. globalSecretVersionsPath = "projects/%s/secrets/%s/versions/%s"
  72. regionalSecretVersionsPath = "projects/%s/locations/%s/secrets/%s/versions/%s"
  73. )
  74. // Client represents a Google Cloud Platform Secret Manager client.
  75. type Client struct {
  76. smClient GoogleSecretManagerClient
  77. kube kclient.Client
  78. store *esv1.GCPSMProvider
  79. storeKind string
  80. // namespace of the external secret
  81. namespace string
  82. workloadIdentity *workloadIdentity
  83. }
  84. // GoogleSecretManagerClient defines the interface for interacting with Google Secret Manager.
  85. type GoogleSecretManagerClient interface {
  86. DeleteSecret(ctx context.Context, req *secretmanagerpb.DeleteSecretRequest, opts ...gax.CallOption) error
  87. AccessSecretVersion(ctx context.Context, req *secretmanagerpb.AccessSecretVersionRequest, opts ...gax.CallOption) (*secretmanagerpb.AccessSecretVersionResponse, error)
  88. ListSecrets(ctx context.Context, req *secretmanagerpb.ListSecretsRequest, opts ...gax.CallOption) *secretmanager.SecretIterator
  89. AddSecretVersion(ctx context.Context, req *secretmanagerpb.AddSecretVersionRequest, opts ...gax.CallOption) (*secretmanagerpb.SecretVersion, error)
  90. CreateSecret(ctx context.Context, req *secretmanagerpb.CreateSecretRequest, opts ...gax.CallOption) (*secretmanagerpb.Secret, error)
  91. Close() error
  92. GetSecret(ctx context.Context, req *secretmanagerpb.GetSecretRequest, opts ...gax.CallOption) (*secretmanagerpb.Secret, error)
  93. UpdateSecret(context.Context, *secretmanagerpb.UpdateSecretRequest, ...gax.CallOption) (*secretmanagerpb.Secret, error)
  94. ListSecretVersions(ctx context.Context, req *secretmanagerpb.ListSecretVersionsRequest, opts ...gax.CallOption) *secretmanager.SecretVersionIterator
  95. }
  96. var log = ctrl.Log.WithName("provider").WithName("gcp").WithName("secretsmanager")
  97. // DeleteSecret deletes a secret from Google Cloud Secret Manager.
  98. func (c *Client) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
  99. name := getName(c.store.ProjectID, c.store.Location, remoteRef.GetRemoteKey())
  100. gcpSecret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  101. Name: name,
  102. })
  103. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMGetSecret, err)
  104. if err != nil {
  105. if status.Code(err) == codes.NotFound {
  106. return nil
  107. }
  108. return err
  109. }
  110. if manager, ok := gcpSecret.Labels[managedByKey]; !ok || manager != managedByValue {
  111. return nil
  112. }
  113. deleteSecretVersionReq := &secretmanagerpb.DeleteSecretRequest{
  114. Name: name,
  115. Etag: gcpSecret.Etag,
  116. }
  117. err = c.smClient.DeleteSecret(ctx, deleteSecretVersionReq)
  118. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMDeleteSecret, err)
  119. return err
  120. }
  121. func parseError(err error) error {
  122. var gerr *apierror.APIError
  123. if errors.As(err, &gerr) && gerr.GRPCStatus().Code() == codes.NotFound {
  124. return esv1.NoSecretError{}
  125. }
  126. return err
  127. }
  128. // SecretExists checks if a secret exists in Google Cloud Secret Manager.
  129. // It verifies the existence of a secret in Google Cloud Secret Manager AND that it has at least one version.
  130. func (c *Client) SecretExists(ctx context.Context, ref esv1.PushSecretRemoteRef) (bool, error) {
  131. secretName := fmt.Sprintf(globalSecretPath, c.store.ProjectID, ref.GetRemoteKey())
  132. gcpSecret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  133. Name: secretName,
  134. })
  135. if err != nil {
  136. if status.Code(err) == codes.NotFound {
  137. return false, nil
  138. }
  139. return false, err
  140. }
  141. if gcpSecret == nil {
  142. return false, nil
  143. }
  144. // Check if the secret has at least one version
  145. versionName := fmt.Sprintf("%s/versions/latest", secretName)
  146. _, err = c.smClient.AccessSecretVersion(ctx, &secretmanagerpb.AccessSecretVersionRequest{
  147. Name: versionName,
  148. })
  149. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  150. if err != nil {
  151. if status.Code(err) == codes.NotFound {
  152. // Secret exists but has no versions
  153. return false, nil
  154. }
  155. return false, err
  156. }
  157. return true, nil
  158. }
  159. // PushSecret pushes a kubernetes secret key into gcp provider Secret.
  160. func (c *Client) PushSecret(ctx context.Context, secret *corev1.Secret, pushSecretData esv1.PushSecretData) error {
  161. var (
  162. payload []byte
  163. err error
  164. )
  165. if pushSecretData.GetSecretKey() == "" {
  166. // Must convert secret values to string, otherwise data will be sent as base64 to Vault
  167. secretStringVal := make(map[string]string)
  168. for k, v := range secret.Data {
  169. secretStringVal[k] = string(v)
  170. }
  171. payload, err = esutils.JSONMarshal(secretStringVal)
  172. if err != nil {
  173. return fmt.Errorf("failed to serialize secret content as JSON: %w", err)
  174. }
  175. } else {
  176. payload = secret.Data[pushSecretData.GetSecretKey()]
  177. }
  178. secretName := getName(c.store.ProjectID, c.store.Location, pushSecretData.GetRemoteKey())
  179. gcpSecret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  180. Name: secretName,
  181. })
  182. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMGetSecret, err)
  183. if err != nil {
  184. if status.Code(err) != codes.NotFound {
  185. return err
  186. }
  187. var replication = &secretmanagerpb.Replication{
  188. Replication: &secretmanagerpb.Replication_Automatic_{
  189. Automatic: &secretmanagerpb.Replication_Automatic{},
  190. },
  191. }
  192. if pushSecretData.GetMetadata() != nil {
  193. replica := &secretmanagerpb.Replication_UserManaged_Replica{}
  194. var err error
  195. meta, err := metadata.ParseMetadataParameters[PushSecretMetadataSpec](pushSecretData.GetMetadata())
  196. if err != nil {
  197. return fmt.Errorf("failed to parse PushSecret metadata: %w", err)
  198. }
  199. if meta != nil && meta.Spec.ReplicationLocation != "" {
  200. replica.Location = meta.Spec.ReplicationLocation
  201. }
  202. if meta != nil && meta.Spec.CMEKKeyName != "" {
  203. replica.CustomerManagedEncryption = &secretmanagerpb.CustomerManagedEncryption{
  204. KmsKeyName: meta.Spec.CMEKKeyName,
  205. }
  206. }
  207. replication = &secretmanagerpb.Replication{
  208. Replication: &secretmanagerpb.Replication_UserManaged_{
  209. UserManaged: &secretmanagerpb.Replication_UserManaged{
  210. Replicas: []*secretmanagerpb.Replication_UserManaged_Replica{
  211. replica,
  212. },
  213. },
  214. },
  215. }
  216. }
  217. parent := getParentName(c.store.ProjectID, c.store.Location)
  218. scrt := &secretmanagerpb.Secret{
  219. Labels: map[string]string{
  220. managedByKey: managedByValue,
  221. },
  222. }
  223. // fix: cannot set Replication at all when using regional Secrets.
  224. if c.store.Location == "" {
  225. scrt.Replication = replication
  226. }
  227. topics, err := esutils.FetchValueFromMetadata(topicsKey, pushSecretData.GetMetadata(), []any{})
  228. if err != nil {
  229. return fmt.Errorf("failed to fetch topics from metadata: %w", err)
  230. }
  231. for _, t := range topics {
  232. name, ok := t.(string)
  233. if !ok {
  234. return fmt.Errorf("invalid topic type")
  235. }
  236. scrt.Topics = append(scrt.Topics, &secretmanagerpb.Topic{
  237. Name: name,
  238. })
  239. }
  240. gcpSecret, err = c.smClient.CreateSecret(ctx, &secretmanagerpb.CreateSecretRequest{
  241. Parent: parent,
  242. SecretId: pushSecretData.GetRemoteKey(),
  243. Secret: scrt,
  244. })
  245. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMCreateSecret, err)
  246. if err != nil {
  247. return err
  248. }
  249. }
  250. builder, err := newPushSecretBuilder(payload, pushSecretData)
  251. if err != nil {
  252. return err
  253. }
  254. annotations, labels, topics, err := builder.buildMetadata(gcpSecret.Annotations, gcpSecret.Labels, gcpSecret.Topics)
  255. if err != nil {
  256. return err
  257. }
  258. // Comparing with a pointer based slice doesn't work so we are converting
  259. // it to a string slice.
  260. existingTopics := make([]string, 0, len(gcpSecret.Topics))
  261. for _, t := range gcpSecret.Topics {
  262. existingTopics = append(existingTopics, t.Name)
  263. }
  264. if !maps.Equal(gcpSecret.Annotations, annotations) || !maps.Equal(gcpSecret.Labels, labels) || !slices.Equal(existingTopics, topics) {
  265. scrt := &secretmanagerpb.Secret{
  266. Name: gcpSecret.Name,
  267. Etag: gcpSecret.Etag,
  268. Labels: labels,
  269. Annotations: annotations,
  270. Topics: gcpSecret.Topics,
  271. }
  272. if c.store.Location != "" {
  273. scrt.Replication = &secretmanagerpb.Replication{
  274. Replication: &secretmanagerpb.Replication_UserManaged_{
  275. UserManaged: &secretmanagerpb.Replication_UserManaged{
  276. Replicas: []*secretmanagerpb.Replication_UserManaged_Replica{
  277. {
  278. Location: c.store.Location,
  279. },
  280. },
  281. },
  282. },
  283. }
  284. }
  285. _, err = c.smClient.UpdateSecret(ctx, &secretmanagerpb.UpdateSecretRequest{
  286. Secret: scrt,
  287. UpdateMask: &field_mask.FieldMask{
  288. Paths: []string{"labels", "annotations"},
  289. },
  290. })
  291. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMUpdateSecret, err)
  292. if err != nil {
  293. return err
  294. }
  295. }
  296. unlock, err := locks.TryLock(providerName, secretName)
  297. if err != nil {
  298. return err
  299. }
  300. defer unlock()
  301. gcpVersion, err := c.smClient.AccessSecretVersion(ctx, &secretmanagerpb.AccessSecretVersionRequest{
  302. Name: fmt.Sprintf("%s/versions/latest", secretName),
  303. })
  304. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  305. if err != nil && status.Code(err) != codes.NotFound {
  306. return err
  307. }
  308. if gcpVersion != nil && gcpVersion.Payload != nil && !builder.needUpdate(gcpVersion.Payload.Data) {
  309. return nil
  310. }
  311. var original []byte
  312. if gcpVersion != nil && gcpVersion.Payload != nil {
  313. original = gcpVersion.Payload.Data
  314. }
  315. data, err := builder.buildData(original)
  316. if err != nil {
  317. return err
  318. }
  319. parent := getName(c.store.ProjectID, c.store.Location, pushSecretData.GetRemoteKey())
  320. addSecretVersionReq := &secretmanagerpb.AddSecretVersionRequest{
  321. Parent: parent,
  322. Payload: &secretmanagerpb.SecretPayload{
  323. Data: data,
  324. },
  325. }
  326. _, err = c.smClient.AddSecretVersion(ctx, addSecretVersionReq)
  327. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAddSecretVersion, err)
  328. return err
  329. }
  330. // GetAllSecrets syncs multiple secrets from gcp provider into a single Kubernetes Secret.
  331. func (c *Client) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  332. if ref.Name != nil {
  333. return c.findByName(ctx, ref)
  334. }
  335. if len(ref.Tags) > 0 {
  336. return c.findByTags(ctx, ref)
  337. }
  338. return nil, errors.New(errUnexpectedFindOperator)
  339. }
  340. func (c *Client) findByName(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  341. // regex matcher
  342. matcher, err := find.New(*ref.Name)
  343. if err != nil {
  344. return nil, err
  345. }
  346. parent := getParentName(c.store.ProjectID, c.store.Location)
  347. req := &secretmanagerpb.ListSecretsRequest{
  348. Parent: parent,
  349. }
  350. if ref.Path != nil {
  351. req.Filter = fmt.Sprintf("name:%s", *ref.Path)
  352. }
  353. // Call the API.
  354. it := c.smClient.ListSecrets(ctx, req)
  355. secretMap := make(map[string][]byte)
  356. var resp *secretmanagerpb.Secret
  357. defer metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMListSecrets, err)
  358. for {
  359. resp, err = it.Next()
  360. if errors.Is(err, iterator.Done) {
  361. break
  362. }
  363. if err != nil {
  364. return nil, fmt.Errorf("failed to list secrets: %w", err)
  365. }
  366. log.V(1).Info("gcp sm findByName found", "secrets", strconv.Itoa(it.PageInfo().Remaining()))
  367. key := c.trimName(resp.Name)
  368. // If we don't match we skip.
  369. // Also, if we have path, and it is not at the beguining we skip.
  370. // We have to check if path is at the beguining of the key because
  371. // there is no way to create a `name:%s*` (starts with) filter
  372. // At https://cloud.google.com/secret-manager/docs/filtering you can use `*`
  373. // but not like that it seems.
  374. if !matcher.MatchName(key) || (ref.Path != nil && !strings.HasPrefix(key, *ref.Path)) {
  375. continue
  376. }
  377. log.V(1).Info("gcp sm findByName matches", "name", resp.Name)
  378. secretMap[key], err = c.getData(ctx, key)
  379. if err != nil {
  380. return nil, err
  381. }
  382. }
  383. return esutils.ConvertKeys(ref.ConversionStrategy, secretMap)
  384. }
  385. func (c *Client) getData(ctx context.Context, key string) ([]byte, error) {
  386. dataRef := esv1.ExternalSecretDataRemoteRef{
  387. Key: key,
  388. }
  389. data, err := c.GetSecret(ctx, dataRef)
  390. if err != nil {
  391. return []byte(""), err
  392. }
  393. return data, nil
  394. }
  395. func (c *Client) findByTags(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  396. var tagFilter string
  397. for k, v := range ref.Tags {
  398. tagFilter = fmt.Sprintf("%slabels.%s=%s ", tagFilter, k, v)
  399. }
  400. tagFilter = strings.TrimSuffix(tagFilter, " ")
  401. if ref.Path != nil {
  402. tagFilter = fmt.Sprintf("%s name:%s", tagFilter, *ref.Path)
  403. }
  404. req := &secretmanagerpb.ListSecretsRequest{
  405. Parent: fmt.Sprintf("projects/%s", c.store.ProjectID),
  406. }
  407. log.V(1).Info("gcp sm findByTags", "tagFilter", tagFilter)
  408. req.Filter = tagFilter
  409. // Call the API.
  410. it := c.smClient.ListSecrets(ctx, req)
  411. var resp *secretmanagerpb.Secret
  412. var err error
  413. defer metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMListSecrets, err)
  414. secretMap := make(map[string][]byte)
  415. for {
  416. resp, err = it.Next()
  417. if errors.Is(err, iterator.Done) {
  418. break
  419. }
  420. if err != nil {
  421. return nil, fmt.Errorf("failed to list secrets: %w", err)
  422. }
  423. key := c.trimName(resp.Name)
  424. if ref.Path != nil && !strings.HasPrefix(key, *ref.Path) {
  425. continue
  426. }
  427. log.V(1).Info("gcp sm findByTags matches tags", "name", resp.Name)
  428. secretMap[key], err = c.getData(ctx, key)
  429. if err != nil {
  430. return nil, err
  431. }
  432. }
  433. return esutils.ConvertKeys(ref.ConversionStrategy, secretMap)
  434. }
  435. func (c *Client) trimName(name string) string {
  436. projectIDNumuber := c.extractProjectIDNumber(name)
  437. prefix := getParentName(projectIDNumuber, c.store.Location)
  438. key := strings.TrimPrefix(name, fmt.Sprintf("%s/secrets/", prefix))
  439. return key
  440. }
  441. // extractProjectIDNumber grabs the project id from the full name returned by gcp api
  442. // gcp api seems to always return the number and not the project name
  443. // (and users would always use the name, while requests accept both).
  444. func (c *Client) extractProjectIDNumber(secretFullName string) string {
  445. s := strings.Split(secretFullName, "/")
  446. ProjectIDNumuber := s[1]
  447. return ProjectIDNumuber
  448. }
  449. // GetSecret returns a single secret from the provider.
  450. func (c *Client) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  451. if esutils.IsNil(c.smClient) || c.store.ProjectID == "" {
  452. return nil, errors.New(errUninitalizedGCPProvider)
  453. }
  454. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  455. return c.getSecretMetadata(ctx, ref)
  456. }
  457. version := ref.Version
  458. if version == "" {
  459. version = defaultVersion
  460. }
  461. name := fmt.Sprintf(globalSecretVersionsPath, c.store.ProjectID, ref.Key, version)
  462. if c.store.Location != "" {
  463. name = fmt.Sprintf(regionalSecretVersionsPath, c.store.ProjectID, c.store.Location, ref.Key, version)
  464. }
  465. req := &secretmanagerpb.AccessSecretVersionRequest{
  466. Name: name,
  467. }
  468. result, err := c.smClient.AccessSecretVersion(ctx, req)
  469. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  470. if err != nil && c.store.SecretVersionSelectionPolicy == esv1.SecretVersionSelectionPolicyLatestOrFetch &&
  471. ref.Version == "" && isErrSecretDestroyedOrDisabled(err) {
  472. // if the secret is destroyed or disabled, and we are configured to get the latest enabled secret,
  473. // we need to get the latest enabled secret
  474. // Extract the secret name from the version name for ListSecretVersions
  475. secretName := fmt.Sprintf(globalSecretPath, c.store.ProjectID, ref.Key)
  476. if c.store.Location != "" {
  477. secretName = fmt.Sprintf(regionalSecretPath, c.store.ProjectID, c.store.Location, ref.Key)
  478. }
  479. result, err = getLatestEnabledVersion(ctx, c.smClient, secretName)
  480. }
  481. if err != nil {
  482. err = parseError(err)
  483. return nil, fmt.Errorf(errClientGetSecretAccess, err)
  484. }
  485. if ref.Property == "" {
  486. if result.Payload.Data != nil {
  487. return result.Payload.Data, nil
  488. }
  489. return nil, fmt.Errorf("invalid secret received. no secret string for key: %s", ref.Key)
  490. }
  491. val, err := getDataByProperty(result.Payload.Data, ref.Property)
  492. if err != nil {
  493. return nil, err
  494. }
  495. if !val.Exists() {
  496. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  497. }
  498. return []byte(val.String()), nil
  499. }
  500. func (c *Client) getSecretMetadata(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  501. name := getName(c.store.ProjectID, c.store.Location, ref.Key)
  502. secret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  503. Name: name,
  504. })
  505. err = parseError(err)
  506. if err != nil {
  507. return nil, fmt.Errorf(errClientGetSecretAccess, err)
  508. }
  509. const (
  510. annotations = "annotations"
  511. labels = "labels"
  512. )
  513. if annotation := c.extractMetadataKey(ref.Property, annotations); annotation != "" {
  514. v, ok := secret.GetAnnotations()[annotation]
  515. if !ok {
  516. return nil, fmt.Errorf("annotation with key %s does not exist in secret %s", annotation, ref.Key)
  517. }
  518. return []byte(v), nil
  519. }
  520. if label := c.extractMetadataKey(ref.Property, labels); label != "" {
  521. v, ok := secret.GetLabels()[label]
  522. if !ok {
  523. return nil, fmt.Errorf("label with key %s does not exist in secret %s", label, ref.Key)
  524. }
  525. return []byte(v), nil
  526. }
  527. if ref.Property == annotations {
  528. j, err := json.Marshal(secret.GetAnnotations())
  529. if err != nil {
  530. return nil, fmt.Errorf("faild marshaling annotations into json: %w", err)
  531. }
  532. return j, nil
  533. }
  534. if ref.Property == labels {
  535. j, err := json.Marshal(secret.GetLabels())
  536. if err != nil {
  537. return nil, fmt.Errorf("faild marshaling labels into json: %w", err)
  538. }
  539. return j, nil
  540. }
  541. if ref.Property != "" {
  542. return nil, fmt.Errorf("invalid property %s: metadata property should start with either %s or %s", ref.Property, annotations, labels)
  543. }
  544. j, err := json.Marshal(map[string]map[string]string{
  545. "annotations": secret.GetAnnotations(),
  546. "labels": secret.GetLabels(),
  547. })
  548. if err != nil {
  549. return nil, fmt.Errorf("faild marshaling metadata map into json: %w", err)
  550. }
  551. return j, nil
  552. }
  553. func (c *Client) extractMetadataKey(s, p string) string {
  554. prefix := p + "."
  555. if !strings.HasPrefix(s, prefix) {
  556. return ""
  557. }
  558. return strings.TrimPrefix(s, prefix)
  559. }
  560. // GetSecretMap returns multiple k/v pairs from the provider.
  561. func (c *Client) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  562. if c.smClient == nil || c.store.ProjectID == "" {
  563. return nil, errors.New(errUninitalizedGCPProvider)
  564. }
  565. data, err := c.GetSecret(ctx, ref)
  566. if err != nil {
  567. return nil, err
  568. }
  569. kv := make(map[string]json.RawMessage)
  570. err = json.Unmarshal(data, &kv)
  571. if err != nil {
  572. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  573. }
  574. secretData := make(map[string][]byte)
  575. for k, v := range kv {
  576. var strVal string
  577. err = json.Unmarshal(v, &strVal)
  578. if err == nil {
  579. secretData[k] = []byte(strVal)
  580. } else {
  581. secretData[k] = v
  582. }
  583. }
  584. return secretData, nil
  585. }
  586. // Close closes the Google Cloud Secret Manager client connection.
  587. func (c *Client) Close(_ context.Context) error {
  588. var err error
  589. if c.smClient != nil {
  590. err = c.smClient.Close()
  591. }
  592. if c.workloadIdentity != nil {
  593. err = c.workloadIdentity.Close()
  594. }
  595. useMu.Unlock()
  596. if err != nil {
  597. return fmt.Errorf(errClientClose, err)
  598. }
  599. return nil
  600. }
  601. // Validate performs validation of the Google Cloud Secret Manager client configuration.
  602. func (c *Client) Validate() (esv1.ValidationResult, error) {
  603. if c.storeKind == esv1.ClusterSecretStoreKind && isReferentSpec(c.store) {
  604. return esv1.ValidationResultUnknown, nil
  605. }
  606. return esv1.ValidationResultReady, nil
  607. }
  608. func getDataByProperty(data []byte, property string) (gjson.Result, error) {
  609. if !json.Valid(data) {
  610. return gjson.Result{}, errors.New(errJSONSecretUnmarshal)
  611. }
  612. var payload string
  613. if data != nil {
  614. payload = string(data)
  615. }
  616. idx := strings.Index(property, ".")
  617. refProperty := property
  618. if idx > 0 {
  619. refProperty = strings.ReplaceAll(refProperty, ".", "\\.")
  620. val := gjson.Get(payload, refProperty)
  621. if val.Exists() {
  622. return val, nil
  623. }
  624. }
  625. return gjson.Get(payload, property), nil
  626. }
  627. func getName(projectID, location, key string) string {
  628. if location != "" {
  629. return fmt.Sprintf(regionalSecretPath, projectID, location, key)
  630. }
  631. return fmt.Sprintf(globalSecretPath, projectID, key)
  632. }
  633. func getParentName(projectID, location string) string {
  634. if location != "" {
  635. return fmt.Sprintf(regionalSecretParentPath, projectID, location)
  636. }
  637. return fmt.Sprintf(globalSecretParentPath, projectID)
  638. }
  639. func isErrSecretDestroyedOrDisabled(err error) bool {
  640. st, _ := status.FromError(err)
  641. return st.Code() == codes.FailedPrecondition &&
  642. (strings.Contains(st.Message(), "DESTROYED state") || strings.Contains(st.Message(), "DISABLED state"))
  643. }
  644. func getLatestEnabledVersion(ctx context.Context, client GoogleSecretManagerClient, name string) (*secretmanagerpb.AccessSecretVersionResponse, error) {
  645. iter := client.ListSecretVersions(ctx, &secretmanagerpb.ListSecretVersionsRequest{
  646. Parent: name,
  647. Filter: "state:ENABLED",
  648. })
  649. latestCreateTime := time.Unix(0, 0)
  650. latestVersion := &secretmanagerpb.SecretVersion{}
  651. for {
  652. version, err := iter.Next()
  653. if errors.Is(err, iterator.Done) {
  654. break
  655. }
  656. if version.CreateTime.AsTime().After(latestCreateTime) {
  657. latestCreateTime = version.CreateTime.AsTime()
  658. latestVersion = version
  659. }
  660. }
  661. req := &secretmanagerpb.AccessSecretVersionRequest{
  662. Name: fmt.Sprintf("%s/versions/%s", name, latestVersion.Name),
  663. }
  664. return client.AccessSecretVersion(ctx, req)
  665. }