kms.go 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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. // https://github.com/external-secrets/external-secrets/issues/644
  46. var _ esv1beta1.SecretsClient = &KeyManagementService{}
  47. var _ esv1beta1.Provider = &KeyManagementService{}
  48. type KeyManagementService struct {
  49. Client SMInterface
  50. }
  51. type SMInterface interface {
  52. GetSecretValue(request *kmssdk.GetSecretValueRequest) (response *kmssdk.GetSecretValueResponse, err error)
  53. }
  54. // setAuth creates a new Alibaba session based on a store.
  55. func (c *Client) setAuth(ctx context.Context) error {
  56. credentialsSecret := &corev1.Secret{}
  57. credentialsSecretName := c.store.Auth.SecretRef.AccessKeyID.Name
  58. if credentialsSecretName == "" {
  59. return fmt.Errorf(errAlibabaCredSecretName)
  60. }
  61. objectKey := types.NamespacedName{
  62. Name: credentialsSecretName,
  63. Namespace: c.namespace,
  64. }
  65. // only ClusterStore is allowed to set namespace (and then it's required)
  66. if c.storeKind == esv1beta1.ClusterSecretStoreKind {
  67. if c.store.Auth.SecretRef.AccessKeyID.Namespace == nil {
  68. return fmt.Errorf(errInvalidClusterStoreMissingAKIDNamespace)
  69. }
  70. objectKey.Namespace = *c.store.Auth.SecretRef.AccessKeyID.Namespace
  71. }
  72. err := c.kube.Get(ctx, objectKey, credentialsSecret)
  73. if err != nil {
  74. return fmt.Errorf(errFetchAKIDSecret, err)
  75. }
  76. objectKey = types.NamespacedName{
  77. Name: c.store.Auth.SecretRef.AccessKeySecret.Name,
  78. Namespace: c.namespace,
  79. }
  80. if c.storeKind == esv1beta1.ClusterSecretStoreKind {
  81. if c.store.Auth.SecretRef.AccessKeySecret.Namespace == nil {
  82. return fmt.Errorf(errInvalidClusterStoreMissingSKNamespace)
  83. }
  84. objectKey.Namespace = *c.store.Auth.SecretRef.AccessKeySecret.Namespace
  85. }
  86. c.keyID = credentialsSecret.Data[c.store.Auth.SecretRef.AccessKeyID.Key]
  87. fmt.Println(c.keyID)
  88. fmt.Println(c.accessKey)
  89. if (c.keyID == nil) || (len(c.keyID) == 0) {
  90. return fmt.Errorf(errMissingAKID)
  91. }
  92. c.accessKey = credentialsSecret.Data[c.store.Auth.SecretRef.AccessKeySecret.Key]
  93. if (c.accessKey == nil) || (len(c.accessKey) == 0) {
  94. return fmt.Errorf(errMissingSAK)
  95. }
  96. c.regionID = c.store.RegionID
  97. return nil
  98. }
  99. // Empty GetAllSecrets.
  100. func (kms *KeyManagementService) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  101. // TO be implemented
  102. return nil, fmt.Errorf("GetAllSecrets not implemented")
  103. }
  104. // GetSecret returns a single secret from the provider.
  105. func (kms *KeyManagementService) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  106. if utils.IsNil(kms.Client) {
  107. return nil, fmt.Errorf(errUninitalizedAlibabaProvider)
  108. }
  109. kmsRequest := kmssdk.CreateGetSecretValueRequest()
  110. kmsRequest.VersionId = ref.Version
  111. kmsRequest.SecretName = ref.Key
  112. kmsRequest.SetScheme("https")
  113. secretOut, err := kms.Client.GetSecretValue(kmsRequest)
  114. if err != nil {
  115. return nil, util.SanitizeErr(err)
  116. }
  117. if ref.Property == "" {
  118. if secretOut.SecretData != "" {
  119. return []byte(secretOut.SecretData), nil
  120. }
  121. return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
  122. }
  123. var payload string
  124. if secretOut.SecretData != "" {
  125. payload = secretOut.SecretData
  126. }
  127. val := gjson.Get(payload, ref.Property)
  128. if !val.Exists() {
  129. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  130. }
  131. return []byte(val.String()), nil
  132. }
  133. // GetSecretMap returns multiple k/v pairs from the provider.
  134. func (kms *KeyManagementService) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  135. data, err := kms.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("unable to unmarshal secret %s: %w", ref.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 esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.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 (kms *KeyManagementService) Validate() error {
  177. return nil
  178. }
  179. func (kms *KeyManagementService) ValidateStore(store esv1beta1.GenericStore) error {
  180. return nil
  181. }
  182. func init() {
  183. esv1beta1.Register(&KeyManagementService{}, &esv1beta1.SecretStoreProvider{
  184. Alibaba: &esv1beta1.AlibabaProvider{},
  185. })
  186. }