client.go 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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 delinea
  13. import (
  14. "context"
  15. "encoding/json"
  16. "errors"
  17. "fmt"
  18. "reflect"
  19. "strconv"
  20. "strings"
  21. "github.com/DelineaXPM/dsv-sdk-go/v2/vault"
  22. "github.com/tidwall/gjson"
  23. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  24. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  25. )
  26. const (
  27. errSecretKeyFmt = "cannot find secret data for key: %q"
  28. errUnexpectedKey = "unexpected key in data: %s"
  29. errSecretFormat = "secret data for property %s not in expected format: %s"
  30. )
  31. type client struct {
  32. api secretAPI
  33. }
  34. var _ esv1beta1.SecretsClient = &client{}
  35. // GetSecret supports two types:
  36. // 1. get the full secret as json-encoded value
  37. // by leaving the ref.Property empty.
  38. // 2. get a key from the secret.
  39. // Nested values are supported by specifying a gjson expression
  40. func (c *client) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  41. secret, err := c.getSecret(ctx, ref)
  42. if err != nil {
  43. return nil, err
  44. }
  45. // Return nil if secret value is null
  46. if secret.Data == nil {
  47. return nil, nil
  48. }
  49. jsonStr, err := json.Marshal(secret.Data)
  50. if err != nil {
  51. return nil, err
  52. }
  53. // return raw json if no property is defined
  54. if ref.Property == "" {
  55. return jsonStr, nil
  56. }
  57. // extract key from secret using gjson
  58. val := gjson.Get(string(jsonStr), ref.Property)
  59. if !val.Exists() {
  60. return nil, esv1beta1.NoSecretError{}
  61. }
  62. return []byte(val.String()), nil
  63. }
  64. func (c *client) PushSecret(_ context.Context, _ []byte, _ *apiextensionsv1.JSON, _ esv1beta1.PushRemoteRef) error {
  65. return errors.New("pushing secrets is not supported by Delinea DevOps Secrets Vault")
  66. }
  67. func (c *client) DeleteSecret(_ context.Context, _ esv1beta1.PushRemoteRef) error {
  68. return errors.New("deleting secrets is not supported by Delinea DevOps Secrets Vault")
  69. }
  70. func (c *client) Validate() (esv1beta1.ValidationResult, error) {
  71. return esv1beta1.ValidationResultReady, nil
  72. }
  73. // GetSecret gets the full secret as json-encoded value.
  74. func (c *client) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  75. secret, err := c.getSecret(ctx, ref)
  76. if err != nil {
  77. return nil, err
  78. }
  79. byteMap := make(map[string][]byte, len(secret.Data))
  80. for k := range secret.Data {
  81. byteMap[k], err = getTypedKey(secret.Data, k)
  82. if err != nil {
  83. return nil, err
  84. }
  85. }
  86. return byteMap, nil
  87. }
  88. // GetAllSecrets lists secrets matching the given criteria and return their latest versions.
  89. func (c *client) GetAllSecrets(_ context.Context, _ esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  90. return nil, errors.New("getting all secrets is not supported by Delinea DevOps Secrets Vault")
  91. }
  92. func (c *client) Close(context.Context) error {
  93. return nil
  94. }
  95. // getSecret retrieves the secret referenced by ref from the Vault API.
  96. func (c *client) getSecret(_ context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (*vault.Secret, error) {
  97. if ref.Version != "" {
  98. return nil, errors.New("specifying a version is not yet supported")
  99. }
  100. return c.api.Secret(ref.Key)
  101. }
  102. // getTypedKey is copied from pkg/provider/vault/vault.go.
  103. func getTypedKey(data map[string]interface{}, key string) ([]byte, error) {
  104. v, ok := data[key]
  105. if !ok {
  106. return nil, fmt.Errorf(errUnexpectedKey, key)
  107. }
  108. switch t := v.(type) {
  109. case string:
  110. return []byte(t), nil
  111. case map[string]interface{}:
  112. return json.Marshal(t)
  113. case []string:
  114. return []byte(strings.Join(t, "\n")), nil
  115. case []byte:
  116. return t, nil
  117. // also covers int and float32 due to json.Marshal
  118. case float64:
  119. return []byte(strconv.FormatFloat(t, 'f', -1, 64)), nil
  120. case json.Number:
  121. return []byte(t.String()), nil
  122. case []interface{}:
  123. return json.Marshal(t)
  124. case bool:
  125. return []byte(strconv.FormatBool(t)), nil
  126. case nil:
  127. return []byte(nil), nil
  128. default:
  129. return nil, fmt.Errorf(errSecretFormat, key, reflect.TypeOf(t))
  130. }
  131. }