vault_test.go 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401
  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 vault
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. "reflect"
  18. "strings"
  19. "testing"
  20. "github.com/google/go-cmp/cmp"
  21. vault "github.com/hashicorp/vault/api"
  22. corev1 "k8s.io/api/core/v1"
  23. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  24. typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
  25. "k8s.io/utils/pointer"
  26. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  27. clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
  28. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  29. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  30. utilfake "github.com/external-secrets/external-secrets/pkg/provider/util/fake"
  31. "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
  32. )
  33. const (
  34. tokenSecretName = "example-secret-token"
  35. secretDataString = "some-creds"
  36. )
  37. var (
  38. secretStorePath = "secret"
  39. )
  40. func makeValidSecretStoreWithVersion(v esv1beta1.VaultKVStoreVersion) *esv1beta1.SecretStore {
  41. return &esv1beta1.SecretStore{
  42. ObjectMeta: metav1.ObjectMeta{
  43. Name: "vault-store",
  44. Namespace: "default",
  45. },
  46. Spec: esv1beta1.SecretStoreSpec{
  47. Provider: &esv1beta1.SecretStoreProvider{
  48. Vault: &esv1beta1.VaultProvider{
  49. Server: "vault.example.com",
  50. Path: &secretStorePath,
  51. Version: v,
  52. Auth: esv1beta1.VaultAuth{
  53. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  54. Path: "kubernetes",
  55. Role: "kubernetes-auth-role",
  56. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  57. Name: "example-sa",
  58. },
  59. },
  60. },
  61. },
  62. },
  63. },
  64. }
  65. }
  66. func makeValidSecretStore() *esv1beta1.SecretStore {
  67. return makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2)
  68. }
  69. func makeValidSecretStoreWithCerts() *esv1beta1.SecretStore {
  70. return &esv1beta1.SecretStore{
  71. ObjectMeta: metav1.ObjectMeta{
  72. Name: "vault-store",
  73. Namespace: "default",
  74. },
  75. Spec: esv1beta1.SecretStoreSpec{
  76. Provider: &esv1beta1.SecretStoreProvider{
  77. Vault: &esv1beta1.VaultProvider{
  78. Server: "vault.example.com",
  79. Path: &secretStorePath,
  80. Version: esv1beta1.VaultKVStoreV2,
  81. Auth: esv1beta1.VaultAuth{
  82. Cert: &esv1beta1.VaultCertAuth{
  83. ClientCert: esmeta.SecretKeySelector{
  84. Name: "tls-auth-certs",
  85. Key: "tls.crt",
  86. },
  87. SecretRef: esmeta.SecretKeySelector{
  88. Name: "tls-auth-certs",
  89. Key: "tls.key",
  90. },
  91. },
  92. },
  93. },
  94. },
  95. },
  96. }
  97. }
  98. func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1beta1.SecretStore {
  99. store := makeSecretStore()
  100. caProvider := &esv1beta1.CAProvider{
  101. Name: "vault-cert",
  102. Key: "cert",
  103. }
  104. if isSecret {
  105. caProvider.Type = "Secret"
  106. } else {
  107. caProvider.Type = "ConfigMap"
  108. }
  109. store.Spec.Provider.Vault.CAProvider = caProvider
  110. return store
  111. }
  112. func makeInvalidClusterSecretStoreWithK8sCerts() *esv1beta1.ClusterSecretStore {
  113. return &esv1beta1.ClusterSecretStore{
  114. TypeMeta: metav1.TypeMeta{
  115. Kind: "ClusterSecretStore",
  116. },
  117. ObjectMeta: metav1.ObjectMeta{
  118. Name: "vault-store",
  119. Namespace: "default",
  120. },
  121. Spec: esv1beta1.SecretStoreSpec{
  122. Provider: &esv1beta1.SecretStoreProvider{
  123. Vault: &esv1beta1.VaultProvider{
  124. Server: "vault.example.com",
  125. Path: &secretStorePath,
  126. Version: "v2",
  127. Auth: esv1beta1.VaultAuth{
  128. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  129. Path: "kubernetes",
  130. Role: "kubernetes-auth-role",
  131. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  132. Name: "example-sa",
  133. },
  134. },
  135. },
  136. CAProvider: &esv1beta1.CAProvider{
  137. Name: "vault-cert",
  138. Key: "cert",
  139. Type: "Secret",
  140. },
  141. },
  142. },
  143. },
  144. }
  145. }
  146. type secretStoreTweakFn func(s *esv1beta1.SecretStore)
  147. func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1beta1.SecretStore {
  148. store := makeValidSecretStore()
  149. for _, fn := range tweaks {
  150. fn(store)
  151. }
  152. return store
  153. }
  154. type args struct {
  155. newClientFunc func(c *vault.Config) (Client, error)
  156. store esv1beta1.GenericStore
  157. kube kclient.Client
  158. corev1 typedcorev1.CoreV1Interface
  159. ns string
  160. }
  161. type want struct {
  162. err error
  163. }
  164. type testCase struct {
  165. reason string
  166. args args
  167. want want
  168. }
  169. func clientWithLoginMock(c *vault.Config) (Client, error) {
  170. cl := fake.VaultClient{
  171. MockAuthToken: fake.NewAuthTokenFn(),
  172. MockSetToken: fake.NewSetTokenFn(),
  173. MockToken: fake.NewTokenFn(""),
  174. MockAuth: fake.NewVaultAuth(),
  175. MockLogical: fake.NewVaultLogical(),
  176. }
  177. auth := cl.Auth()
  178. token := cl.AuthToken()
  179. logical := cl.Logical()
  180. out := VClient{
  181. setToken: cl.SetToken,
  182. token: cl.Token,
  183. clearToken: cl.ClearToken,
  184. auth: auth,
  185. authToken: token,
  186. logical: logical,
  187. setNamespace: cl.SetNamespace,
  188. addHeader: cl.AddHeader,
  189. }
  190. return out, nil
  191. }
  192. func TestNewVault(t *testing.T) {
  193. errBoom := errors.New("boom")
  194. secretClientKey := []byte(`-----BEGIN PRIVATE KEY-----
  195. MIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCi4cG2CxHejOXaWW0Xri4PbWyuainurCZuULPLC0jJsJF0zkq778O7JleWzh7QhqVBKKIhW6LNUVS9tmGHfHC7ufaHr9YtadzVkiDzQKtA0Cgcco98CfX7bzn5pZn/yfnbRN/aTyxT5335DFhHc0/FCJn2Q/5H9UtX6LR3H3zbT9Io32T0B6OAUKKB/3uzxAECFwwSK8UqGUee8JKGBrU10XRAMGxOc1BOWYpCHWZRH2FRGIgS+bwYHOXUjPv6FH7qx+wCMzlxqd9LGvic2CpFE0BiEsOLIiY/qEqozvd2aOLVhBPjT/9LTXvRZwX/qA7h4YIsnq5N8lN4ytryb13N9fdRVgymVykGkaAmh5zA4DIg48ULWzOfdPwRQ1kVq2TRmj3IlcJsNn6MgHJTbRqvCdJMyA59FUZC9+QHfC307sV2aWPoVTwuUyD3pOFu4K0LV+OKIVQ8OTOqApbnL9dOLVx4wFVYE32lTC4tRdxUU8MKiPEoT19A+bLMPrZHnqXCIRzLwwfewICgTNYNuDHV93OmqJK4IXcF8UG00v+pRw+umqXNxNkk0x3grfX5w0sBGZbyuojYHnQQx6wZfUl3mEzJ2zlmCB1/2GKtXn6tIDmRxzeJ2bgaKTjG/uCv9OGtp1VLmn3b/3qC+he4fv/lGh/zd/i5JMVgMXM9MPRlWQIDAQABAoICAAec04fllo03Oprs6QtdSavQ6m5wactM4nLvdKe9vEYo6XNzHM0R1K0PirJyqcAHOvwDoSg79yzvay1+s6o4Z7BubZZD4pe2xep5bO7Ri+94ixdhR1F9ybBZr3T6h2sMDpBv9KJoZuL5A8s7B3k3a3gDAecfoGfOkBnot16F6zj4zxK39ijtnnelzSKURTzOoVluqFLFFu7zxYQpLD/1WkzMoElLuhQkkZFH4A1dAGY0OEEpC1sPrvnVh+xaNoCmqpPgiihEKqAkV1pURWBXPgqCbtTmmZsMGouJGwwuuCQhnNBr3t4V5BGp6mqMDRy4xxFJj+Lz+6OK+tm/aWJBUDn38JK1rQLCA5W3BxMoit4745VWxJc9PX068w6YwBRpqhfg94qZBZHxDe+nQBBEguQ5kBhoBpx60Wscrkjvr4ggb4fzuU6JxLDIDuE2HMIO+EZXl9HEwOB4ImmJhFxcxC8QTU7MnMJ05SuafZDGM2YdmvP2D/BfZf3DlWvVGOnbGh0vUSVLeS5qBBSNAoeG2UR4T3MCXLSaa9+GqIqzti+euPXXAUSYAC+y1qkqkE9rsPezMmKOJmybBIBf40hVLge8fIZPZuvMSW7Sykuex/EjIDfjohAj7GAkrzXOTKlnz7vZAv6Y3EUsoEiVKh5vot+p9xn/XEYH8+JMsVqAABH9AoIBAQDY8VwccTRzYjMoKxhWXdXKvCAAFumo8uUowpJnbbkZfTbf8+75zwi/XXHn9nm9ON/7tUrWAzwuUvtKz4AiHmwHt/IiicEC8Vlyl7N0X40pW/wtcFZJarFQAmVoRiZAzyszqggv3cwCcf8o1ugaBh1Q83RoT8Fz72yI+J70ldiGsu86aZY4V7ApzPH2OHdNbLUDTKkiMUrS6io5DzIeDx4x4riu+GAqm33nhnYdk1nwx/EATixPqwTN62n6XKhE5QysrKlO2pUEr0YXypN6ynRYiCBPsh8OvnB+2ibkgBNQRicSkOBoSMl/1BI35rwmARl/qUoypqJEUO4pgBsCBLBTAoIBAQDANMp+6rluPLGYXLf4vqT7Zlr1EgHIl0aBWzcqQlpVr6UrgHaFnw+q9T/wg+oFM7zMD02oPjGnsKyL8zaIveUCKSYQFjlznvLnFWeLMTbnrjkMrsN3aLriQ+7w6TXZVuGpA1W+DdChKl0z4BDJiMuHcZjiX4F9jFEB4xhvbH54e947Vk16GZVflSCqcBOAhH8DtGC/fQK76g1ndIHZjmUP8f2yQA7NaLhNbnZp0N2AvXOLBu+pDOaAKheENUOMRkDA+pNkEP0Krr0eW+P5o1iIuqK09ILytyECmUGd+VV6ePPsNAc/rKt0lF7Adg4Ay16hgPHHLbM7j+vsZd7KLU4jAoIBAE33SBRMtv30v8/i1QdNB+WpgJKnqWf3i1X/v1/+dfRsJMmNwEf1GP61VZd45D2V8CFlATUyynEXj4pOUo1wg4Cuog25li05kdz2Gh9rq66+iT3HTqtp9bl8cvdrppnKGouhwvl467XBRGNoANhBdE3AgQhwCWViGY6MU4wxQjT+n61NfxhWo1ASgK7tkiq4M8GwzmQkdPCiCXSiOm/FHSPuiFMRnnYRlckccNymNT+si7eBYLltC/f5cAfzPuIrs0dnch2NvtqFJ1qrih8qHXAn0/zwVesVlBZyzmF2ifpii+5HNO8loY0YKUf/24SJBqHztF/JtS16LG2rxYkPKFMCggEAT7yW1RgjXSwosQCmAbd1UiYgTdLuknzPbxKcTBfCyhFYADgG82ANa+raX7kZ+JaCGFWw7b7/coXEzzpSwV+mBcN0WvAdXW3vbxZeIkyEbpDEchJ+XKdCAGQWWDMnd8anTypnA7VPe8zLZZ3q2PC7HrFtr1vXqHHxmUrQ9EiaHvmkNBGVirXaVhDTwGFGdeaBmtPV3xrJa5Opg+W9iLeeDYNir/QLMAPlkZnl3fgcLDBsIpz6B7OmXD0aDGrcXvE2I9jQFI9HqorbQiD07rdpHy/uGAvn1zFJrH5Pzm2FnI1ZBACBkVTcvDxhIo7XOFUmKPIJW4wF8wu94BBS4KTy6QKCAQEAiG8TYUEAcCTpPzRC6oMc3uD0ukxJIYm94MbGts7j9cb+kULoxHN9BjPTeNMcq2dHFZoobLt33YmqcRbH4bRenBGAu1iGCGJsVDnwsnGrThuWwhlQQSVetGaIT7ODjuR2KA9ms/U0jpuYmcXFnQtAs9jhZ2Hx2GkWyQkcTEyQalwqAl3kCv05VYlRGOaYZA31xNyUnsjL0AMLzOAs0+t+IPM12l4FCEXV83m10J5DTFxpb12jWHRwGNmDlsk/Mknlj4uQEvmr9iopnpZnFOgi+jvRmx1CBmARXoMz5D/Hh/EVuCwJS1vIytYsHsml0x2yRxDYxD0V44p//HS/dG4SsQ==
  196. -----END PRIVATE KEY-----`)
  197. clientCrt := []byte(`-----BEGIN CERTIFICATE-----
  198. MIIFkTCCA3mgAwIBAgIUBEUg3m/WqAsWHG4Q/II3IePFfuowDQYJKoZIhvcNAQELBQAwWDELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDERMA8GA1UEAwwIdmF1bHQtY2EwHhcNMjIwNzI5MjEyMjE4WhcNMzkwMTAxMjEyMjE4WjBYMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMREwDwYDVQQDDAh2YXVsdC1jYTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAKLhwbYLEd6M5dpZbReuLg9tbK5qKe6sJm5Qs8sLSMmwkXTOSrvvw7smV5bOHtCGpUEooiFbos1RVL22YYd8cLu59oev1i1p3NWSIPNAq0DQKBxyj3wJ9ftvOfmlmf/J+dtE39pPLFPnffkMWEdzT8UImfZD/kf1S1fotHcffNtP0ijfZPQHo4BQooH/e7PEAQIXDBIrxSoZR57wkoYGtTXRdEAwbE5zUE5ZikIdZlEfYVEYiBL5vBgc5dSM+/oUfurH7AIzOXGp30sa+JzYKkUTQGISw4siJj+oSqjO93Zo4tWEE+NP/0tNe9FnBf+oDuHhgiyerk3yU3jK2vJvXc3191FWDKZXKQaRoCaHnMDgMiDjxQtbM590/BFDWRWrZNGaPciVwmw2foyAclNtGq8J0kzIDn0VRkL35Ad8LfTuxXZpY+hVPC5TIPek4W7grQtX44ohVDw5M6oClucv104tXHjAVVgTfaVMLi1F3FRTwwqI8ShPX0D5ssw+tkeepcIhHMvDB97AgKBM1g24MdX3c6aokrghdwXxQbTS/6lHD66apc3E2STTHeCt9fnDSwEZlvK6iNgedBDHrBl9SXeYTMnbOWYIHX/YYq1efq0gOZHHN4nZuBopOMb+4K/04a2nVUuafdv/eoL6F7h+/+UaH/N3+LkkxWAxcz0w9GVZAgMBAAGjUzBRMB0GA1UdDgQWBBQuIVwmjMZvkq+jf6ViTelH5KDBVDAfBgNVHSMEGDAWgBQuIVwmjMZvkq+jf6ViTelH5KDBVDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQAk4kNyFzmiKnREmi5PPj7xGAtv2aJIdMEfcZJ9e+H0Nb2aCvMvZsDodduXu6G5+1opd45v0AeTjLBkXDO6/8vnyM32VZEEKCAwMCLcOLD1z0+r+gaurDYMOGU5qr8hQadHKFsxEDYnR/9KdHhBg6A8qE2cOQa1ryu34DnWQ3m0CBApClf1YBRp/4T8BmHumfH6odD96H30HVzINrd9WM2hR9GRE3xqQyfwlvqmGn9S6snSVa+mcJ6w2wNE2LPGx0kOtBeOIUdfSsEgvSRjbowSHz9lohFZ0LxJYyizCA5vnMmYyhhkfJqm7YtjHkGWgXmqpH9BFt0D3gfORlIh787nuWfxtZ+554rDyQmPjYQG/qF4+Awehr4RxiGWTox1C67G/RzA6TOXX09xuFY+3U1ich90/KffvhoHvRVfhzxx+HUUY2qSU3HqQDzgieQQBaMuOhd1i6pua+/kPSXkuXqnIs8daao/goR5iU/lPLs7M8Dy7xZ9adzbIPuNuzHir2UuvtPlW+x/sSvOnVL9r/7TrAuWhdScglQ70EInPDVX7BgDWKrZUh86N4d7fu2f/T+6VoUSGEjq8obCj3BQ61mNEoftKVECUO4MMUdat6pY/4Xh6Dwc+FnbvR2+sX7IzI7FtgOrfO6abT+LCAR0R+UXyvnqZcjK2zkHz4DfXFbCQg==
  199. -----END CERTIFICATE-----`)
  200. secretData := []byte(secretDataString)
  201. cases := map[string]testCase{
  202. "InvalidVaultStore": {
  203. reason: "Should return error if given an invalid vault store.",
  204. args: args{
  205. store: &esv1beta1.SecretStore{},
  206. },
  207. want: want{
  208. err: errors.New(errVaultStore),
  209. },
  210. },
  211. "AddVaultStoreCertsError": {
  212. reason: "Should return error if given an invalid CA certificate.",
  213. args: args{
  214. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  215. s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
  216. }),
  217. },
  218. want: want{
  219. err: errors.New(errVaultCert),
  220. },
  221. },
  222. "VaultAuthFormatError": {
  223. reason: "Should return error if no valid authentication method is given.",
  224. args: args{
  225. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  226. s.Spec.Provider.Vault.Auth = esv1beta1.VaultAuth{}
  227. }),
  228. },
  229. want: want{
  230. err: errors.New(errAuthFormat),
  231. },
  232. },
  233. "GetKubeServiceAccountError": {
  234. reason: "Should return error if fetching kubernetes secret fails.",
  235. args: args{
  236. newClientFunc: clientWithLoginMock,
  237. ns: "default",
  238. kube: clientfake.NewClientBuilder().Build(),
  239. store: makeSecretStore(),
  240. corev1: utilfake.NewCreateTokenMock().WithError(errBoom),
  241. },
  242. want: want{
  243. err: fmt.Errorf(errGetKubeSATokenRequest, "example-sa", errBoom),
  244. },
  245. },
  246. "GetKubeSecretError": {
  247. reason: "Should return error if fetching kubernetes secret fails.",
  248. args: args{
  249. ns: "default",
  250. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  251. s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
  252. s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
  253. Name: "vault-secret",
  254. Key: "key",
  255. }
  256. }),
  257. kube: clientfake.NewClientBuilder().Build(),
  258. },
  259. want: want{
  260. err: fmt.Errorf(errGetKubeSecret, "vault-secret", errors.New("secrets \"vault-secret\" not found")),
  261. },
  262. },
  263. "SuccessfulVaultStoreWithCertAuth": {
  264. reason: "Should return a Vault provider successfully",
  265. args: args{
  266. store: makeValidSecretStoreWithCerts(),
  267. ns: "default",
  268. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  269. ObjectMeta: metav1.ObjectMeta{
  270. Name: "tls-auth-certs",
  271. Namespace: "default",
  272. },
  273. Data: map[string][]byte{
  274. "tls.key": secretClientKey,
  275. "tls.crt": clientCrt,
  276. },
  277. }).Build(),
  278. newClientFunc: clientWithLoginMock,
  279. },
  280. want: want{
  281. err: nil,
  282. },
  283. },
  284. "SuccessfulVaultStoreWithK8sCertSecret": {
  285. reason: "Should return a Vault prodvider with the cert from k8s",
  286. args: args{
  287. store: makeValidSecretStoreWithK8sCerts(true),
  288. ns: "default",
  289. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  290. ObjectMeta: metav1.ObjectMeta{
  291. Name: "vault-cert",
  292. Namespace: "default",
  293. },
  294. Data: map[string][]byte{
  295. "cert": clientCrt,
  296. "token": secretData,
  297. },
  298. }).Build(),
  299. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  300. newClientFunc: clientWithLoginMock,
  301. },
  302. want: want{
  303. err: nil,
  304. },
  305. },
  306. "GetCertNamespaceMissingError": {
  307. reason: "Should return an error if namespace is missing and is a ClusterSecretStore",
  308. args: args{
  309. store: makeInvalidClusterSecretStoreWithK8sCerts(),
  310. ns: "default",
  311. kube: clientfake.NewClientBuilder().Build(),
  312. },
  313. want: want{
  314. err: errors.New(errCANamespace),
  315. },
  316. },
  317. "GetCertSecretKeyMissingError": {
  318. reason: "Should return an error if the secret key is missing",
  319. args: args{
  320. store: makeValidSecretStoreWithK8sCerts(true),
  321. ns: "default",
  322. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  323. ObjectMeta: metav1.ObjectMeta{
  324. Name: "vault-cert",
  325. Namespace: "default",
  326. },
  327. Data: map[string][]byte{},
  328. }).Build(),
  329. newClientFunc: clientWithLoginMock,
  330. },
  331. want: want{
  332. err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
  333. },
  334. },
  335. "SuccessfulVaultStoreWithK8sCertConfigMap": {
  336. reason: "Should return a Vault prodvider with the cert from k8s",
  337. args: args{
  338. store: makeValidSecretStoreWithK8sCerts(false),
  339. ns: "default",
  340. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ConfigMap{
  341. ObjectMeta: metav1.ObjectMeta{
  342. Name: "vault-cert",
  343. },
  344. Data: map[string]string{
  345. "cert": string(clientCrt),
  346. },
  347. }).Build(),
  348. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  349. newClientFunc: clientWithLoginMock,
  350. },
  351. want: want{
  352. err: nil,
  353. },
  354. },
  355. "GetCertConfigMapMissingError": {
  356. reason: "Should return an error if the config map key is missing",
  357. args: args{
  358. store: makeValidSecretStoreWithK8sCerts(false),
  359. ns: "default",
  360. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
  361. ObjectMeta: metav1.ObjectMeta{
  362. Name: "example-sa",
  363. Namespace: "default",
  364. },
  365. Secrets: []corev1.ObjectReference{
  366. {
  367. Name: tokenSecretName,
  368. },
  369. },
  370. }, &corev1.ConfigMap{
  371. ObjectMeta: metav1.ObjectMeta{
  372. Name: "vault-cert",
  373. },
  374. Data: map[string]string{},
  375. }).Build(),
  376. newClientFunc: clientWithLoginMock,
  377. },
  378. want: want{
  379. err: fmt.Errorf(errConfigMapFmt, "cert"),
  380. },
  381. },
  382. "GetCertificateFormatError": {
  383. reason: "Should return error if client certificate is in wrong format.",
  384. args: args{
  385. store: makeValidSecretStoreWithCerts(),
  386. ns: "default",
  387. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  388. ObjectMeta: metav1.ObjectMeta{
  389. Name: "tls-auth-certs",
  390. Namespace: "default",
  391. },
  392. Data: map[string][]byte{
  393. "tls.key": secretClientKey,
  394. "tls.crt": []byte("cert with mistak"),
  395. },
  396. }).Build(),
  397. newClientFunc: clientWithLoginMock,
  398. },
  399. want: want{
  400. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
  401. },
  402. },
  403. "GetKeyFormatError": {
  404. reason: "Should return error if client key is in wrong format.",
  405. args: args{
  406. store: makeValidSecretStoreWithCerts(),
  407. ns: "default",
  408. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  409. ObjectMeta: metav1.ObjectMeta{
  410. Name: "tls-auth-certs",
  411. Namespace: "default",
  412. },
  413. Data: map[string][]byte{
  414. "tls.key": []byte("key with mistake"),
  415. "tls.crt": clientCrt,
  416. },
  417. }).Build(),
  418. newClientFunc: clientWithLoginMock,
  419. },
  420. want: want{
  421. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  422. },
  423. },
  424. }
  425. for name, tc := range cases {
  426. t.Run(name, func(t *testing.T) {
  427. vaultTest(t, name, tc)
  428. })
  429. }
  430. }
  431. func vaultTest(t *testing.T, name string, tc testCase) {
  432. conn := &connector{
  433. newVaultClient: tc.args.newClientFunc,
  434. }
  435. if tc.args.newClientFunc == nil {
  436. conn.newVaultClient = newVaultClient
  437. }
  438. _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
  439. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  440. t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
  441. }
  442. }
  443. func TestGetSecret(t *testing.T) {
  444. errBoom := errors.New("boom")
  445. secret := map[string]interface{}{
  446. "access_key": "access_key",
  447. "access_secret": "access_secret",
  448. }
  449. secretWithNilVal := map[string]interface{}{
  450. "access_key": "access_key",
  451. "access_secret": "access_secret",
  452. "token": nil,
  453. }
  454. secretWithNestedVal := map[string]interface{}{
  455. "access_key": "access_key",
  456. "access_secret": "access_secret",
  457. "nested.bar": "something different",
  458. "nested": map[string]string{
  459. "foo": "oke",
  460. "bar": "also ok?",
  461. },
  462. }
  463. type args struct {
  464. store *esv1beta1.VaultProvider
  465. kube kclient.Client
  466. vLogical Logical
  467. ns string
  468. data esv1beta1.ExternalSecretDataRemoteRef
  469. }
  470. type want struct {
  471. err error
  472. val []byte
  473. }
  474. cases := map[string]struct {
  475. reason string
  476. args args
  477. want want
  478. }{
  479. "ReadSecret": {
  480. reason: "Should return the secret with property",
  481. args: args{
  482. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  483. data: esv1beta1.ExternalSecretDataRemoteRef{
  484. Property: "access_key",
  485. },
  486. vLogical: &fake.Logical{
  487. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  488. },
  489. },
  490. want: want{
  491. err: nil,
  492. val: []byte("access_key"),
  493. },
  494. },
  495. "ReadSecretWithNil": {
  496. reason: "Should return the secret with property if it has a nil val",
  497. args: args{
  498. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  499. data: esv1beta1.ExternalSecretDataRemoteRef{
  500. Property: "access_key",
  501. },
  502. vLogical: &fake.Logical{
  503. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  504. },
  505. },
  506. want: want{
  507. err: nil,
  508. val: []byte("access_key"),
  509. },
  510. },
  511. "ReadSecretWithoutProperty": {
  512. reason: "Should return the json encoded secret without property",
  513. args: args{
  514. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  515. data: esv1beta1.ExternalSecretDataRemoteRef{},
  516. vLogical: &fake.Logical{
  517. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  518. },
  519. },
  520. want: want{
  521. err: nil,
  522. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  523. },
  524. },
  525. "ReadSecretWithNestedValue": {
  526. reason: "Should return a nested property",
  527. args: args{
  528. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  529. data: esv1beta1.ExternalSecretDataRemoteRef{
  530. Property: "nested.foo",
  531. },
  532. vLogical: &fake.Logical{
  533. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  534. },
  535. },
  536. want: want{
  537. err: nil,
  538. val: []byte("oke"),
  539. },
  540. },
  541. "ReadSecretWithNestedValueFromData": {
  542. reason: "Should return a nested property",
  543. args: args{
  544. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  545. data: esv1beta1.ExternalSecretDataRemoteRef{
  546. //
  547. Property: "nested.bar",
  548. },
  549. vLogical: &fake.Logical{
  550. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  551. },
  552. },
  553. want: want{
  554. err: nil,
  555. val: []byte("something different"),
  556. },
  557. },
  558. "NonexistentProperty": {
  559. reason: "Should return error property does not exist.",
  560. args: args{
  561. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  562. data: esv1beta1.ExternalSecretDataRemoteRef{
  563. Property: "nop.doesnt.exist",
  564. },
  565. vLogical: &fake.Logical{
  566. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  567. },
  568. },
  569. want: want{
  570. err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
  571. },
  572. },
  573. "ReadSecretError": {
  574. reason: "Should return error if vault client fails to read secret.",
  575. args: args{
  576. store: makeSecretStore().Spec.Provider.Vault,
  577. vLogical: &fake.Logical{
  578. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  579. },
  580. },
  581. want: want{
  582. err: fmt.Errorf(errReadSecret, errBoom),
  583. },
  584. },
  585. "ReadSecretNotFound": {
  586. reason: "Secret doesn't exist",
  587. args: args{
  588. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  589. data: esv1beta1.ExternalSecretDataRemoteRef{
  590. Property: "access_key",
  591. },
  592. vLogical: &fake.Logical{
  593. ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  594. return nil, nil
  595. },
  596. },
  597. },
  598. want: want{
  599. err: errors.New(errNotFound),
  600. },
  601. },
  602. }
  603. for name, tc := range cases {
  604. t.Run(name, func(t *testing.T) {
  605. vStore := &client{
  606. kube: tc.args.kube,
  607. logical: tc.args.vLogical,
  608. store: tc.args.store,
  609. namespace: tc.args.ns,
  610. }
  611. val, err := vStore.GetSecret(context.Background(), tc.args.data)
  612. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  613. t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
  614. }
  615. if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
  616. t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
  617. }
  618. })
  619. }
  620. }
  621. func TestGetSecretMap(t *testing.T) {
  622. errBoom := errors.New("boom")
  623. secret := map[string]interface{}{
  624. "access_key": "access_key",
  625. "access_secret": "access_secret",
  626. }
  627. secretWithNilVal := map[string]interface{}{
  628. "access_key": "access_key",
  629. "access_secret": "access_secret",
  630. "token": nil,
  631. }
  632. secretWithNestedVal := map[string]interface{}{
  633. "access_key": "access_key",
  634. "access_secret": "access_secret",
  635. "nested": map[string]interface{}{
  636. "foo": map[string]string{
  637. "oke": "yup",
  638. "mhkeih": "yada yada",
  639. },
  640. },
  641. }
  642. secretWithTypes := map[string]interface{}{
  643. "access_secret": "access_secret",
  644. "f32": float32(2.12),
  645. "f64": float64(2.1234534153423423),
  646. "int": 42,
  647. "bool": true,
  648. "bt": []byte("foobar"),
  649. }
  650. type args struct {
  651. store *esv1beta1.VaultProvider
  652. kube kclient.Client
  653. vClient Logical
  654. ns string
  655. data esv1beta1.ExternalSecretDataRemoteRef
  656. }
  657. type want struct {
  658. err error
  659. val map[string][]byte
  660. }
  661. cases := map[string]struct {
  662. reason string
  663. args args
  664. want want
  665. }{
  666. "ReadSecretKV1": {
  667. reason: "Should map the secret even if it has a nil value",
  668. args: args{
  669. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  670. vClient: &fake.Logical{
  671. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  672. },
  673. },
  674. want: want{
  675. err: nil,
  676. val: map[string][]byte{
  677. "access_key": []byte("access_key"),
  678. "access_secret": []byte("access_secret"),
  679. },
  680. },
  681. },
  682. "ReadSecretKV2": {
  683. reason: "Should map the secret even if it has a nil value",
  684. args: args{
  685. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  686. vClient: &fake.Logical{
  687. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  688. "data": secret,
  689. }, nil),
  690. },
  691. },
  692. want: want{
  693. err: nil,
  694. val: map[string][]byte{
  695. "access_key": []byte("access_key"),
  696. "access_secret": []byte("access_secret"),
  697. },
  698. },
  699. },
  700. "ReadSecretWithNilValueKV1": {
  701. reason: "Should map the secret even if it has a nil value",
  702. args: args{
  703. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  704. vClient: &fake.Logical{
  705. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  706. },
  707. },
  708. want: want{
  709. err: nil,
  710. val: map[string][]byte{
  711. "access_key": []byte("access_key"),
  712. "access_secret": []byte("access_secret"),
  713. "token": []byte(nil),
  714. },
  715. },
  716. },
  717. "ReadSecretWithNilValueKV2": {
  718. reason: "Should map the secret even if it has a nil value",
  719. args: args{
  720. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  721. vClient: &fake.Logical{
  722. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  723. "data": secretWithNilVal}, nil),
  724. },
  725. },
  726. want: want{
  727. err: nil,
  728. val: map[string][]byte{
  729. "access_key": []byte("access_key"),
  730. "access_secret": []byte("access_secret"),
  731. "token": []byte(nil),
  732. },
  733. },
  734. },
  735. "ReadSecretWithTypesKV2": {
  736. reason: "Should map the secret even if it has other types",
  737. args: args{
  738. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  739. vClient: &fake.Logical{
  740. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  741. "data": secretWithTypes}, nil),
  742. },
  743. },
  744. want: want{
  745. err: nil,
  746. val: map[string][]byte{
  747. "access_secret": []byte("access_secret"),
  748. "f32": []byte("2.12"),
  749. "f64": []byte("2.1234534153423423"),
  750. "int": []byte("42"),
  751. "bool": []byte("true"),
  752. "bt": []byte("Zm9vYmFy"), // base64
  753. },
  754. },
  755. },
  756. "ReadNestedSecret": {
  757. reason: "Should map the secret for deeply nested property",
  758. args: args{
  759. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  760. data: esv1beta1.ExternalSecretDataRemoteRef{
  761. Property: "nested",
  762. },
  763. vClient: &fake.Logical{
  764. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  765. "data": secretWithNestedVal}, nil),
  766. },
  767. },
  768. want: want{
  769. err: nil,
  770. val: map[string][]byte{
  771. "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
  772. },
  773. },
  774. },
  775. "ReadDeeplyNestedSecret": {
  776. reason: "Should map the secret for deeply nested property",
  777. args: args{
  778. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  779. data: esv1beta1.ExternalSecretDataRemoteRef{
  780. Property: "nested.foo",
  781. },
  782. vClient: &fake.Logical{
  783. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  784. "data": secretWithNestedVal}, nil),
  785. },
  786. },
  787. want: want{
  788. err: nil,
  789. val: map[string][]byte{
  790. "oke": []byte("yup"),
  791. "mhkeih": []byte("yada yada"),
  792. },
  793. },
  794. },
  795. "ReadSecretError": {
  796. reason: "Should return error if vault client fails to read secret.",
  797. args: args{
  798. store: makeSecretStore().Spec.Provider.Vault,
  799. vClient: &fake.Logical{
  800. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  801. },
  802. },
  803. want: want{
  804. err: fmt.Errorf(errReadSecret, errBoom),
  805. },
  806. },
  807. }
  808. for name, tc := range cases {
  809. t.Run(name, func(t *testing.T) {
  810. vStore := &client{
  811. kube: tc.args.kube,
  812. logical: tc.args.vClient,
  813. store: tc.args.store,
  814. namespace: tc.args.ns,
  815. }
  816. val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
  817. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  818. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  819. }
  820. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  821. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  822. }
  823. })
  824. }
  825. }
  826. func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
  827. return func(ctx context.Context, path string) (*vault.Secret, error) {
  828. path = strings.TrimPrefix(path, "secret/metadata/")
  829. if path == "" {
  830. path = "default"
  831. }
  832. data, ok := secrets[path]
  833. if !ok {
  834. return nil, errors.New("Secret not found")
  835. }
  836. meta := data.(map[string]interface{})
  837. ans := meta["metadata"].(map[string]interface{})
  838. secret := &vault.Secret{
  839. Data: map[string]interface{}{
  840. "keys": ans["keys"],
  841. },
  842. }
  843. return secret, nil
  844. }
  845. }
  846. func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  847. return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  848. path = strings.TrimPrefix(path, "secret/data/")
  849. path = strings.TrimPrefix(path, "secret/metadata/")
  850. if path == "" {
  851. path = "default"
  852. }
  853. data, ok := secrets[path]
  854. if !ok {
  855. return nil, errors.New("Secret not found")
  856. }
  857. meta := data.(map[string]interface{})
  858. metadata := meta["metadata"].(map[string]interface{})
  859. content := map[string]interface{}{
  860. "data": meta["data"],
  861. "custom_metadata": metadata["custom_metadata"],
  862. }
  863. secret := &vault.Secret{
  864. Data: content,
  865. }
  866. return secret, nil
  867. }
  868. }
  869. func TestGetAllSecrets(t *testing.T) {
  870. secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
  871. secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
  872. path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
  873. path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
  874. tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
  875. path := "path"
  876. secret := map[string]interface{}{
  877. "secret1": map[string]interface{}{
  878. "metadata": map[string]interface{}{
  879. "custom_metadata": map[string]interface{}{
  880. "foo": "bar",
  881. },
  882. },
  883. "data": map[string]interface{}{
  884. "access_key": "access_key",
  885. "access_secret": "access_secret",
  886. },
  887. },
  888. "secret2": map[string]interface{}{
  889. "metadata": map[string]interface{}{
  890. "custom_metadata": map[string]interface{}{
  891. "foo": "baz",
  892. },
  893. },
  894. "data": map[string]interface{}{
  895. "access_key": "access_key2",
  896. "access_secret": "access_secret2",
  897. },
  898. },
  899. "secret3": map[string]interface{}{
  900. "metadata": map[string]interface{}{
  901. "custom_metadata": map[string]interface{}{
  902. "foo": "baz",
  903. },
  904. },
  905. "data": nil,
  906. },
  907. "tag": map[string]interface{}{
  908. "metadata": map[string]interface{}{
  909. "custom_metadata": map[string]interface{}{
  910. "foo": "baz",
  911. },
  912. },
  913. "data": map[string]interface{}{
  914. "access_key": "unfetched",
  915. "access_secret": "unfetched",
  916. },
  917. },
  918. "path/1": map[string]interface{}{
  919. "metadata": map[string]interface{}{
  920. "custom_metadata": map[string]interface{}{
  921. "foo": "path",
  922. },
  923. },
  924. "data": map[string]interface{}{
  925. "access_key": "path1",
  926. "access_secret": "path1",
  927. },
  928. },
  929. "path/2": map[string]interface{}{
  930. "metadata": map[string]interface{}{
  931. "custom_metadata": map[string]interface{}{
  932. "foo": "path",
  933. },
  934. },
  935. "data": map[string]interface{}{
  936. "access_key": "path2",
  937. "access_secret": "path2",
  938. },
  939. },
  940. "default": map[string]interface{}{
  941. "data": map[string]interface{}{
  942. "empty": "true",
  943. },
  944. "metadata": map[string]interface{}{
  945. "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
  946. },
  947. },
  948. "path/": map[string]interface{}{
  949. "data": map[string]interface{}{
  950. "empty": "true",
  951. },
  952. "metadata": map[string]interface{}{
  953. "keys": []interface{}{"1", "2"},
  954. },
  955. },
  956. }
  957. type args struct {
  958. store *esv1beta1.VaultProvider
  959. kube kclient.Client
  960. vLogical Logical
  961. ns string
  962. data esv1beta1.ExternalSecretFind
  963. }
  964. type want struct {
  965. err error
  966. val map[string][]byte
  967. }
  968. cases := map[string]struct {
  969. reason string
  970. args args
  971. want want
  972. }{
  973. "FindByName": {
  974. reason: "should map multiple secrets matching name",
  975. args: args{
  976. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  977. vLogical: &fake.Logical{
  978. ListWithContextFn: newListWithContextFn(secret),
  979. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  980. },
  981. data: esv1beta1.ExternalSecretFind{
  982. Name: &esv1beta1.FindName{
  983. RegExp: "secret.*",
  984. },
  985. },
  986. },
  987. want: want{
  988. err: nil,
  989. val: map[string][]byte{
  990. "secret1": secret1Bytes,
  991. "secret2": secret2Bytes,
  992. },
  993. },
  994. },
  995. "FindByTag": {
  996. reason: "should map multiple secrets matching tags",
  997. args: args{
  998. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  999. vLogical: &fake.Logical{
  1000. ListWithContextFn: newListWithContextFn(secret),
  1001. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1002. },
  1003. data: esv1beta1.ExternalSecretFind{
  1004. Tags: map[string]string{
  1005. "foo": "baz",
  1006. },
  1007. },
  1008. },
  1009. want: want{
  1010. err: nil,
  1011. val: map[string][]byte{
  1012. "tag": tagBytes,
  1013. "secret2": secret2Bytes,
  1014. },
  1015. },
  1016. },
  1017. "FilterByPath": {
  1018. reason: "should filter secrets based on path",
  1019. args: args{
  1020. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1021. vLogical: &fake.Logical{
  1022. ListWithContextFn: newListWithContextFn(secret),
  1023. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1024. },
  1025. data: esv1beta1.ExternalSecretFind{
  1026. Path: &path,
  1027. Tags: map[string]string{
  1028. "foo": "path",
  1029. },
  1030. },
  1031. },
  1032. want: want{
  1033. err: nil,
  1034. val: map[string][]byte{
  1035. "path/1": path1Bytes,
  1036. "path/2": path2Bytes,
  1037. },
  1038. },
  1039. },
  1040. "FailIfKv1": {
  1041. reason: "should not work if using kv1 store",
  1042. args: args{
  1043. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1044. vLogical: &fake.Logical{
  1045. ListWithContextFn: newListWithContextFn(secret),
  1046. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1047. },
  1048. data: esv1beta1.ExternalSecretFind{
  1049. Tags: map[string]string{
  1050. "foo": "baz",
  1051. },
  1052. },
  1053. },
  1054. want: want{
  1055. err: errors.New(errUnsupportedKvVersion),
  1056. },
  1057. },
  1058. "MetadataNotFound": {
  1059. reason: "metadata secret not found",
  1060. args: args{
  1061. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1062. vLogical: &fake.Logical{
  1063. ListWithContextFn: newListWithContextFn(secret),
  1064. ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1065. return nil, nil
  1066. },
  1067. },
  1068. data: esv1beta1.ExternalSecretFind{
  1069. Tags: map[string]string{
  1070. "foo": "baz",
  1071. },
  1072. },
  1073. },
  1074. want: want{
  1075. err: errors.New(errNotFound),
  1076. },
  1077. },
  1078. }
  1079. for name, tc := range cases {
  1080. t.Run(name, func(t *testing.T) {
  1081. vStore := &client{
  1082. kube: tc.args.kube,
  1083. logical: tc.args.vLogical,
  1084. store: tc.args.store,
  1085. namespace: tc.args.ns,
  1086. }
  1087. val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
  1088. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1089. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1090. }
  1091. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1092. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1093. }
  1094. })
  1095. }
  1096. }
  1097. func TestGetSecretPath(t *testing.T) {
  1098. storeV2 := makeValidSecretStore()
  1099. storeV2NoPath := storeV2.DeepCopy()
  1100. multiPath := "secret/path"
  1101. storeV2.Spec.Provider.Vault.Path = &multiPath
  1102. storeV2NoPath.Spec.Provider.Vault.Path = nil
  1103. storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
  1104. storeV1NoPath := storeV1.DeepCopy()
  1105. storeV1.Spec.Provider.Vault.Path = &multiPath
  1106. storeV1NoPath.Spec.Provider.Vault.Path = nil
  1107. type args struct {
  1108. store *esv1beta1.VaultProvider
  1109. path string
  1110. expected string
  1111. }
  1112. cases := map[string]struct {
  1113. reason string
  1114. args args
  1115. }{
  1116. "PathWithoutFormatV2": {
  1117. reason: "path should compose with mount point if set",
  1118. args: args{
  1119. store: storeV2.Spec.Provider.Vault,
  1120. path: "secret/path/data/test",
  1121. expected: "secret/path/data/test",
  1122. },
  1123. },
  1124. "PathWithoutFormatV2_NoData": {
  1125. reason: "path should compose with mount point if set without data",
  1126. args: args{
  1127. store: storeV2.Spec.Provider.Vault,
  1128. path: "secret/path/test",
  1129. expected: "secret/path/data/test",
  1130. },
  1131. },
  1132. "PathWithoutFormatV2_NoPath": {
  1133. reason: "if no mountpoint and no data available, needs to be set in second element",
  1134. args: args{
  1135. store: storeV2NoPath.Spec.Provider.Vault,
  1136. path: "secret/test/big/path",
  1137. expected: "secret/data/test/big/path",
  1138. },
  1139. },
  1140. "PathWithoutFormatV2_NoPathWithData": {
  1141. reason: "if data is available, should respect order",
  1142. args: args{
  1143. store: storeV2NoPath.Spec.Provider.Vault,
  1144. path: "secret/test/data/not/the/first/and/data/twice",
  1145. expected: "secret/test/data/not/the/first/and/data/twice",
  1146. },
  1147. },
  1148. "PathWithoutFormatV1": {
  1149. reason: "v1 mountpoint should be added but not enforce 'data'",
  1150. args: args{
  1151. store: storeV1.Spec.Provider.Vault,
  1152. path: "secret/path/test",
  1153. expected: "secret/path/test",
  1154. },
  1155. },
  1156. "PathWithoutFormatV1_NoPath": {
  1157. reason: "Should not append any path information if v1 with no mountpoint",
  1158. args: args{
  1159. store: storeV1NoPath.Spec.Provider.Vault,
  1160. path: "secret/test",
  1161. expected: "secret/test",
  1162. },
  1163. },
  1164. "WithoutPathButMountpointV2": {
  1165. reason: "Mountpoint needs to be set in addition to data",
  1166. args: args{
  1167. store: storeV2.Spec.Provider.Vault,
  1168. path: "test",
  1169. expected: "secret/path/data/test",
  1170. },
  1171. },
  1172. "WithoutPathButMountpointV1": {
  1173. reason: "Mountpoint needs to be set in addition to data",
  1174. args: args{
  1175. store: storeV1.Spec.Provider.Vault,
  1176. path: "test",
  1177. expected: "secret/path/test",
  1178. },
  1179. },
  1180. }
  1181. for name, tc := range cases {
  1182. t.Run(name, func(t *testing.T) {
  1183. vStore := &client{
  1184. store: tc.args.store,
  1185. }
  1186. want := vStore.buildPath(tc.args.path)
  1187. if diff := cmp.Diff(want, tc.args.expected); diff != "" {
  1188. t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
  1189. }
  1190. })
  1191. }
  1192. }
  1193. func TestValidateStore(t *testing.T) {
  1194. type args struct {
  1195. auth esv1beta1.VaultAuth
  1196. }
  1197. tests := []struct {
  1198. name string
  1199. args args
  1200. wantErr bool
  1201. }{
  1202. {
  1203. name: "empty auth",
  1204. args: args{},
  1205. },
  1206. {
  1207. name: "invalid approle with namespace",
  1208. args: args{
  1209. auth: esv1beta1.VaultAuth{
  1210. AppRole: &esv1beta1.VaultAppRole{
  1211. SecretRef: esmeta.SecretKeySelector{
  1212. Namespace: pointer.StringPtr("invalid"),
  1213. },
  1214. },
  1215. },
  1216. },
  1217. wantErr: true,
  1218. },
  1219. {
  1220. name: "invalid clientcert",
  1221. args: args{
  1222. auth: esv1beta1.VaultAuth{
  1223. Cert: &esv1beta1.VaultCertAuth{
  1224. ClientCert: esmeta.SecretKeySelector{
  1225. Namespace: pointer.StringPtr("invalid"),
  1226. },
  1227. },
  1228. },
  1229. },
  1230. wantErr: true,
  1231. },
  1232. {
  1233. name: "invalid cert secret",
  1234. args: args{
  1235. auth: esv1beta1.VaultAuth{
  1236. Cert: &esv1beta1.VaultCertAuth{
  1237. SecretRef: esmeta.SecretKeySelector{
  1238. Namespace: pointer.StringPtr("invalid"),
  1239. },
  1240. },
  1241. },
  1242. },
  1243. wantErr: true,
  1244. },
  1245. {
  1246. name: "invalid jwt secret",
  1247. args: args{
  1248. auth: esv1beta1.VaultAuth{
  1249. Jwt: &esv1beta1.VaultJwtAuth{
  1250. SecretRef: &esmeta.SecretKeySelector{
  1251. Namespace: pointer.StringPtr("invalid"),
  1252. },
  1253. },
  1254. },
  1255. },
  1256. wantErr: true,
  1257. },
  1258. {
  1259. name: "invalid kubernetes sa",
  1260. args: args{
  1261. auth: esv1beta1.VaultAuth{
  1262. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1263. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  1264. Namespace: pointer.StringPtr("invalid"),
  1265. },
  1266. },
  1267. },
  1268. },
  1269. wantErr: true,
  1270. },
  1271. {
  1272. name: "invalid kubernetes secret",
  1273. args: args{
  1274. auth: esv1beta1.VaultAuth{
  1275. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1276. SecretRef: &esmeta.SecretKeySelector{
  1277. Namespace: pointer.StringPtr("invalid"),
  1278. },
  1279. },
  1280. },
  1281. },
  1282. wantErr: true,
  1283. },
  1284. {
  1285. name: "invalid ldap secret",
  1286. args: args{
  1287. auth: esv1beta1.VaultAuth{
  1288. Ldap: &esv1beta1.VaultLdapAuth{
  1289. SecretRef: esmeta.SecretKeySelector{
  1290. Namespace: pointer.StringPtr("invalid"),
  1291. },
  1292. },
  1293. },
  1294. },
  1295. wantErr: true,
  1296. },
  1297. {
  1298. name: "invalid token secret",
  1299. args: args{
  1300. auth: esv1beta1.VaultAuth{
  1301. TokenSecretRef: &esmeta.SecretKeySelector{
  1302. Namespace: pointer.StringPtr("invalid"),
  1303. },
  1304. },
  1305. },
  1306. wantErr: true,
  1307. },
  1308. }
  1309. for _, tt := range tests {
  1310. t.Run(tt.name, func(t *testing.T) {
  1311. c := &connector{
  1312. newVaultClient: nil,
  1313. }
  1314. store := &esv1beta1.SecretStore{
  1315. Spec: esv1beta1.SecretStoreSpec{
  1316. Provider: &esv1beta1.SecretStoreProvider{
  1317. Vault: &esv1beta1.VaultProvider{
  1318. Auth: tt.args.auth,
  1319. },
  1320. },
  1321. },
  1322. }
  1323. if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
  1324. t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
  1325. }
  1326. })
  1327. }
  1328. }
  1329. // EquateErrors returns true if the supplied errors are of the same type and
  1330. // produce identical strings. This mirrors the error comparison behavior of
  1331. // https://github.com/go-test/deep, which most Crossplane tests targeted before
  1332. // we switched to go-cmp.
  1333. //
  1334. // This differs from cmpopts.EquateErrors, which does not test for error strings
  1335. // and instead returns whether one error 'is' (in the errors.Is sense) the
  1336. // other.
  1337. func EquateErrors() cmp.Option {
  1338. return cmp.Comparer(func(a, b error) bool {
  1339. if a == nil || b == nil {
  1340. return a == nil && b == nil
  1341. }
  1342. av := reflect.ValueOf(a)
  1343. bv := reflect.ValueOf(b)
  1344. if av.Type() != bv.Type() {
  1345. return false
  1346. }
  1347. return a.Error() == b.Error()
  1348. })
  1349. }