akeyless.go 4.5 KB

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