akeyless.go 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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 akeyless
  13. import (
  14. "context"
  15. "encoding/json"
  16. "fmt"
  17. "strconv"
  18. "time"
  19. "github.com/akeylesslabs/akeyless-go/v2"
  20. "sigs.k8s.io/controller-runtime/pkg/client"
  21. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  22. "github.com/external-secrets/external-secrets/pkg/utils"
  23. )
  24. const (
  25. defaultAPIUrl = "https://api.akeyless.io"
  26. )
  27. // https://github.com/external-secrets/external-secrets/issues/644
  28. var _ esv1beta1.SecretsClient = &Akeyless{}
  29. var _ esv1beta1.Provider = &Provider{}
  30. // Provider satisfies the provider interface.
  31. type Provider struct{}
  32. // akeylessBase satisfies the provider.SecretsClient interface.
  33. type akeylessBase struct {
  34. kube client.Client
  35. store esv1beta1.GenericStore
  36. namespace string
  37. akeylessGwAPIURL string
  38. RestAPI *akeyless.V2ApiService
  39. }
  40. type Akeyless struct {
  41. Client akeylessVaultInterface
  42. url string
  43. }
  44. type akeylessVaultInterface interface {
  45. GetSecretByType(secretName, token string, version int32) (string, error)
  46. TokenFromSecretRef(ctx context.Context) (string, error)
  47. }
  48. func init() {
  49. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  50. Akeyless: &esv1beta1.AkeylessProvider{},
  51. })
  52. }
  53. // NewClient constructs a new secrets client based on the provided store.
  54. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string) (esv1beta1.SecretsClient, error) {
  55. return newClient(ctx, store, kube, namespace)
  56. }
  57. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) error {
  58. return nil
  59. }
  60. func newClient(_ context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string) (esv1beta1.SecretsClient, error) {
  61. akl := &akeylessBase{
  62. kube: kube,
  63. store: store,
  64. namespace: namespace,
  65. }
  66. spec, err := GetAKeylessProvider(store)
  67. if err != nil {
  68. return nil, err
  69. }
  70. akeylessGwAPIURL := defaultAPIUrl
  71. if spec != nil && spec.AkeylessGWApiURL != nil && *spec.AkeylessGWApiURL != "" {
  72. akeylessGwAPIURL = getV2Url(*spec.AkeylessGWApiURL)
  73. }
  74. if spec.Auth == nil {
  75. return nil, fmt.Errorf("missing Auth in store config")
  76. }
  77. RestAPIClient := akeyless.NewAPIClient(&akeyless.Configuration{
  78. Servers: []akeyless.ServerConfiguration{
  79. {
  80. URL: akeylessGwAPIURL,
  81. },
  82. },
  83. }).V2Api
  84. akl.akeylessGwAPIURL = akeylessGwAPIURL
  85. akl.RestAPI = RestAPIClient
  86. return &Akeyless{Client: akl, url: akeylessGwAPIURL}, nil
  87. }
  88. func (a *Akeyless) Close(ctx context.Context) error {
  89. return nil
  90. }
  91. func (a *Akeyless) Validate() (esv1beta1.ValidationResult, error) {
  92. timeout := 15 * time.Second
  93. url := a.url
  94. if err := utils.NetworkValidate(url, timeout); err != nil {
  95. return esv1beta1.ValidationResultError, err
  96. }
  97. return esv1beta1.ValidationResultReady, nil
  98. }
  99. // Implements store.Client.GetSecret Interface.
  100. // Retrieves a secret with the secret name defined in ref.Name.
  101. func (a *Akeyless) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  102. if utils.IsNil(a.Client) {
  103. return nil, fmt.Errorf(errUninitalizedAkeylessProvider)
  104. }
  105. token, err := a.Client.TokenFromSecretRef(ctx)
  106. if err != nil {
  107. return nil, err
  108. }
  109. version := int32(0)
  110. if ref.Version != "" {
  111. i, err := strconv.ParseInt(ref.Version, 10, 32)
  112. if err == nil {
  113. version = int32(i)
  114. }
  115. }
  116. value, err := a.Client.GetSecretByType(ref.Key, token, version)
  117. if err != nil {
  118. return nil, err
  119. }
  120. return []byte(value), nil
  121. }
  122. // Empty GetAllSecrets.
  123. func (a *Akeyless) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  124. // TO be implemented
  125. return nil, fmt.Errorf("GetAllSecrets not implemented")
  126. }
  127. // Implements store.Client.GetSecretMap Interface.
  128. // New version of GetSecretMap.
  129. func (a *Akeyless) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  130. if utils.IsNil(a.Client) {
  131. return nil, fmt.Errorf(errUninitalizedAkeylessProvider)
  132. }
  133. val, err := a.GetSecret(ctx, ref)
  134. if err != nil {
  135. return nil, err
  136. }
  137. // Maps the json data to a string:string map
  138. kv := make(map[string]string)
  139. err = json.Unmarshal(val, &kv)
  140. if err != nil {
  141. return nil, fmt.Errorf(errJSONSecretUnmarshal, err)
  142. }
  143. // Converts values in K:V pairs into bytes, while leaving keys as strings
  144. secretData := make(map[string][]byte)
  145. for k, v := range kv {
  146. secretData[k] = []byte(v)
  147. }
  148. return secretData, nil
  149. }