client.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  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. if c.store.Location != "" {
  133. secretName = fmt.Sprintf(regionalSecretPath, c.store.ProjectID, c.store.Location, ref.GetRemoteKey())
  134. }
  135. gcpSecret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  136. Name: secretName,
  137. })
  138. if err != nil {
  139. if status.Code(err) == codes.NotFound {
  140. return false, nil
  141. }
  142. return false, err
  143. }
  144. if gcpSecret == nil {
  145. return false, nil
  146. }
  147. // Check if the secret has at least one version
  148. versionName := fmt.Sprintf("%s/versions/latest", secretName)
  149. _, err = c.smClient.AccessSecretVersion(ctx, &secretmanagerpb.AccessSecretVersionRequest{
  150. Name: versionName,
  151. })
  152. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  153. if err != nil {
  154. if status.Code(err) == codes.NotFound {
  155. // Secret exists but has no versions
  156. return false, nil
  157. }
  158. return false, err
  159. }
  160. return true, nil
  161. }
  162. // PushSecret pushes a kubernetes secret key into gcp provider Secret.
  163. func (c *Client) PushSecret(ctx context.Context, secret *corev1.Secret, pushSecretData esv1.PushSecretData) error {
  164. var (
  165. payload []byte
  166. err error
  167. )
  168. if pushSecretData.GetSecretKey() == "" {
  169. // Must convert secret values to string, otherwise data will be sent as base64 to Vault
  170. secretStringVal := make(map[string]string)
  171. for k, v := range secret.Data {
  172. secretStringVal[k] = string(v)
  173. }
  174. payload, err = esutils.JSONMarshal(secretStringVal)
  175. if err != nil {
  176. return fmt.Errorf("failed to serialize secret content as JSON: %w", err)
  177. }
  178. } else {
  179. payload = secret.Data[pushSecretData.GetSecretKey()]
  180. }
  181. secretName := getName(c.store.ProjectID, c.store.Location, pushSecretData.GetRemoteKey())
  182. gcpSecret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  183. Name: secretName,
  184. })
  185. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMGetSecret, err)
  186. if err != nil {
  187. if status.Code(err) != codes.NotFound {
  188. return err
  189. }
  190. var replication = &secretmanagerpb.Replication{
  191. Replication: &secretmanagerpb.Replication_Automatic_{
  192. Automatic: &secretmanagerpb.Replication_Automatic{},
  193. },
  194. }
  195. if pushSecretData.GetMetadata() != nil {
  196. replica := &secretmanagerpb.Replication_UserManaged_Replica{}
  197. var err error
  198. meta, err := metadata.ParseMetadataParameters[PushSecretMetadataSpec](pushSecretData.GetMetadata())
  199. if err != nil {
  200. return fmt.Errorf("failed to parse PushSecret metadata: %w", err)
  201. }
  202. if meta != nil && meta.Spec.ReplicationLocation != "" {
  203. replica.Location = meta.Spec.ReplicationLocation
  204. }
  205. if meta != nil && meta.Spec.CMEKKeyName != "" {
  206. replica.CustomerManagedEncryption = &secretmanagerpb.CustomerManagedEncryption{
  207. KmsKeyName: meta.Spec.CMEKKeyName,
  208. }
  209. }
  210. replication = &secretmanagerpb.Replication{
  211. Replication: &secretmanagerpb.Replication_UserManaged_{
  212. UserManaged: &secretmanagerpb.Replication_UserManaged{
  213. Replicas: []*secretmanagerpb.Replication_UserManaged_Replica{
  214. replica,
  215. },
  216. },
  217. },
  218. }
  219. }
  220. parent := getParentName(c.store.ProjectID, c.store.Location)
  221. scrt := &secretmanagerpb.Secret{
  222. Labels: map[string]string{
  223. managedByKey: managedByValue,
  224. },
  225. }
  226. // fix: cannot set Replication at all when using regional Secrets.
  227. if c.store.Location == "" {
  228. scrt.Replication = replication
  229. }
  230. topics, err := esutils.FetchValueFromMetadata(topicsKey, pushSecretData.GetMetadata(), []any{})
  231. if err != nil {
  232. return fmt.Errorf("failed to fetch topics from metadata: %w", err)
  233. }
  234. for _, t := range topics {
  235. name, ok := t.(string)
  236. if !ok {
  237. return fmt.Errorf("invalid topic type")
  238. }
  239. scrt.Topics = append(scrt.Topics, &secretmanagerpb.Topic{
  240. Name: name,
  241. })
  242. }
  243. gcpSecret, err = c.smClient.CreateSecret(ctx, &secretmanagerpb.CreateSecretRequest{
  244. Parent: parent,
  245. SecretId: pushSecretData.GetRemoteKey(),
  246. Secret: scrt,
  247. })
  248. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMCreateSecret, err)
  249. if err != nil {
  250. return err
  251. }
  252. }
  253. builder, err := newPushSecretBuilder(payload, pushSecretData)
  254. if err != nil {
  255. return err
  256. }
  257. annotations, labels, topics, err := builder.buildMetadata(gcpSecret.Annotations, gcpSecret.Labels, gcpSecret.Topics)
  258. if err != nil {
  259. return err
  260. }
  261. // Comparing with a pointer based slice doesn't work so we are converting
  262. // it to a string slice.
  263. existingTopics := make([]string, 0, len(gcpSecret.Topics))
  264. for _, t := range gcpSecret.Topics {
  265. existingTopics = append(existingTopics, t.Name)
  266. }
  267. if !maps.Equal(gcpSecret.Annotations, annotations) || !maps.Equal(gcpSecret.Labels, labels) || !slices.Equal(existingTopics, topics) {
  268. scrt := &secretmanagerpb.Secret{
  269. Name: gcpSecret.Name,
  270. Etag: gcpSecret.Etag,
  271. Labels: labels,
  272. Annotations: annotations,
  273. Topics: gcpSecret.Topics,
  274. }
  275. if c.store.Location != "" {
  276. scrt.Replication = &secretmanagerpb.Replication{
  277. Replication: &secretmanagerpb.Replication_UserManaged_{
  278. UserManaged: &secretmanagerpb.Replication_UserManaged{
  279. Replicas: []*secretmanagerpb.Replication_UserManaged_Replica{
  280. {
  281. Location: c.store.Location,
  282. },
  283. },
  284. },
  285. },
  286. }
  287. }
  288. _, err = c.smClient.UpdateSecret(ctx, &secretmanagerpb.UpdateSecretRequest{
  289. Secret: scrt,
  290. UpdateMask: &field_mask.FieldMask{
  291. Paths: []string{"labels", "annotations"},
  292. },
  293. })
  294. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMUpdateSecret, err)
  295. if err != nil {
  296. return err
  297. }
  298. }
  299. unlock, err := locks.TryLock(providerName, secretName)
  300. if err != nil {
  301. return err
  302. }
  303. defer unlock()
  304. gcpVersion, err := c.smClient.AccessSecretVersion(ctx, &secretmanagerpb.AccessSecretVersionRequest{
  305. Name: fmt.Sprintf("%s/versions/latest", secretName),
  306. })
  307. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  308. if err != nil && status.Code(err) != codes.NotFound {
  309. return err
  310. }
  311. if gcpVersion != nil && gcpVersion.Payload != nil && !builder.needUpdate(gcpVersion.Payload.Data) {
  312. return nil
  313. }
  314. var original []byte
  315. if gcpVersion != nil && gcpVersion.Payload != nil {
  316. original = gcpVersion.Payload.Data
  317. }
  318. data, err := builder.buildData(original)
  319. if err != nil {
  320. return err
  321. }
  322. parent := getName(c.store.ProjectID, c.store.Location, pushSecretData.GetRemoteKey())
  323. addSecretVersionReq := &secretmanagerpb.AddSecretVersionRequest{
  324. Parent: parent,
  325. Payload: &secretmanagerpb.SecretPayload{
  326. Data: data,
  327. },
  328. }
  329. _, err = c.smClient.AddSecretVersion(ctx, addSecretVersionReq)
  330. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAddSecretVersion, err)
  331. return err
  332. }
  333. // GetAllSecrets syncs multiple secrets from gcp provider into a single Kubernetes Secret.
  334. func (c *Client) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  335. if ref.Name != nil {
  336. return c.findByName(ctx, ref)
  337. }
  338. if len(ref.Tags) > 0 {
  339. return c.findByTags(ctx, ref)
  340. }
  341. return nil, errors.New(errUnexpectedFindOperator)
  342. }
  343. func (c *Client) findByName(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  344. // regex matcher
  345. matcher, err := find.New(*ref.Name)
  346. if err != nil {
  347. return nil, err
  348. }
  349. parent := getParentName(c.store.ProjectID, c.store.Location)
  350. req := &secretmanagerpb.ListSecretsRequest{
  351. Parent: parent,
  352. }
  353. if ref.Path != nil {
  354. req.Filter = fmt.Sprintf("name:%s", *ref.Path)
  355. }
  356. // Call the API.
  357. it := c.smClient.ListSecrets(ctx, req)
  358. secretMap := make(map[string][]byte)
  359. var resp *secretmanagerpb.Secret
  360. defer metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMListSecrets, err)
  361. for {
  362. resp, err = it.Next()
  363. if errors.Is(err, iterator.Done) {
  364. break
  365. }
  366. if err != nil {
  367. return nil, fmt.Errorf("failed to list secrets: %w", err)
  368. }
  369. log.V(1).Info("gcp sm findByName found", "secrets", strconv.Itoa(it.PageInfo().Remaining()))
  370. key := c.trimName(resp.Name)
  371. // If we don't match we skip.
  372. // Also, if we have path, and it is not at the beguining we skip.
  373. // We have to check if path is at the beguining of the key because
  374. // there is no way to create a `name:%s*` (starts with) filter
  375. // At https://cloud.google.com/secret-manager/docs/filtering you can use `*`
  376. // but not like that it seems.
  377. if !matcher.MatchName(key) || (ref.Path != nil && !strings.HasPrefix(key, *ref.Path)) {
  378. continue
  379. }
  380. log.V(1).Info("gcp sm findByName matches", "name", resp.Name)
  381. secretMap[key], err = c.getData(ctx, key)
  382. if err != nil {
  383. return nil, err
  384. }
  385. }
  386. return esutils.ConvertKeys(ref.ConversionStrategy, secretMap)
  387. }
  388. func (c *Client) getData(ctx context.Context, key string) ([]byte, error) {
  389. dataRef := esv1.ExternalSecretDataRemoteRef{
  390. Key: key,
  391. }
  392. data, err := c.GetSecret(ctx, dataRef)
  393. if err != nil {
  394. return []byte(""), err
  395. }
  396. return data, nil
  397. }
  398. func (c *Client) findByTags(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  399. var tagFilter string
  400. for k, v := range ref.Tags {
  401. tagFilter = fmt.Sprintf("%slabels.%s=%s ", tagFilter, k, v)
  402. }
  403. tagFilter = strings.TrimSuffix(tagFilter, " ")
  404. if ref.Path != nil {
  405. tagFilter = fmt.Sprintf("%s name:%s", tagFilter, *ref.Path)
  406. }
  407. req := &secretmanagerpb.ListSecretsRequest{
  408. Parent: fmt.Sprintf("projects/%s", c.store.ProjectID),
  409. }
  410. log.V(1).Info("gcp sm findByTags", "tagFilter", tagFilter)
  411. req.Filter = tagFilter
  412. // Call the API.
  413. it := c.smClient.ListSecrets(ctx, req)
  414. var resp *secretmanagerpb.Secret
  415. var err error
  416. defer metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMListSecrets, err)
  417. secretMap := make(map[string][]byte)
  418. for {
  419. resp, err = it.Next()
  420. if errors.Is(err, iterator.Done) {
  421. break
  422. }
  423. if err != nil {
  424. return nil, fmt.Errorf("failed to list secrets: %w", err)
  425. }
  426. key := c.trimName(resp.Name)
  427. if ref.Path != nil && !strings.HasPrefix(key, *ref.Path) {
  428. continue
  429. }
  430. log.V(1).Info("gcp sm findByTags matches tags", "name", resp.Name)
  431. secretMap[key], err = c.getData(ctx, key)
  432. if err != nil {
  433. return nil, err
  434. }
  435. }
  436. return esutils.ConvertKeys(ref.ConversionStrategy, secretMap)
  437. }
  438. func (c *Client) trimName(name string) string {
  439. projectIDNumuber := c.extractProjectIDNumber(name)
  440. prefix := getParentName(projectIDNumuber, c.store.Location)
  441. key := strings.TrimPrefix(name, fmt.Sprintf("%s/secrets/", prefix))
  442. return key
  443. }
  444. // extractProjectIDNumber grabs the project id from the full name returned by gcp api
  445. // gcp api seems to always return the number and not the project name
  446. // (and users would always use the name, while requests accept both).
  447. func (c *Client) extractProjectIDNumber(secretFullName string) string {
  448. s := strings.Split(secretFullName, "/")
  449. ProjectIDNumuber := s[1]
  450. return ProjectIDNumuber
  451. }
  452. // GetSecret returns a single secret from the provider.
  453. func (c *Client) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  454. if esutils.IsNil(c.smClient) || c.store.ProjectID == "" {
  455. return nil, errors.New(errUninitalizedGCPProvider)
  456. }
  457. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  458. return c.getSecretMetadata(ctx, ref)
  459. }
  460. version := ref.Version
  461. if version == "" {
  462. version = defaultVersion
  463. }
  464. name := fmt.Sprintf(globalSecretVersionsPath, c.store.ProjectID, ref.Key, version)
  465. if c.store.Location != "" {
  466. name = fmt.Sprintf(regionalSecretVersionsPath, c.store.ProjectID, c.store.Location, ref.Key, version)
  467. }
  468. req := &secretmanagerpb.AccessSecretVersionRequest{
  469. Name: name,
  470. }
  471. result, err := c.smClient.AccessSecretVersion(ctx, req)
  472. metrics.ObserveAPICall(constants.ProviderGCPSM, constants.CallGCPSMAccessSecretVersion, err)
  473. if err != nil && c.store.SecretVersionSelectionPolicy == esv1.SecretVersionSelectionPolicyLatestOrFetch &&
  474. ref.Version == "" && isErrSecretDestroyedOrDisabled(err) {
  475. // if the secret is destroyed or disabled, and we are configured to get the latest enabled secret,
  476. // we need to get the latest enabled secret
  477. // Extract the secret name from the version name for ListSecretVersions
  478. secretName := fmt.Sprintf(globalSecretPath, c.store.ProjectID, ref.Key)
  479. if c.store.Location != "" {
  480. secretName = fmt.Sprintf(regionalSecretPath, c.store.ProjectID, c.store.Location, ref.Key)
  481. }
  482. result, err = getLatestEnabledVersion(ctx, c.smClient, secretName)
  483. }
  484. if err != nil {
  485. err = parseError(err)
  486. return nil, fmt.Errorf(errClientGetSecretAccess, err)
  487. }
  488. if ref.Property == "" {
  489. if result.Payload.Data != nil {
  490. return result.Payload.Data, nil
  491. }
  492. return nil, fmt.Errorf("invalid secret received. no secret string for key: %s", ref.Key)
  493. }
  494. val, err := getDataByProperty(result.Payload.Data, ref.Property)
  495. if err != nil {
  496. return nil, err
  497. }
  498. if !val.Exists() {
  499. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  500. }
  501. return []byte(val.String()), nil
  502. }
  503. func (c *Client) getSecretMetadata(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  504. name := getName(c.store.ProjectID, c.store.Location, ref.Key)
  505. secret, err := c.smClient.GetSecret(ctx, &secretmanagerpb.GetSecretRequest{
  506. Name: name,
  507. })
  508. err = parseError(err)
  509. if err != nil {
  510. return nil, fmt.Errorf(errClientGetSecretAccess, err)
  511. }
  512. const (
  513. annotations = "annotations"
  514. labels = "labels"
  515. )
  516. if annotation := c.extractMetadataKey(ref.Property, annotations); annotation != "" {
  517. v, ok := secret.GetAnnotations()[annotation]
  518. if !ok {
  519. return nil, fmt.Errorf("annotation with key %s does not exist in secret %s", annotation, ref.Key)
  520. }
  521. return []byte(v), nil
  522. }
  523. if label := c.extractMetadataKey(ref.Property, labels); label != "" {
  524. v, ok := secret.GetLabels()[label]
  525. if !ok {
  526. return nil, fmt.Errorf("label with key %s does not exist in secret %s", label, ref.Key)
  527. }
  528. return []byte(v), nil
  529. }
  530. if ref.Property == annotations {
  531. j, err := json.Marshal(secret.GetAnnotations())
  532. if err != nil {
  533. return nil, fmt.Errorf("faild marshaling annotations into json: %w", err)
  534. }
  535. return j, nil
  536. }
  537. if ref.Property == labels {
  538. j, err := json.Marshal(secret.GetLabels())
  539. if err != nil {
  540. return nil, fmt.Errorf("faild marshaling labels into json: %w", err)
  541. }
  542. return j, nil
  543. }
  544. if ref.Property != "" {
  545. return nil, fmt.Errorf("invalid property %s: metadata property should start with either %s or %s", ref.Property, annotations, labels)
  546. }
  547. j, err := json.Marshal(map[string]map[string]string{
  548. "annotations": secret.GetAnnotations(),
  549. "labels": secret.GetLabels(),
  550. })
  551. if err != nil {
  552. return nil, fmt.Errorf("faild marshaling metadata map into json: %w", err)
  553. }
  554. return j, nil
  555. }
  556. func (c *Client) extractMetadataKey(s, p string) string {
  557. prefix := p + "."
  558. if !strings.HasPrefix(s, prefix) {
  559. return ""
  560. }
  561. return strings.TrimPrefix(s, prefix)
  562. }
  563. // GetSecretMap returns multiple k/v pairs from the provider.
  564. func (c *Client) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  565. if c.smClient == nil || c.store.ProjectID == "" {
  566. return nil, errors.New(errUninitalizedGCPProvider)
  567. }
  568. data, err := c.GetSecret(ctx, ref)
  569. if err != nil {
  570. return nil, err
  571. }
  572. kv := make(map[string]json.RawMessage)
  573. err = json.Unmarshal(data, &kv)
  574. if err != nil {
  575. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  576. }
  577. secretData := make(map[string][]byte)
  578. for k, v := range kv {
  579. var strVal string
  580. err = json.Unmarshal(v, &strVal)
  581. if err == nil {
  582. secretData[k] = []byte(strVal)
  583. } else {
  584. secretData[k] = v
  585. }
  586. }
  587. return secretData, nil
  588. }
  589. // Close closes the Google Cloud Secret Manager client connection.
  590. func (c *Client) Close(_ context.Context) error {
  591. var err error
  592. if c.smClient != nil {
  593. err = c.smClient.Close()
  594. }
  595. if c.workloadIdentity != nil {
  596. err = c.workloadIdentity.Close()
  597. }
  598. useMu.Unlock()
  599. if err != nil {
  600. return fmt.Errorf(errClientClose, err)
  601. }
  602. return nil
  603. }
  604. // Validate performs validation of the Google Cloud Secret Manager client configuration.
  605. func (c *Client) Validate() (esv1.ValidationResult, error) {
  606. if c.storeKind == esv1.ClusterSecretStoreKind && isReferentSpec(c.store) {
  607. return esv1.ValidationResultUnknown, nil
  608. }
  609. return esv1.ValidationResultReady, nil
  610. }
  611. func getDataByProperty(data []byte, property string) (gjson.Result, error) {
  612. if !json.Valid(data) {
  613. return gjson.Result{}, errors.New(errJSONSecretUnmarshal)
  614. }
  615. var payload string
  616. if data != nil {
  617. payload = string(data)
  618. }
  619. idx := strings.Index(property, ".")
  620. refProperty := property
  621. if idx > 0 {
  622. refProperty = strings.ReplaceAll(refProperty, ".", "\\.")
  623. val := gjson.Get(payload, refProperty)
  624. if val.Exists() {
  625. return val, nil
  626. }
  627. }
  628. return gjson.Get(payload, property), nil
  629. }
  630. func getName(projectID, location, key string) string {
  631. if location != "" {
  632. return fmt.Sprintf(regionalSecretPath, projectID, location, key)
  633. }
  634. return fmt.Sprintf(globalSecretPath, projectID, key)
  635. }
  636. func getParentName(projectID, location string) string {
  637. if location != "" {
  638. return fmt.Sprintf(regionalSecretParentPath, projectID, location)
  639. }
  640. return fmt.Sprintf(globalSecretParentPath, projectID)
  641. }
  642. func isErrSecretDestroyedOrDisabled(err error) bool {
  643. st, _ := status.FromError(err)
  644. return st.Code() == codes.FailedPrecondition &&
  645. (strings.Contains(st.Message(), "DESTROYED state") || strings.Contains(st.Message(), "DISABLED state"))
  646. }
  647. func getLatestEnabledVersion(ctx context.Context, client GoogleSecretManagerClient, name string) (*secretmanagerpb.AccessSecretVersionResponse, error) {
  648. iter := client.ListSecretVersions(ctx, &secretmanagerpb.ListSecretVersionsRequest{
  649. Parent: name,
  650. Filter: "state:ENABLED",
  651. })
  652. latestCreateTime := time.Unix(0, 0)
  653. latestVersion := &secretmanagerpb.SecretVersion{}
  654. for {
  655. version, err := iter.Next()
  656. if errors.Is(err, iterator.Done) {
  657. break
  658. }
  659. if version.CreateTime.AsTime().After(latestCreateTime) {
  660. latestCreateTime = version.CreateTime.AsTime()
  661. latestVersion = version
  662. }
  663. }
  664. req := &secretmanagerpb.AccessSecretVersionRequest{
  665. Name: fmt.Sprintf("%s/versions/%s", name, latestVersion.Name),
  666. }
  667. return client.AccessSecretVersion(ctx, req)
  668. }