vault_test.go 41 KB

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