akeyless.go 4.6 KB

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