oracle.go 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  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. errInvalidSecret = "invalid secret received. no secret string nor binary for key: %s"
  47. )
  48. type client struct {
  49. kube kclient.Client
  50. store *esv1alpha1.OracleProvider
  51. namespace string
  52. storeKind string
  53. tenancy string
  54. user string
  55. region string
  56. fingerprint string
  57. privateKey string
  58. }
  59. type VaultManagementService struct {
  60. Client VMInterface
  61. }
  62. type VMInterface interface {
  63. GetSecretBundle(ctx context.Context, request secrets.GetSecretBundleRequest) (response secrets.GetSecretBundleResponse, err error)
  64. }
  65. func (c *client) setAuth(ctx context.Context) error {
  66. credentialsSecret := &corev1.Secret{}
  67. credentialsSecretName := c.store.Auth.SecretRef.PrivateKey.Name
  68. if credentialsSecretName == "" {
  69. return fmt.Errorf(errORACLECredSecretName)
  70. }
  71. objectKey := types.NamespacedName{
  72. Name: credentialsSecretName,
  73. Namespace: c.namespace,
  74. }
  75. // only ClusterStore is allowed to set namespace (and then it's required)
  76. if c.storeKind == esv1alpha1.ClusterSecretStoreKind {
  77. if c.store.Auth.SecretRef.PrivateKey.Namespace == nil {
  78. return fmt.Errorf(errInvalidClusterStoreMissingSKNamespace)
  79. }
  80. objectKey.Namespace = *c.store.Auth.SecretRef.PrivateKey.Namespace
  81. }
  82. err := c.kube.Get(ctx, objectKey, credentialsSecret)
  83. if err != nil {
  84. return fmt.Errorf(errFetchSAKSecret, err)
  85. }
  86. c.privateKey = string(credentialsSecret.Data[c.store.Auth.SecretRef.PrivateKey.Key])
  87. if c.privateKey == "" {
  88. return fmt.Errorf(errMissingPK)
  89. }
  90. c.fingerprint = string(credentialsSecret.Data[c.store.Auth.SecretRef.Fingerprint.Key])
  91. if c.fingerprint == "" {
  92. return fmt.Errorf(errMissingFingerprint)
  93. }
  94. c.user = c.store.User
  95. if c.user == "" {
  96. return fmt.Errorf(errMissingUser)
  97. }
  98. c.tenancy = c.store.Tenancy
  99. if c.tenancy == "" {
  100. return fmt.Errorf(errMissingTenancy)
  101. }
  102. c.region = c.store.Region
  103. if c.region == "" {
  104. return fmt.Errorf(errMissingRegion)
  105. }
  106. return nil
  107. }
  108. func (vms *VaultManagementService) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  109. if utils.IsNil(vms.Client) {
  110. return nil, fmt.Errorf(errUninitalizedOracleProvider)
  111. }
  112. sec, err := vms.Client.GetSecretBundle(ctx, secrets.GetSecretBundleRequest{
  113. SecretId: &ref.Key,
  114. Stage: secrets.GetSecretBundleStageEnum(ref.Version),
  115. })
  116. if err != nil {
  117. return nil, util.SanitizeErr(err)
  118. }
  119. // TODO: should bt.Content be base64 decoded??
  120. bt, ok := sec.SecretBundleContent.(secrets.Base64SecretBundleContentDetails)
  121. if !ok {
  122. return nil, fmt.Errorf(errUnexpectedContent)
  123. }
  124. payload := *bt.Content
  125. if ref.Property == "" {
  126. return []byte(payload), nil
  127. }
  128. val := gjson.Get(payload, ref.Property)
  129. if !val.Exists() {
  130. return nil, fmt.Errorf(errMissingKey, ref.Key)
  131. }
  132. return []byte(val.String()), nil
  133. }
  134. func (vms *VaultManagementService) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  135. data, err := vms.GetSecret(ctx, ref)
  136. if err != nil {
  137. return nil, err
  138. }
  139. kv := make(map[string]string)
  140. err = json.Unmarshal(data, &kv)
  141. if err != nil {
  142. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  143. }
  144. secretData := make(map[string][]byte)
  145. for k, v := range kv {
  146. secretData[k] = []byte(v)
  147. }
  148. return secretData, nil
  149. }
  150. // NewClient constructs a new secrets client based on the provided store.
  151. func (vms *VaultManagementService) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  152. storeSpec := store.GetSpec()
  153. oracleSpec := storeSpec.Provider.Oracle
  154. oracleStore := &client{
  155. kube: kube,
  156. store: oracleSpec,
  157. namespace: namespace,
  158. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  159. }
  160. if err := oracleStore.setAuth(ctx); err != nil {
  161. return nil, err
  162. }
  163. oracleTenancy := oracleStore.tenancy
  164. oracleUser := oracleStore.user
  165. oracleRegion := oracleStore.region
  166. oracleFingerprint := oracleStore.fingerprint
  167. oraclePrivateKey := oracleStore.privateKey
  168. configurationProvider := common.NewRawConfigurationProvider(oracleTenancy, oracleUser, oracleRegion, oracleFingerprint, oraclePrivateKey, nil)
  169. secretManagementService, err := secrets.NewSecretsClientWithConfigurationProvider(configurationProvider)
  170. if err != nil {
  171. return nil, fmt.Errorf(errOracleClient, err)
  172. }
  173. vms.Client = secretManagementService
  174. return vms, nil
  175. }
  176. func (vms *VaultManagementService) Close(ctx context.Context) error {
  177. return nil
  178. }
  179. func init() {
  180. schema.Register(&VaultManagementService{}, &esv1alpha1.SecretStoreProvider{
  181. Oracle: &esv1alpha1.OracleProvider{},
  182. })
  183. }