vault_test.go 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999
  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. "encoding/json"
  16. "errors"
  17. "fmt"
  18. "reflect"
  19. "strings"
  20. "testing"
  21. "github.com/google/go-cmp/cmp"
  22. vault "github.com/hashicorp/vault/api"
  23. corev1 "k8s.io/api/core/v1"
  24. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  25. typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
  26. "k8s.io/utils/pointer"
  27. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  28. clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
  29. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  30. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  31. utilfake "github.com/external-secrets/external-secrets/pkg/provider/util/fake"
  32. "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
  33. "github.com/external-secrets/external-secrets/pkg/provider/vault/util"
  34. )
  35. const (
  36. tokenSecretName = "example-secret-token"
  37. secretDataString = "some-creds"
  38. )
  39. var (
  40. secretStorePath = "secret"
  41. )
  42. func makeValidSecretStoreWithVersion(v esv1beta1.VaultKVStoreVersion) *esv1beta1.SecretStore {
  43. return &esv1beta1.SecretStore{
  44. ObjectMeta: metav1.ObjectMeta{
  45. Name: "vault-store",
  46. Namespace: "default",
  47. },
  48. Spec: esv1beta1.SecretStoreSpec{
  49. Provider: &esv1beta1.SecretStoreProvider{
  50. Vault: &esv1beta1.VaultProvider{
  51. Server: "vault.example.com",
  52. Path: &secretStorePath,
  53. Version: v,
  54. Auth: esv1beta1.VaultAuth{
  55. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  56. Path: "kubernetes",
  57. Role: "kubernetes-auth-role",
  58. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  59. Name: "example-sa",
  60. },
  61. },
  62. },
  63. },
  64. },
  65. },
  66. }
  67. }
  68. func makeValidSecretStore() *esv1beta1.SecretStore {
  69. return makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2)
  70. }
  71. func makeValidSecretStoreWithCerts() *esv1beta1.SecretStore {
  72. return &esv1beta1.SecretStore{
  73. ObjectMeta: metav1.ObjectMeta{
  74. Name: "vault-store",
  75. Namespace: "default",
  76. },
  77. Spec: esv1beta1.SecretStoreSpec{
  78. Provider: &esv1beta1.SecretStoreProvider{
  79. Vault: &esv1beta1.VaultProvider{
  80. Server: "vault.example.com",
  81. Path: &secretStorePath,
  82. Version: esv1beta1.VaultKVStoreV2,
  83. Auth: esv1beta1.VaultAuth{
  84. Cert: &esv1beta1.VaultCertAuth{
  85. ClientCert: esmeta.SecretKeySelector{
  86. Name: "tls-auth-certs",
  87. Key: "tls.crt",
  88. },
  89. SecretRef: esmeta.SecretKeySelector{
  90. Name: "tls-auth-certs",
  91. Key: "tls.key",
  92. },
  93. },
  94. },
  95. },
  96. },
  97. },
  98. }
  99. }
  100. func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1beta1.SecretStore {
  101. store := makeSecretStore()
  102. caProvider := &esv1beta1.CAProvider{
  103. Name: "vault-cert",
  104. Key: "cert",
  105. }
  106. if isSecret {
  107. caProvider.Type = "Secret"
  108. } else {
  109. caProvider.Type = "ConfigMap"
  110. }
  111. store.Spec.Provider.Vault.CAProvider = caProvider
  112. return store
  113. }
  114. func makeInvalidClusterSecretStoreWithK8sCerts() *esv1beta1.ClusterSecretStore {
  115. return &esv1beta1.ClusterSecretStore{
  116. TypeMeta: metav1.TypeMeta{
  117. Kind: "ClusterSecretStore",
  118. },
  119. ObjectMeta: metav1.ObjectMeta{
  120. Name: "vault-store",
  121. Namespace: "default",
  122. },
  123. Spec: esv1beta1.SecretStoreSpec{
  124. Provider: &esv1beta1.SecretStoreProvider{
  125. Vault: &esv1beta1.VaultProvider{
  126. Server: "vault.example.com",
  127. Path: &secretStorePath,
  128. Version: "v2",
  129. Auth: esv1beta1.VaultAuth{
  130. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  131. Path: "kubernetes",
  132. Role: "kubernetes-auth-role",
  133. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  134. Name: "example-sa",
  135. },
  136. },
  137. },
  138. CAProvider: &esv1beta1.CAProvider{
  139. Name: "vault-cert",
  140. Key: "cert",
  141. Type: "Secret",
  142. },
  143. },
  144. },
  145. },
  146. }
  147. }
  148. func makeValidSecretStoreWithIamAuthSecret() *esv1beta1.SecretStore {
  149. return &esv1beta1.SecretStore{
  150. ObjectMeta: metav1.ObjectMeta{
  151. Name: "vault-store",
  152. Namespace: "default",
  153. },
  154. Spec: esv1beta1.SecretStoreSpec{
  155. Provider: &esv1beta1.SecretStoreProvider{
  156. Vault: &esv1beta1.VaultProvider{
  157. Server: "https://vault.example.com:8200",
  158. Path: &secretStorePath,
  159. Version: esv1beta1.VaultKVStoreV2,
  160. Auth: esv1beta1.VaultAuth{
  161. Iam: &esv1beta1.VaultIamAuth{
  162. Path: "aws",
  163. Region: "us-east-1",
  164. Role: "vault-role",
  165. SecretRef: &esv1beta1.VaultAwsAuthSecretRef{
  166. AccessKeyID: esmeta.SecretKeySelector{
  167. Name: "vault-iam-creds-secret",
  168. Key: "access-key",
  169. },
  170. SecretAccessKey: esmeta.SecretKeySelector{
  171. Name: "vault-iam-creds-secret",
  172. Key: "secret-access-key",
  173. },
  174. SessionToken: &esmeta.SecretKeySelector{
  175. Name: "vault-iam-creds-secret",
  176. Key: "secret-session-token",
  177. },
  178. },
  179. },
  180. },
  181. },
  182. },
  183. },
  184. }
  185. }
  186. type secretStoreTweakFn func(s *esv1beta1.SecretStore)
  187. func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1beta1.SecretStore {
  188. store := makeValidSecretStore()
  189. for _, fn := range tweaks {
  190. fn(store)
  191. }
  192. return store
  193. }
  194. type args struct {
  195. newClientFunc func(c *vault.Config) (util.Client, error)
  196. store esv1beta1.GenericStore
  197. kube kclient.Client
  198. corev1 typedcorev1.CoreV1Interface
  199. ns string
  200. }
  201. type want struct {
  202. err error
  203. }
  204. type testCase struct {
  205. reason string
  206. args args
  207. want want
  208. }
  209. func TestNewVault(t *testing.T) {
  210. errBoom := errors.New("boom")
  211. secretClientKey := []byte(`-----BEGIN PRIVATE KEY-----
  212. 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==
  213. -----END PRIVATE KEY-----`)
  214. clientCrt := []byte(`-----BEGIN CERTIFICATE-----
  215. 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==
  216. -----END CERTIFICATE-----`)
  217. secretData := []byte(secretDataString)
  218. cases := map[string]testCase{
  219. "InvalidVaultStore": {
  220. reason: "Should return error if given an invalid vault store.",
  221. args: args{
  222. store: &esv1beta1.SecretStore{},
  223. },
  224. want: want{
  225. err: errors.New(errVaultStore),
  226. },
  227. },
  228. "AddVaultStoreCertsError": {
  229. reason: "Should return error if given an invalid CA certificate.",
  230. args: args{
  231. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  232. s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
  233. }),
  234. },
  235. want: want{
  236. err: fmt.Errorf(errVaultCert, errors.New("failed to parse certificates from CertPool")),
  237. },
  238. },
  239. "VaultAuthFormatError": {
  240. reason: "Should return error if no valid authentication method is given.",
  241. args: args{
  242. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  243. s.Spec.Provider.Vault.Auth = esv1beta1.VaultAuth{}
  244. }),
  245. },
  246. want: want{
  247. err: errors.New(errAuthFormat),
  248. },
  249. },
  250. "GetKubeServiceAccountError": {
  251. reason: "Should return error if fetching kubernetes secret fails.",
  252. args: args{
  253. newClientFunc: fake.ClientWithLoginMock,
  254. ns: "default",
  255. kube: clientfake.NewClientBuilder().Build(),
  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. ns: "default",
  267. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  268. s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
  269. s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
  270. Name: "vault-secret",
  271. Key: "key",
  272. }
  273. }),
  274. kube: clientfake.NewClientBuilder().Build(),
  275. },
  276. want: want{
  277. err: fmt.Errorf(errGetKubeSecret, "vault-secret", errors.New("secrets \"vault-secret\" not found")),
  278. },
  279. },
  280. "SuccessfulVaultStoreWithCertAuth": {
  281. reason: "Should return a Vault provider successfully",
  282. args: args{
  283. store: makeValidSecretStoreWithCerts(),
  284. ns: "default",
  285. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  286. ObjectMeta: metav1.ObjectMeta{
  287. Name: "tls-auth-certs",
  288. Namespace: "default",
  289. },
  290. Data: map[string][]byte{
  291. "tls.key": secretClientKey,
  292. "tls.crt": clientCrt,
  293. },
  294. }).Build(),
  295. newClientFunc: fake.ClientWithLoginMock,
  296. },
  297. want: want{
  298. err: nil,
  299. },
  300. },
  301. "SuccessfulVaultStoreWithK8sCertSecret": {
  302. reason: "Should return a Vault provider with the cert from k8s",
  303. args: args{
  304. store: makeValidSecretStoreWithK8sCerts(true),
  305. ns: "default",
  306. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  307. ObjectMeta: metav1.ObjectMeta{
  308. Name: "vault-cert",
  309. Namespace: "default",
  310. },
  311. Data: map[string][]byte{
  312. "cert": clientCrt,
  313. "token": secretData,
  314. },
  315. }).Build(),
  316. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  317. newClientFunc: fake.ClientWithLoginMock,
  318. },
  319. want: want{
  320. err: nil,
  321. },
  322. },
  323. "GetCertNamespaceMissingError": {
  324. reason: "Should return an error if namespace is missing and is a ClusterSecretStore",
  325. args: args{
  326. store: makeInvalidClusterSecretStoreWithK8sCerts(),
  327. ns: "default",
  328. kube: clientfake.NewClientBuilder().Build(),
  329. },
  330. want: want{
  331. err: errors.New(errCANamespace),
  332. },
  333. },
  334. "GetCertSecretKeyMissingError": {
  335. reason: "Should return an error if the secret key is missing",
  336. args: args{
  337. store: makeValidSecretStoreWithK8sCerts(true),
  338. ns: "default",
  339. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  340. ObjectMeta: metav1.ObjectMeta{
  341. Name: "vault-cert",
  342. Namespace: "default",
  343. },
  344. Data: map[string][]byte{},
  345. }).Build(),
  346. newClientFunc: fake.ClientWithLoginMock,
  347. },
  348. want: want{
  349. err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
  350. },
  351. },
  352. "SuccessfulVaultStoreWithIamAuthSecret": {
  353. reason: "Should return a Vault provider successfully",
  354. args: args{
  355. store: makeValidSecretStoreWithIamAuthSecret(),
  356. ns: "default",
  357. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  358. ObjectMeta: metav1.ObjectMeta{
  359. Name: "vault-iam-creds-secret",
  360. Namespace: "default",
  361. },
  362. Data: map[string][]byte{
  363. "access-key": []byte("TESTING"),
  364. "secret-access-key": []byte("ABCDEF"),
  365. "secret-session-token": []byte("c2VjcmV0LXNlc3Npb24tdG9rZW4K"),
  366. },
  367. }).Build(),
  368. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  369. newClientFunc: fake.ClientWithLoginMock,
  370. },
  371. want: want{
  372. err: nil,
  373. },
  374. },
  375. "SuccessfulVaultStoreWithK8sCertConfigMap": {
  376. reason: "Should return a Vault prodvider with the cert from k8s",
  377. args: args{
  378. store: makeValidSecretStoreWithK8sCerts(false),
  379. ns: "default",
  380. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ConfigMap{
  381. ObjectMeta: metav1.ObjectMeta{
  382. Name: "vault-cert",
  383. },
  384. Data: map[string]string{
  385. "cert": string(clientCrt),
  386. },
  387. }).Build(),
  388. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  389. newClientFunc: fake.ClientWithLoginMock,
  390. },
  391. want: want{
  392. err: nil,
  393. },
  394. },
  395. "GetCertConfigMapMissingError": {
  396. reason: "Should return an error if the config map key is missing",
  397. args: args{
  398. store: makeValidSecretStoreWithK8sCerts(false),
  399. ns: "default",
  400. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
  401. ObjectMeta: metav1.ObjectMeta{
  402. Name: "example-sa",
  403. Namespace: "default",
  404. },
  405. Secrets: []corev1.ObjectReference{
  406. {
  407. Name: tokenSecretName,
  408. },
  409. },
  410. }, &corev1.ConfigMap{
  411. ObjectMeta: metav1.ObjectMeta{
  412. Name: "vault-cert",
  413. },
  414. Data: map[string]string{},
  415. }).Build(),
  416. newClientFunc: fake.ClientWithLoginMock,
  417. },
  418. want: want{
  419. err: fmt.Errorf(errConfigMapFmt, "cert"),
  420. },
  421. },
  422. "GetCertificateFormatError": {
  423. reason: "Should return error if client certificate is in wrong format.",
  424. args: args{
  425. store: makeValidSecretStoreWithCerts(),
  426. ns: "default",
  427. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  428. ObjectMeta: metav1.ObjectMeta{
  429. Name: "tls-auth-certs",
  430. Namespace: "default",
  431. },
  432. Data: map[string][]byte{
  433. "tls.key": secretClientKey,
  434. "tls.crt": []byte("cert with mistak"),
  435. },
  436. }).Build(),
  437. newClientFunc: fake.ClientWithLoginMock,
  438. },
  439. want: want{
  440. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
  441. },
  442. },
  443. "GetKeyFormatError": {
  444. reason: "Should return error if client key is in wrong format.",
  445. args: args{
  446. store: makeValidSecretStoreWithCerts(),
  447. ns: "default",
  448. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  449. ObjectMeta: metav1.ObjectMeta{
  450. Name: "tls-auth-certs",
  451. Namespace: "default",
  452. },
  453. Data: map[string][]byte{
  454. "tls.key": []byte("key with mistake"),
  455. "tls.crt": clientCrt,
  456. },
  457. }).Build(),
  458. newClientFunc: fake.ClientWithLoginMock,
  459. },
  460. want: want{
  461. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  462. },
  463. },
  464. }
  465. for name, tc := range cases {
  466. t.Run(name, func(t *testing.T) {
  467. vaultTest(t, name, tc)
  468. })
  469. }
  470. }
  471. func vaultTest(t *testing.T, _ string, tc testCase) {
  472. conn := &Connector{
  473. NewVaultClient: tc.args.newClientFunc,
  474. }
  475. if tc.args.newClientFunc == nil {
  476. conn.NewVaultClient = NewVaultClient
  477. }
  478. _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
  479. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  480. t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
  481. }
  482. }
  483. func TestGetSecret(t *testing.T) {
  484. errBoom := errors.New("boom")
  485. secret := map[string]interface{}{
  486. "access_key": "access_key",
  487. "access_secret": "access_secret",
  488. }
  489. secretWithNilVal := map[string]interface{}{
  490. "access_key": "access_key",
  491. "access_secret": "access_secret",
  492. "token": nil,
  493. }
  494. secretWithNestedVal := map[string]interface{}{
  495. "access_key": "access_key",
  496. "access_secret": "access_secret",
  497. "nested.bar": "something different",
  498. "nested": map[string]string{
  499. "foo": "oke",
  500. "bar": "also ok?",
  501. },
  502. "list_of_values": []string{
  503. "first_value",
  504. "second_value",
  505. "third_value",
  506. },
  507. "json_number": json.Number("42"),
  508. }
  509. type args struct {
  510. store *esv1beta1.VaultProvider
  511. kube kclient.Client
  512. vLogical util.Logical
  513. ns string
  514. data esv1beta1.ExternalSecretDataRemoteRef
  515. }
  516. type want struct {
  517. err error
  518. val []byte
  519. }
  520. cases := map[string]struct {
  521. reason string
  522. args args
  523. want want
  524. }{
  525. "ReadSecret": {
  526. reason: "Should return the secret with property",
  527. args: args{
  528. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  529. data: esv1beta1.ExternalSecretDataRemoteRef{
  530. Property: "access_key",
  531. },
  532. vLogical: &fake.Logical{
  533. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  534. },
  535. },
  536. want: want{
  537. err: nil,
  538. val: []byte("access_key"),
  539. },
  540. },
  541. "ReadSecretWithNil": {
  542. reason: "Should return the secret with property if it has a nil val",
  543. args: args{
  544. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  545. data: esv1beta1.ExternalSecretDataRemoteRef{
  546. Property: "access_key",
  547. },
  548. vLogical: &fake.Logical{
  549. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  550. },
  551. },
  552. want: want{
  553. err: nil,
  554. val: []byte("access_key"),
  555. },
  556. },
  557. "ReadSecretWithoutProperty": {
  558. reason: "Should return the json encoded secret without property",
  559. args: args{
  560. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  561. data: esv1beta1.ExternalSecretDataRemoteRef{},
  562. vLogical: &fake.Logical{
  563. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  564. },
  565. },
  566. want: want{
  567. err: nil,
  568. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  569. },
  570. },
  571. "ReadSecretWithNestedValue": {
  572. reason: "Should return a nested property",
  573. args: args{
  574. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  575. data: esv1beta1.ExternalSecretDataRemoteRef{
  576. Property: "nested.foo",
  577. },
  578. vLogical: &fake.Logical{
  579. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  580. },
  581. },
  582. want: want{
  583. err: nil,
  584. val: []byte("oke"),
  585. },
  586. },
  587. "ReadSecretWithNestedValueFromData": {
  588. reason: "Should return a nested property",
  589. args: args{
  590. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  591. data: esv1beta1.ExternalSecretDataRemoteRef{
  592. //
  593. Property: "nested.bar",
  594. },
  595. vLogical: &fake.Logical{
  596. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  597. },
  598. },
  599. want: want{
  600. err: nil,
  601. val: []byte("something different"),
  602. },
  603. },
  604. "ReadSecretWithMissingValueFromData": {
  605. reason: "Should return a NoSecretErr",
  606. args: args{
  607. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  608. data: esv1beta1.ExternalSecretDataRemoteRef{
  609. Property: "not-relevant",
  610. },
  611. vLogical: &fake.Logical{
  612. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  613. },
  614. },
  615. want: want{
  616. err: esv1beta1.NoSecretErr,
  617. val: nil,
  618. },
  619. },
  620. "ReadSecretWithSliceValue": {
  621. reason: "Should return property as a joined slice",
  622. args: args{
  623. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  624. data: esv1beta1.ExternalSecretDataRemoteRef{
  625. Property: "list_of_values",
  626. },
  627. vLogical: &fake.Logical{
  628. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  629. },
  630. },
  631. want: want{
  632. err: nil,
  633. val: []byte("first_value\nsecond_value\nthird_value"),
  634. },
  635. },
  636. "ReadSecretWithJsonNumber": {
  637. reason: "Should return parsed json.Number property",
  638. args: args{
  639. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  640. data: esv1beta1.ExternalSecretDataRemoteRef{
  641. Property: "json_number",
  642. },
  643. vLogical: &fake.Logical{
  644. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  645. },
  646. },
  647. want: want{
  648. err: nil,
  649. val: []byte("42"),
  650. },
  651. },
  652. "NonexistentProperty": {
  653. reason: "Should return error property does not exist.",
  654. args: args{
  655. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  656. data: esv1beta1.ExternalSecretDataRemoteRef{
  657. Property: "nop.doesnt.exist",
  658. },
  659. vLogical: &fake.Logical{
  660. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  661. },
  662. },
  663. want: want{
  664. err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
  665. },
  666. },
  667. "ReadSecretError": {
  668. reason: "Should return error if vault client fails to read secret.",
  669. args: args{
  670. store: makeSecretStore().Spec.Provider.Vault,
  671. vLogical: &fake.Logical{
  672. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  673. },
  674. },
  675. want: want{
  676. err: fmt.Errorf(errReadSecret, errBoom),
  677. },
  678. },
  679. "ReadSecretNotFound": {
  680. reason: "Secret doesn't exist",
  681. args: args{
  682. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  683. data: esv1beta1.ExternalSecretDataRemoteRef{
  684. Property: "access_key",
  685. },
  686. vLogical: &fake.Logical{
  687. ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  688. return nil, nil
  689. },
  690. },
  691. },
  692. want: want{
  693. err: esv1beta1.NoSecretError{},
  694. },
  695. },
  696. "ReadSecretMetadataWithoutProperty": {
  697. reason: "Should return the json encoded metadata",
  698. args: args{
  699. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  700. data: esv1beta1.ExternalSecretDataRemoteRef{
  701. MetadataPolicy: "Fetch",
  702. },
  703. vLogical: &fake.Logical{
  704. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  705. },
  706. },
  707. want: want{
  708. err: nil,
  709. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  710. },
  711. },
  712. "ReadSecretMetadataWithProperty": {
  713. reason: "Should return the access_key value from the metadata",
  714. args: args{
  715. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  716. data: esv1beta1.ExternalSecretDataRemoteRef{
  717. MetadataPolicy: "Fetch",
  718. Property: "access_key",
  719. },
  720. vLogical: &fake.Logical{
  721. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  722. },
  723. },
  724. want: want{
  725. err: nil,
  726. val: []byte("access_key"),
  727. },
  728. },
  729. "FailReadSecretMetadataInvalidProperty": {
  730. reason: "Should return error of non existent key inmetadata",
  731. args: args{
  732. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  733. data: esv1beta1.ExternalSecretDataRemoteRef{
  734. MetadataPolicy: "Fetch",
  735. Property: "does_not_exist",
  736. },
  737. vLogical: &fake.Logical{
  738. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  739. },
  740. },
  741. want: want{
  742. err: fmt.Errorf(errSecretKeyFmt, "does_not_exist"),
  743. },
  744. },
  745. "FailReadSecretMetadataNoMetadata": {
  746. reason: "Should return the access_key value from the metadata",
  747. args: args{
  748. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  749. data: esv1beta1.ExternalSecretDataRemoteRef{
  750. MetadataPolicy: "Fetch",
  751. },
  752. vLogical: &fake.Logical{
  753. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  754. },
  755. },
  756. want: want{
  757. err: fmt.Errorf(errNotFound),
  758. },
  759. },
  760. "FailReadSecretMetadataWrongVersion": {
  761. reason: "Should return the access_key value from the metadata",
  762. args: args{
  763. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  764. data: esv1beta1.ExternalSecretDataRemoteRef{
  765. MetadataPolicy: "Fetch",
  766. },
  767. vLogical: &fake.Logical{
  768. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  769. },
  770. },
  771. want: want{
  772. err: fmt.Errorf(errUnsupportedMetadataKvVersion),
  773. },
  774. },
  775. }
  776. for name, tc := range cases {
  777. t.Run(name, func(t *testing.T) {
  778. vStore := &client{
  779. kube: tc.args.kube,
  780. logical: tc.args.vLogical,
  781. store: tc.args.store,
  782. namespace: tc.args.ns,
  783. }
  784. val, err := vStore.GetSecret(context.Background(), tc.args.data)
  785. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  786. t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
  787. }
  788. if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
  789. t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
  790. }
  791. })
  792. }
  793. }
  794. func TestGetSecretMap(t *testing.T) {
  795. errBoom := errors.New("boom")
  796. secret := map[string]interface{}{
  797. "access_key": "access_key",
  798. "access_secret": "access_secret",
  799. }
  800. secretWithNilVal := map[string]interface{}{
  801. "access_key": "access_key",
  802. "access_secret": "access_secret",
  803. "token": nil,
  804. }
  805. secretWithNestedVal := map[string]interface{}{
  806. "access_key": "access_key",
  807. "access_secret": "access_secret",
  808. "nested": map[string]interface{}{
  809. "foo": map[string]string{
  810. "oke": "yup",
  811. "mhkeih": "yada yada",
  812. },
  813. },
  814. }
  815. secretWithTypes := map[string]interface{}{
  816. "access_secret": "access_secret",
  817. "f32": float32(2.12),
  818. "f64": float64(2.1234534153423423),
  819. "int": 42,
  820. "bool": true,
  821. "bt": []byte("foobar"),
  822. }
  823. type args struct {
  824. store *esv1beta1.VaultProvider
  825. kube kclient.Client
  826. vClient util.Logical
  827. ns string
  828. data esv1beta1.ExternalSecretDataRemoteRef
  829. }
  830. type want struct {
  831. err error
  832. val map[string][]byte
  833. }
  834. cases := map[string]struct {
  835. reason string
  836. args args
  837. want want
  838. }{
  839. "ReadSecretKV1": {
  840. reason: "Should map the secret even if it has a nil value",
  841. args: args{
  842. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  843. vClient: &fake.Logical{
  844. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  845. },
  846. },
  847. want: want{
  848. err: nil,
  849. val: map[string][]byte{
  850. "access_key": []byte("access_key"),
  851. "access_secret": []byte("access_secret"),
  852. },
  853. },
  854. },
  855. "ReadSecretKV2": {
  856. reason: "Should map the secret even if it has a nil value",
  857. args: args{
  858. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  859. vClient: &fake.Logical{
  860. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  861. "data": secret,
  862. }, nil),
  863. },
  864. },
  865. want: want{
  866. err: nil,
  867. val: map[string][]byte{
  868. "access_key": []byte("access_key"),
  869. "access_secret": []byte("access_secret"),
  870. },
  871. },
  872. },
  873. "ReadSecretWithNilValueKV1": {
  874. reason: "Should map the secret even if it has a nil value",
  875. args: args{
  876. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  877. vClient: &fake.Logical{
  878. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  879. },
  880. },
  881. want: want{
  882. err: nil,
  883. val: map[string][]byte{
  884. "access_key": []byte("access_key"),
  885. "access_secret": []byte("access_secret"),
  886. "token": []byte(nil),
  887. },
  888. },
  889. },
  890. "ReadSecretWithNilValueKV2": {
  891. reason: "Should map the secret even if it has a nil value",
  892. args: args{
  893. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  894. vClient: &fake.Logical{
  895. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  896. "data": secretWithNilVal}, nil),
  897. },
  898. },
  899. want: want{
  900. err: nil,
  901. val: map[string][]byte{
  902. "access_key": []byte("access_key"),
  903. "access_secret": []byte("access_secret"),
  904. "token": []byte(nil),
  905. },
  906. },
  907. },
  908. "ReadSecretWithTypesKV2": {
  909. reason: "Should map the secret even if it has other types",
  910. args: args{
  911. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  912. vClient: &fake.Logical{
  913. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  914. "data": secretWithTypes}, nil),
  915. },
  916. },
  917. want: want{
  918. err: nil,
  919. val: map[string][]byte{
  920. "access_secret": []byte("access_secret"),
  921. "f32": []byte("2.12"),
  922. "f64": []byte("2.1234534153423423"),
  923. "int": []byte("42"),
  924. "bool": []byte("true"),
  925. "bt": []byte("Zm9vYmFy"), // base64
  926. },
  927. },
  928. },
  929. "ReadNestedSecret": {
  930. reason: "Should map the secret for deeply nested property",
  931. args: args{
  932. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  933. data: esv1beta1.ExternalSecretDataRemoteRef{
  934. Property: "nested",
  935. },
  936. vClient: &fake.Logical{
  937. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  938. "data": secretWithNestedVal}, nil),
  939. },
  940. },
  941. want: want{
  942. err: nil,
  943. val: map[string][]byte{
  944. "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
  945. },
  946. },
  947. },
  948. "ReadDeeplyNestedSecret": {
  949. reason: "Should map the secret for deeply nested property",
  950. args: args{
  951. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  952. data: esv1beta1.ExternalSecretDataRemoteRef{
  953. Property: "nested.foo",
  954. },
  955. vClient: &fake.Logical{
  956. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  957. "data": secretWithNestedVal}, nil),
  958. },
  959. },
  960. want: want{
  961. err: nil,
  962. val: map[string][]byte{
  963. "oke": []byte("yup"),
  964. "mhkeih": []byte("yada yada"),
  965. },
  966. },
  967. },
  968. "ReadSecretError": {
  969. reason: "Should return error if vault client fails to read secret.",
  970. args: args{
  971. store: makeSecretStore().Spec.Provider.Vault,
  972. vClient: &fake.Logical{
  973. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  974. },
  975. },
  976. want: want{
  977. err: fmt.Errorf(errReadSecret, errBoom),
  978. },
  979. },
  980. }
  981. for name, tc := range cases {
  982. t.Run(name, func(t *testing.T) {
  983. vStore := &client{
  984. kube: tc.args.kube,
  985. logical: tc.args.vClient,
  986. store: tc.args.store,
  987. namespace: tc.args.ns,
  988. }
  989. val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
  990. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  991. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  992. }
  993. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  994. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  995. }
  996. })
  997. }
  998. }
  999. func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
  1000. return func(ctx context.Context, path string) (*vault.Secret, error) {
  1001. path = strings.TrimPrefix(path, "secret/metadata/")
  1002. if path == "" {
  1003. path = "default"
  1004. }
  1005. data, ok := secrets[path]
  1006. if !ok {
  1007. return nil, errors.New("Secret not found")
  1008. }
  1009. meta := data.(map[string]interface{})
  1010. ans := meta["metadata"].(map[string]interface{})
  1011. secret := &vault.Secret{
  1012. Data: map[string]interface{}{
  1013. "keys": ans["keys"],
  1014. },
  1015. }
  1016. return secret, nil
  1017. }
  1018. }
  1019. func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  1020. return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1021. path = strings.TrimPrefix(path, "secret/data/")
  1022. path = strings.TrimPrefix(path, "secret/metadata/")
  1023. if path == "" {
  1024. path = "default"
  1025. }
  1026. data, ok := secrets[path]
  1027. if !ok {
  1028. return nil, errors.New("Secret not found")
  1029. }
  1030. meta := data.(map[string]interface{})
  1031. metadata := meta["metadata"].(map[string]interface{})
  1032. content := map[string]interface{}{
  1033. "data": meta["data"],
  1034. "custom_metadata": metadata["custom_metadata"],
  1035. }
  1036. secret := &vault.Secret{
  1037. Data: content,
  1038. }
  1039. return secret, nil
  1040. }
  1041. }
  1042. func TestGetAllSecrets(t *testing.T) {
  1043. secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
  1044. secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
  1045. path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
  1046. path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
  1047. tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
  1048. path := "path"
  1049. secret := map[string]interface{}{
  1050. "secret1": map[string]interface{}{
  1051. "metadata": map[string]interface{}{
  1052. "custom_metadata": map[string]interface{}{
  1053. "foo": "bar",
  1054. },
  1055. },
  1056. "data": map[string]interface{}{
  1057. "access_key": "access_key",
  1058. "access_secret": "access_secret",
  1059. },
  1060. },
  1061. "secret2": map[string]interface{}{
  1062. "metadata": map[string]interface{}{
  1063. "custom_metadata": map[string]interface{}{
  1064. "foo": "baz",
  1065. },
  1066. },
  1067. "data": map[string]interface{}{
  1068. "access_key": "access_key2",
  1069. "access_secret": "access_secret2",
  1070. },
  1071. },
  1072. "secret3": map[string]interface{}{
  1073. "metadata": map[string]interface{}{
  1074. "custom_metadata": map[string]interface{}{
  1075. "foo": "baz",
  1076. },
  1077. },
  1078. "data": nil,
  1079. },
  1080. "tag": map[string]interface{}{
  1081. "metadata": map[string]interface{}{
  1082. "custom_metadata": map[string]interface{}{
  1083. "foo": "baz",
  1084. },
  1085. },
  1086. "data": map[string]interface{}{
  1087. "access_key": "unfetched",
  1088. "access_secret": "unfetched",
  1089. },
  1090. },
  1091. "path/1": map[string]interface{}{
  1092. "metadata": map[string]interface{}{
  1093. "custom_metadata": map[string]interface{}{
  1094. "foo": "path",
  1095. },
  1096. },
  1097. "data": map[string]interface{}{
  1098. "access_key": "path1",
  1099. "access_secret": "path1",
  1100. },
  1101. },
  1102. "path/2": map[string]interface{}{
  1103. "metadata": map[string]interface{}{
  1104. "custom_metadata": map[string]interface{}{
  1105. "foo": "path",
  1106. },
  1107. },
  1108. "data": map[string]interface{}{
  1109. "access_key": "path2",
  1110. "access_secret": "path2",
  1111. },
  1112. },
  1113. "default": map[string]interface{}{
  1114. "data": map[string]interface{}{
  1115. "empty": "true",
  1116. },
  1117. "metadata": map[string]interface{}{
  1118. "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
  1119. },
  1120. },
  1121. "path/": map[string]interface{}{
  1122. "data": map[string]interface{}{
  1123. "empty": "true",
  1124. },
  1125. "metadata": map[string]interface{}{
  1126. "keys": []interface{}{"1", "2"},
  1127. },
  1128. },
  1129. }
  1130. type args struct {
  1131. store *esv1beta1.VaultProvider
  1132. kube kclient.Client
  1133. vLogical util.Logical
  1134. ns string
  1135. data esv1beta1.ExternalSecretFind
  1136. }
  1137. type want struct {
  1138. err error
  1139. val map[string][]byte
  1140. }
  1141. cases := map[string]struct {
  1142. reason string
  1143. args args
  1144. want want
  1145. }{
  1146. "FindByName": {
  1147. reason: "should map multiple secrets matching name",
  1148. args: args{
  1149. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1150. vLogical: &fake.Logical{
  1151. ListWithContextFn: newListWithContextFn(secret),
  1152. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1153. },
  1154. data: esv1beta1.ExternalSecretFind{
  1155. Name: &esv1beta1.FindName{
  1156. RegExp: "secret.*",
  1157. },
  1158. },
  1159. },
  1160. want: want{
  1161. err: nil,
  1162. val: map[string][]byte{
  1163. "secret1": secret1Bytes,
  1164. "secret2": secret2Bytes,
  1165. },
  1166. },
  1167. },
  1168. "FindByTag": {
  1169. reason: "should map multiple secrets matching tags",
  1170. args: args{
  1171. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1172. vLogical: &fake.Logical{
  1173. ListWithContextFn: newListWithContextFn(secret),
  1174. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1175. },
  1176. data: esv1beta1.ExternalSecretFind{
  1177. Tags: map[string]string{
  1178. "foo": "baz",
  1179. },
  1180. },
  1181. },
  1182. want: want{
  1183. err: nil,
  1184. val: map[string][]byte{
  1185. "tag": tagBytes,
  1186. "secret2": secret2Bytes,
  1187. },
  1188. },
  1189. },
  1190. "FilterByPath": {
  1191. reason: "should filter secrets based on path",
  1192. args: args{
  1193. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1194. vLogical: &fake.Logical{
  1195. ListWithContextFn: newListWithContextFn(secret),
  1196. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1197. },
  1198. data: esv1beta1.ExternalSecretFind{
  1199. Path: &path,
  1200. Tags: map[string]string{
  1201. "foo": "path",
  1202. },
  1203. },
  1204. },
  1205. want: want{
  1206. err: nil,
  1207. val: map[string][]byte{
  1208. "path/1": path1Bytes,
  1209. "path/2": path2Bytes,
  1210. },
  1211. },
  1212. },
  1213. "FailIfKv1": {
  1214. reason: "should not work if using kv1 store",
  1215. args: args{
  1216. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1217. vLogical: &fake.Logical{
  1218. ListWithContextFn: newListWithContextFn(secret),
  1219. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1220. },
  1221. data: esv1beta1.ExternalSecretFind{
  1222. Tags: map[string]string{
  1223. "foo": "baz",
  1224. },
  1225. },
  1226. },
  1227. want: want{
  1228. err: errors.New(errUnsupportedKvVersion),
  1229. },
  1230. },
  1231. "MetadataNotFound": {
  1232. reason: "metadata secret not found",
  1233. args: args{
  1234. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1235. vLogical: &fake.Logical{
  1236. ListWithContextFn: newListWithContextFn(secret),
  1237. ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1238. return nil, nil
  1239. },
  1240. },
  1241. data: esv1beta1.ExternalSecretFind{
  1242. Tags: map[string]string{
  1243. "foo": "baz",
  1244. },
  1245. },
  1246. },
  1247. want: want{
  1248. err: errors.New(errNotFound),
  1249. },
  1250. },
  1251. }
  1252. for name, tc := range cases {
  1253. t.Run(name, func(t *testing.T) {
  1254. vStore := &client{
  1255. kube: tc.args.kube,
  1256. logical: tc.args.vLogical,
  1257. store: tc.args.store,
  1258. namespace: tc.args.ns,
  1259. }
  1260. val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
  1261. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1262. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1263. }
  1264. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1265. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1266. }
  1267. })
  1268. }
  1269. }
  1270. func TestGetSecretPath(t *testing.T) {
  1271. storeV2 := makeValidSecretStore()
  1272. storeV2NoPath := storeV2.DeepCopy()
  1273. multiPath := "secret/path"
  1274. storeV2.Spec.Provider.Vault.Path = &multiPath
  1275. storeV2NoPath.Spec.Provider.Vault.Path = nil
  1276. storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
  1277. storeV1NoPath := storeV1.DeepCopy()
  1278. storeV1.Spec.Provider.Vault.Path = &multiPath
  1279. storeV1NoPath.Spec.Provider.Vault.Path = nil
  1280. type args struct {
  1281. store *esv1beta1.VaultProvider
  1282. path string
  1283. expected string
  1284. }
  1285. cases := map[string]struct {
  1286. reason string
  1287. args args
  1288. }{
  1289. "PathWithoutFormatV2": {
  1290. reason: "path should compose with mount point if set",
  1291. args: args{
  1292. store: storeV2.Spec.Provider.Vault,
  1293. path: "secret/path/data/test",
  1294. expected: "secret/path/data/test",
  1295. },
  1296. },
  1297. "PathWithoutFormatV2_NoData": {
  1298. reason: "path should compose with mount point if set without data",
  1299. args: args{
  1300. store: storeV2.Spec.Provider.Vault,
  1301. path: "secret/path/test",
  1302. expected: "secret/path/data/test",
  1303. },
  1304. },
  1305. "PathWithoutFormatV2_NoPath": {
  1306. reason: "if no mountpoint and no data available, needs to be set in second element",
  1307. args: args{
  1308. store: storeV2NoPath.Spec.Provider.Vault,
  1309. path: "secret/test/big/path",
  1310. expected: "secret/data/test/big/path",
  1311. },
  1312. },
  1313. "PathWithoutFormatV2_NoPathWithData": {
  1314. reason: "if data is available, should respect order",
  1315. args: args{
  1316. store: storeV2NoPath.Spec.Provider.Vault,
  1317. path: "secret/test/data/not/the/first/and/data/twice",
  1318. expected: "secret/test/data/not/the/first/and/data/twice",
  1319. },
  1320. },
  1321. "PathWithoutFormatV1": {
  1322. reason: "v1 mountpoint should be added but not enforce 'data'",
  1323. args: args{
  1324. store: storeV1.Spec.Provider.Vault,
  1325. path: "secret/path/test",
  1326. expected: "secret/path/test",
  1327. },
  1328. },
  1329. "PathWithoutFormatV1_NoPath": {
  1330. reason: "Should not append any path information if v1 with no mountpoint",
  1331. args: args{
  1332. store: storeV1NoPath.Spec.Provider.Vault,
  1333. path: "secret/test",
  1334. expected: "secret/test",
  1335. },
  1336. },
  1337. "WithoutPathButMountpointV2": {
  1338. reason: "Mountpoint needs to be set in addition to data",
  1339. args: args{
  1340. store: storeV2.Spec.Provider.Vault,
  1341. path: "test",
  1342. expected: "secret/path/data/test",
  1343. },
  1344. },
  1345. "WithoutPathButMountpointV1": {
  1346. reason: "Mountpoint needs to be set in addition to data",
  1347. args: args{
  1348. store: storeV1.Spec.Provider.Vault,
  1349. path: "test",
  1350. expected: "secret/path/test",
  1351. },
  1352. },
  1353. }
  1354. for name, tc := range cases {
  1355. t.Run(name, func(t *testing.T) {
  1356. vStore := &client{
  1357. store: tc.args.store,
  1358. }
  1359. want := vStore.buildPath(tc.args.path)
  1360. if diff := cmp.Diff(want, tc.args.expected); diff != "" {
  1361. t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
  1362. }
  1363. })
  1364. }
  1365. }
  1366. func TestValidateStore(t *testing.T) {
  1367. type args struct {
  1368. auth esv1beta1.VaultAuth
  1369. }
  1370. tests := []struct {
  1371. name string
  1372. args args
  1373. wantErr bool
  1374. }{
  1375. {
  1376. name: "empty auth",
  1377. args: args{},
  1378. },
  1379. {
  1380. name: "invalid approle with namespace",
  1381. args: args{
  1382. auth: esv1beta1.VaultAuth{
  1383. AppRole: &esv1beta1.VaultAppRole{
  1384. SecretRef: esmeta.SecretKeySelector{
  1385. Namespace: pointer.String("invalid"),
  1386. },
  1387. },
  1388. },
  1389. },
  1390. wantErr: true,
  1391. },
  1392. {
  1393. name: "invalid approle with roleId and no roleRef",
  1394. args: args{
  1395. auth: esv1beta1.VaultAuth{
  1396. AppRole: &esv1beta1.VaultAppRole{
  1397. RoleID: "",
  1398. RoleRef: nil,
  1399. },
  1400. },
  1401. },
  1402. wantErr: true,
  1403. },
  1404. {
  1405. name: "valid approle with roleId and no roleRef",
  1406. args: args{
  1407. auth: esv1beta1.VaultAuth{
  1408. AppRole: &esv1beta1.VaultAppRole{
  1409. RoleID: "fake-value",
  1410. },
  1411. },
  1412. },
  1413. wantErr: false,
  1414. },
  1415. {
  1416. name: "valid approle with roleId and no roleRef",
  1417. args: args{
  1418. auth: esv1beta1.VaultAuth{
  1419. AppRole: &esv1beta1.VaultAppRole{
  1420. RoleRef: &esmeta.SecretKeySelector{
  1421. Name: "fake-value",
  1422. },
  1423. },
  1424. },
  1425. },
  1426. wantErr: false,
  1427. },
  1428. {
  1429. name: "invalid clientcert",
  1430. args: args{
  1431. auth: esv1beta1.VaultAuth{
  1432. Cert: &esv1beta1.VaultCertAuth{
  1433. ClientCert: esmeta.SecretKeySelector{
  1434. Namespace: pointer.String("invalid"),
  1435. },
  1436. },
  1437. },
  1438. },
  1439. wantErr: true,
  1440. },
  1441. {
  1442. name: "invalid cert secret",
  1443. args: args{
  1444. auth: esv1beta1.VaultAuth{
  1445. Cert: &esv1beta1.VaultCertAuth{
  1446. SecretRef: esmeta.SecretKeySelector{
  1447. Namespace: pointer.String("invalid"),
  1448. },
  1449. },
  1450. },
  1451. },
  1452. wantErr: true,
  1453. },
  1454. {
  1455. name: "invalid jwt secret",
  1456. args: args{
  1457. auth: esv1beta1.VaultAuth{
  1458. Jwt: &esv1beta1.VaultJwtAuth{
  1459. SecretRef: &esmeta.SecretKeySelector{
  1460. Namespace: pointer.String("invalid"),
  1461. },
  1462. },
  1463. },
  1464. },
  1465. wantErr: true,
  1466. },
  1467. {
  1468. name: "invalid kubernetes sa",
  1469. args: args{
  1470. auth: esv1beta1.VaultAuth{
  1471. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1472. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  1473. Namespace: pointer.String("invalid"),
  1474. },
  1475. },
  1476. },
  1477. },
  1478. wantErr: true,
  1479. },
  1480. {
  1481. name: "invalid kubernetes secret",
  1482. args: args{
  1483. auth: esv1beta1.VaultAuth{
  1484. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1485. SecretRef: &esmeta.SecretKeySelector{
  1486. Namespace: pointer.String("invalid"),
  1487. },
  1488. },
  1489. },
  1490. },
  1491. wantErr: true,
  1492. },
  1493. {
  1494. name: "invalid ldap secret",
  1495. args: args{
  1496. auth: esv1beta1.VaultAuth{
  1497. Ldap: &esv1beta1.VaultLdapAuth{
  1498. SecretRef: esmeta.SecretKeySelector{
  1499. Namespace: pointer.String("invalid"),
  1500. },
  1501. },
  1502. },
  1503. },
  1504. wantErr: true,
  1505. },
  1506. {
  1507. name: "invalid token secret",
  1508. args: args{
  1509. auth: esv1beta1.VaultAuth{
  1510. TokenSecretRef: &esmeta.SecretKeySelector{
  1511. Namespace: pointer.String("invalid"),
  1512. },
  1513. },
  1514. },
  1515. wantErr: true,
  1516. },
  1517. }
  1518. for _, tt := range tests {
  1519. t.Run(tt.name, func(t *testing.T) {
  1520. c := &Connector{
  1521. NewVaultClient: nil,
  1522. }
  1523. store := &esv1beta1.SecretStore{
  1524. Spec: esv1beta1.SecretStoreSpec{
  1525. Provider: &esv1beta1.SecretStoreProvider{
  1526. Vault: &esv1beta1.VaultProvider{
  1527. Auth: tt.args.auth,
  1528. },
  1529. },
  1530. },
  1531. }
  1532. if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
  1533. t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
  1534. }
  1535. })
  1536. }
  1537. }
  1538. type fakeRef struct {
  1539. key string
  1540. property string
  1541. }
  1542. func (f fakeRef) GetRemoteKey() string {
  1543. return f.key
  1544. }
  1545. func (f fakeRef) GetProperty() string {
  1546. return f.property
  1547. }
  1548. func TestDeleteSecret(t *testing.T) {
  1549. type args struct {
  1550. store *esv1beta1.VaultProvider
  1551. vLogical util.Logical
  1552. }
  1553. type want struct {
  1554. err error
  1555. }
  1556. tests := map[string]struct {
  1557. reason string
  1558. args args
  1559. ref *fakeRef
  1560. want want
  1561. value []byte
  1562. }{
  1563. "DeleteSecretNoOp": {
  1564. reason: "No secret is because it does not exist",
  1565. args: args{
  1566. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1567. vLogical: &fake.Logical{
  1568. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1569. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1570. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1571. },
  1572. },
  1573. want: want{
  1574. err: nil,
  1575. },
  1576. },
  1577. "DeleteSecretFailIfError": {
  1578. reason: "No secret is because it does not exist",
  1579. args: args{
  1580. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1581. vLogical: &fake.Logical{
  1582. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
  1583. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1584. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1585. },
  1586. },
  1587. want: want{
  1588. err: fmt.Errorf("failed to read"),
  1589. },
  1590. },
  1591. "DeleteSecretNotManaged": {
  1592. reason: "No secret is because it does not exist",
  1593. args: args{
  1594. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1595. vLogical: &fake.Logical{
  1596. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1597. "data": map[string]interface{}{
  1598. "fake-key": "fake-value",
  1599. },
  1600. "custom_metadata": map[string]interface{}{
  1601. "managed-by": "another-secret-tool",
  1602. },
  1603. }, nil),
  1604. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1605. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1606. },
  1607. },
  1608. want: want{
  1609. err: nil,
  1610. },
  1611. },
  1612. "DeleteSecretSuccess": {
  1613. reason: "No secret is because it does not exist",
  1614. args: args{
  1615. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1616. vLogical: &fake.Logical{
  1617. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1618. "data": map[string]interface{}{
  1619. "fake-key": "fake-value",
  1620. },
  1621. "custom_metadata": map[string]interface{}{
  1622. "managed-by": "external-secrets",
  1623. },
  1624. }, nil),
  1625. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1626. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1627. },
  1628. },
  1629. want: want{
  1630. err: nil,
  1631. },
  1632. },
  1633. "DeleteSecretError": {
  1634. reason: "No secret is because it does not exist",
  1635. args: args{
  1636. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1637. vLogical: &fake.Logical{
  1638. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1639. "data": map[string]interface{}{
  1640. "fake-key": "fake-value",
  1641. },
  1642. "custom_metadata": map[string]interface{}{
  1643. "managed-by": "external-secrets",
  1644. },
  1645. }, nil),
  1646. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1647. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
  1648. },
  1649. },
  1650. want: want{
  1651. err: fmt.Errorf("failed to delete"),
  1652. },
  1653. },
  1654. "DeleteSecretUpdateProperty": {
  1655. reason: "Secret should only be updated if Property is set",
  1656. ref: &fakeRef{key: "secret", property: "fake-key"},
  1657. args: args{
  1658. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1659. vLogical: &fake.Logical{
  1660. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1661. "data": map[string]interface{}{
  1662. "fake-key": "fake-value",
  1663. "foo": "bar",
  1664. },
  1665. "custom_metadata": map[string]interface{}{
  1666. "managed-by": "external-secrets",
  1667. },
  1668. }, nil),
  1669. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "bar"}}),
  1670. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1671. },
  1672. },
  1673. want: want{
  1674. err: nil,
  1675. },
  1676. },
  1677. "DeleteSecretIfNoOtherProperties": {
  1678. reason: "Secret should only be deleted if no other properties are set",
  1679. ref: &fakeRef{key: "secret", property: "foo"},
  1680. args: args{
  1681. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1682. vLogical: &fake.Logical{
  1683. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1684. "data": map[string]interface{}{
  1685. "foo": "bar",
  1686. },
  1687. "custom_metadata": map[string]interface{}{
  1688. "managed-by": "external-secrets",
  1689. },
  1690. }, nil),
  1691. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1692. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1693. },
  1694. },
  1695. want: want{
  1696. err: nil,
  1697. },
  1698. },
  1699. }
  1700. for name, tc := range tests {
  1701. t.Run(name, func(t *testing.T) {
  1702. ref := fakeRef{key: "secret", property: ""}
  1703. if tc.ref != nil {
  1704. ref = *tc.ref
  1705. }
  1706. client := &client{
  1707. logical: tc.args.vLogical,
  1708. store: tc.args.store,
  1709. }
  1710. err := client.DeleteSecret(context.Background(), ref)
  1711. // Error nil XOR tc.want.err nil
  1712. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  1713. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  1714. }
  1715. // if errors are the same type but their contents do not match
  1716. if err != nil && tc.want.err != nil {
  1717. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  1718. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  1719. }
  1720. }
  1721. })
  1722. }
  1723. }
  1724. func TestSetSecret(t *testing.T) {
  1725. noPermission := errors.New("no permission")
  1726. type args struct {
  1727. store *esv1beta1.VaultProvider
  1728. vLogical util.Logical
  1729. }
  1730. type want struct {
  1731. err error
  1732. }
  1733. tests := map[string]struct {
  1734. reason string
  1735. args args
  1736. want want
  1737. ref *fakeRef
  1738. value []byte
  1739. }{
  1740. "SetSecret": {
  1741. reason: "secret is successfully set, with no existing vault secret",
  1742. args: args{
  1743. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1744. vLogical: &fake.Logical{
  1745. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1746. WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
  1747. },
  1748. },
  1749. want: want{
  1750. err: nil,
  1751. },
  1752. },
  1753. "SetSecretWithWriteError": {
  1754. reason: "secret cannot be pushed if write fails",
  1755. args: args{
  1756. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1757. vLogical: &fake.Logical{
  1758. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1759. WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
  1760. },
  1761. },
  1762. want: want{
  1763. err: noPermission,
  1764. },
  1765. },
  1766. "SetSecretEqualsPushSecret": {
  1767. reason: "vault secret kv equals secret to push kv",
  1768. args: args{
  1769. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1770. vLogical: &fake.Logical{
  1771. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1772. "data": map[string]interface{}{
  1773. "fake-key": "fake-value",
  1774. },
  1775. "custom_metadata": map[string]interface{}{
  1776. "managed-by": "external-secrets",
  1777. },
  1778. }, nil),
  1779. },
  1780. },
  1781. want: want{
  1782. err: nil,
  1783. },
  1784. },
  1785. "PushSecretProperty": {
  1786. reason: "push secret with property adds the property",
  1787. value: []byte("fake-value"),
  1788. ref: &fakeRef{key: "secret", property: "foo"},
  1789. args: args{
  1790. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1791. vLogical: &fake.Logical{
  1792. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1793. "data": map[string]interface{}{
  1794. "fake-key": "fake-value",
  1795. },
  1796. "custom_metadata": map[string]interface{}{
  1797. "managed-by": "external-secrets",
  1798. },
  1799. }, nil),
  1800. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"fake-key": "fake-value", "foo": "fake-value"}}),
  1801. },
  1802. },
  1803. want: want{
  1804. err: nil,
  1805. },
  1806. },
  1807. "PushSecretUpdateProperty": {
  1808. reason: "push secret with property only updates the property",
  1809. value: []byte("new-value"),
  1810. ref: &fakeRef{key: "secret", property: "foo"},
  1811. args: args{
  1812. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1813. vLogical: &fake.Logical{
  1814. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1815. "data": map[string]interface{}{
  1816. "foo": "fake-value",
  1817. },
  1818. "custom_metadata": map[string]interface{}{
  1819. "managed-by": "external-secrets",
  1820. },
  1821. }, nil),
  1822. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "new-value"}}),
  1823. },
  1824. },
  1825. want: want{
  1826. err: nil,
  1827. },
  1828. },
  1829. "PushSecretPropertyNoUpdate": {
  1830. reason: "push secret with property only updates the property",
  1831. value: []byte("fake-value"),
  1832. ref: &fakeRef{key: "secret", property: "foo"},
  1833. args: args{
  1834. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1835. vLogical: &fake.Logical{
  1836. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1837. "data": map[string]interface{}{
  1838. "foo": "fake-value",
  1839. },
  1840. "custom_metadata": map[string]interface{}{
  1841. "managed-by": "external-secrets",
  1842. },
  1843. }, nil),
  1844. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1845. },
  1846. },
  1847. want: want{
  1848. err: nil,
  1849. },
  1850. },
  1851. "SetSecretErrorReadingSecret": {
  1852. reason: "error occurs if secret cannot be read",
  1853. args: args{
  1854. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1855. vLogical: &fake.Logical{
  1856. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
  1857. },
  1858. },
  1859. want: want{
  1860. err: fmt.Errorf(errReadSecret, noPermission),
  1861. },
  1862. },
  1863. "SetSecretNotManagedByESO": {
  1864. reason: "a secret not managed by ESO cannot be updated",
  1865. args: args{
  1866. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1867. vLogical: &fake.Logical{
  1868. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1869. "data": map[string]interface{}{
  1870. "fake-key": "fake-value2",
  1871. "custom_metadata": map[string]interface{}{
  1872. "managed-by": "not-external-secrets",
  1873. },
  1874. },
  1875. }, nil),
  1876. },
  1877. },
  1878. want: want{
  1879. err: errors.New("secret not managed by external-secrets"),
  1880. },
  1881. },
  1882. }
  1883. for name, tc := range tests {
  1884. t.Run(name, func(t *testing.T) {
  1885. ref := fakeRef{key: "secret", property: ""}
  1886. if tc.ref != nil {
  1887. ref = *tc.ref
  1888. }
  1889. client := &client{
  1890. logical: tc.args.vLogical,
  1891. store: tc.args.store,
  1892. }
  1893. val := tc.value
  1894. if val == nil {
  1895. val = []byte(`{"fake-key":"fake-value"}`)
  1896. }
  1897. err := client.PushSecret(context.Background(), val, ref)
  1898. // Error nil XOR tc.want.err nil
  1899. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  1900. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  1901. }
  1902. // if errors are the same type but their contents do not match
  1903. if err != nil && tc.want.err != nil {
  1904. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  1905. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  1906. }
  1907. }
  1908. })
  1909. }
  1910. }
  1911. // EquateErrors returns true if the supplied errors are of the same type and
  1912. // produce identical strings. This mirrors the error comparison behavior of
  1913. // https://github.com/go-test/deep, which most Crossplane tests targeted before
  1914. // we switched to go-cmp.
  1915. //
  1916. // This differs from cmpopts.EquateErrors, which does not test for error strings
  1917. // and instead returns whether one error 'is' (in the errors.Is sense) the
  1918. // other.
  1919. func EquateErrors() cmp.Option {
  1920. return cmp.Comparer(func(a, b error) bool {
  1921. if a == nil || b == nil {
  1922. return a == nil && b == nil
  1923. }
  1924. av := reflect.ValueOf(a)
  1925. bv := reflect.ValueOf(b)
  1926. if av.Type() != bv.Type() {
  1927. return false
  1928. }
  1929. return a.Error() == b.Error()
  1930. })
  1931. }