vault_test.go 75 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463
  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. pointer "k8s.io/utils/ptr"
  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. testingfake "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
  32. utilfake "github.com/external-secrets/external-secrets/pkg/provider/util/fake"
  33. "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
  34. "github.com/external-secrets/external-secrets/pkg/provider/vault/util"
  35. )
  36. const (
  37. tokenSecretName = "example-secret-token"
  38. secretDataString = "some-creds"
  39. )
  40. var (
  41. secretStorePath = "secret"
  42. )
  43. func makeValidSecretStoreWithVersion(v esv1beta1.VaultKVStoreVersion) *esv1beta1.SecretStore {
  44. return &esv1beta1.SecretStore{
  45. ObjectMeta: metav1.ObjectMeta{
  46. Name: "vault-store",
  47. Namespace: "default",
  48. },
  49. Spec: esv1beta1.SecretStoreSpec{
  50. Provider: &esv1beta1.SecretStoreProvider{
  51. Vault: &esv1beta1.VaultProvider{
  52. Server: "vault.example.com",
  53. Path: &secretStorePath,
  54. Version: v,
  55. Auth: esv1beta1.VaultAuth{
  56. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  57. Path: "kubernetes",
  58. Role: "kubernetes-auth-role",
  59. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  60. Name: "example-sa",
  61. },
  62. },
  63. },
  64. },
  65. },
  66. },
  67. }
  68. }
  69. func makeValidSecretStore() *esv1beta1.SecretStore {
  70. return makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2)
  71. }
  72. func makeValidSecretStoreWithCerts() *esv1beta1.SecretStore {
  73. return &esv1beta1.SecretStore{
  74. ObjectMeta: metav1.ObjectMeta{
  75. Name: "vault-store",
  76. Namespace: "default",
  77. },
  78. Spec: esv1beta1.SecretStoreSpec{
  79. Provider: &esv1beta1.SecretStoreProvider{
  80. Vault: &esv1beta1.VaultProvider{
  81. Server: "vault.example.com",
  82. Path: &secretStorePath,
  83. Version: esv1beta1.VaultKVStoreV2,
  84. Auth: esv1beta1.VaultAuth{
  85. Cert: &esv1beta1.VaultCertAuth{
  86. ClientCert: esmeta.SecretKeySelector{
  87. Name: "tls-auth-certs",
  88. Key: "tls.crt",
  89. },
  90. SecretRef: esmeta.SecretKeySelector{
  91. Name: "tls-auth-certs",
  92. Key: "tls.key",
  93. },
  94. },
  95. },
  96. },
  97. },
  98. },
  99. }
  100. }
  101. func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1beta1.SecretStore {
  102. store := makeSecretStore()
  103. caProvider := &esv1beta1.CAProvider{
  104. Name: "vault-cert",
  105. Key: "cert",
  106. }
  107. if isSecret {
  108. caProvider.Type = "Secret"
  109. } else {
  110. caProvider.Type = "ConfigMap"
  111. }
  112. store.Spec.Provider.Vault.CAProvider = caProvider
  113. return store
  114. }
  115. func makeInvalidClusterSecretStoreWithK8sCerts() *esv1beta1.ClusterSecretStore {
  116. return &esv1beta1.ClusterSecretStore{
  117. TypeMeta: metav1.TypeMeta{
  118. Kind: "ClusterSecretStore",
  119. },
  120. ObjectMeta: metav1.ObjectMeta{
  121. Name: "vault-store",
  122. Namespace: "default",
  123. },
  124. Spec: esv1beta1.SecretStoreSpec{
  125. Provider: &esv1beta1.SecretStoreProvider{
  126. Vault: &esv1beta1.VaultProvider{
  127. Server: "vault.example.com",
  128. Path: &secretStorePath,
  129. Version: "v2",
  130. Auth: esv1beta1.VaultAuth{
  131. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  132. Path: "kubernetes",
  133. Role: "kubernetes-auth-role",
  134. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  135. Name: "example-sa",
  136. },
  137. },
  138. },
  139. CAProvider: &esv1beta1.CAProvider{
  140. Name: "vault-cert",
  141. Key: "cert",
  142. Type: "Secret",
  143. },
  144. },
  145. },
  146. },
  147. }
  148. }
  149. func makeValidSecretStoreWithIamAuthSecret() *esv1beta1.SecretStore {
  150. return &esv1beta1.SecretStore{
  151. ObjectMeta: metav1.ObjectMeta{
  152. Name: "vault-store",
  153. Namespace: "default",
  154. },
  155. Spec: esv1beta1.SecretStoreSpec{
  156. Provider: &esv1beta1.SecretStoreProvider{
  157. Vault: &esv1beta1.VaultProvider{
  158. Server: "https://vault.example.com:8200",
  159. Path: &secretStorePath,
  160. Version: esv1beta1.VaultKVStoreV2,
  161. Auth: esv1beta1.VaultAuth{
  162. Iam: &esv1beta1.VaultIamAuth{
  163. Path: "aws",
  164. Region: "us-east-1",
  165. Role: "vault-role",
  166. SecretRef: &esv1beta1.VaultAwsAuthSecretRef{
  167. AccessKeyID: esmeta.SecretKeySelector{
  168. Name: "vault-iam-creds-secret",
  169. Key: "access-key",
  170. },
  171. SecretAccessKey: esmeta.SecretKeySelector{
  172. Name: "vault-iam-creds-secret",
  173. Key: "secret-access-key",
  174. },
  175. SessionToken: &esmeta.SecretKeySelector{
  176. Name: "vault-iam-creds-secret",
  177. Key: "secret-session-token",
  178. },
  179. },
  180. },
  181. },
  182. },
  183. },
  184. },
  185. }
  186. }
  187. type secretStoreTweakFn func(s *esv1beta1.SecretStore)
  188. func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1beta1.SecretStore {
  189. store := makeValidSecretStore()
  190. for _, fn := range tweaks {
  191. fn(store)
  192. }
  193. return store
  194. }
  195. type args struct {
  196. newClientFunc func(c *vault.Config) (util.Client, error)
  197. store esv1beta1.GenericStore
  198. kube kclient.Client
  199. corev1 typedcorev1.CoreV1Interface
  200. ns string
  201. }
  202. type want struct {
  203. err error
  204. }
  205. type testCase struct {
  206. reason string
  207. args args
  208. want want
  209. }
  210. func TestNewVault(t *testing.T) {
  211. errBoom := errors.New("boom")
  212. secretClientKey := []byte(`-----BEGIN PRIVATE KEY-----
  213. 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==
  214. -----END PRIVATE KEY-----`)
  215. clientCrt := []byte(`-----BEGIN CERTIFICATE-----
  216. 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==
  217. -----END CERTIFICATE-----`)
  218. secretData := []byte(secretDataString)
  219. cases := map[string]testCase{
  220. "InvalidVaultStore": {
  221. reason: "Should return error if given an invalid vault store.",
  222. args: args{
  223. store: &esv1beta1.SecretStore{},
  224. },
  225. want: want{
  226. err: errors.New(errVaultStore),
  227. },
  228. },
  229. "InvalidRetrySettings": {
  230. reason: "Should return error if given an invalid Retry Interval.",
  231. args: args{
  232. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  233. s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
  234. MaxRetries: pointer.To(int32(3)),
  235. RetryInterval: pointer.To("not-an-interval"),
  236. }
  237. }),
  238. },
  239. want: want{
  240. err: errors.New("time: invalid duration \"not-an-interval\""),
  241. },
  242. },
  243. "ValidRetrySettings": {
  244. reason: "Should return a Vault provider with custom retry settings",
  245. args: args{
  246. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  247. s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
  248. MaxRetries: pointer.To(int32(3)),
  249. RetryInterval: pointer.To("10m"),
  250. }
  251. }),
  252. ns: "default",
  253. kube: clientfake.NewClientBuilder().Build(),
  254. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  255. newClientFunc: fake.ClientWithLoginMock,
  256. },
  257. want: want{
  258. err: nil,
  259. },
  260. },
  261. "AddVaultStoreCertsError": {
  262. reason: "Should return error if given an invalid CA certificate.",
  263. args: args{
  264. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  265. s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
  266. }),
  267. },
  268. want: want{
  269. err: fmt.Errorf(errVaultCert, errors.New("failed to parse certificates from CertPool")),
  270. },
  271. },
  272. "VaultAuthFormatError": {
  273. reason: "Should return error if no valid authentication method is given.",
  274. args: args{
  275. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  276. s.Spec.Provider.Vault.Auth = esv1beta1.VaultAuth{}
  277. }),
  278. },
  279. want: want{
  280. err: errors.New(errAuthFormat),
  281. },
  282. },
  283. "GetKubeServiceAccountError": {
  284. reason: "Should return error if fetching kubernetes secret fails.",
  285. args: args{
  286. newClientFunc: fake.ClientWithLoginMock,
  287. ns: "default",
  288. kube: clientfake.NewClientBuilder().Build(),
  289. store: makeSecretStore(),
  290. corev1: utilfake.NewCreateTokenMock().WithError(errBoom),
  291. },
  292. want: want{
  293. err: fmt.Errorf(errGetKubeSATokenRequest, "example-sa", errBoom),
  294. },
  295. },
  296. "GetKubeSecretError": {
  297. reason: "Should return error if fetching kubernetes secret fails.",
  298. args: args{
  299. ns: "default",
  300. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  301. s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
  302. s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
  303. Name: "vault-secret",
  304. Key: "key",
  305. }
  306. }),
  307. kube: clientfake.NewClientBuilder().Build(),
  308. },
  309. want: want{
  310. err: fmt.Errorf(errGetKubeSecret, "vault-secret", "default", errors.New("secrets \"vault-secret\" not found")),
  311. },
  312. },
  313. "SuccessfulVaultStoreWithCertAuth": {
  314. reason: "Should return a Vault provider successfully",
  315. args: args{
  316. store: makeValidSecretStoreWithCerts(),
  317. ns: "default",
  318. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  319. ObjectMeta: metav1.ObjectMeta{
  320. Name: "tls-auth-certs",
  321. Namespace: "default",
  322. },
  323. Data: map[string][]byte{
  324. "tls.key": secretClientKey,
  325. "tls.crt": clientCrt,
  326. },
  327. }).Build(),
  328. newClientFunc: fake.ClientWithLoginMock,
  329. },
  330. want: want{
  331. err: nil,
  332. },
  333. },
  334. "SuccessfulVaultStoreWithK8sCertSecret": {
  335. reason: "Should return a Vault provider with the cert from k8s",
  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. "cert": clientCrt,
  346. "token": secretData,
  347. },
  348. }).Build(),
  349. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  350. newClientFunc: fake.ClientWithLoginMock,
  351. },
  352. want: want{
  353. err: nil,
  354. },
  355. },
  356. "GetCertNamespaceMissingError": {
  357. reason: "Should return an error if namespace is missing and is a ClusterSecretStore",
  358. args: args{
  359. store: makeInvalidClusterSecretStoreWithK8sCerts(),
  360. ns: "default",
  361. kube: clientfake.NewClientBuilder().Build(),
  362. },
  363. want: want{
  364. err: errors.New(errCANamespace),
  365. },
  366. },
  367. "GetCertSecretKeyMissingError": {
  368. reason: "Should return an error if the secret key is missing",
  369. args: args{
  370. store: makeValidSecretStoreWithK8sCerts(true),
  371. ns: "default",
  372. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  373. ObjectMeta: metav1.ObjectMeta{
  374. Name: "vault-cert",
  375. Namespace: "default",
  376. },
  377. Data: map[string][]byte{},
  378. }).Build(),
  379. newClientFunc: fake.ClientWithLoginMock,
  380. },
  381. want: want{
  382. err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
  383. },
  384. },
  385. "SuccessfulVaultStoreWithIamAuthSecret": {
  386. reason: "Should return a Vault provider successfully",
  387. args: args{
  388. store: makeValidSecretStoreWithIamAuthSecret(),
  389. ns: "default",
  390. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  391. ObjectMeta: metav1.ObjectMeta{
  392. Name: "vault-iam-creds-secret",
  393. Namespace: "default",
  394. },
  395. Data: map[string][]byte{
  396. "access-key": []byte("TESTING"),
  397. "secret-access-key": []byte("ABCDEF"),
  398. "secret-session-token": []byte("c2VjcmV0LXNlc3Npb24tdG9rZW4K"),
  399. },
  400. }).Build(),
  401. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  402. newClientFunc: fake.ClientWithLoginMock,
  403. },
  404. want: want{
  405. err: nil,
  406. },
  407. },
  408. "SuccessfulVaultStoreWithK8sCertConfigMap": {
  409. reason: "Should return a Vault prodvider with the cert from k8s",
  410. args: args{
  411. store: makeValidSecretStoreWithK8sCerts(false),
  412. ns: "default",
  413. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ConfigMap{
  414. ObjectMeta: metav1.ObjectMeta{
  415. Name: "vault-cert",
  416. Namespace: "default",
  417. },
  418. Data: map[string]string{
  419. "cert": string(clientCrt),
  420. },
  421. }).Build(),
  422. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  423. newClientFunc: fake.ClientWithLoginMock,
  424. },
  425. want: want{
  426. err: nil,
  427. },
  428. },
  429. "GetCertConfigMapMissingError": {
  430. reason: "Should return an error if the config map key is missing",
  431. args: args{
  432. store: makeValidSecretStoreWithK8sCerts(false),
  433. ns: "default",
  434. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
  435. ObjectMeta: metav1.ObjectMeta{
  436. Name: "example-sa",
  437. Namespace: "default",
  438. },
  439. Secrets: []corev1.ObjectReference{
  440. {
  441. Name: tokenSecretName,
  442. },
  443. },
  444. }, &corev1.ConfigMap{
  445. ObjectMeta: metav1.ObjectMeta{
  446. Name: "vault-cert",
  447. Namespace: "default",
  448. },
  449. Data: map[string]string{},
  450. }).Build(),
  451. newClientFunc: fake.ClientWithLoginMock,
  452. },
  453. want: want{
  454. err: fmt.Errorf(errConfigMapFmt, "cert"),
  455. },
  456. },
  457. "GetCertificateFormatError": {
  458. reason: "Should return error if client certificate is in wrong format.",
  459. args: args{
  460. store: makeValidSecretStoreWithCerts(),
  461. ns: "default",
  462. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  463. ObjectMeta: metav1.ObjectMeta{
  464. Name: "tls-auth-certs",
  465. Namespace: "default",
  466. },
  467. Data: map[string][]byte{
  468. "tls.key": secretClientKey,
  469. "tls.crt": []byte("cert with mistak"),
  470. },
  471. }).Build(),
  472. newClientFunc: fake.ClientWithLoginMock,
  473. },
  474. want: want{
  475. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
  476. },
  477. },
  478. "GetKeyFormatError": {
  479. reason: "Should return error if client key is in wrong format.",
  480. args: args{
  481. store: makeValidSecretStoreWithCerts(),
  482. ns: "default",
  483. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  484. ObjectMeta: metav1.ObjectMeta{
  485. Name: "tls-auth-certs",
  486. Namespace: "default",
  487. },
  488. Data: map[string][]byte{
  489. "tls.key": []byte("key with mistake"),
  490. "tls.crt": clientCrt,
  491. },
  492. }).Build(),
  493. newClientFunc: fake.ClientWithLoginMock,
  494. },
  495. want: want{
  496. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  497. },
  498. },
  499. "ClientTlsInvalidCertificatesError": {
  500. reason: "Should return error if client key is in wrong format.",
  501. args: args{
  502. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  503. s.Spec.Provider.Vault.ClientTLS = esv1beta1.VaultClientTLS{
  504. CertSecretRef: &esmeta.SecretKeySelector{
  505. Name: "tls-auth-certs",
  506. },
  507. KeySecretRef: &esmeta.SecretKeySelector{
  508. Name: "tls-auth-certs",
  509. },
  510. }
  511. }),
  512. ns: "default",
  513. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  514. ObjectMeta: metav1.ObjectMeta{
  515. Name: "tls-auth-certs",
  516. Namespace: "default",
  517. },
  518. Data: map[string][]byte{
  519. "tls.key": []byte("key with mistake"),
  520. "tls.crt": clientCrt,
  521. },
  522. }).Build(),
  523. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  524. newClientFunc: fake.ClientWithLoginMock,
  525. },
  526. want: want{
  527. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  528. },
  529. },
  530. "SuccessfulVaultStoreValidClientTls": {
  531. reason: "Should return a Vault provider with the cert from k8s",
  532. args: args{
  533. store: makeSecretStore(func(s *esv1beta1.SecretStore) {
  534. s.Spec.Provider.Vault.ClientTLS = esv1beta1.VaultClientTLS{
  535. CertSecretRef: &esmeta.SecretKeySelector{
  536. Name: "tls-auth-certs",
  537. },
  538. KeySecretRef: &esmeta.SecretKeySelector{
  539. Name: "tls-auth-certs",
  540. },
  541. }
  542. }),
  543. ns: "default",
  544. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  545. ObjectMeta: metav1.ObjectMeta{
  546. Name: "tls-auth-certs",
  547. Namespace: "default",
  548. },
  549. Data: map[string][]byte{
  550. "tls.key": secretClientKey,
  551. "tls.crt": clientCrt,
  552. },
  553. }).Build(),
  554. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  555. newClientFunc: fake.ClientWithLoginMock,
  556. },
  557. want: want{
  558. err: nil,
  559. },
  560. },
  561. }
  562. for name, tc := range cases {
  563. t.Run(name, func(t *testing.T) {
  564. vaultTest(t, name, tc)
  565. })
  566. }
  567. }
  568. func vaultTest(t *testing.T, _ string, tc testCase) {
  569. conn := &Connector{
  570. NewVaultClient: tc.args.newClientFunc,
  571. }
  572. if tc.args.newClientFunc == nil {
  573. conn.NewVaultClient = NewVaultClient
  574. }
  575. _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
  576. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  577. t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
  578. }
  579. }
  580. func TestGetSecret(t *testing.T) {
  581. errBoom := errors.New("boom")
  582. secret := map[string]interface{}{
  583. "access_key": "access_key",
  584. "access_secret": "access_secret",
  585. }
  586. secretWithNilVal := map[string]interface{}{
  587. "access_key": "access_key",
  588. "access_secret": "access_secret",
  589. "token": nil,
  590. }
  591. secretWithNestedVal := map[string]interface{}{
  592. "access_key": "access_key",
  593. "access_secret": "access_secret",
  594. "nested.bar": "something different",
  595. "nested": map[string]string{
  596. "foo": "oke",
  597. "bar": "also ok?",
  598. },
  599. "list_of_values": []string{
  600. "first_value",
  601. "second_value",
  602. "third_value",
  603. },
  604. "json_number": json.Number("42"),
  605. }
  606. type args struct {
  607. store *esv1beta1.VaultProvider
  608. kube kclient.Client
  609. vLogical util.Logical
  610. ns string
  611. data esv1beta1.ExternalSecretDataRemoteRef
  612. }
  613. type want struct {
  614. err error
  615. val []byte
  616. }
  617. cases := map[string]struct {
  618. reason string
  619. args args
  620. want want
  621. }{
  622. "ReadSecret": {
  623. reason: "Should return the secret with property",
  624. args: args{
  625. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  626. data: esv1beta1.ExternalSecretDataRemoteRef{
  627. Property: "access_key",
  628. },
  629. vLogical: &fake.Logical{
  630. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  631. },
  632. },
  633. want: want{
  634. err: nil,
  635. val: []byte("access_key"),
  636. },
  637. },
  638. "ReadSecretWithNil": {
  639. reason: "Should return the secret with property if it has a nil val",
  640. args: args{
  641. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  642. data: esv1beta1.ExternalSecretDataRemoteRef{
  643. Property: "access_key",
  644. },
  645. vLogical: &fake.Logical{
  646. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  647. },
  648. },
  649. want: want{
  650. err: nil,
  651. val: []byte("access_key"),
  652. },
  653. },
  654. "ReadSecretWithoutProperty": {
  655. reason: "Should return the json encoded secret without property",
  656. args: args{
  657. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  658. data: esv1beta1.ExternalSecretDataRemoteRef{},
  659. vLogical: &fake.Logical{
  660. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  661. },
  662. },
  663. want: want{
  664. err: nil,
  665. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  666. },
  667. },
  668. "ReadSecretWithNestedValue": {
  669. reason: "Should return a nested property",
  670. args: args{
  671. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  672. data: esv1beta1.ExternalSecretDataRemoteRef{
  673. Property: "nested.foo",
  674. },
  675. vLogical: &fake.Logical{
  676. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  677. },
  678. },
  679. want: want{
  680. err: nil,
  681. val: []byte("oke"),
  682. },
  683. },
  684. "ReadSecretWithNestedValueFromData": {
  685. reason: "Should return a nested property",
  686. args: args{
  687. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  688. data: esv1beta1.ExternalSecretDataRemoteRef{
  689. //
  690. Property: "nested.bar",
  691. },
  692. vLogical: &fake.Logical{
  693. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  694. },
  695. },
  696. want: want{
  697. err: nil,
  698. val: []byte("something different"),
  699. },
  700. },
  701. "ReadSecretWithMissingValueFromData": {
  702. reason: "Should return a NoSecretErr",
  703. args: args{
  704. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  705. data: esv1beta1.ExternalSecretDataRemoteRef{
  706. Property: "not-relevant",
  707. },
  708. vLogical: &fake.Logical{
  709. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  710. },
  711. },
  712. want: want{
  713. err: esv1beta1.NoSecretErr,
  714. val: nil,
  715. },
  716. },
  717. "ReadSecretWithSliceValue": {
  718. reason: "Should return property as a joined slice",
  719. args: args{
  720. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  721. data: esv1beta1.ExternalSecretDataRemoteRef{
  722. Property: "list_of_values",
  723. },
  724. vLogical: &fake.Logical{
  725. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  726. },
  727. },
  728. want: want{
  729. err: nil,
  730. val: []byte("first_value\nsecond_value\nthird_value"),
  731. },
  732. },
  733. "ReadSecretWithJsonNumber": {
  734. reason: "Should return parsed json.Number property",
  735. args: args{
  736. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  737. data: esv1beta1.ExternalSecretDataRemoteRef{
  738. Property: "json_number",
  739. },
  740. vLogical: &fake.Logical{
  741. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  742. },
  743. },
  744. want: want{
  745. err: nil,
  746. val: []byte("42"),
  747. },
  748. },
  749. "NonexistentProperty": {
  750. reason: "Should return error property does not exist.",
  751. args: args{
  752. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  753. data: esv1beta1.ExternalSecretDataRemoteRef{
  754. Property: "nop.doesnt.exist",
  755. },
  756. vLogical: &fake.Logical{
  757. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  758. },
  759. },
  760. want: want{
  761. err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
  762. },
  763. },
  764. "ReadSecretError": {
  765. reason: "Should return error if vault client fails to read secret.",
  766. args: args{
  767. store: makeSecretStore().Spec.Provider.Vault,
  768. vLogical: &fake.Logical{
  769. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  770. },
  771. },
  772. want: want{
  773. err: fmt.Errorf(errReadSecret, errBoom),
  774. },
  775. },
  776. "ReadSecretNotFound": {
  777. reason: "Secret doesn't exist",
  778. args: args{
  779. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  780. data: esv1beta1.ExternalSecretDataRemoteRef{
  781. Property: "access_key",
  782. },
  783. vLogical: &fake.Logical{
  784. ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  785. return nil, nil
  786. },
  787. },
  788. },
  789. want: want{
  790. err: esv1beta1.NoSecretError{},
  791. },
  792. },
  793. "ReadSecretMetadataWithoutProperty": {
  794. reason: "Should return the json encoded metadata",
  795. args: args{
  796. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  797. data: esv1beta1.ExternalSecretDataRemoteRef{
  798. MetadataPolicy: "Fetch",
  799. },
  800. vLogical: &fake.Logical{
  801. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  802. },
  803. },
  804. want: want{
  805. err: nil,
  806. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  807. },
  808. },
  809. "ReadSecretMetadataWithProperty": {
  810. reason: "Should return the access_key value from the metadata",
  811. args: args{
  812. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  813. data: esv1beta1.ExternalSecretDataRemoteRef{
  814. MetadataPolicy: "Fetch",
  815. Property: "access_key",
  816. },
  817. vLogical: &fake.Logical{
  818. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  819. },
  820. },
  821. want: want{
  822. err: nil,
  823. val: []byte("access_key"),
  824. },
  825. },
  826. "FailReadSecretMetadataInvalidProperty": {
  827. reason: "Should return error of non existent key inmetadata",
  828. args: args{
  829. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  830. data: esv1beta1.ExternalSecretDataRemoteRef{
  831. MetadataPolicy: "Fetch",
  832. Property: "does_not_exist",
  833. },
  834. vLogical: &fake.Logical{
  835. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  836. },
  837. },
  838. want: want{
  839. err: fmt.Errorf(errSecretKeyFmt, "does_not_exist"),
  840. },
  841. },
  842. "FailReadSecretMetadataNoMetadata": {
  843. reason: "Should return the access_key value from the metadata",
  844. args: args{
  845. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  846. data: esv1beta1.ExternalSecretDataRemoteRef{
  847. MetadataPolicy: "Fetch",
  848. },
  849. vLogical: &fake.Logical{
  850. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  851. },
  852. },
  853. want: want{
  854. err: fmt.Errorf(errNotFound),
  855. },
  856. },
  857. "FailReadSecretMetadataWrongVersion": {
  858. reason: "Should return the access_key value from the metadata",
  859. args: args{
  860. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  861. data: esv1beta1.ExternalSecretDataRemoteRef{
  862. MetadataPolicy: "Fetch",
  863. },
  864. vLogical: &fake.Logical{
  865. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  866. },
  867. },
  868. want: want{
  869. err: fmt.Errorf(errUnsupportedMetadataKvVersion),
  870. },
  871. },
  872. }
  873. for name, tc := range cases {
  874. t.Run(name, func(t *testing.T) {
  875. vStore := &client{
  876. kube: tc.args.kube,
  877. logical: tc.args.vLogical,
  878. store: tc.args.store,
  879. namespace: tc.args.ns,
  880. }
  881. val, err := vStore.GetSecret(context.Background(), tc.args.data)
  882. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  883. t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
  884. }
  885. if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
  886. t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
  887. }
  888. })
  889. }
  890. }
  891. func TestGetSecretMap(t *testing.T) {
  892. errBoom := errors.New("boom")
  893. secret := map[string]interface{}{
  894. "access_key": "access_key",
  895. "access_secret": "access_secret",
  896. }
  897. secretWithSpecialCharacter := map[string]interface{}{
  898. "access_key": "acc<ess_&ke.,y",
  899. "access_secret": "acce&?ss_s>ecret",
  900. }
  901. secretWithNilVal := map[string]interface{}{
  902. "access_key": "access_key",
  903. "access_secret": "access_secret",
  904. "token": nil,
  905. }
  906. secretWithNestedVal := map[string]interface{}{
  907. "access_key": "access_key",
  908. "access_secret": "access_secret",
  909. "nested": map[string]interface{}{
  910. "foo": map[string]string{
  911. "oke": "yup",
  912. "mhkeih": "yada yada",
  913. },
  914. },
  915. }
  916. secretWithTypes := map[string]interface{}{
  917. "access_secret": "access_secret",
  918. "f32": float32(2.12),
  919. "f64": float64(2.1234534153423423),
  920. "int": 42,
  921. "bool": true,
  922. "bt": []byte("foobar"),
  923. }
  924. type args struct {
  925. store *esv1beta1.VaultProvider
  926. kube kclient.Client
  927. vClient util.Logical
  928. ns string
  929. data esv1beta1.ExternalSecretDataRemoteRef
  930. }
  931. type want struct {
  932. err error
  933. val map[string][]byte
  934. }
  935. cases := map[string]struct {
  936. reason string
  937. args args
  938. want want
  939. }{
  940. "ReadSecretKV1": {
  941. reason: "Should map the secret even if it has a nil value",
  942. args: args{
  943. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  944. vClient: &fake.Logical{
  945. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  946. },
  947. },
  948. want: want{
  949. err: nil,
  950. val: map[string][]byte{
  951. "access_key": []byte("access_key"),
  952. "access_secret": []byte("access_secret"),
  953. },
  954. },
  955. },
  956. "ReadSecretKV2": {
  957. reason: "Should map the secret even if it has a nil value",
  958. args: args{
  959. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  960. vClient: &fake.Logical{
  961. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  962. "data": secret,
  963. }, nil),
  964. },
  965. },
  966. want: want{
  967. err: nil,
  968. val: map[string][]byte{
  969. "access_key": []byte("access_key"),
  970. "access_secret": []byte("access_secret"),
  971. },
  972. },
  973. },
  974. "ReadSecretWithSpecialCharactersKV1": {
  975. reason: "Should map the secret even if it has a nil value",
  976. args: args{
  977. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  978. vClient: &fake.Logical{
  979. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithSpecialCharacter, nil),
  980. },
  981. },
  982. want: want{
  983. err: nil,
  984. val: map[string][]byte{
  985. "access_key": []byte("acc<ess_&ke.,y"),
  986. "access_secret": []byte("acce&?ss_s>ecret"),
  987. },
  988. },
  989. },
  990. "ReadSecretWithSpecialCharactersKV2": {
  991. reason: "Should map the secret even if it has a nil value",
  992. args: args{
  993. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  994. vClient: &fake.Logical{
  995. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  996. "data": secretWithSpecialCharacter,
  997. }, nil),
  998. },
  999. },
  1000. want: want{
  1001. err: nil,
  1002. val: map[string][]byte{
  1003. "access_key": []byte("acc<ess_&ke.,y"),
  1004. "access_secret": []byte("acce&?ss_s>ecret"),
  1005. },
  1006. },
  1007. },
  1008. "ReadSecretWithNilValueKV1": {
  1009. reason: "Should map the secret even if it has a nil value",
  1010. args: args{
  1011. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1012. vClient: &fake.Logical{
  1013. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  1014. },
  1015. },
  1016. want: want{
  1017. err: nil,
  1018. val: map[string][]byte{
  1019. "access_key": []byte("access_key"),
  1020. "access_secret": []byte("access_secret"),
  1021. "token": []byte(nil),
  1022. },
  1023. },
  1024. },
  1025. "ReadSecretWithNilValueKV2": {
  1026. reason: "Should map the secret even if it has a nil value",
  1027. args: args{
  1028. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1029. vClient: &fake.Logical{
  1030. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1031. "data": secretWithNilVal}, nil),
  1032. },
  1033. },
  1034. want: want{
  1035. err: nil,
  1036. val: map[string][]byte{
  1037. "access_key": []byte("access_key"),
  1038. "access_secret": []byte("access_secret"),
  1039. "token": []byte(nil),
  1040. },
  1041. },
  1042. },
  1043. "ReadSecretWithTypesKV2": {
  1044. reason: "Should map the secret even if it has other types",
  1045. args: args{
  1046. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1047. vClient: &fake.Logical{
  1048. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1049. "data": secretWithTypes}, nil),
  1050. },
  1051. },
  1052. want: want{
  1053. err: nil,
  1054. val: map[string][]byte{
  1055. "access_secret": []byte("access_secret"),
  1056. "f32": []byte("2.12"),
  1057. "f64": []byte("2.1234534153423423"),
  1058. "int": []byte("42"),
  1059. "bool": []byte("true"),
  1060. "bt": []byte("Zm9vYmFy"), // base64
  1061. },
  1062. },
  1063. },
  1064. "ReadNestedSecret": {
  1065. reason: "Should map the secret for deeply nested property",
  1066. args: args{
  1067. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1068. data: esv1beta1.ExternalSecretDataRemoteRef{
  1069. Property: "nested",
  1070. },
  1071. vClient: &fake.Logical{
  1072. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1073. "data": secretWithNestedVal}, nil),
  1074. },
  1075. },
  1076. want: want{
  1077. err: nil,
  1078. val: map[string][]byte{
  1079. "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
  1080. },
  1081. },
  1082. },
  1083. "ReadDeeplyNestedSecret": {
  1084. reason: "Should map the secret for deeply nested property",
  1085. args: args{
  1086. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1087. data: esv1beta1.ExternalSecretDataRemoteRef{
  1088. Property: "nested.foo",
  1089. },
  1090. vClient: &fake.Logical{
  1091. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1092. "data": secretWithNestedVal}, nil),
  1093. },
  1094. },
  1095. want: want{
  1096. err: nil,
  1097. val: map[string][]byte{
  1098. "oke": []byte("yup"),
  1099. "mhkeih": []byte("yada yada"),
  1100. },
  1101. },
  1102. },
  1103. "ReadSecretError": {
  1104. reason: "Should return error if vault client fails to read secret.",
  1105. args: args{
  1106. store: makeSecretStore().Spec.Provider.Vault,
  1107. vClient: &fake.Logical{
  1108. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  1109. },
  1110. },
  1111. want: want{
  1112. err: fmt.Errorf(errReadSecret, errBoom),
  1113. },
  1114. },
  1115. }
  1116. for name, tc := range cases {
  1117. t.Run(name, func(t *testing.T) {
  1118. vStore := &client{
  1119. kube: tc.args.kube,
  1120. logical: tc.args.vClient,
  1121. store: tc.args.store,
  1122. namespace: tc.args.ns,
  1123. }
  1124. val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
  1125. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1126. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1127. }
  1128. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1129. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1130. }
  1131. })
  1132. }
  1133. }
  1134. func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
  1135. return func(ctx context.Context, path string) (*vault.Secret, error) {
  1136. path = strings.TrimPrefix(path, "secret/metadata/")
  1137. if path == "" {
  1138. path = "default"
  1139. }
  1140. data, ok := secrets[path]
  1141. if !ok {
  1142. return nil, errors.New("Secret not found")
  1143. }
  1144. meta := data.(map[string]interface{})
  1145. ans := meta["metadata"].(map[string]interface{})
  1146. secret := &vault.Secret{
  1147. Data: map[string]interface{}{
  1148. "keys": ans["keys"],
  1149. },
  1150. }
  1151. return secret, nil
  1152. }
  1153. }
  1154. func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  1155. return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1156. path = strings.TrimPrefix(path, "secret/data/")
  1157. path = strings.TrimPrefix(path, "secret/metadata/")
  1158. if path == "" {
  1159. path = "default"
  1160. }
  1161. data, ok := secrets[path]
  1162. if !ok {
  1163. return nil, errors.New("Secret not found")
  1164. }
  1165. meta := data.(map[string]interface{})
  1166. metadata := meta["metadata"].(map[string]interface{})
  1167. content := map[string]interface{}{
  1168. "data": meta["data"],
  1169. "custom_metadata": metadata["custom_metadata"],
  1170. }
  1171. secret := &vault.Secret{
  1172. Data: content,
  1173. }
  1174. return secret, nil
  1175. }
  1176. }
  1177. func TestGetAllSecrets(t *testing.T) {
  1178. secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
  1179. secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
  1180. path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
  1181. path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
  1182. tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
  1183. path := "path"
  1184. secret := map[string]interface{}{
  1185. "secret1": map[string]interface{}{
  1186. "metadata": map[string]interface{}{
  1187. "custom_metadata": map[string]interface{}{
  1188. "foo": "bar",
  1189. },
  1190. },
  1191. "data": map[string]interface{}{
  1192. "access_key": "access_key",
  1193. "access_secret": "access_secret",
  1194. },
  1195. },
  1196. "secret2": map[string]interface{}{
  1197. "metadata": map[string]interface{}{
  1198. "custom_metadata": map[string]interface{}{
  1199. "foo": "baz",
  1200. },
  1201. },
  1202. "data": map[string]interface{}{
  1203. "access_key": "access_key2",
  1204. "access_secret": "access_secret2",
  1205. },
  1206. },
  1207. "secret3": map[string]interface{}{
  1208. "metadata": map[string]interface{}{
  1209. "custom_metadata": map[string]interface{}{
  1210. "foo": "baz",
  1211. },
  1212. },
  1213. "data": nil,
  1214. },
  1215. "tag": map[string]interface{}{
  1216. "metadata": map[string]interface{}{
  1217. "custom_metadata": map[string]interface{}{
  1218. "foo": "baz",
  1219. },
  1220. },
  1221. "data": map[string]interface{}{
  1222. "access_key": "unfetched",
  1223. "access_secret": "unfetched",
  1224. },
  1225. },
  1226. "path/1": map[string]interface{}{
  1227. "metadata": map[string]interface{}{
  1228. "custom_metadata": map[string]interface{}{
  1229. "foo": "path",
  1230. },
  1231. },
  1232. "data": map[string]interface{}{
  1233. "access_key": "path1",
  1234. "access_secret": "path1",
  1235. },
  1236. },
  1237. "path/2": map[string]interface{}{
  1238. "metadata": map[string]interface{}{
  1239. "custom_metadata": map[string]interface{}{
  1240. "foo": "path",
  1241. },
  1242. },
  1243. "data": map[string]interface{}{
  1244. "access_key": "path2",
  1245. "access_secret": "path2",
  1246. },
  1247. },
  1248. "default": map[string]interface{}{
  1249. "data": map[string]interface{}{
  1250. "empty": "true",
  1251. },
  1252. "metadata": map[string]interface{}{
  1253. "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
  1254. },
  1255. },
  1256. "path/": map[string]interface{}{
  1257. "data": map[string]interface{}{
  1258. "empty": "true",
  1259. },
  1260. "metadata": map[string]interface{}{
  1261. "keys": []interface{}{"1", "2"},
  1262. },
  1263. },
  1264. }
  1265. type args struct {
  1266. store *esv1beta1.VaultProvider
  1267. kube kclient.Client
  1268. vLogical util.Logical
  1269. ns string
  1270. data esv1beta1.ExternalSecretFind
  1271. }
  1272. type want struct {
  1273. err error
  1274. val map[string][]byte
  1275. }
  1276. cases := map[string]struct {
  1277. reason string
  1278. args args
  1279. want want
  1280. }{
  1281. "FindByName": {
  1282. reason: "should map multiple secrets matching name",
  1283. args: args{
  1284. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1285. vLogical: &fake.Logical{
  1286. ListWithContextFn: newListWithContextFn(secret),
  1287. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1288. },
  1289. data: esv1beta1.ExternalSecretFind{
  1290. Name: &esv1beta1.FindName{
  1291. RegExp: "secret.*",
  1292. },
  1293. },
  1294. },
  1295. want: want{
  1296. err: nil,
  1297. val: map[string][]byte{
  1298. "secret1": secret1Bytes,
  1299. "secret2": secret2Bytes,
  1300. },
  1301. },
  1302. },
  1303. "FindByTag": {
  1304. reason: "should map multiple secrets matching tags",
  1305. args: args{
  1306. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1307. vLogical: &fake.Logical{
  1308. ListWithContextFn: newListWithContextFn(secret),
  1309. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1310. },
  1311. data: esv1beta1.ExternalSecretFind{
  1312. Tags: map[string]string{
  1313. "foo": "baz",
  1314. },
  1315. },
  1316. },
  1317. want: want{
  1318. err: nil,
  1319. val: map[string][]byte{
  1320. "tag": tagBytes,
  1321. "secret2": secret2Bytes,
  1322. },
  1323. },
  1324. },
  1325. "FilterByPath": {
  1326. reason: "should filter secrets based on path",
  1327. args: args{
  1328. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1329. vLogical: &fake.Logical{
  1330. ListWithContextFn: newListWithContextFn(secret),
  1331. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1332. },
  1333. data: esv1beta1.ExternalSecretFind{
  1334. Path: &path,
  1335. Tags: map[string]string{
  1336. "foo": "path",
  1337. },
  1338. },
  1339. },
  1340. want: want{
  1341. err: nil,
  1342. val: map[string][]byte{
  1343. "path/1": path1Bytes,
  1344. "path/2": path2Bytes,
  1345. },
  1346. },
  1347. },
  1348. "FailIfKv1": {
  1349. reason: "should not work if using kv1 store",
  1350. args: args{
  1351. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1352. vLogical: &fake.Logical{
  1353. ListWithContextFn: newListWithContextFn(secret),
  1354. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1355. },
  1356. data: esv1beta1.ExternalSecretFind{
  1357. Tags: map[string]string{
  1358. "foo": "baz",
  1359. },
  1360. },
  1361. },
  1362. want: want{
  1363. err: errors.New(errUnsupportedKvVersion),
  1364. },
  1365. },
  1366. "MetadataNotFound": {
  1367. reason: "metadata secret not found",
  1368. args: args{
  1369. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1370. vLogical: &fake.Logical{
  1371. ListWithContextFn: newListWithContextFn(secret),
  1372. ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1373. return nil, nil
  1374. },
  1375. },
  1376. data: esv1beta1.ExternalSecretFind{
  1377. Tags: map[string]string{
  1378. "foo": "baz",
  1379. },
  1380. },
  1381. },
  1382. want: want{
  1383. err: errors.New(errNotFound),
  1384. },
  1385. },
  1386. }
  1387. for name, tc := range cases {
  1388. t.Run(name, func(t *testing.T) {
  1389. vStore := &client{
  1390. kube: tc.args.kube,
  1391. logical: tc.args.vLogical,
  1392. store: tc.args.store,
  1393. namespace: tc.args.ns,
  1394. }
  1395. val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
  1396. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1397. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1398. }
  1399. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1400. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1401. }
  1402. })
  1403. }
  1404. }
  1405. func TestGetSecretPath(t *testing.T) {
  1406. storeV2 := makeValidSecretStore()
  1407. storeV2NoPath := storeV2.DeepCopy()
  1408. multiPath := "secret/path"
  1409. storeV2.Spec.Provider.Vault.Path = &multiPath
  1410. storeV2NoPath.Spec.Provider.Vault.Path = nil
  1411. storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
  1412. storeV1NoPath := storeV1.DeepCopy()
  1413. storeV1.Spec.Provider.Vault.Path = &multiPath
  1414. storeV1NoPath.Spec.Provider.Vault.Path = nil
  1415. type args struct {
  1416. store *esv1beta1.VaultProvider
  1417. path string
  1418. expected string
  1419. }
  1420. cases := map[string]struct {
  1421. reason string
  1422. args args
  1423. }{
  1424. "PathWithoutFormatV2": {
  1425. reason: "path should compose with mount point if set",
  1426. args: args{
  1427. store: storeV2.Spec.Provider.Vault,
  1428. path: "secret/path/data/test",
  1429. expected: "secret/path/data/test",
  1430. },
  1431. },
  1432. "PathWithoutFormatV2_NoData": {
  1433. reason: "path should compose with mount point if set without data",
  1434. args: args{
  1435. store: storeV2.Spec.Provider.Vault,
  1436. path: "secret/path/test",
  1437. expected: "secret/path/data/test",
  1438. },
  1439. },
  1440. "PathWithoutFormatV2_NoPath": {
  1441. reason: "if no mountpoint and no data available, needs to be set in second element",
  1442. args: args{
  1443. store: storeV2NoPath.Spec.Provider.Vault,
  1444. path: "secret/test/big/path",
  1445. expected: "secret/data/test/big/path",
  1446. },
  1447. },
  1448. "PathWithoutFormatV2_NoPathWithData": {
  1449. reason: "if data is available, should respect order",
  1450. args: args{
  1451. store: storeV2NoPath.Spec.Provider.Vault,
  1452. path: "secret/test/data/not/the/first/and/data/twice",
  1453. expected: "secret/test/data/not/the/first/and/data/twice",
  1454. },
  1455. },
  1456. "PathWithoutFormatV1": {
  1457. reason: "v1 mountpoint should be added but not enforce 'data'",
  1458. args: args{
  1459. store: storeV1.Spec.Provider.Vault,
  1460. path: "secret/path/test",
  1461. expected: "secret/path/test",
  1462. },
  1463. },
  1464. "PathWithoutFormatV1_NoPath": {
  1465. reason: "Should not append any path information if v1 with no mountpoint",
  1466. args: args{
  1467. store: storeV1NoPath.Spec.Provider.Vault,
  1468. path: "secret/test",
  1469. expected: "secret/test",
  1470. },
  1471. },
  1472. "WithoutPathButMountpointV2": {
  1473. reason: "Mountpoint needs to be set in addition to data",
  1474. args: args{
  1475. store: storeV2.Spec.Provider.Vault,
  1476. path: "test",
  1477. expected: "secret/path/data/test",
  1478. },
  1479. },
  1480. "WithoutPathButMountpointV1": {
  1481. reason: "Mountpoint needs to be set in addition to data",
  1482. args: args{
  1483. store: storeV1.Spec.Provider.Vault,
  1484. path: "test",
  1485. expected: "secret/path/test",
  1486. },
  1487. },
  1488. }
  1489. for name, tc := range cases {
  1490. t.Run(name, func(t *testing.T) {
  1491. vStore := &client{
  1492. store: tc.args.store,
  1493. }
  1494. want := vStore.buildPath(tc.args.path)
  1495. if diff := cmp.Diff(want, tc.args.expected); diff != "" {
  1496. t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
  1497. }
  1498. })
  1499. }
  1500. }
  1501. func TestValidateStore(t *testing.T) {
  1502. type args struct {
  1503. auth esv1beta1.VaultAuth
  1504. clientTLS esv1beta1.VaultClientTLS
  1505. }
  1506. tests := []struct {
  1507. name string
  1508. args args
  1509. wantErr bool
  1510. }{
  1511. {
  1512. name: "empty auth",
  1513. args: args{},
  1514. },
  1515. {
  1516. name: "invalid approle with namespace",
  1517. args: args{
  1518. auth: esv1beta1.VaultAuth{
  1519. AppRole: &esv1beta1.VaultAppRole{
  1520. SecretRef: esmeta.SecretKeySelector{
  1521. Namespace: pointer.To("invalid"),
  1522. },
  1523. },
  1524. },
  1525. },
  1526. wantErr: true,
  1527. },
  1528. {
  1529. name: "invalid approle with roleId and no roleRef",
  1530. args: args{
  1531. auth: esv1beta1.VaultAuth{
  1532. AppRole: &esv1beta1.VaultAppRole{
  1533. RoleID: "",
  1534. RoleRef: nil,
  1535. },
  1536. },
  1537. },
  1538. wantErr: true,
  1539. },
  1540. {
  1541. name: "valid approle with roleId and no roleRef",
  1542. args: args{
  1543. auth: esv1beta1.VaultAuth{
  1544. AppRole: &esv1beta1.VaultAppRole{
  1545. RoleID: "fake-value",
  1546. },
  1547. },
  1548. },
  1549. wantErr: false,
  1550. },
  1551. {
  1552. name: "valid approle with roleId and no roleRef",
  1553. args: args{
  1554. auth: esv1beta1.VaultAuth{
  1555. AppRole: &esv1beta1.VaultAppRole{
  1556. RoleRef: &esmeta.SecretKeySelector{
  1557. Name: "fake-value",
  1558. },
  1559. },
  1560. },
  1561. },
  1562. wantErr: false,
  1563. },
  1564. {
  1565. name: "invalid clientcert",
  1566. args: args{
  1567. auth: esv1beta1.VaultAuth{
  1568. Cert: &esv1beta1.VaultCertAuth{
  1569. ClientCert: esmeta.SecretKeySelector{
  1570. Namespace: pointer.To("invalid"),
  1571. },
  1572. },
  1573. },
  1574. },
  1575. wantErr: true,
  1576. },
  1577. {
  1578. name: "invalid cert secret",
  1579. args: args{
  1580. auth: esv1beta1.VaultAuth{
  1581. Cert: &esv1beta1.VaultCertAuth{
  1582. SecretRef: esmeta.SecretKeySelector{
  1583. Namespace: pointer.To("invalid"),
  1584. },
  1585. },
  1586. },
  1587. },
  1588. wantErr: true,
  1589. },
  1590. {
  1591. name: "invalid jwt secret",
  1592. args: args{
  1593. auth: esv1beta1.VaultAuth{
  1594. Jwt: &esv1beta1.VaultJwtAuth{
  1595. SecretRef: &esmeta.SecretKeySelector{
  1596. Namespace: pointer.To("invalid"),
  1597. },
  1598. },
  1599. },
  1600. },
  1601. wantErr: true,
  1602. },
  1603. {
  1604. name: "invalid kubernetes sa",
  1605. args: args{
  1606. auth: esv1beta1.VaultAuth{
  1607. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1608. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  1609. Namespace: pointer.To("invalid"),
  1610. },
  1611. },
  1612. },
  1613. },
  1614. wantErr: true,
  1615. },
  1616. {
  1617. name: "invalid kubernetes secret",
  1618. args: args{
  1619. auth: esv1beta1.VaultAuth{
  1620. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1621. SecretRef: &esmeta.SecretKeySelector{
  1622. Namespace: pointer.To("invalid"),
  1623. },
  1624. },
  1625. },
  1626. },
  1627. wantErr: true,
  1628. },
  1629. {
  1630. name: "invalid ldap secret",
  1631. args: args{
  1632. auth: esv1beta1.VaultAuth{
  1633. Ldap: &esv1beta1.VaultLdapAuth{
  1634. SecretRef: esmeta.SecretKeySelector{
  1635. Namespace: pointer.To("invalid"),
  1636. },
  1637. },
  1638. },
  1639. },
  1640. wantErr: true,
  1641. },
  1642. {
  1643. name: "invalid userpass secret",
  1644. args: args{
  1645. auth: esv1beta1.VaultAuth{
  1646. UserPass: &esv1beta1.VaultUserPassAuth{
  1647. SecretRef: esmeta.SecretKeySelector{
  1648. Namespace: pointer.To("invalid"),
  1649. },
  1650. },
  1651. },
  1652. },
  1653. wantErr: true,
  1654. },
  1655. {
  1656. name: "invalid token secret",
  1657. args: args{
  1658. auth: esv1beta1.VaultAuth{
  1659. TokenSecretRef: &esmeta.SecretKeySelector{
  1660. Namespace: pointer.To("invalid"),
  1661. },
  1662. },
  1663. },
  1664. wantErr: true,
  1665. },
  1666. {
  1667. name: "valid clientTls config",
  1668. args: args{
  1669. auth: esv1beta1.VaultAuth{
  1670. AppRole: &esv1beta1.VaultAppRole{
  1671. RoleRef: &esmeta.SecretKeySelector{
  1672. Name: "fake-value",
  1673. },
  1674. },
  1675. },
  1676. clientTLS: esv1beta1.VaultClientTLS{
  1677. CertSecretRef: &esmeta.SecretKeySelector{
  1678. Name: "tls-auth-certs",
  1679. },
  1680. KeySecretRef: &esmeta.SecretKeySelector{
  1681. Name: "tls-auth-certs",
  1682. },
  1683. },
  1684. },
  1685. wantErr: false,
  1686. },
  1687. {
  1688. name: "invalid clientTls config, missing SecretRef",
  1689. args: args{
  1690. auth: esv1beta1.VaultAuth{
  1691. AppRole: &esv1beta1.VaultAppRole{
  1692. RoleRef: &esmeta.SecretKeySelector{
  1693. Name: "fake-value",
  1694. },
  1695. },
  1696. },
  1697. clientTLS: esv1beta1.VaultClientTLS{
  1698. CertSecretRef: &esmeta.SecretKeySelector{
  1699. Name: "tls-auth-certs",
  1700. },
  1701. },
  1702. },
  1703. wantErr: true,
  1704. },
  1705. {
  1706. name: "invalid clientTls config, missing ClientCert",
  1707. args: args{
  1708. auth: esv1beta1.VaultAuth{
  1709. AppRole: &esv1beta1.VaultAppRole{
  1710. RoleRef: &esmeta.SecretKeySelector{
  1711. Name: "fake-value",
  1712. },
  1713. },
  1714. },
  1715. clientTLS: esv1beta1.VaultClientTLS{
  1716. KeySecretRef: &esmeta.SecretKeySelector{
  1717. Name: "tls-auth-certs",
  1718. },
  1719. },
  1720. },
  1721. wantErr: true,
  1722. },
  1723. }
  1724. for _, tt := range tests {
  1725. t.Run(tt.name, func(t *testing.T) {
  1726. c := &Connector{
  1727. NewVaultClient: nil,
  1728. }
  1729. store := &esv1beta1.SecretStore{
  1730. Spec: esv1beta1.SecretStoreSpec{
  1731. Provider: &esv1beta1.SecretStoreProvider{
  1732. Vault: &esv1beta1.VaultProvider{
  1733. Auth: tt.args.auth,
  1734. ClientTLS: tt.args.clientTLS,
  1735. },
  1736. },
  1737. },
  1738. }
  1739. if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
  1740. t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
  1741. }
  1742. })
  1743. }
  1744. }
  1745. func TestDeleteSecret(t *testing.T) {
  1746. type args struct {
  1747. store *esv1beta1.VaultProvider
  1748. vLogical util.Logical
  1749. }
  1750. type want struct {
  1751. err error
  1752. }
  1753. tests := map[string]struct {
  1754. reason string
  1755. args args
  1756. ref *testingfake.PushSecretData
  1757. want want
  1758. value []byte
  1759. }{
  1760. "DeleteSecretNoOpKV1": {
  1761. reason: "No secret is because it does not exist",
  1762. args: args{
  1763. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1764. vLogical: &fake.Logical{
  1765. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1766. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1767. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1768. },
  1769. },
  1770. want: want{
  1771. err: nil,
  1772. },
  1773. },
  1774. "DeleteSecretNoOpKV2": {
  1775. reason: "No secret is because it does not exist",
  1776. args: args{
  1777. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1778. vLogical: &fake.Logical{
  1779. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1780. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1781. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1782. },
  1783. },
  1784. want: want{
  1785. err: nil,
  1786. },
  1787. },
  1788. "DeleteSecretFailIfErrorKV1": {
  1789. reason: "No secret is because it does not exist",
  1790. args: args{
  1791. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1792. vLogical: &fake.Logical{
  1793. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
  1794. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1795. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1796. },
  1797. },
  1798. want: want{
  1799. err: fmt.Errorf("failed to read"),
  1800. },
  1801. },
  1802. "DeleteSecretFailIfErrorKV2": {
  1803. reason: "No secret is because it does not exist",
  1804. args: args{
  1805. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1806. vLogical: &fake.Logical{
  1807. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
  1808. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1809. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1810. },
  1811. },
  1812. want: want{
  1813. err: fmt.Errorf("failed to read"),
  1814. },
  1815. },
  1816. "DeleteSecretNotManagedKV1": {
  1817. reason: "No secret is because it does not exist",
  1818. args: args{
  1819. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1820. vLogical: &fake.Logical{
  1821. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1822. "fake-key": "fake-value",
  1823. "custom_metadata": map[string]interface{}{
  1824. "managed-by": "another-secret-tool",
  1825. },
  1826. }, nil),
  1827. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1828. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1829. },
  1830. },
  1831. want: want{
  1832. err: nil,
  1833. },
  1834. },
  1835. "DeleteSecretNotManagedKV2": {
  1836. reason: "No secret is because it does not exist",
  1837. args: args{
  1838. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1839. vLogical: &fake.Logical{
  1840. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1841. "data": map[string]interface{}{
  1842. "fake-key": "fake-value",
  1843. },
  1844. "custom_metadata": map[string]interface{}{
  1845. "managed-by": "another-secret-tool",
  1846. },
  1847. }, nil),
  1848. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1849. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1850. },
  1851. },
  1852. want: want{
  1853. err: nil,
  1854. },
  1855. },
  1856. "DeleteSecretSuccessKV1": {
  1857. reason: "No secret is because it does not exist",
  1858. args: args{
  1859. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1860. vLogical: &fake.Logical{
  1861. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1862. "fake-key": "fake-value",
  1863. "custom_metadata": map[string]interface{}{
  1864. "managed-by": "external-secrets",
  1865. },
  1866. }, nil),
  1867. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1868. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1869. },
  1870. },
  1871. want: want{
  1872. err: nil,
  1873. },
  1874. },
  1875. "DeleteSecretSuccessKV2": {
  1876. reason: "No secret is because it does not exist",
  1877. args: args{
  1878. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1879. vLogical: &fake.Logical{
  1880. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1881. "data": map[string]interface{}{
  1882. "fake-key": "fake-value",
  1883. },
  1884. "custom_metadata": map[string]interface{}{
  1885. "managed-by": "external-secrets",
  1886. },
  1887. }, nil),
  1888. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1889. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1890. },
  1891. },
  1892. want: want{
  1893. err: nil,
  1894. },
  1895. },
  1896. "DeleteSecretErrorKV1": {
  1897. reason: "No secret is because it does not exist",
  1898. args: args{
  1899. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1900. vLogical: &fake.Logical{
  1901. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1902. "fake-key": "fake-value",
  1903. "custom_metadata": map[string]interface{}{
  1904. "managed-by": "external-secrets",
  1905. },
  1906. }, nil),
  1907. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1908. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
  1909. },
  1910. },
  1911. want: want{
  1912. err: fmt.Errorf("failed to delete"),
  1913. },
  1914. },
  1915. "DeleteSecretErrorKV2": {
  1916. reason: "No secret is because it does not exist",
  1917. args: args{
  1918. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1919. vLogical: &fake.Logical{
  1920. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1921. "data": map[string]interface{}{
  1922. "fake-key": "fake-value",
  1923. },
  1924. "custom_metadata": map[string]interface{}{
  1925. "managed-by": "external-secrets",
  1926. },
  1927. }, nil),
  1928. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1929. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
  1930. },
  1931. },
  1932. want: want{
  1933. err: fmt.Errorf("failed to delete"),
  1934. },
  1935. },
  1936. "DeleteSecretUpdatePropertyKV1": {
  1937. reason: "Secret should only be updated if Property is set",
  1938. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
  1939. args: args{
  1940. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1941. vLogical: &fake.Logical{
  1942. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1943. "fake-key": "fake-value",
  1944. "foo": "bar",
  1945. "custom_metadata": map[string]interface{}{
  1946. "managed-by": "external-secrets",
  1947. },
  1948. }, nil),
  1949. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  1950. "foo": "bar",
  1951. "custom_metadata": map[string]interface{}{
  1952. "managed-by": "external-secrets",
  1953. }}),
  1954. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1955. },
  1956. },
  1957. want: want{
  1958. err: nil,
  1959. },
  1960. },
  1961. "DeleteSecretUpdatePropertyKV2": {
  1962. reason: "Secret should only be updated if Property is set",
  1963. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
  1964. args: args{
  1965. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1966. vLogical: &fake.Logical{
  1967. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1968. "data": map[string]interface{}{
  1969. "fake-key": "fake-value",
  1970. "foo": "bar",
  1971. },
  1972. "custom_metadata": map[string]interface{}{
  1973. "managed-by": "external-secrets",
  1974. },
  1975. }, nil),
  1976. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "bar"}}),
  1977. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1978. },
  1979. },
  1980. want: want{
  1981. err: nil,
  1982. },
  1983. },
  1984. "DeleteSecretIfNoOtherPropertiesKV1": {
  1985. reason: "Secret should only be deleted if no other properties are set",
  1986. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
  1987. args: args{
  1988. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1989. vLogical: &fake.Logical{
  1990. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1991. "foo": "bar",
  1992. "custom_metadata": map[string]interface{}{
  1993. "managed-by": "external-secrets",
  1994. },
  1995. }, nil),
  1996. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1997. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1998. },
  1999. },
  2000. want: want{
  2001. err: nil,
  2002. },
  2003. },
  2004. "DeleteSecretIfNoOtherPropertiesKV2": {
  2005. reason: "Secret should only be deleted if no other properties are set",
  2006. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
  2007. args: args{
  2008. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2009. vLogical: &fake.Logical{
  2010. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2011. "data": map[string]interface{}{
  2012. "foo": "bar",
  2013. },
  2014. "custom_metadata": map[string]interface{}{
  2015. "managed-by": "external-secrets",
  2016. },
  2017. }, nil),
  2018. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  2019. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  2020. },
  2021. },
  2022. want: want{
  2023. err: nil,
  2024. },
  2025. },
  2026. }
  2027. for name, tc := range tests {
  2028. t.Run(name, func(t *testing.T) {
  2029. ref := testingfake.PushSecretData{RemoteKey: "secret", Property: ""}
  2030. if tc.ref != nil {
  2031. ref = *tc.ref
  2032. }
  2033. client := &client{
  2034. logical: tc.args.vLogical,
  2035. store: tc.args.store,
  2036. }
  2037. err := client.DeleteSecret(context.Background(), ref)
  2038. // Error nil XOR tc.want.err nil
  2039. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  2040. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  2041. }
  2042. // if errors are the same type but their contents do not match
  2043. if err != nil && tc.want.err != nil {
  2044. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  2045. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  2046. }
  2047. }
  2048. })
  2049. }
  2050. }
  2051. func TestPushSecret(t *testing.T) {
  2052. secretKey := "secret-key"
  2053. noPermission := errors.New("no permission")
  2054. type args struct {
  2055. store *esv1beta1.VaultProvider
  2056. vLogical util.Logical
  2057. }
  2058. type want struct {
  2059. err error
  2060. }
  2061. tests := map[string]struct {
  2062. reason string
  2063. args args
  2064. want want
  2065. data *testingfake.PushSecretData
  2066. value []byte
  2067. }{
  2068. "SetSecretKV1": {
  2069. reason: "secret is successfully set, with no existing vault secret",
  2070. args: args{
  2071. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2072. vLogical: &fake.Logical{
  2073. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  2074. WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
  2075. },
  2076. },
  2077. want: want{
  2078. err: nil,
  2079. },
  2080. },
  2081. "SetSecretKV2": {
  2082. reason: "secret is successfully set, with no existing vault secret",
  2083. args: args{
  2084. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2085. vLogical: &fake.Logical{
  2086. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  2087. WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
  2088. },
  2089. },
  2090. want: want{
  2091. err: nil,
  2092. },
  2093. },
  2094. "SetSecretWithWriteErrorKV1": {
  2095. reason: "secret cannot be pushed if write fails",
  2096. args: args{
  2097. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2098. vLogical: &fake.Logical{
  2099. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  2100. WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
  2101. },
  2102. },
  2103. want: want{
  2104. err: noPermission,
  2105. },
  2106. },
  2107. "SetSecretWithWriteErrorKV2": {
  2108. reason: "secret cannot be pushed if write fails",
  2109. args: args{
  2110. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2111. vLogical: &fake.Logical{
  2112. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  2113. WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
  2114. },
  2115. },
  2116. want: want{
  2117. err: noPermission,
  2118. },
  2119. },
  2120. "SetSecretEqualsPushSecretV1": {
  2121. reason: "vault secret kv equals secret to push kv",
  2122. args: args{
  2123. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2124. vLogical: &fake.Logical{
  2125. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2126. "fake-key": "fake-value",
  2127. "custom_metadata": map[string]interface{}{
  2128. "managed-by": "external-secrets",
  2129. },
  2130. }, nil),
  2131. },
  2132. },
  2133. want: want{
  2134. err: nil,
  2135. },
  2136. },
  2137. "SetSecretEqualsPushSecretV2": {
  2138. reason: "vault secret kv equals secret to push kv",
  2139. args: args{
  2140. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2141. vLogical: &fake.Logical{
  2142. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2143. "data": map[string]interface{}{
  2144. "fake-key": "fake-value",
  2145. },
  2146. "custom_metadata": map[string]interface{}{
  2147. "managed-by": "external-secrets",
  2148. },
  2149. }, nil),
  2150. },
  2151. },
  2152. want: want{
  2153. err: nil,
  2154. },
  2155. },
  2156. "PushSecretPropertyKV1": {
  2157. reason: "push secret with property adds the property",
  2158. value: []byte("fake-value"),
  2159. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2160. args: args{
  2161. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2162. vLogical: &fake.Logical{
  2163. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2164. "fake-key": "fake-value",
  2165. "custom_metadata": map[string]interface{}{
  2166. "managed-by": "external-secrets",
  2167. },
  2168. }, nil),
  2169. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  2170. "fake-key": "fake-value",
  2171. "custom_metadata": map[string]string{
  2172. "managed-by": "external-secrets",
  2173. },
  2174. "foo": "fake-value",
  2175. }),
  2176. },
  2177. },
  2178. want: want{
  2179. err: nil,
  2180. },
  2181. },
  2182. "PushSecretPropertyKV2": {
  2183. reason: "push secret with property adds the property",
  2184. value: []byte("fake-value"),
  2185. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2186. args: args{
  2187. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2188. vLogical: &fake.Logical{
  2189. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2190. "data": map[string]interface{}{
  2191. "fake-key": "fake-value",
  2192. },
  2193. "custom_metadata": map[string]interface{}{
  2194. "managed-by": "external-secrets",
  2195. },
  2196. }, nil),
  2197. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"fake-key": "fake-value", "foo": "fake-value"}}),
  2198. },
  2199. },
  2200. want: want{
  2201. err: nil,
  2202. },
  2203. },
  2204. "PushSecretUpdatePropertyKV1": {
  2205. reason: "push secret with property only updates the property",
  2206. value: []byte("new-value"),
  2207. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2208. args: args{
  2209. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2210. vLogical: &fake.Logical{
  2211. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2212. "foo": "fake-value",
  2213. "custom_metadata": map[string]interface{}{
  2214. "managed-by": "external-secrets",
  2215. },
  2216. }, nil),
  2217. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  2218. "foo": "new-value",
  2219. "custom_metadata": map[string]string{
  2220. "managed-by": "external-secrets",
  2221. },
  2222. }),
  2223. },
  2224. },
  2225. want: want{
  2226. err: nil,
  2227. },
  2228. },
  2229. "PushSecretUpdatePropertyKV2": {
  2230. reason: "push secret with property only updates the property",
  2231. value: []byte("new-value"),
  2232. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2233. args: args{
  2234. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2235. vLogical: &fake.Logical{
  2236. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2237. "data": map[string]interface{}{
  2238. "foo": "fake-value",
  2239. },
  2240. "custom_metadata": map[string]interface{}{
  2241. "managed-by": "external-secrets",
  2242. },
  2243. }, nil),
  2244. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "new-value"}}),
  2245. },
  2246. },
  2247. want: want{
  2248. err: nil,
  2249. },
  2250. },
  2251. "PushSecretPropertyNoUpdateKV1": {
  2252. reason: "push secret with property only updates the property",
  2253. value: []byte("fake-value"),
  2254. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2255. args: args{
  2256. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2257. vLogical: &fake.Logical{
  2258. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2259. "foo": "fake-value",
  2260. "custom_metadata": map[string]interface{}{
  2261. "managed-by": "external-secrets",
  2262. },
  2263. }, nil),
  2264. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  2265. },
  2266. },
  2267. want: want{
  2268. err: nil,
  2269. },
  2270. },
  2271. "PushSecretPropertyNoUpdateKV2": {
  2272. reason: "push secret with property only updates the property",
  2273. value: []byte("fake-value"),
  2274. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2275. args: args{
  2276. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2277. vLogical: &fake.Logical{
  2278. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2279. "data": map[string]interface{}{
  2280. "foo": "fake-value",
  2281. },
  2282. "custom_metadata": map[string]interface{}{
  2283. "managed-by": "external-secrets",
  2284. },
  2285. }, nil),
  2286. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  2287. },
  2288. },
  2289. want: want{
  2290. err: nil,
  2291. },
  2292. },
  2293. "SetSecretErrorReadingSecretKV1": {
  2294. reason: "error occurs if secret cannot be read",
  2295. args: args{
  2296. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2297. vLogical: &fake.Logical{
  2298. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
  2299. },
  2300. },
  2301. want: want{
  2302. err: fmt.Errorf(errReadSecret, noPermission),
  2303. },
  2304. },
  2305. "SetSecretErrorReadingSecretKV2": {
  2306. reason: "error occurs if secret cannot be read",
  2307. args: args{
  2308. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2309. vLogical: &fake.Logical{
  2310. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
  2311. },
  2312. },
  2313. want: want{
  2314. err: fmt.Errorf(errReadSecret, noPermission),
  2315. },
  2316. },
  2317. "SetSecretNotManagedByESOV1": {
  2318. reason: "a secret not managed by ESO cannot be updated",
  2319. args: args{
  2320. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2321. vLogical: &fake.Logical{
  2322. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2323. "fake-key": "fake-value2",
  2324. "custom_metadata": map[string]interface{}{
  2325. "managed-by": "not-external-secrets",
  2326. },
  2327. }, nil),
  2328. },
  2329. },
  2330. want: want{
  2331. err: errors.New("secret not managed by external-secrets"),
  2332. },
  2333. },
  2334. "SetSecretNotManagedByESOV2": {
  2335. reason: "a secret not managed by ESO cannot be updated",
  2336. args: args{
  2337. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2338. vLogical: &fake.Logical{
  2339. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2340. "data": map[string]interface{}{
  2341. "fake-key": "fake-value2",
  2342. "custom_metadata": map[string]interface{}{
  2343. "managed-by": "not-external-secrets",
  2344. },
  2345. },
  2346. }, nil),
  2347. },
  2348. },
  2349. want: want{
  2350. err: errors.New("secret not managed by external-secrets"),
  2351. },
  2352. },
  2353. }
  2354. for name, tc := range tests {
  2355. t.Run(name, func(t *testing.T) {
  2356. data := testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: ""}
  2357. if tc.data != nil {
  2358. data = *tc.data
  2359. }
  2360. client := &client{
  2361. logical: tc.args.vLogical,
  2362. store: tc.args.store,
  2363. }
  2364. val := tc.value
  2365. if val == nil {
  2366. val = []byte(`{"fake-key":"fake-value"}`)
  2367. }
  2368. s := &corev1.Secret{Data: map[string][]byte{secretKey: val}}
  2369. err := client.PushSecret(context.Background(), s, data)
  2370. // Error nil XOR tc.want.err nil
  2371. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  2372. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  2373. }
  2374. // if errors are the same type but their contents do not match
  2375. if err != nil && tc.want.err != nil {
  2376. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  2377. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  2378. }
  2379. }
  2380. })
  2381. }
  2382. }
  2383. // EquateErrors returns true if the supplied errors are of the same type and
  2384. // produce identical strings. This mirrors the error comparison behavior of
  2385. // https://github.com/go-test/deep, which most Crossplane tests targeted before
  2386. // we switched to go-cmp.
  2387. //
  2388. // This differs from cmpopts.EquateErrors, which does not test for error strings
  2389. // and instead returns whether one error 'is' (in the errors.Is sense) the
  2390. // other.
  2391. func EquateErrors() cmp.Option {
  2392. return cmp.Comparer(func(a, b error) bool {
  2393. if a == nil || b == nil {
  2394. return a == nil && b == nil
  2395. }
  2396. av := reflect.ValueOf(a)
  2397. bv := reflect.ValueOf(b)
  2398. if av.Type() != bv.Type() {
  2399. return false
  2400. }
  2401. return a.Error() == b.Error()
  2402. })
  2403. }