oracle.go 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  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/base64"
  16. "encoding/json"
  17. "fmt"
  18. "github.com/oracle/oci-go-sdk/v45/common"
  19. "github.com/oracle/oci-go-sdk/v45/secrets"
  20. "github.com/tidwall/gjson"
  21. corev1 "k8s.io/api/core/v1"
  22. "k8s.io/apimachinery/pkg/types"
  23. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  24. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  25. "github.com/external-secrets/external-secrets/pkg/provider"
  26. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  27. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  28. "github.com/external-secrets/external-secrets/pkg/utils"
  29. )
  30. const (
  31. VaultEndpointEnv = "ORACLE_VAULT_ENDPOINT"
  32. STSEndpointEnv = "ORACLE_STS_ENDPOINT"
  33. SVMEndpointEnv = "ORACLE_SVM_ENDPOINT"
  34. errOracleClient = "cannot setup new oracle client: %w"
  35. errORACLECredSecretName = "invalid oracle SecretStore resource: missing oracle APIKey"
  36. errUninitalizedOracleProvider = "provider oracle is not initialized"
  37. errInvalidClusterStoreMissingSKNamespace = "invalid ClusterStore, missing namespace"
  38. errFetchSAKSecret = "could not fetch SecretAccessKey secret: %w"
  39. errMissingPK = "missing PrivateKey"
  40. errMissingUser = "missing User ID"
  41. errMissingTenancy = "missing Tenancy ID"
  42. errMissingRegion = "missing Region"
  43. errMissingFingerprint = "missing Fingerprint"
  44. errMissingVault = "missing Vault"
  45. errJSONSecretUnmarshal = "unable to unmarshal secret: %w"
  46. errMissingKey = "missing Key in secret: %s"
  47. errUnexpectedContent = "unexpected secret bundle content"
  48. )
  49. type client struct {
  50. kube kclient.Client
  51. store *esv1alpha1.OracleProvider
  52. namespace string
  53. storeKind string
  54. tenancy string
  55. user string
  56. region string
  57. fingerprint string
  58. privateKey string
  59. }
  60. type VaultManagementService struct {
  61. Client VMInterface
  62. vault string
  63. }
  64. type VMInterface interface {
  65. GetSecretBundleByName(ctx context.Context, request secrets.GetSecretBundleByNameRequest) (secrets.GetSecretBundleByNameResponse, error)
  66. }
  67. func (c *client) setAuth(ctx context.Context) error {
  68. credentialsSecret := &corev1.Secret{}
  69. credentialsSecretName := c.store.Auth.SecretRef.PrivateKey.Name
  70. if credentialsSecretName == "" {
  71. return fmt.Errorf(errORACLECredSecretName)
  72. }
  73. objectKey := types.NamespacedName{
  74. Name: credentialsSecretName,
  75. Namespace: c.namespace,
  76. }
  77. // only ClusterStore is allowed to set namespace (and then it's required)
  78. if c.storeKind == esv1alpha1.ClusterSecretStoreKind {
  79. if c.store.Auth.SecretRef.PrivateKey.Namespace == nil {
  80. return fmt.Errorf(errInvalidClusterStoreMissingSKNamespace)
  81. }
  82. objectKey.Namespace = *c.store.Auth.SecretRef.PrivateKey.Namespace
  83. }
  84. err := c.kube.Get(ctx, objectKey, credentialsSecret)
  85. if err != nil {
  86. return fmt.Errorf(errFetchSAKSecret, err)
  87. }
  88. c.privateKey = string(credentialsSecret.Data[c.store.Auth.SecretRef.PrivateKey.Key])
  89. if c.privateKey == "" {
  90. return fmt.Errorf(errMissingPK)
  91. }
  92. c.fingerprint = string(credentialsSecret.Data[c.store.Auth.SecretRef.Fingerprint.Key])
  93. if c.fingerprint == "" {
  94. return fmt.Errorf(errMissingFingerprint)
  95. }
  96. c.user = c.store.User
  97. if c.user == "" {
  98. return fmt.Errorf(errMissingUser)
  99. }
  100. c.tenancy = c.store.Tenancy
  101. if c.tenancy == "" {
  102. return fmt.Errorf(errMissingTenancy)
  103. }
  104. c.region = c.store.Region
  105. if c.region == "" {
  106. return fmt.Errorf(errMissingRegion)
  107. }
  108. return nil
  109. }
  110. func (vms *VaultManagementService) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  111. if utils.IsNil(vms.Client) {
  112. return nil, fmt.Errorf(errUninitalizedOracleProvider)
  113. }
  114. sec, err := vms.Client.GetSecretBundleByName(ctx, secrets.GetSecretBundleByNameRequest{
  115. VaultId: &vms.vault,
  116. SecretName: &ref.Key,
  117. Stage: secrets.GetSecretBundleByNameStageEnum(ref.Version),
  118. })
  119. if err != nil {
  120. return nil, util.SanitizeErr(err)
  121. }
  122. bt, ok := sec.SecretBundleContent.(secrets.Base64SecretBundleContentDetails)
  123. if !ok {
  124. return nil, fmt.Errorf(errUnexpectedContent)
  125. }
  126. payload, err := base64.StdEncoding.DecodeString(*bt.Content)
  127. if err != nil {
  128. return nil, err
  129. }
  130. if ref.Property == "" {
  131. return payload, nil
  132. }
  133. val := gjson.Get(string(payload), ref.Property)
  134. if !val.Exists() {
  135. return nil, fmt.Errorf(errMissingKey, ref.Key)
  136. }
  137. return []byte(val.String()), nil
  138. }
  139. func (vms *VaultManagementService) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  140. data, err := vms.GetSecret(ctx, ref)
  141. if err != nil {
  142. return nil, err
  143. }
  144. kv := make(map[string]string)
  145. err = json.Unmarshal(data, &kv)
  146. if err != nil {
  147. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  148. }
  149. secretData := make(map[string][]byte)
  150. for k, v := range kv {
  151. secretData[k] = []byte(v)
  152. }
  153. return secretData, nil
  154. }
  155. // NewClient constructs a new secrets client based on the provided store.
  156. func (vms *VaultManagementService) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  157. storeSpec := store.GetSpec()
  158. oracleSpec := storeSpec.Provider.Oracle
  159. if oracleSpec.Vault == "" {
  160. return nil, fmt.Errorf(errMissingVault)
  161. }
  162. oracleStore := &client{
  163. kube: kube,
  164. store: oracleSpec,
  165. namespace: namespace,
  166. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  167. }
  168. if err := oracleStore.setAuth(ctx); err != nil {
  169. return nil, err
  170. }
  171. oracleTenancy := oracleStore.tenancy
  172. oracleUser := oracleStore.user
  173. oracleRegion := oracleStore.region
  174. oracleFingerprint := oracleStore.fingerprint
  175. oraclePrivateKey := oracleStore.privateKey
  176. configurationProvider := common.NewRawConfigurationProvider(oracleTenancy, oracleUser, oracleRegion, oracleFingerprint, oraclePrivateKey, nil)
  177. secretManagementService, err := secrets.NewSecretsClientWithConfigurationProvider(configurationProvider)
  178. if err != nil {
  179. return nil, fmt.Errorf(errOracleClient, err)
  180. }
  181. return &VaultManagementService{
  182. Client: secretManagementService,
  183. vault: oracleSpec.Vault,
  184. }, nil
  185. }
  186. func (vms *VaultManagementService) Close(ctx context.Context) error {
  187. return nil
  188. }
  189. func init() {
  190. schema.Register(&VaultManagementService{}, &esv1alpha1.SecretStoreProvider{
  191. Oracle: &esv1alpha1.OracleProvider{},
  192. })
  193. }