oracle.go 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package oracle
  13. import (
  14. "context"
  15. "encoding/json"
  16. "fmt"
  17. "github.com/oracle/oci-go-sdk/v45/common"
  18. secrets "github.com/oracle/oci-go-sdk/v45/secrets"
  19. "github.com/tidwall/gjson"
  20. corev1 "k8s.io/api/core/v1"
  21. "k8s.io/apimachinery/pkg/types"
  22. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  23. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  24. "github.com/external-secrets/external-secrets/pkg/provider"
  25. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  26. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  27. "github.com/external-secrets/external-secrets/pkg/utils"
  28. )
  29. const (
  30. VaultEndpointEnv = "ORACLE_VAULT_ENDPOINT"
  31. STSEndpointEnv = "ORACLE_STS_ENDPOINT"
  32. SVMEndpointEnv = "ORACLE_SVM_ENDPOINT"
  33. errOracleClient = "cannot setup new oracle client: %w"
  34. errORACLECredSecretName = "invalid oracle SecretStore resource: missing oracle APIKey"
  35. errUninitalizedOracleProvider = "provider oracle is not initialized"
  36. errInvalidClusterStoreMissingSKNamespace = "invalid ClusterStore, missing namespace"
  37. errFetchSAKSecret = "could not fetch SecretAccessKey secret: %w"
  38. errMissingPK = "missing PrivateKey"
  39. errMissingUser = "missing User ID"
  40. errMissingTenancy = "missing Tenancy ID"
  41. errMissingRegion = "missing Region"
  42. errMissingFingerprint = "missing Fingerprint"
  43. errJSONSecretUnmarshal = "unable to unmarshal secret: %w"
  44. errMissingKey = "missing Key in secret: %s"
  45. errUnexpectedContent = "unexpected secret bundle content"
  46. )
  47. type client struct {
  48. kube kclient.Client
  49. store *esv1alpha1.OracleProvider
  50. namespace string
  51. storeKind string
  52. tenancy string
  53. user string
  54. region string
  55. fingerprint string
  56. privateKey string
  57. }
  58. type VaultManagementService struct {
  59. Client VMInterface
  60. }
  61. type VMInterface interface {
  62. GetSecretBundle(ctx context.Context, request secrets.GetSecretBundleRequest) (response secrets.GetSecretBundleResponse, err error)
  63. }
  64. func (c *client) setAuth(ctx context.Context) error {
  65. credentialsSecret := &corev1.Secret{}
  66. credentialsSecretName := c.store.Auth.SecretRef.PrivateKey.Name
  67. if credentialsSecretName == "" {
  68. return fmt.Errorf(errORACLECredSecretName)
  69. }
  70. objectKey := types.NamespacedName{
  71. Name: credentialsSecretName,
  72. Namespace: c.namespace,
  73. }
  74. // only ClusterStore is allowed to set namespace (and then it's required)
  75. if c.storeKind == esv1alpha1.ClusterSecretStoreKind {
  76. if c.store.Auth.SecretRef.PrivateKey.Namespace == nil {
  77. return fmt.Errorf(errInvalidClusterStoreMissingSKNamespace)
  78. }
  79. objectKey.Namespace = *c.store.Auth.SecretRef.PrivateKey.Namespace
  80. }
  81. err := c.kube.Get(ctx, objectKey, credentialsSecret)
  82. if err != nil {
  83. return fmt.Errorf(errFetchSAKSecret, err)
  84. }
  85. c.privateKey = string(credentialsSecret.Data[c.store.Auth.SecretRef.PrivateKey.Key])
  86. if c.privateKey == "" {
  87. return fmt.Errorf(errMissingPK)
  88. }
  89. c.fingerprint = string(credentialsSecret.Data[c.store.Auth.SecretRef.Fingerprint.Key])
  90. if c.fingerprint == "" {
  91. return fmt.Errorf(errMissingFingerprint)
  92. }
  93. c.user = c.store.User
  94. if c.user == "" {
  95. return fmt.Errorf(errMissingUser)
  96. }
  97. c.tenancy = c.store.Tenancy
  98. if c.tenancy == "" {
  99. return fmt.Errorf(errMissingTenancy)
  100. }
  101. c.region = c.store.Region
  102. if c.region == "" {
  103. return fmt.Errorf(errMissingRegion)
  104. }
  105. return nil
  106. }
  107. func (vms *VaultManagementService) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  108. if utils.IsNil(vms.Client) {
  109. return nil, fmt.Errorf(errUninitalizedOracleProvider)
  110. }
  111. sec, err := vms.Client.GetSecretBundle(ctx, secrets.GetSecretBundleRequest{
  112. SecretId: &ref.Key,
  113. Stage: secrets.GetSecretBundleStageEnum(ref.Version),
  114. })
  115. if err != nil {
  116. return nil, util.SanitizeErr(err)
  117. }
  118. // TODO: should bt.Content be base64 decoded??
  119. bt, ok := sec.SecretBundleContent.(secrets.Base64SecretBundleContentDetails)
  120. if !ok {
  121. return nil, fmt.Errorf(errUnexpectedContent)
  122. }
  123. payload := *bt.Content
  124. if ref.Property == "" {
  125. return []byte(payload), nil
  126. }
  127. val := gjson.Get(payload, ref.Property)
  128. if !val.Exists() {
  129. return nil, fmt.Errorf(errMissingKey, ref.Key)
  130. }
  131. return []byte(val.String()), nil
  132. }
  133. func (vms *VaultManagementService) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  134. data, err := vms.GetSecret(ctx, ref)
  135. if err != nil {
  136. return nil, err
  137. }
  138. kv := make(map[string]string)
  139. err = json.Unmarshal(data, &kv)
  140. if err != nil {
  141. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  142. }
  143. secretData := make(map[string][]byte)
  144. for k, v := range kv {
  145. secretData[k] = []byte(v)
  146. }
  147. return secretData, nil
  148. }
  149. // NewClient constructs a new secrets client based on the provided store.
  150. func (vms *VaultManagementService) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  151. storeSpec := store.GetSpec()
  152. oracleSpec := storeSpec.Provider.Oracle
  153. oracleStore := &client{
  154. kube: kube,
  155. store: oracleSpec,
  156. namespace: namespace,
  157. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  158. }
  159. if err := oracleStore.setAuth(ctx); err != nil {
  160. return nil, err
  161. }
  162. oracleTenancy := oracleStore.tenancy
  163. oracleUser := oracleStore.user
  164. oracleRegion := oracleStore.region
  165. oracleFingerprint := oracleStore.fingerprint
  166. oraclePrivateKey := oracleStore.privateKey
  167. configurationProvider := common.NewRawConfigurationProvider(oracleTenancy, oracleUser, oracleRegion, oracleFingerprint, oraclePrivateKey, nil)
  168. secretManagementService, err := secrets.NewSecretsClientWithConfigurationProvider(configurationProvider)
  169. if err != nil {
  170. return nil, fmt.Errorf(errOracleClient, err)
  171. }
  172. vms.Client = secretManagementService
  173. return vms, nil
  174. }
  175. func (vms *VaultManagementService) Close(ctx context.Context) error {
  176. return nil
  177. }
  178. func init() {
  179. schema.Register(&VaultManagementService{}, &esv1alpha1.SecretStoreProvider{
  180. Oracle: &esv1alpha1.OracleProvider{},
  181. })
  182. }