kms.go 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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 alibaba
  13. import (
  14. "context"
  15. "encoding/json"
  16. "fmt"
  17. kmssdk "github.com/aliyun/alibaba-cloud-sdk-go/services/kms"
  18. "github.com/tidwall/gjson"
  19. corev1 "k8s.io/api/core/v1"
  20. "k8s.io/apimachinery/pkg/types"
  21. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  22. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  23. "github.com/external-secrets/external-secrets/pkg/provider"
  24. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  25. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  26. "github.com/external-secrets/external-secrets/pkg/utils"
  27. )
  28. const (
  29. errAlibabaClient = "cannot setup new Alibaba client: %w"
  30. errAlibabaCredSecretName = "invalid Alibaba SecretStore resource: missing Alibaba APIKey"
  31. errUninitalizedAlibabaProvider = "provider Alibaba is not initialized"
  32. errInvalidClusterStoreMissingAKIDNamespace = "invalid ClusterStore, missing AccessKeyID namespace"
  33. errInvalidClusterStoreMissingSKNamespace = "invalid ClusterStore, missing namespace"
  34. errFetchAKIDSecret = "could not fetch AccessKeyID secret: %w"
  35. errMissingSAK = "missing AccessSecretKey"
  36. errMissingAKID = "missing AccessKeyID"
  37. )
  38. type Client struct {
  39. kube kclient.Client
  40. store *esv1alpha1.AlibabaProvider
  41. namespace string
  42. storeKind string
  43. regionID string
  44. keyID []byte
  45. accessKey []byte
  46. }
  47. type KeyManagementService struct {
  48. Client SMInterface
  49. }
  50. type SMInterface interface {
  51. GetSecretValue(request *kmssdk.GetSecretValueRequest) (response *kmssdk.GetSecretValueResponse, err error)
  52. }
  53. // setAuth creates a new Alibaba session based on a store.
  54. func (c *Client) setAuth(ctx context.Context) error {
  55. credentialsSecret := &corev1.Secret{}
  56. credentialsSecretName := c.store.Auth.SecretRef.AccessKeyID.Name
  57. if credentialsSecretName == "" {
  58. return fmt.Errorf(errAlibabaCredSecretName)
  59. }
  60. objectKey := types.NamespacedName{
  61. Name: credentialsSecretName,
  62. Namespace: c.namespace,
  63. }
  64. // only ClusterStore is allowed to set namespace (and then it's required)
  65. if c.storeKind == esv1alpha1.ClusterSecretStoreKind {
  66. if c.store.Auth.SecretRef.AccessKeyID.Namespace == nil {
  67. return fmt.Errorf(errInvalidClusterStoreMissingAKIDNamespace)
  68. }
  69. objectKey.Namespace = *c.store.Auth.SecretRef.AccessKeyID.Namespace
  70. }
  71. err := c.kube.Get(ctx, objectKey, credentialsSecret)
  72. if err != nil {
  73. return fmt.Errorf(errFetchAKIDSecret, err)
  74. }
  75. objectKey = types.NamespacedName{
  76. Name: c.store.Auth.SecretRef.AccessKeySecret.Name,
  77. Namespace: c.namespace,
  78. }
  79. if c.storeKind == esv1alpha1.ClusterSecretStoreKind {
  80. if c.store.Auth.SecretRef.AccessKeySecret.Namespace == nil {
  81. return fmt.Errorf(errInvalidClusterStoreMissingSKNamespace)
  82. }
  83. objectKey.Namespace = *c.store.Auth.SecretRef.AccessKeySecret.Namespace
  84. }
  85. c.keyID = credentialsSecret.Data[c.store.Auth.SecretRef.AccessKeyID.Key]
  86. fmt.Println(c.keyID)
  87. fmt.Println(c.accessKey)
  88. if (c.keyID == nil) || (len(c.keyID) == 0) {
  89. return fmt.Errorf(errMissingAKID)
  90. }
  91. c.accessKey = credentialsSecret.Data[c.store.Auth.SecretRef.AccessKeySecret.Key]
  92. if (c.accessKey == nil) || (len(c.accessKey) == 0) {
  93. return fmt.Errorf(errMissingSAK)
  94. }
  95. c.regionID = c.store.RegionID
  96. return nil
  97. }
  98. // GetSecret returns a single secret from the provider.
  99. func (kms *KeyManagementService) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  100. if utils.IsNil(kms.Client) {
  101. return nil, fmt.Errorf(errUninitalizedAlibabaProvider)
  102. }
  103. kmsRequest := kmssdk.CreateGetSecretValueRequest()
  104. kmsRequest.VersionId = ref.Version
  105. kmsRequest.SecretName = ref.Key
  106. kmsRequest.SetScheme("https")
  107. secretOut, err := kms.Client.GetSecretValue(kmsRequest)
  108. if err != nil {
  109. return nil, util.SanitizeErr(err)
  110. }
  111. if ref.Property == "" {
  112. if secretOut.SecretData != "" {
  113. return []byte(secretOut.SecretData), nil
  114. }
  115. return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
  116. }
  117. var payload string
  118. if secretOut.SecretData != "" {
  119. payload = secretOut.SecretData
  120. }
  121. val := gjson.Get(payload, ref.Property)
  122. if !val.Exists() {
  123. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  124. }
  125. return []byte(val.String()), nil
  126. }
  127. // Implements store.Client.GetAllSecrets Interface.
  128. // New version of GetAllSecrets.
  129. func (kms *KeyManagementService) GetAllSecrets(ctx context.Context, ref esv1alpha1.ExternalSecretDataFromRemoteRef) (map[string][]byte, error) {
  130. // TO be implemented
  131. return map[string][]byte{}, nil
  132. }
  133. // GetSecretMap returns multiple k/v pairs from the provider.
  134. func (kms *KeyManagementService) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataFromRemoteRef) (map[string][]byte, error) {
  135. data, err := kms.GetSecret(ctx, ref.GetDataRemoteRef())
  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("unable to unmarshal secret %s: %w", ref.Extract.Key, 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 (kms *KeyManagementService) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  152. storeSpec := store.GetSpec()
  153. alibabaSpec := storeSpec.Provider.Alibaba
  154. iStore := &Client{
  155. kube: kube,
  156. store: alibabaSpec,
  157. namespace: namespace,
  158. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  159. }
  160. if err := iStore.setAuth(ctx); err != nil {
  161. return nil, err
  162. }
  163. alibabaRegion := iStore.regionID
  164. alibabaKeyID := iStore.keyID
  165. alibabaSecretKey := iStore.accessKey
  166. keyManagementService, err := kmssdk.NewClientWithAccessKey(alibabaRegion, string(alibabaKeyID), string(alibabaSecretKey))
  167. if err != nil {
  168. return nil, fmt.Errorf(errAlibabaClient, err)
  169. }
  170. kms.Client = keyManagementService
  171. return kms, nil
  172. }
  173. func (kms *KeyManagementService) Close(ctx context.Context) error {
  174. return nil
  175. }
  176. func init() {
  177. schema.Register(&KeyManagementService{}, &esv1alpha1.SecretStoreProvider{
  178. Alibaba: &esv1alpha1.AlibabaProvider{},
  179. })
  180. }