vault_test.go 41 KB

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