kms.go 6.7 KB

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