fakeclient.go 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. /*
  2. Copyright © The ESO Authors
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package client
  14. import (
  15. "context"
  16. "errors"
  17. "time"
  18. "github.com/go-logr/logr"
  19. "github.com/google/go-cmp/cmp"
  20. "github.com/google/go-cmp/cmp/cmpopts"
  21. "github.com/google/uuid"
  22. api "github.com/yandex-cloud/go-genproto/yandex/cloud/lockbox/v1"
  23. "github.com/yandex-cloud/go-sdk/iamkey"
  24. ydxcommon "github.com/external-secrets/external-secrets/providers/v1/yandex/common"
  25. "github.com/external-secrets/external-secrets/providers/v1/yandex/common/clock"
  26. )
  27. // Fake implementation of LockboxClient.
  28. type fakeLockboxClient struct {
  29. fakeLockboxServer *FakeLockboxServer
  30. }
  31. // NewFakeLockboxClient creates a new fake LockboxClient.
  32. func NewFakeLockboxClient(fakeLockboxServer *FakeLockboxServer) LockboxClient {
  33. return &fakeLockboxClient{fakeLockboxServer}
  34. }
  35. func (c *fakeLockboxClient) GetPayloadEntries(_ context.Context, iamToken, secretID, versionID string) ([]*api.Payload_Entry, error) {
  36. return c.fakeLockboxServer.getEntries(iamToken, secretID, versionID)
  37. }
  38. func (c *fakeLockboxClient) GetExPayload(_ context.Context, iamToken, folderID, name, versionID string) (map[string][]byte, error) {
  39. return c.fakeLockboxServer.getExPayload(iamToken, folderID, name, versionID)
  40. }
  41. // FakeLockboxServer fakes Yandex Lockbox service backend.
  42. type FakeLockboxServer struct {
  43. secretMap map[secretKey]secretValue // secret specific data
  44. versionMap map[versionKey]versionValue // version specific data
  45. tokenMap map[tokenKey]tokenValue // token specific data
  46. folderAndNameMap map[folderAndNameKey]folderAndNameValue // folderAndName specific data
  47. tokenExpirationDuration time.Duration
  48. clock clock.Clock
  49. logger logr.Logger
  50. }
  51. type secretKey struct {
  52. secretID string
  53. }
  54. type secretValue struct {
  55. expectedAuthorizedKey *iamkey.Key // authorized key expected to access the secret
  56. }
  57. type versionKey struct {
  58. secretID string
  59. versionID string
  60. }
  61. type versionValue struct {
  62. entries []*api.Payload_Entry
  63. }
  64. type folderAndNameKey struct {
  65. folderID string
  66. name string
  67. }
  68. type folderAndNameValue struct {
  69. secretID string
  70. }
  71. type tokenKey struct {
  72. token string
  73. }
  74. type tokenValue struct {
  75. authorizedKey *iamkey.Key
  76. expiresAt time.Time
  77. }
  78. // NewFakeLockboxServer creates a new FakeLockboxServer.
  79. func NewFakeLockboxServer(clock clock.Clock, tokenExpirationDuration time.Duration) *FakeLockboxServer {
  80. return &FakeLockboxServer{
  81. secretMap: make(map[secretKey]secretValue),
  82. versionMap: make(map[versionKey]versionValue),
  83. tokenMap: make(map[tokenKey]tokenValue),
  84. folderAndNameMap: make(map[folderAndNameKey]folderAndNameValue),
  85. tokenExpirationDuration: tokenExpirationDuration,
  86. clock: clock,
  87. }
  88. }
  89. // CreateSecret creates a new secret with the given entries in the fake server.
  90. func (s *FakeLockboxServer) CreateSecret(authorizedKey *iamkey.Key, folderID, name string, entries ...*api.Payload_Entry) (string, string) {
  91. secretID := uuid.NewString()
  92. versionID := uuid.NewString()
  93. s.secretMap[secretKey{secretID}] = secretValue{authorizedKey}
  94. s.versionMap[versionKey{secretID, ""}] = versionValue{entries} // empty versionID corresponds to the latest version
  95. s.versionMap[versionKey{secretID, versionID}] = versionValue{entries}
  96. if _, exists := s.folderAndNameMap[folderAndNameKey{folderID, name}]; exists {
  97. s.logger.Error(nil, "On the fake server, you cannot add two certificates with the same name in the same folder")
  98. }
  99. s.folderAndNameMap[folderAndNameKey{folderID, name}] = folderAndNameValue{secretID}
  100. return secretID, versionID
  101. }
  102. // AddVersion adds a new version with the given entries to an existing secret in the fake server.
  103. func (s *FakeLockboxServer) AddVersion(secretID string, entries ...*api.Payload_Entry) string {
  104. versionID := uuid.NewString()
  105. s.versionMap[versionKey{secretID, ""}] = versionValue{entries} // empty versionID corresponds to the latest version
  106. s.versionMap[versionKey{secretID, versionID}] = versionValue{entries}
  107. return versionID
  108. }
  109. // NewIamToken creates a new IAM token for the given authorized key.
  110. // The token is valid for the duration configured in FakeLockboxServer.
  111. func (s *FakeLockboxServer) NewIamToken(authorizedKey *iamkey.Key) *ydxcommon.IamToken {
  112. token := uuid.NewString()
  113. expiresAt := s.clock.CurrentTime().Add(s.tokenExpirationDuration)
  114. s.tokenMap[tokenKey{token}] = tokenValue{authorizedKey, expiresAt}
  115. return &ydxcommon.IamToken{Token: token, ExpiresAt: expiresAt}
  116. }
  117. func (s *FakeLockboxServer) getEntries(iamToken, secretID, versionID string) ([]*api.Payload_Entry, error) {
  118. if _, ok := s.secretMap[secretKey{secretID}]; !ok {
  119. return nil, errors.New("secret not found")
  120. }
  121. if _, ok := s.versionMap[versionKey{secretID, versionID}]; !ok {
  122. return nil, errors.New("version not found")
  123. }
  124. if _, ok := s.tokenMap[tokenKey{iamToken}]; !ok {
  125. return nil, errors.New("unauthenticated")
  126. }
  127. if s.tokenMap[tokenKey{iamToken}].expiresAt.Before(s.clock.CurrentTime()) {
  128. return nil, errors.New("iam token expired")
  129. }
  130. if !cmp.Equal(s.tokenMap[tokenKey{iamToken}].authorizedKey, s.secretMap[secretKey{secretID}].expectedAuthorizedKey, cmpopts.IgnoreUnexported(iamkey.Key{})) {
  131. return nil, errors.New("permission denied")
  132. }
  133. return s.versionMap[versionKey{secretID, versionID}].entries, nil
  134. }
  135. func (s *FakeLockboxServer) getExPayload(iamToken, folderID, name, versionID string) (map[string][]byte, error) {
  136. if _, ok := s.folderAndNameMap[folderAndNameKey{folderID, name}]; !ok {
  137. return nil, errors.New("secret not found")
  138. }
  139. secretID := s.folderAndNameMap[folderAndNameKey{folderID, name}].secretID
  140. if _, ok := s.versionMap[versionKey{secretID, versionID}]; !ok {
  141. return nil, errors.New("version not found")
  142. }
  143. if s.tokenMap[tokenKey{iamToken}].expiresAt.Before(s.clock.CurrentTime()) {
  144. return nil, errors.New("iam token expired")
  145. }
  146. if !cmp.Equal(s.tokenMap[tokenKey{iamToken}].authorizedKey, s.secretMap[secretKey{secretID}].expectedAuthorizedKey, cmpopts.IgnoreUnexported(iamkey.Key{})) {
  147. return nil, errors.New("permission denied")
  148. }
  149. entries := s.versionMap[versionKey{secretID, versionID}].entries
  150. out := make(map[string][]byte, len(entries))
  151. for _, e := range entries {
  152. switch e.Value.(type) {
  153. case *api.Payload_Entry_TextValue:
  154. out[e.Key] = []byte(e.GetTextValue())
  155. case *api.Payload_Entry_BinaryValue:
  156. out[e.Key] = e.GetBinaryValue()
  157. }
  158. }
  159. return out, nil
  160. }