client.go 23 KB

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