oracle.go 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  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. vault "github.com/oracle/oci-go-sdk/v45/vault"
  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. SecretsManagerEndpointEnv = "ORACLE_SECRETSMANAGER_ENDPOINT"
  31. STSEndpointEnv = "ORACLE_STS_ENDPOINT"
  32. SSMEndpointEnv = "ORACLE_SSM_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. errInvalidSecret = "invalid secret received. no secret string nor binary for key: %s"
  46. )
  47. type client struct {
  48. kube kclient.Client
  49. store *esv1alpha1.OracleProvider
  50. namespace string
  51. storeKind string
  52. credentials []byte
  53. tenancy string
  54. user string
  55. region string
  56. fingerprint string
  57. privateKey string
  58. }
  59. type KeyManagementService struct {
  60. Client SMInterface
  61. }
  62. type SMInterface interface {
  63. GetSecret(ctx context.Context, request vault.GetSecretRequest) (response vault.GetSecretResponse, 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 == "") || (len(c.privateKey) == 0) {
  88. return fmt.Errorf(errMissingPK)
  89. }
  90. c.fingerprint = string(credentialsSecret.Data[c.store.Auth.SecretRef.Fingerprint.Key])
  91. if (c.fingerprint == "") || (len(c.fingerprint) == 0) {
  92. return fmt.Errorf(errMissingFingerprint)
  93. }
  94. c.user = string(c.store.User)
  95. if (c.user == "") || (len(c.user) == 0) {
  96. return fmt.Errorf(errMissingUser)
  97. }
  98. c.tenancy = string(c.store.Tenancy)
  99. if (c.tenancy == "") || (len(c.tenancy) == 0) {
  100. return fmt.Errorf(errMissingTenancy)
  101. }
  102. c.region = string(c.store.Region)
  103. if (c.region == "") || (len(c.region) == 0) {
  104. return fmt.Errorf(errMissingRegion)
  105. }
  106. return nil
  107. }
  108. func (kms *KeyManagementService) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  109. if utils.IsNil(kms.Client) {
  110. return nil, fmt.Errorf(errUninitalizedOracleProvider)
  111. }
  112. kmsRequest := vault.GetSecretRequest{
  113. SecretId: &ref.Key,
  114. }
  115. secretOut, err := kms.Client.GetSecret(context.Background(), kmsRequest)
  116. if err != nil {
  117. return nil, util.SanitizeErr(err)
  118. }
  119. if ref.Property == "" {
  120. if *secretOut.SecretName != "" {
  121. return []byte(*secretOut.SecretName), nil
  122. }
  123. return nil, fmt.Errorf(errInvalidSecret, ref.Key)
  124. }
  125. var payload *string
  126. if secretOut.SecretName != nil {
  127. payload = secretOut.SecretName
  128. }
  129. payloadval := *payload
  130. val := gjson.Get(payloadval, ref.Property)
  131. if !val.Exists() {
  132. return nil, fmt.Errorf(errMissingKey, ref.Key)
  133. }
  134. return []byte(val.String()), nil
  135. }
  136. func (kms *KeyManagementService) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  137. data, err := kms.GetSecret(ctx, ref)
  138. if err != nil {
  139. return nil, err
  140. }
  141. kv := make(map[string]string)
  142. err = json.Unmarshal(data, &kv)
  143. if err != nil {
  144. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  145. }
  146. secretData := make(map[string][]byte)
  147. for k, v := range kv {
  148. secretData[k] = []byte(v)
  149. }
  150. return secretData, nil
  151. }
  152. //NewClient constructs a new secrets client based on the provided store.
  153. func (kms *KeyManagementService) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  154. storeSpec := store.GetSpec()
  155. oracleSpec := storeSpec.Provider.Oracle
  156. oracleStore := &client{
  157. kube: kube,
  158. store: oracleSpec,
  159. namespace: namespace,
  160. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  161. }
  162. if err := oracleStore.setAuth(ctx); err != nil {
  163. return nil, err
  164. }
  165. oracleTenancy := oracleStore.tenancy
  166. oracleUser := oracleStore.user
  167. oracleRegion := oracleStore.region
  168. oracleFingerprint := oracleStore.fingerprint
  169. oraclePrivateKey := oracleStore.privateKey
  170. configurationProvider := common.NewRawConfigurationProvider(oracleTenancy, oracleUser, oracleRegion, oracleFingerprint, oraclePrivateKey, nil)
  171. keyManagementService, err := vault.NewVaultsClientWithConfigurationProvider(configurationProvider)
  172. if err != nil {
  173. return nil, fmt.Errorf(errOracleClient, err)
  174. }
  175. kms.Client = keyManagementService
  176. return kms, nil
  177. }
  178. func (kms *KeyManagementService) Close(ctx context.Context) error {
  179. return nil
  180. }
  181. func init() {
  182. schema.Register(&KeyManagementService{}, &esv1alpha1.SecretStoreProvider{
  183. Oracle: &esv1alpha1.OracleProvider{},
  184. })
  185. }