oracle.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699
  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 oracle implements a provider for Oracle Cloud Infrastructure Vault.
  14. // It allows fetching and managing secrets stored in OCI Vault using the OCI SDK.
  15. package oracle
  16. import (
  17. "bytes"
  18. "context"
  19. "encoding/base64"
  20. "encoding/json"
  21. "errors"
  22. "fmt"
  23. "os"
  24. "regexp"
  25. "sync"
  26. "time"
  27. "github.com/oracle/oci-go-sdk/v65/common"
  28. "github.com/oracle/oci-go-sdk/v65/common/auth"
  29. "github.com/oracle/oci-go-sdk/v65/keymanagement"
  30. "github.com/oracle/oci-go-sdk/v65/secrets"
  31. "github.com/oracle/oci-go-sdk/v65/vault"
  32. "github.com/tidwall/gjson"
  33. corev1 "k8s.io/api/core/v1"
  34. "k8s.io/client-go/kubernetes"
  35. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  36. ctrlcfg "sigs.k8s.io/controller-runtime/pkg/client/config"
  37. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  38. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  39. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  40. "github.com/external-secrets/external-secrets/pkg/esutils"
  41. "github.com/external-secrets/external-secrets/pkg/esutils/resolvers"
  42. )
  43. const (
  44. errOracleClient = "cannot setup new oracle client: %w"
  45. errORACLECredSecretName = "invalid oracle SecretStore resource: missing oracle APIKey"
  46. errUninitalizedOracleProvider = "provider oracle is not initialized"
  47. errFetchSAKSecret = "could not fetch SecretAccessKey secret: %w"
  48. errMissingPK = "missing PrivateKey"
  49. errMissingUser = "missing User ID"
  50. errMissingTenancy = "missing Tenancy ID"
  51. errMissingRegion = "missing Region"
  52. errMissingFingerprint = "missing Fingerprint"
  53. errMissingVault = "missing Vault"
  54. errJSONSecretUnmarshal = "unable to unmarshal secret from JSON: %w"
  55. errMissingKey = "missing Key in secret: %s"
  56. errUnexpectedContent = "unexpected secret bundle content"
  57. errSettingOCIEnvVariables = "unable to set OCI SDK environment variable %s: %w"
  58. )
  59. const (
  60. authConfigurationsCachePoolSize = 50
  61. )
  62. // https://github.com/external-secrets/external-secrets/issues/644
  63. var _ esv1.SecretsClient = &VaultManagementService{}
  64. var _ esv1.Provider = &VaultManagementService{}
  65. // VaultManagementService implements the External Secrets provider interface for Oracle Cloud Infrastructure Vault.
  66. type VaultManagementService struct {
  67. Client VMInterface
  68. KmsVaultClient KmsVCInterface
  69. VaultClient VaultInterface
  70. vault string
  71. compartment string
  72. encryptionKey string
  73. workloadIdentityMutex sync.Mutex
  74. authConfigurationsCache map[string]auth.ConfigurationProviderWithClaimAccess
  75. }
  76. // VMInterface defines the interface for OCI Secrets Management Client operations.
  77. type VMInterface interface {
  78. GetSecretBundleByName(ctx context.Context, request secrets.GetSecretBundleByNameRequest) (secrets.GetSecretBundleByNameResponse, error)
  79. }
  80. // KmsVCInterface defines the interface for OCI Key Management Service Vault Client operations.
  81. type KmsVCInterface interface {
  82. GetVault(ctx context.Context, request keymanagement.GetVaultRequest) (response keymanagement.GetVaultResponse, err error)
  83. }
  84. // VaultInterface defines the interface for OCI Vault operations.
  85. type VaultInterface interface {
  86. ListSecrets(ctx context.Context, request vault.ListSecretsRequest) (response vault.ListSecretsResponse, err error)
  87. CreateSecret(ctx context.Context, request vault.CreateSecretRequest) (response vault.CreateSecretResponse, err error)
  88. UpdateSecret(ctx context.Context, request vault.UpdateSecretRequest) (response vault.UpdateSecretResponse, err error)
  89. ScheduleSecretDeletion(ctx context.Context, request vault.ScheduleSecretDeletionRequest) (response vault.ScheduleSecretDeletionResponse, err error)
  90. }
  91. const (
  92. // SecretNotFound indicates that the requested secret was not found in the vault.
  93. SecretNotFound = iota
  94. // SecretExists indicates that the secret exists in the vault.
  95. SecretExists
  96. // SecretAPIError indicates that an API error occurred while accessing the secret.
  97. SecretAPIError
  98. )
  99. // PushSecret creates or updates a secret in the Oracle Cloud Infrastructure Vault.
  100. func (vms *VaultManagementService) PushSecret(ctx context.Context, secret *corev1.Secret, data esv1.PushSecretData) error {
  101. if vms.encryptionKey == "" {
  102. return errors.New("SecretStore must reference encryption key")
  103. }
  104. value := secret.Data[data.GetSecretKey()]
  105. if data.GetSecretKey() == "" {
  106. secretData := map[string]string{}
  107. for k, v := range secret.Data {
  108. secretData[k] = string(v)
  109. }
  110. jsonSecret, err := json.Marshal(secretData)
  111. if err != nil {
  112. return fmt.Errorf("unable to create json %v from value: %v", value, secretData)
  113. }
  114. value = jsonSecret
  115. }
  116. secretName := data.GetRemoteKey()
  117. encodedValue := base64.StdEncoding.EncodeToString(value)
  118. sec, action, err := vms.getSecretBundleWithCode(ctx, secretName)
  119. switch action {
  120. case SecretNotFound:
  121. _, err = vms.VaultClient.CreateSecret(ctx, vault.CreateSecretRequest{
  122. CreateSecretDetails: vault.CreateSecretDetails{
  123. CompartmentId: &vms.compartment,
  124. KeyId: &vms.encryptionKey,
  125. SecretContent: vault.Base64SecretContentDetails{
  126. Content: &encodedValue,
  127. },
  128. SecretName: &secretName,
  129. VaultId: &vms.vault,
  130. },
  131. })
  132. return sanitizeOCISDKErr(err)
  133. case SecretExists:
  134. payload, err := decodeBundle(sec)
  135. if err != nil {
  136. return err
  137. }
  138. if bytes.Equal(payload, value) {
  139. return nil
  140. }
  141. _, err = vms.VaultClient.UpdateSecret(ctx, vault.UpdateSecretRequest{
  142. SecretId: sec.SecretId,
  143. UpdateSecretDetails: vault.UpdateSecretDetails{
  144. SecretContent: vault.Base64SecretContentDetails{
  145. Content: &encodedValue,
  146. },
  147. },
  148. })
  149. return sanitizeOCISDKErr(err)
  150. default:
  151. return sanitizeOCISDKErr(err)
  152. }
  153. }
  154. // DeleteSecret removes a secret from the Oracle Cloud Infrastructure Vault.
  155. func (vms *VaultManagementService) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
  156. secretName := remoteRef.GetRemoteKey()
  157. resp, action, err := vms.getSecretBundleWithCode(ctx, secretName)
  158. switch action {
  159. case SecretNotFound:
  160. return nil
  161. case SecretExists:
  162. if resp.TimeOfDeletion != nil {
  163. return nil
  164. }
  165. _, err = vms.VaultClient.ScheduleSecretDeletion(ctx, vault.ScheduleSecretDeletionRequest{
  166. SecretId: resp.SecretId,
  167. })
  168. return sanitizeOCISDKErr(err)
  169. default:
  170. return sanitizeOCISDKErr(err)
  171. }
  172. }
  173. // SecretExists checks if a secret exists in the Oracle Cloud Infrastructure Vault.
  174. func (vms *VaultManagementService) SecretExists(_ context.Context, _ esv1.PushSecretRemoteRef) (bool, error) {
  175. return false, errors.New("not implemented")
  176. }
  177. // GetAllSecrets retrieves all secrets from the Oracle Cloud Infrastructure Vault that match the given criteria.
  178. func (vms *VaultManagementService) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  179. var page *string
  180. var summaries []vault.SecretSummary
  181. for {
  182. resp, err := vms.VaultClient.ListSecrets(ctx, vault.ListSecretsRequest{
  183. CompartmentId: &vms.compartment,
  184. Page: page,
  185. VaultId: &vms.vault,
  186. })
  187. if err != nil {
  188. return nil, sanitizeOCISDKErr(err)
  189. }
  190. summaries = append(summaries, resp.Items...)
  191. if page = resp.OpcNextPage; resp.OpcNextPage == nil {
  192. break
  193. }
  194. }
  195. return vms.filteredSummaryResult(ctx, summaries, ref)
  196. }
  197. // GetSecret retrieves a specific secret from the Oracle Cloud Infrastructure Vault.
  198. func (vms *VaultManagementService) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  199. if esutils.IsNil(vms.Client) {
  200. return nil, errors.New(errUninitalizedOracleProvider)
  201. }
  202. sec, err := vms.Client.GetSecretBundleByName(ctx, secrets.GetSecretBundleByNameRequest{
  203. VaultId: &vms.vault,
  204. SecretName: &ref.Key,
  205. Stage: secrets.GetSecretBundleByNameStageEnum(ref.Version),
  206. })
  207. if err != nil {
  208. return nil, sanitizeOCISDKErr(err)
  209. }
  210. payload, err := decodeBundle(sec)
  211. if err != nil {
  212. return nil, err
  213. }
  214. if ref.Property == "" {
  215. return payload, nil
  216. }
  217. val := gjson.Get(string(payload), ref.Property)
  218. if !val.Exists() {
  219. return nil, fmt.Errorf(errMissingKey, ref.Key)
  220. }
  221. return []byte(val.String()), nil
  222. }
  223. func decodeBundle(sec secrets.GetSecretBundleByNameResponse) ([]byte, error) {
  224. bt, ok := sec.SecretBundleContent.(secrets.Base64SecretBundleContentDetails)
  225. if !ok {
  226. return nil, errors.New(errUnexpectedContent)
  227. }
  228. payload, err := base64.StdEncoding.DecodeString(*bt.Content)
  229. if err != nil {
  230. return nil, err
  231. }
  232. return payload, nil
  233. }
  234. // GetSecretMap retrieves a secret and returns it as a map of key/value pairs.
  235. func (vms *VaultManagementService) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  236. data, err := vms.GetSecret(ctx, ref)
  237. if err != nil {
  238. return nil, sanitizeOCISDKErr(err)
  239. }
  240. kv := make(map[string]string)
  241. err = json.Unmarshal(data, &kv)
  242. if err != nil {
  243. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  244. }
  245. secretData := make(map[string][]byte)
  246. for k, v := range kv {
  247. secretData[k] = []byte(v)
  248. }
  249. return secretData, nil
  250. }
  251. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  252. func (vms *VaultManagementService) Capabilities() esv1.SecretStoreCapabilities {
  253. return esv1.SecretStoreReadOnly
  254. }
  255. // NewClient constructs a new secrets client based on the provided store.
  256. func (vms *VaultManagementService) NewClient(ctx context.Context, store esv1.GenericStore, kube kclient.Client, namespace string) (esv1.SecretsClient, error) {
  257. storeSpec := store.GetSpec()
  258. oracleSpec := storeSpec.Provider.Oracle
  259. if oracleSpec.Vault == "" {
  260. return nil, errors.New(errMissingVault)
  261. }
  262. if oracleSpec.Region == "" {
  263. return nil, errors.New(errMissingRegion)
  264. }
  265. configurationProvider, err := vms.constructProvider(ctx, store, oracleSpec, kube, namespace)
  266. if err != nil {
  267. return nil, err
  268. }
  269. secretManagementService, err := secrets.NewSecretsClientWithConfigurationProvider(configurationProvider)
  270. if err != nil {
  271. return nil, fmt.Errorf(errOracleClient, err)
  272. }
  273. secretManagementService.SetRegion(oracleSpec.Region)
  274. kmsVaultClient, err := keymanagement.NewKmsVaultClientWithConfigurationProvider(configurationProvider)
  275. if err != nil {
  276. return nil, fmt.Errorf(errOracleClient, err)
  277. }
  278. kmsVaultClient.SetRegion(oracleSpec.Region)
  279. vaultClient, err := vault.NewVaultsClientWithConfigurationProvider(configurationProvider)
  280. if err != nil {
  281. return nil, fmt.Errorf(errOracleClient, err)
  282. }
  283. vaultClient.SetRegion(oracleSpec.Region)
  284. if storeSpec.RetrySettings != nil {
  285. if err := vms.configureRetryPolicy(storeSpec, secretManagementService, kmsVaultClient, vaultClient); err != nil {
  286. return nil, fmt.Errorf(errOracleClient, err)
  287. }
  288. }
  289. return &VaultManagementService{
  290. Client: secretManagementService,
  291. KmsVaultClient: kmsVaultClient,
  292. VaultClient: vaultClient,
  293. vault: oracleSpec.Vault,
  294. compartment: oracleSpec.Compartment,
  295. encryptionKey: oracleSpec.EncryptionKey,
  296. }, nil
  297. }
  298. func (vms *VaultManagementService) constructOptions(storeSpec *esv1.SecretStoreSpec) ([]common.RetryPolicyOption, error) {
  299. opts := []common.RetryPolicyOption{common.WithShouldRetryOperation(common.DefaultShouldRetryOperation)}
  300. if mr := storeSpec.RetrySettings.MaxRetries; mr != nil {
  301. attempts := safeConvert(*mr)
  302. opts = append(opts, common.WithMaximumNumberAttempts(attempts))
  303. }
  304. if ri := storeSpec.RetrySettings.RetryInterval; ri != nil {
  305. i, err := time.ParseDuration(*storeSpec.RetrySettings.RetryInterval)
  306. if err != nil {
  307. return nil, fmt.Errorf(errOracleClient, err)
  308. }
  309. opts = append(opts, common.WithFixedBackoff(i))
  310. }
  311. return opts, nil
  312. }
  313. func safeConvert(i int32) uint {
  314. if i < 0 {
  315. return 0
  316. }
  317. return uint(i)
  318. }
  319. func (vms *VaultManagementService) getSecretBundleWithCode(ctx context.Context, secretName string) (secrets.GetSecretBundleByNameResponse, int, error) {
  320. // Try to look up the secret, which will determine if we should create or update the secret.
  321. resp, err := vms.Client.GetSecretBundleByName(ctx, secrets.GetSecretBundleByNameRequest{
  322. SecretName: &secretName,
  323. VaultId: &vms.vault,
  324. })
  325. // Get a PushSecret action depending on the ListSecrets response.
  326. action := getSecretBundleCode(err)
  327. return resp, action, err
  328. }
  329. func getSecretBundleCode(err error) int {
  330. if err != nil {
  331. // If we got a 404 service error, try to create the secret.
  332. if serviceErr, ok := err.(common.ServiceError); ok && serviceErr.GetHTTPStatusCode() == 404 {
  333. return SecretNotFound
  334. }
  335. return SecretAPIError
  336. }
  337. // Otherwise, update the existing secret.
  338. return SecretExists
  339. }
  340. func (vms *VaultManagementService) filteredSummaryResult(ctx context.Context, secretSummaries []vault.SecretSummary, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  341. secretMap := map[string][]byte{}
  342. for _, summary := range secretSummaries {
  343. matches, err := matchesRef(summary, ref)
  344. if err != nil {
  345. return nil, err
  346. }
  347. if !matches || summary.TimeOfDeletion != nil {
  348. continue
  349. }
  350. secret, err := vms.GetSecret(ctx, esv1.ExternalSecretDataRemoteRef{
  351. Key: *summary.SecretName,
  352. })
  353. if err != nil {
  354. return nil, err
  355. }
  356. secretMap[*summary.SecretName] = secret
  357. }
  358. return secretMap, nil
  359. }
  360. func matchesRef(secretSummary vault.SecretSummary, ref esv1.ExternalSecretFind) (bool, error) {
  361. if ref.Name != nil {
  362. matchString, err := regexp.MatchString(ref.Name.RegExp, *secretSummary.SecretName)
  363. if err != nil {
  364. return false, err
  365. }
  366. return matchString, nil
  367. }
  368. for k, v := range ref.Tags {
  369. if val, ok := secretSummary.FreeformTags[k]; ok {
  370. if val == v {
  371. return true, nil
  372. }
  373. }
  374. }
  375. return false, nil
  376. }
  377. func getSecretData(ctx context.Context, kube kclient.Client, namespace, storeKind string, secretRef esmeta.SecretKeySelector) (string, error) {
  378. if secretRef.Name == "" {
  379. return "", errors.New(errORACLECredSecretName)
  380. }
  381. secret, err := resolvers.SecretKeyRef(
  382. ctx,
  383. kube,
  384. storeKind,
  385. namespace,
  386. &secretRef,
  387. )
  388. if err != nil {
  389. return "", fmt.Errorf(errFetchSAKSecret, err)
  390. }
  391. return secret, nil
  392. }
  393. func getUserAuthConfigurationProvider(ctx context.Context, kube kclient.Client, store *esv1.OracleProvider, namespace, storeKind, region string) (common.ConfigurationProvider, error) {
  394. privateKey, err := getSecretData(ctx, kube, namespace, storeKind, store.Auth.SecretRef.PrivateKey)
  395. if err != nil {
  396. return nil, err
  397. }
  398. if privateKey == "" {
  399. return nil, errors.New(errMissingPK)
  400. }
  401. fingerprint, err := getSecretData(ctx, kube, namespace, storeKind, store.Auth.SecretRef.Fingerprint)
  402. if err != nil {
  403. return nil, err
  404. }
  405. if fingerprint == "" {
  406. return nil, errors.New(errMissingFingerprint)
  407. }
  408. if store.Auth.User == "" {
  409. return nil, errors.New(errMissingUser)
  410. }
  411. if store.Auth.Tenancy == "" {
  412. return nil, errors.New(errMissingTenancy)
  413. }
  414. return common.NewRawConfigurationProvider(store.Auth.Tenancy, store.Auth.User, region, fingerprint, privateKey, nil), nil
  415. }
  416. // Close releases any resources used by the VaultManagementService.
  417. func (vms *VaultManagementService) Close(_ context.Context) error {
  418. return nil
  419. }
  420. // Validate performs validation of the Oracle Cloud Infrastructure provider configuration.
  421. func (vms *VaultManagementService) Validate() (esv1.ValidationResult, error) {
  422. _, err := vms.KmsVaultClient.GetVault(
  423. context.Background(), keymanagement.GetVaultRequest{
  424. VaultId: &vms.vault,
  425. },
  426. )
  427. if err != nil {
  428. failure, ok := common.IsServiceError(err)
  429. if ok {
  430. code := failure.GetCode()
  431. switch code {
  432. case "NotAuthenticated":
  433. return esv1.ValidationResultError, sanitizeOCISDKErr(err)
  434. case "NotAuthorizedOrNotFound":
  435. // User authentication was successful, but user might not have a permission like:
  436. //
  437. // Allow group external_secrets to read vaults in tenancy
  438. //
  439. // Which is fine, because to read secrets we only need:
  440. //
  441. // Allow group external_secrets to read secret-family in tenancy
  442. //
  443. // But we can't test for this permission without knowing the name of a secret
  444. return esv1.ValidationResultUnknown, sanitizeOCISDKErr(err)
  445. default:
  446. return esv1.ValidationResultError, sanitizeOCISDKErr(err)
  447. }
  448. } else {
  449. return esv1.ValidationResultError, err
  450. }
  451. }
  452. return esv1.ValidationResultReady, nil
  453. }
  454. // ValidateStore validates the Oracle Cloud Infrastructure SecretStore resource configuration.
  455. func (vms *VaultManagementService) ValidateStore(store esv1.GenericStore) (admission.Warnings, error) {
  456. storeSpec := store.GetSpec()
  457. oracleSpec := storeSpec.Provider.Oracle
  458. vault := oracleSpec.Vault
  459. if vault == "" {
  460. return nil, errors.New("vault cannot be empty")
  461. }
  462. region := oracleSpec.Region
  463. if region == "" {
  464. return nil, errors.New("region cannot be empty")
  465. }
  466. auth := oracleSpec.Auth
  467. if auth == nil {
  468. return nil, nil
  469. }
  470. user := oracleSpec.Auth.User
  471. if user == "" {
  472. return nil, errors.New("user cannot be empty")
  473. }
  474. tenant := oracleSpec.Auth.Tenancy
  475. if tenant == "" {
  476. return nil, errors.New("tenant cannot be empty")
  477. }
  478. privateKey := oracleSpec.Auth.SecretRef.PrivateKey
  479. if privateKey.Name == "" {
  480. return nil, errors.New("privateKey.name cannot be empty")
  481. }
  482. if privateKey.Key == "" {
  483. return nil, errors.New("privateKey.key cannot be empty")
  484. }
  485. err := esutils.ValidateSecretSelector(store, privateKey)
  486. if err != nil {
  487. return nil, err
  488. }
  489. fingerprint := oracleSpec.Auth.SecretRef.Fingerprint
  490. if fingerprint.Name == "" {
  491. return nil, errors.New("fingerprint.name cannot be empty")
  492. }
  493. if fingerprint.Key == "" {
  494. return nil, errors.New("fingerprint.key cannot be empty")
  495. }
  496. err = esutils.ValidateSecretSelector(store, fingerprint)
  497. if err != nil {
  498. return nil, err
  499. }
  500. if oracleSpec.ServiceAccountRef != nil {
  501. if err := esutils.ValidateReferentServiceAccountSelector(store, *oracleSpec.ServiceAccountRef); err != nil {
  502. return nil, fmt.Errorf("invalid ServiceAccountRef: %w", err)
  503. }
  504. }
  505. return nil, nil
  506. }
  507. func (vms *VaultManagementService) getWorkloadIdentityProvider(store esv1.GenericStore, serviceAcccountRef *esmeta.ServiceAccountSelector, region, namespace string) (configurationProvider common.ConfigurationProvider, err error) {
  508. defer func() {
  509. if uerr := os.Unsetenv(auth.ResourcePrincipalVersionEnvVar); uerr != nil {
  510. err = errors.Join(err, fmt.Errorf(errSettingOCIEnvVariables, auth.ResourcePrincipalRegionEnvVar, uerr))
  511. }
  512. if uerr := os.Unsetenv(auth.ResourcePrincipalRegionEnvVar); uerr != nil {
  513. err = errors.Join(err, fmt.Errorf("unabled to unset OCI SDK environment variable %s: %w", auth.ResourcePrincipalVersionEnvVar, uerr))
  514. }
  515. vms.workloadIdentityMutex.Unlock()
  516. }()
  517. vms.workloadIdentityMutex.Lock()
  518. // OCI SDK requires specific environment variables for workload identity.
  519. if err := os.Setenv(auth.ResourcePrincipalVersionEnvVar, auth.ResourcePrincipalVersion2_2); err != nil {
  520. return nil, fmt.Errorf(errSettingOCIEnvVariables, auth.ResourcePrincipalVersionEnvVar, err)
  521. }
  522. if err := os.Setenv(auth.ResourcePrincipalRegionEnvVar, region); err != nil {
  523. return nil, fmt.Errorf(errSettingOCIEnvVariables, auth.ResourcePrincipalRegionEnvVar, err)
  524. }
  525. // If no service account is specified, use the pod service account to create the Workload Identity provider.
  526. if serviceAcccountRef == nil {
  527. return auth.OkeWorkloadIdentityConfigurationProvider()
  528. }
  529. // Ensure the service account ref is being used appropriately, so arbitrary tokens are not minted by the provider.
  530. if err = esutils.ValidateServiceAccountSelector(store, *serviceAcccountRef); err != nil {
  531. return nil, fmt.Errorf("invalid ServiceAccountRef: %w", err)
  532. }
  533. cfg, err := ctrlcfg.GetConfig()
  534. if err != nil {
  535. return nil, err
  536. }
  537. clientset, err := kubernetes.NewForConfig(cfg)
  538. if err != nil {
  539. return nil, err
  540. }
  541. tokenProvider := NewTokenProvider(clientset, serviceAcccountRef, namespace)
  542. // Cache OKE token providers per SecretStore to avoid creating multiple providers for the same store.
  543. // We also reset the cache if it exceeds a certain size to avoid unbounded memory growth.
  544. if vms.authConfigurationsCache == nil || len(vms.authConfigurationsCache) >= authConfigurationsCachePoolSize {
  545. vms.authConfigurationsCache = make(map[string]auth.ConfigurationProviderWithClaimAccess)
  546. }
  547. // Caching by resource version to ensure that updates to the SecretStore are reflected in the cached provider.
  548. _, ok := vms.authConfigurationsCache[store.GetResourceVersion()]
  549. if !ok {
  550. vms.authConfigurationsCache[store.GetResourceVersion()], err = auth.OkeWorkloadIdentityConfigurationProviderWithServiceAccountTokenProvider(tokenProvider)
  551. if err != nil {
  552. return nil, err
  553. }
  554. }
  555. return vms.authConfigurationsCache[store.GetResourceVersion()], nil
  556. }
  557. func (vms *VaultManagementService) constructProvider(ctx context.Context, store esv1.GenericStore, oracleSpec *esv1.OracleProvider, kube kclient.Client, namespace string) (common.ConfigurationProvider, error) {
  558. var (
  559. configurationProvider common.ConfigurationProvider
  560. err error
  561. )
  562. if oracleSpec.PrincipalType == esv1.WorkloadPrincipal {
  563. configurationProvider, err = vms.getWorkloadIdentityProvider(store, oracleSpec.ServiceAccountRef, oracleSpec.Region, namespace)
  564. } else if oracleSpec.PrincipalType == esv1.InstancePrincipal || oracleSpec.Auth == nil {
  565. configurationProvider, err = auth.InstancePrincipalConfigurationProvider()
  566. } else {
  567. configurationProvider, err = getUserAuthConfigurationProvider(ctx, kube, oracleSpec, namespace, store.GetObjectKind().GroupVersionKind().Kind, oracleSpec.Region)
  568. }
  569. if err != nil {
  570. return nil, fmt.Errorf(errOracleClient, err)
  571. }
  572. return configurationProvider, nil
  573. }
  574. func (vms *VaultManagementService) configureRetryPolicy(
  575. storeSpec *esv1.SecretStoreSpec,
  576. secretManagementService secrets.SecretsClient,
  577. kmsVaultClient keymanagement.KmsVaultClient,
  578. vaultClient vault.VaultsClient,
  579. ) error {
  580. opts, err := vms.constructOptions(storeSpec)
  581. if err != nil {
  582. return err
  583. }
  584. customRetryPolicy := common.NewRetryPolicyWithOptions(opts...)
  585. secretManagementService.SetCustomClientConfiguration(common.CustomClientConfiguration{
  586. RetryPolicy: &customRetryPolicy,
  587. })
  588. kmsVaultClient.SetCustomClientConfiguration(common.CustomClientConfiguration{
  589. RetryPolicy: &customRetryPolicy,
  590. })
  591. vaultClient.SetCustomClientConfiguration(common.CustomClientConfiguration{
  592. RetryPolicy: &customRetryPolicy,
  593. })
  594. return err
  595. }
  596. func sanitizeOCISDKErr(err error) error {
  597. if err == nil {
  598. return nil
  599. }
  600. // If we have a ServiceError from the OCI SDK, strip only the message from the verbose error
  601. if serviceError, ok := err.(common.ServiceErrorRichInfo); ok {
  602. return fmt.Errorf("%s service failed to %s, HTTP status code %d: %s", serviceError.GetTargetService(), serviceError.GetOperationName(), serviceError.GetHTTPStatusCode(), serviceError.GetMessage())
  603. }
  604. return err
  605. }
  606. func init() {
  607. esv1.Register(&VaultManagementService{}, &esv1.SecretStoreProvider{
  608. Oracle: &esv1.OracleProvider{},
  609. }, esv1.MaintenanceStatusMaintained)
  610. }