vault_test.go 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340
  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", 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. },
  417. Data: map[string]string{
  418. "cert": string(clientCrt),
  419. },
  420. }).Build(),
  421. corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
  422. newClientFunc: fake.ClientWithLoginMock,
  423. },
  424. want: want{
  425. err: nil,
  426. },
  427. },
  428. "GetCertConfigMapMissingError": {
  429. reason: "Should return an error if the config map key is missing",
  430. args: args{
  431. store: makeValidSecretStoreWithK8sCerts(false),
  432. ns: "default",
  433. kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
  434. ObjectMeta: metav1.ObjectMeta{
  435. Name: "example-sa",
  436. Namespace: "default",
  437. },
  438. Secrets: []corev1.ObjectReference{
  439. {
  440. Name: tokenSecretName,
  441. },
  442. },
  443. }, &corev1.ConfigMap{
  444. ObjectMeta: metav1.ObjectMeta{
  445. Name: "vault-cert",
  446. },
  447. Data: map[string]string{},
  448. }).Build(),
  449. newClientFunc: fake.ClientWithLoginMock,
  450. },
  451. want: want{
  452. err: fmt.Errorf(errConfigMapFmt, "cert"),
  453. },
  454. },
  455. "GetCertificateFormatError": {
  456. reason: "Should return error if client certificate is in wrong format.",
  457. args: args{
  458. store: makeValidSecretStoreWithCerts(),
  459. ns: "default",
  460. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  461. ObjectMeta: metav1.ObjectMeta{
  462. Name: "tls-auth-certs",
  463. Namespace: "default",
  464. },
  465. Data: map[string][]byte{
  466. "tls.key": secretClientKey,
  467. "tls.crt": []byte("cert with mistak"),
  468. },
  469. }).Build(),
  470. newClientFunc: fake.ClientWithLoginMock,
  471. },
  472. want: want{
  473. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
  474. },
  475. },
  476. "GetKeyFormatError": {
  477. reason: "Should return error if client key is in wrong format.",
  478. args: args{
  479. store: makeValidSecretStoreWithCerts(),
  480. ns: "default",
  481. kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
  482. ObjectMeta: metav1.ObjectMeta{
  483. Name: "tls-auth-certs",
  484. Namespace: "default",
  485. },
  486. Data: map[string][]byte{
  487. "tls.key": []byte("key with mistake"),
  488. "tls.crt": clientCrt,
  489. },
  490. }).Build(),
  491. newClientFunc: fake.ClientWithLoginMock,
  492. },
  493. want: want{
  494. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  495. },
  496. },
  497. }
  498. for name, tc := range cases {
  499. t.Run(name, func(t *testing.T) {
  500. vaultTest(t, name, tc)
  501. })
  502. }
  503. }
  504. func vaultTest(t *testing.T, _ string, tc testCase) {
  505. conn := &Connector{
  506. NewVaultClient: tc.args.newClientFunc,
  507. }
  508. if tc.args.newClientFunc == nil {
  509. conn.NewVaultClient = NewVaultClient
  510. }
  511. _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
  512. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  513. t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
  514. }
  515. }
  516. func TestGetSecret(t *testing.T) {
  517. errBoom := errors.New("boom")
  518. secret := map[string]interface{}{
  519. "access_key": "access_key",
  520. "access_secret": "access_secret",
  521. }
  522. secretWithNilVal := map[string]interface{}{
  523. "access_key": "access_key",
  524. "access_secret": "access_secret",
  525. "token": nil,
  526. }
  527. secretWithNestedVal := map[string]interface{}{
  528. "access_key": "access_key",
  529. "access_secret": "access_secret",
  530. "nested.bar": "something different",
  531. "nested": map[string]string{
  532. "foo": "oke",
  533. "bar": "also ok?",
  534. },
  535. "list_of_values": []string{
  536. "first_value",
  537. "second_value",
  538. "third_value",
  539. },
  540. "json_number": json.Number("42"),
  541. }
  542. type args struct {
  543. store *esv1beta1.VaultProvider
  544. kube kclient.Client
  545. vLogical util.Logical
  546. ns string
  547. data esv1beta1.ExternalSecretDataRemoteRef
  548. }
  549. type want struct {
  550. err error
  551. val []byte
  552. }
  553. cases := map[string]struct {
  554. reason string
  555. args args
  556. want want
  557. }{
  558. "ReadSecret": {
  559. reason: "Should return the secret with property",
  560. args: args{
  561. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  562. data: esv1beta1.ExternalSecretDataRemoteRef{
  563. Property: "access_key",
  564. },
  565. vLogical: &fake.Logical{
  566. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  567. },
  568. },
  569. want: want{
  570. err: nil,
  571. val: []byte("access_key"),
  572. },
  573. },
  574. "ReadSecretWithNil": {
  575. reason: "Should return the secret with property if it has a nil val",
  576. args: args{
  577. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  578. data: esv1beta1.ExternalSecretDataRemoteRef{
  579. Property: "access_key",
  580. },
  581. vLogical: &fake.Logical{
  582. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  583. },
  584. },
  585. want: want{
  586. err: nil,
  587. val: []byte("access_key"),
  588. },
  589. },
  590. "ReadSecretWithoutProperty": {
  591. reason: "Should return the json encoded secret without property",
  592. args: args{
  593. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  594. data: esv1beta1.ExternalSecretDataRemoteRef{},
  595. vLogical: &fake.Logical{
  596. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  597. },
  598. },
  599. want: want{
  600. err: nil,
  601. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  602. },
  603. },
  604. "ReadSecretWithNestedValue": {
  605. reason: "Should return a nested property",
  606. args: args{
  607. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  608. data: esv1beta1.ExternalSecretDataRemoteRef{
  609. Property: "nested.foo",
  610. },
  611. vLogical: &fake.Logical{
  612. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  613. },
  614. },
  615. want: want{
  616. err: nil,
  617. val: []byte("oke"),
  618. },
  619. },
  620. "ReadSecretWithNestedValueFromData": {
  621. reason: "Should return a nested property",
  622. args: args{
  623. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  624. data: esv1beta1.ExternalSecretDataRemoteRef{
  625. //
  626. Property: "nested.bar",
  627. },
  628. vLogical: &fake.Logical{
  629. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  630. },
  631. },
  632. want: want{
  633. err: nil,
  634. val: []byte("something different"),
  635. },
  636. },
  637. "ReadSecretWithMissingValueFromData": {
  638. reason: "Should return a NoSecretErr",
  639. args: args{
  640. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  641. data: esv1beta1.ExternalSecretDataRemoteRef{
  642. Property: "not-relevant",
  643. },
  644. vLogical: &fake.Logical{
  645. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  646. },
  647. },
  648. want: want{
  649. err: esv1beta1.NoSecretErr,
  650. val: nil,
  651. },
  652. },
  653. "ReadSecretWithSliceValue": {
  654. reason: "Should return property as a joined slice",
  655. args: args{
  656. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  657. data: esv1beta1.ExternalSecretDataRemoteRef{
  658. Property: "list_of_values",
  659. },
  660. vLogical: &fake.Logical{
  661. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  662. },
  663. },
  664. want: want{
  665. err: nil,
  666. val: []byte("first_value\nsecond_value\nthird_value"),
  667. },
  668. },
  669. "ReadSecretWithJsonNumber": {
  670. reason: "Should return parsed json.Number property",
  671. args: args{
  672. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  673. data: esv1beta1.ExternalSecretDataRemoteRef{
  674. Property: "json_number",
  675. },
  676. vLogical: &fake.Logical{
  677. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  678. },
  679. },
  680. want: want{
  681. err: nil,
  682. val: []byte("42"),
  683. },
  684. },
  685. "NonexistentProperty": {
  686. reason: "Should return error property does not exist.",
  687. args: args{
  688. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  689. data: esv1beta1.ExternalSecretDataRemoteRef{
  690. Property: "nop.doesnt.exist",
  691. },
  692. vLogical: &fake.Logical{
  693. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
  694. },
  695. },
  696. want: want{
  697. err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
  698. },
  699. },
  700. "ReadSecretError": {
  701. reason: "Should return error if vault client fails to read secret.",
  702. args: args{
  703. store: makeSecretStore().Spec.Provider.Vault,
  704. vLogical: &fake.Logical{
  705. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  706. },
  707. },
  708. want: want{
  709. err: fmt.Errorf(errReadSecret, errBoom),
  710. },
  711. },
  712. "ReadSecretNotFound": {
  713. reason: "Secret doesn't exist",
  714. args: args{
  715. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  716. data: esv1beta1.ExternalSecretDataRemoteRef{
  717. Property: "access_key",
  718. },
  719. vLogical: &fake.Logical{
  720. ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  721. return nil, nil
  722. },
  723. },
  724. },
  725. want: want{
  726. err: esv1beta1.NoSecretError{},
  727. },
  728. },
  729. "ReadSecretMetadataWithoutProperty": {
  730. reason: "Should return the json encoded metadata",
  731. args: args{
  732. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  733. data: esv1beta1.ExternalSecretDataRemoteRef{
  734. MetadataPolicy: "Fetch",
  735. },
  736. vLogical: &fake.Logical{
  737. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  738. },
  739. },
  740. want: want{
  741. err: nil,
  742. val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
  743. },
  744. },
  745. "ReadSecretMetadataWithProperty": {
  746. reason: "Should return the access_key value from the metadata",
  747. args: args{
  748. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  749. data: esv1beta1.ExternalSecretDataRemoteRef{
  750. MetadataPolicy: "Fetch",
  751. Property: "access_key",
  752. },
  753. vLogical: &fake.Logical{
  754. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  755. },
  756. },
  757. want: want{
  758. err: nil,
  759. val: []byte("access_key"),
  760. },
  761. },
  762. "FailReadSecretMetadataInvalidProperty": {
  763. reason: "Should return error of non existent key inmetadata",
  764. args: args{
  765. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  766. data: esv1beta1.ExternalSecretDataRemoteRef{
  767. MetadataPolicy: "Fetch",
  768. Property: "does_not_exist",
  769. },
  770. vLogical: &fake.Logical{
  771. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
  772. },
  773. },
  774. want: want{
  775. err: fmt.Errorf(errSecretKeyFmt, "does_not_exist"),
  776. },
  777. },
  778. "FailReadSecretMetadataNoMetadata": {
  779. reason: "Should return the access_key value from the metadata",
  780. args: args{
  781. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  782. data: esv1beta1.ExternalSecretDataRemoteRef{
  783. MetadataPolicy: "Fetch",
  784. },
  785. vLogical: &fake.Logical{
  786. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  787. },
  788. },
  789. want: want{
  790. err: fmt.Errorf(errNotFound),
  791. },
  792. },
  793. "FailReadSecretMetadataWrongVersion": {
  794. reason: "Should return the access_key value from the metadata",
  795. args: args{
  796. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  797. data: esv1beta1.ExternalSecretDataRemoteRef{
  798. MetadataPolicy: "Fetch",
  799. },
  800. vLogical: &fake.Logical{
  801. ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
  802. },
  803. },
  804. want: want{
  805. err: fmt.Errorf(errUnsupportedMetadataKvVersion),
  806. },
  807. },
  808. }
  809. for name, tc := range cases {
  810. t.Run(name, func(t *testing.T) {
  811. vStore := &client{
  812. kube: tc.args.kube,
  813. logical: tc.args.vLogical,
  814. store: tc.args.store,
  815. namespace: tc.args.ns,
  816. }
  817. val, err := vStore.GetSecret(context.Background(), tc.args.data)
  818. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  819. t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
  820. }
  821. if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
  822. t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
  823. }
  824. })
  825. }
  826. }
  827. func TestGetSecretMap(t *testing.T) {
  828. errBoom := errors.New("boom")
  829. secret := map[string]interface{}{
  830. "access_key": "access_key",
  831. "access_secret": "access_secret",
  832. }
  833. secretWithSpecialCharacter := map[string]interface{}{
  834. "access_key": "acc<ess_&ke.,y",
  835. "access_secret": "acce&?ss_s>ecret",
  836. }
  837. secretWithNilVal := map[string]interface{}{
  838. "access_key": "access_key",
  839. "access_secret": "access_secret",
  840. "token": nil,
  841. }
  842. secretWithNestedVal := map[string]interface{}{
  843. "access_key": "access_key",
  844. "access_secret": "access_secret",
  845. "nested": map[string]interface{}{
  846. "foo": map[string]string{
  847. "oke": "yup",
  848. "mhkeih": "yada yada",
  849. },
  850. },
  851. }
  852. secretWithTypes := map[string]interface{}{
  853. "access_secret": "access_secret",
  854. "f32": float32(2.12),
  855. "f64": float64(2.1234534153423423),
  856. "int": 42,
  857. "bool": true,
  858. "bt": []byte("foobar"),
  859. }
  860. type args struct {
  861. store *esv1beta1.VaultProvider
  862. kube kclient.Client
  863. vClient util.Logical
  864. ns string
  865. data esv1beta1.ExternalSecretDataRemoteRef
  866. }
  867. type want struct {
  868. err error
  869. val map[string][]byte
  870. }
  871. cases := map[string]struct {
  872. reason string
  873. args args
  874. want want
  875. }{
  876. "ReadSecretKV1": {
  877. reason: "Should map the secret even if it has a nil value",
  878. args: args{
  879. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  880. vClient: &fake.Logical{
  881. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
  882. },
  883. },
  884. want: want{
  885. err: nil,
  886. val: map[string][]byte{
  887. "access_key": []byte("access_key"),
  888. "access_secret": []byte("access_secret"),
  889. },
  890. },
  891. },
  892. "ReadSecretKV2": {
  893. reason: "Should map the secret even if it has a nil value",
  894. args: args{
  895. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  896. vClient: &fake.Logical{
  897. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  898. "data": secret,
  899. }, nil),
  900. },
  901. },
  902. want: want{
  903. err: nil,
  904. val: map[string][]byte{
  905. "access_key": []byte("access_key"),
  906. "access_secret": []byte("access_secret"),
  907. },
  908. },
  909. },
  910. "ReadSecretWithSpecialCharactersKV1": {
  911. reason: "Should map the secret even if it has a nil value",
  912. args: args{
  913. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  914. vClient: &fake.Logical{
  915. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithSpecialCharacter, nil),
  916. },
  917. },
  918. want: want{
  919. err: nil,
  920. val: map[string][]byte{
  921. "access_key": []byte("acc<ess_&ke.,y"),
  922. "access_secret": []byte("acce&?ss_s>ecret"),
  923. },
  924. },
  925. },
  926. "ReadSecretWithSpecialCharactersKV2": {
  927. reason: "Should map the secret even if it has a nil value",
  928. args: args{
  929. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  930. vClient: &fake.Logical{
  931. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  932. "data": secretWithSpecialCharacter,
  933. }, nil),
  934. },
  935. },
  936. want: want{
  937. err: nil,
  938. val: map[string][]byte{
  939. "access_key": []byte("acc<ess_&ke.,y"),
  940. "access_secret": []byte("acce&?ss_s>ecret"),
  941. },
  942. },
  943. },
  944. "ReadSecretWithNilValueKV1": {
  945. reason: "Should map the secret even if it has a nil value",
  946. args: args{
  947. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  948. vClient: &fake.Logical{
  949. ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
  950. },
  951. },
  952. want: want{
  953. err: nil,
  954. val: map[string][]byte{
  955. "access_key": []byte("access_key"),
  956. "access_secret": []byte("access_secret"),
  957. "token": []byte(nil),
  958. },
  959. },
  960. },
  961. "ReadSecretWithNilValueKV2": {
  962. reason: "Should map the secret even if it has a nil value",
  963. args: args{
  964. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  965. vClient: &fake.Logical{
  966. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  967. "data": secretWithNilVal}, nil),
  968. },
  969. },
  970. want: want{
  971. err: nil,
  972. val: map[string][]byte{
  973. "access_key": []byte("access_key"),
  974. "access_secret": []byte("access_secret"),
  975. "token": []byte(nil),
  976. },
  977. },
  978. },
  979. "ReadSecretWithTypesKV2": {
  980. reason: "Should map the secret even if it has other types",
  981. args: args{
  982. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  983. vClient: &fake.Logical{
  984. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  985. "data": secretWithTypes}, nil),
  986. },
  987. },
  988. want: want{
  989. err: nil,
  990. val: map[string][]byte{
  991. "access_secret": []byte("access_secret"),
  992. "f32": []byte("2.12"),
  993. "f64": []byte("2.1234534153423423"),
  994. "int": []byte("42"),
  995. "bool": []byte("true"),
  996. "bt": []byte("Zm9vYmFy"), // base64
  997. },
  998. },
  999. },
  1000. "ReadNestedSecret": {
  1001. reason: "Should map the secret for deeply nested property",
  1002. args: args{
  1003. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1004. data: esv1beta1.ExternalSecretDataRemoteRef{
  1005. Property: "nested",
  1006. },
  1007. vClient: &fake.Logical{
  1008. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1009. "data": secretWithNestedVal}, nil),
  1010. },
  1011. },
  1012. want: want{
  1013. err: nil,
  1014. val: map[string][]byte{
  1015. "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
  1016. },
  1017. },
  1018. },
  1019. "ReadDeeplyNestedSecret": {
  1020. reason: "Should map the secret for deeply nested property",
  1021. args: args{
  1022. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1023. data: esv1beta1.ExternalSecretDataRemoteRef{
  1024. Property: "nested.foo",
  1025. },
  1026. vClient: &fake.Logical{
  1027. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1028. "data": secretWithNestedVal}, nil),
  1029. },
  1030. },
  1031. want: want{
  1032. err: nil,
  1033. val: map[string][]byte{
  1034. "oke": []byte("yup"),
  1035. "mhkeih": []byte("yada yada"),
  1036. },
  1037. },
  1038. },
  1039. "ReadSecretError": {
  1040. reason: "Should return error if vault client fails to read secret.",
  1041. args: args{
  1042. store: makeSecretStore().Spec.Provider.Vault,
  1043. vClient: &fake.Logical{
  1044. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
  1045. },
  1046. },
  1047. want: want{
  1048. err: fmt.Errorf(errReadSecret, errBoom),
  1049. },
  1050. },
  1051. }
  1052. for name, tc := range cases {
  1053. t.Run(name, func(t *testing.T) {
  1054. vStore := &client{
  1055. kube: tc.args.kube,
  1056. logical: tc.args.vClient,
  1057. store: tc.args.store,
  1058. namespace: tc.args.ns,
  1059. }
  1060. val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
  1061. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1062. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1063. }
  1064. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1065. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1066. }
  1067. })
  1068. }
  1069. }
  1070. func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
  1071. return func(ctx context.Context, path string) (*vault.Secret, error) {
  1072. path = strings.TrimPrefix(path, "secret/metadata/")
  1073. if path == "" {
  1074. path = "default"
  1075. }
  1076. data, ok := secrets[path]
  1077. if !ok {
  1078. return nil, errors.New("Secret not found")
  1079. }
  1080. meta := data.(map[string]interface{})
  1081. ans := meta["metadata"].(map[string]interface{})
  1082. secret := &vault.Secret{
  1083. Data: map[string]interface{}{
  1084. "keys": ans["keys"],
  1085. },
  1086. }
  1087. return secret, nil
  1088. }
  1089. }
  1090. func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
  1091. return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1092. path = strings.TrimPrefix(path, "secret/data/")
  1093. path = strings.TrimPrefix(path, "secret/metadata/")
  1094. if path == "" {
  1095. path = "default"
  1096. }
  1097. data, ok := secrets[path]
  1098. if !ok {
  1099. return nil, errors.New("Secret not found")
  1100. }
  1101. meta := data.(map[string]interface{})
  1102. metadata := meta["metadata"].(map[string]interface{})
  1103. content := map[string]interface{}{
  1104. "data": meta["data"],
  1105. "custom_metadata": metadata["custom_metadata"],
  1106. }
  1107. secret := &vault.Secret{
  1108. Data: content,
  1109. }
  1110. return secret, nil
  1111. }
  1112. }
  1113. func TestGetAllSecrets(t *testing.T) {
  1114. secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
  1115. secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
  1116. path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
  1117. path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
  1118. tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
  1119. path := "path"
  1120. secret := map[string]interface{}{
  1121. "secret1": map[string]interface{}{
  1122. "metadata": map[string]interface{}{
  1123. "custom_metadata": map[string]interface{}{
  1124. "foo": "bar",
  1125. },
  1126. },
  1127. "data": map[string]interface{}{
  1128. "access_key": "access_key",
  1129. "access_secret": "access_secret",
  1130. },
  1131. },
  1132. "secret2": map[string]interface{}{
  1133. "metadata": map[string]interface{}{
  1134. "custom_metadata": map[string]interface{}{
  1135. "foo": "baz",
  1136. },
  1137. },
  1138. "data": map[string]interface{}{
  1139. "access_key": "access_key2",
  1140. "access_secret": "access_secret2",
  1141. },
  1142. },
  1143. "secret3": map[string]interface{}{
  1144. "metadata": map[string]interface{}{
  1145. "custom_metadata": map[string]interface{}{
  1146. "foo": "baz",
  1147. },
  1148. },
  1149. "data": nil,
  1150. },
  1151. "tag": map[string]interface{}{
  1152. "metadata": map[string]interface{}{
  1153. "custom_metadata": map[string]interface{}{
  1154. "foo": "baz",
  1155. },
  1156. },
  1157. "data": map[string]interface{}{
  1158. "access_key": "unfetched",
  1159. "access_secret": "unfetched",
  1160. },
  1161. },
  1162. "path/1": map[string]interface{}{
  1163. "metadata": map[string]interface{}{
  1164. "custom_metadata": map[string]interface{}{
  1165. "foo": "path",
  1166. },
  1167. },
  1168. "data": map[string]interface{}{
  1169. "access_key": "path1",
  1170. "access_secret": "path1",
  1171. },
  1172. },
  1173. "path/2": map[string]interface{}{
  1174. "metadata": map[string]interface{}{
  1175. "custom_metadata": map[string]interface{}{
  1176. "foo": "path",
  1177. },
  1178. },
  1179. "data": map[string]interface{}{
  1180. "access_key": "path2",
  1181. "access_secret": "path2",
  1182. },
  1183. },
  1184. "default": map[string]interface{}{
  1185. "data": map[string]interface{}{
  1186. "empty": "true",
  1187. },
  1188. "metadata": map[string]interface{}{
  1189. "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
  1190. },
  1191. },
  1192. "path/": map[string]interface{}{
  1193. "data": map[string]interface{}{
  1194. "empty": "true",
  1195. },
  1196. "metadata": map[string]interface{}{
  1197. "keys": []interface{}{"1", "2"},
  1198. },
  1199. },
  1200. }
  1201. type args struct {
  1202. store *esv1beta1.VaultProvider
  1203. kube kclient.Client
  1204. vLogical util.Logical
  1205. ns string
  1206. data esv1beta1.ExternalSecretFind
  1207. }
  1208. type want struct {
  1209. err error
  1210. val map[string][]byte
  1211. }
  1212. cases := map[string]struct {
  1213. reason string
  1214. args args
  1215. want want
  1216. }{
  1217. "FindByName": {
  1218. reason: "should map multiple secrets matching name",
  1219. args: args{
  1220. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1221. vLogical: &fake.Logical{
  1222. ListWithContextFn: newListWithContextFn(secret),
  1223. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1224. },
  1225. data: esv1beta1.ExternalSecretFind{
  1226. Name: &esv1beta1.FindName{
  1227. RegExp: "secret.*",
  1228. },
  1229. },
  1230. },
  1231. want: want{
  1232. err: nil,
  1233. val: map[string][]byte{
  1234. "secret1": secret1Bytes,
  1235. "secret2": secret2Bytes,
  1236. },
  1237. },
  1238. },
  1239. "FindByTag": {
  1240. reason: "should map multiple secrets matching tags",
  1241. args: args{
  1242. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1243. vLogical: &fake.Logical{
  1244. ListWithContextFn: newListWithContextFn(secret),
  1245. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1246. },
  1247. data: esv1beta1.ExternalSecretFind{
  1248. Tags: map[string]string{
  1249. "foo": "baz",
  1250. },
  1251. },
  1252. },
  1253. want: want{
  1254. err: nil,
  1255. val: map[string][]byte{
  1256. "tag": tagBytes,
  1257. "secret2": secret2Bytes,
  1258. },
  1259. },
  1260. },
  1261. "FilterByPath": {
  1262. reason: "should filter secrets based on path",
  1263. args: args{
  1264. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1265. vLogical: &fake.Logical{
  1266. ListWithContextFn: newListWithContextFn(secret),
  1267. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1268. },
  1269. data: esv1beta1.ExternalSecretFind{
  1270. Path: &path,
  1271. Tags: map[string]string{
  1272. "foo": "path",
  1273. },
  1274. },
  1275. },
  1276. want: want{
  1277. err: nil,
  1278. val: map[string][]byte{
  1279. "path/1": path1Bytes,
  1280. "path/2": path2Bytes,
  1281. },
  1282. },
  1283. },
  1284. "FailIfKv1": {
  1285. reason: "should not work if using kv1 store",
  1286. args: args{
  1287. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1288. vLogical: &fake.Logical{
  1289. ListWithContextFn: newListWithContextFn(secret),
  1290. ReadWithDataWithContextFn: newReadtWithContextFn(secret),
  1291. },
  1292. data: esv1beta1.ExternalSecretFind{
  1293. Tags: map[string]string{
  1294. "foo": "baz",
  1295. },
  1296. },
  1297. },
  1298. want: want{
  1299. err: errors.New(errUnsupportedKvVersion),
  1300. },
  1301. },
  1302. "MetadataNotFound": {
  1303. reason: "metadata secret not found",
  1304. args: args{
  1305. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1306. vLogical: &fake.Logical{
  1307. ListWithContextFn: newListWithContextFn(secret),
  1308. ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
  1309. return nil, nil
  1310. },
  1311. },
  1312. data: esv1beta1.ExternalSecretFind{
  1313. Tags: map[string]string{
  1314. "foo": "baz",
  1315. },
  1316. },
  1317. },
  1318. want: want{
  1319. err: errors.New(errNotFound),
  1320. },
  1321. },
  1322. }
  1323. for name, tc := range cases {
  1324. t.Run(name, func(t *testing.T) {
  1325. vStore := &client{
  1326. kube: tc.args.kube,
  1327. logical: tc.args.vLogical,
  1328. store: tc.args.store,
  1329. namespace: tc.args.ns,
  1330. }
  1331. val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
  1332. if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
  1333. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  1334. }
  1335. if diff := cmp.Diff(tc.want.val, val); diff != "" {
  1336. t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
  1337. }
  1338. })
  1339. }
  1340. }
  1341. func TestGetSecretPath(t *testing.T) {
  1342. storeV2 := makeValidSecretStore()
  1343. storeV2NoPath := storeV2.DeepCopy()
  1344. multiPath := "secret/path"
  1345. storeV2.Spec.Provider.Vault.Path = &multiPath
  1346. storeV2NoPath.Spec.Provider.Vault.Path = nil
  1347. storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
  1348. storeV1NoPath := storeV1.DeepCopy()
  1349. storeV1.Spec.Provider.Vault.Path = &multiPath
  1350. storeV1NoPath.Spec.Provider.Vault.Path = nil
  1351. type args struct {
  1352. store *esv1beta1.VaultProvider
  1353. path string
  1354. expected string
  1355. }
  1356. cases := map[string]struct {
  1357. reason string
  1358. args args
  1359. }{
  1360. "PathWithoutFormatV2": {
  1361. reason: "path should compose with mount point if set",
  1362. args: args{
  1363. store: storeV2.Spec.Provider.Vault,
  1364. path: "secret/path/data/test",
  1365. expected: "secret/path/data/test",
  1366. },
  1367. },
  1368. "PathWithoutFormatV2_NoData": {
  1369. reason: "path should compose with mount point if set without data",
  1370. args: args{
  1371. store: storeV2.Spec.Provider.Vault,
  1372. path: "secret/path/test",
  1373. expected: "secret/path/data/test",
  1374. },
  1375. },
  1376. "PathWithoutFormatV2_NoPath": {
  1377. reason: "if no mountpoint and no data available, needs to be set in second element",
  1378. args: args{
  1379. store: storeV2NoPath.Spec.Provider.Vault,
  1380. path: "secret/test/big/path",
  1381. expected: "secret/data/test/big/path",
  1382. },
  1383. },
  1384. "PathWithoutFormatV2_NoPathWithData": {
  1385. reason: "if data is available, should respect order",
  1386. args: args{
  1387. store: storeV2NoPath.Spec.Provider.Vault,
  1388. path: "secret/test/data/not/the/first/and/data/twice",
  1389. expected: "secret/test/data/not/the/first/and/data/twice",
  1390. },
  1391. },
  1392. "PathWithoutFormatV1": {
  1393. reason: "v1 mountpoint should be added but not enforce 'data'",
  1394. args: args{
  1395. store: storeV1.Spec.Provider.Vault,
  1396. path: "secret/path/test",
  1397. expected: "secret/path/test",
  1398. },
  1399. },
  1400. "PathWithoutFormatV1_NoPath": {
  1401. reason: "Should not append any path information if v1 with no mountpoint",
  1402. args: args{
  1403. store: storeV1NoPath.Spec.Provider.Vault,
  1404. path: "secret/test",
  1405. expected: "secret/test",
  1406. },
  1407. },
  1408. "WithoutPathButMountpointV2": {
  1409. reason: "Mountpoint needs to be set in addition to data",
  1410. args: args{
  1411. store: storeV2.Spec.Provider.Vault,
  1412. path: "test",
  1413. expected: "secret/path/data/test",
  1414. },
  1415. },
  1416. "WithoutPathButMountpointV1": {
  1417. reason: "Mountpoint needs to be set in addition to data",
  1418. args: args{
  1419. store: storeV1.Spec.Provider.Vault,
  1420. path: "test",
  1421. expected: "secret/path/test",
  1422. },
  1423. },
  1424. }
  1425. for name, tc := range cases {
  1426. t.Run(name, func(t *testing.T) {
  1427. vStore := &client{
  1428. store: tc.args.store,
  1429. }
  1430. want := vStore.buildPath(tc.args.path)
  1431. if diff := cmp.Diff(want, tc.args.expected); diff != "" {
  1432. t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
  1433. }
  1434. })
  1435. }
  1436. }
  1437. func TestValidateStore(t *testing.T) {
  1438. type args struct {
  1439. auth esv1beta1.VaultAuth
  1440. }
  1441. tests := []struct {
  1442. name string
  1443. args args
  1444. wantErr bool
  1445. }{
  1446. {
  1447. name: "empty auth",
  1448. args: args{},
  1449. },
  1450. {
  1451. name: "invalid approle with namespace",
  1452. args: args{
  1453. auth: esv1beta1.VaultAuth{
  1454. AppRole: &esv1beta1.VaultAppRole{
  1455. SecretRef: esmeta.SecretKeySelector{
  1456. Namespace: pointer.To("invalid"),
  1457. },
  1458. },
  1459. },
  1460. },
  1461. wantErr: true,
  1462. },
  1463. {
  1464. name: "invalid approle with roleId and no roleRef",
  1465. args: args{
  1466. auth: esv1beta1.VaultAuth{
  1467. AppRole: &esv1beta1.VaultAppRole{
  1468. RoleID: "",
  1469. RoleRef: nil,
  1470. },
  1471. },
  1472. },
  1473. wantErr: true,
  1474. },
  1475. {
  1476. name: "valid approle with roleId and no roleRef",
  1477. args: args{
  1478. auth: esv1beta1.VaultAuth{
  1479. AppRole: &esv1beta1.VaultAppRole{
  1480. RoleID: "fake-value",
  1481. },
  1482. },
  1483. },
  1484. wantErr: false,
  1485. },
  1486. {
  1487. name: "valid approle with roleId and no roleRef",
  1488. args: args{
  1489. auth: esv1beta1.VaultAuth{
  1490. AppRole: &esv1beta1.VaultAppRole{
  1491. RoleRef: &esmeta.SecretKeySelector{
  1492. Name: "fake-value",
  1493. },
  1494. },
  1495. },
  1496. },
  1497. wantErr: false,
  1498. },
  1499. {
  1500. name: "invalid clientcert",
  1501. args: args{
  1502. auth: esv1beta1.VaultAuth{
  1503. Cert: &esv1beta1.VaultCertAuth{
  1504. ClientCert: esmeta.SecretKeySelector{
  1505. Namespace: pointer.To("invalid"),
  1506. },
  1507. },
  1508. },
  1509. },
  1510. wantErr: true,
  1511. },
  1512. {
  1513. name: "invalid cert secret",
  1514. args: args{
  1515. auth: esv1beta1.VaultAuth{
  1516. Cert: &esv1beta1.VaultCertAuth{
  1517. SecretRef: esmeta.SecretKeySelector{
  1518. Namespace: pointer.To("invalid"),
  1519. },
  1520. },
  1521. },
  1522. },
  1523. wantErr: true,
  1524. },
  1525. {
  1526. name: "invalid jwt secret",
  1527. args: args{
  1528. auth: esv1beta1.VaultAuth{
  1529. Jwt: &esv1beta1.VaultJwtAuth{
  1530. SecretRef: &esmeta.SecretKeySelector{
  1531. Namespace: pointer.To("invalid"),
  1532. },
  1533. },
  1534. },
  1535. },
  1536. wantErr: true,
  1537. },
  1538. {
  1539. name: "invalid kubernetes sa",
  1540. args: args{
  1541. auth: esv1beta1.VaultAuth{
  1542. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1543. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  1544. Namespace: pointer.To("invalid"),
  1545. },
  1546. },
  1547. },
  1548. },
  1549. wantErr: true,
  1550. },
  1551. {
  1552. name: "invalid kubernetes secret",
  1553. args: args{
  1554. auth: esv1beta1.VaultAuth{
  1555. Kubernetes: &esv1beta1.VaultKubernetesAuth{
  1556. SecretRef: &esmeta.SecretKeySelector{
  1557. Namespace: pointer.To("invalid"),
  1558. },
  1559. },
  1560. },
  1561. },
  1562. wantErr: true,
  1563. },
  1564. {
  1565. name: "invalid ldap secret",
  1566. args: args{
  1567. auth: esv1beta1.VaultAuth{
  1568. Ldap: &esv1beta1.VaultLdapAuth{
  1569. SecretRef: esmeta.SecretKeySelector{
  1570. Namespace: pointer.To("invalid"),
  1571. },
  1572. },
  1573. },
  1574. },
  1575. wantErr: true,
  1576. },
  1577. {
  1578. name: "invalid userpass secret",
  1579. args: args{
  1580. auth: esv1beta1.VaultAuth{
  1581. UserPass: &esv1beta1.VaultUserPassAuth{
  1582. SecretRef: esmeta.SecretKeySelector{
  1583. Namespace: pointer.To("invalid"),
  1584. },
  1585. },
  1586. },
  1587. },
  1588. wantErr: true,
  1589. },
  1590. {
  1591. name: "invalid token secret",
  1592. args: args{
  1593. auth: esv1beta1.VaultAuth{
  1594. TokenSecretRef: &esmeta.SecretKeySelector{
  1595. Namespace: pointer.To("invalid"),
  1596. },
  1597. },
  1598. },
  1599. wantErr: true,
  1600. },
  1601. }
  1602. for _, tt := range tests {
  1603. t.Run(tt.name, func(t *testing.T) {
  1604. c := &Connector{
  1605. NewVaultClient: nil,
  1606. }
  1607. store := &esv1beta1.SecretStore{
  1608. Spec: esv1beta1.SecretStoreSpec{
  1609. Provider: &esv1beta1.SecretStoreProvider{
  1610. Vault: &esv1beta1.VaultProvider{
  1611. Auth: tt.args.auth,
  1612. },
  1613. },
  1614. },
  1615. }
  1616. if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
  1617. t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
  1618. }
  1619. })
  1620. }
  1621. }
  1622. func TestDeleteSecret(t *testing.T) {
  1623. type args struct {
  1624. store *esv1beta1.VaultProvider
  1625. vLogical util.Logical
  1626. }
  1627. type want struct {
  1628. err error
  1629. }
  1630. tests := map[string]struct {
  1631. reason string
  1632. args args
  1633. ref *testingfake.PushSecretData
  1634. want want
  1635. value []byte
  1636. }{
  1637. "DeleteSecretNoOpKV1": {
  1638. reason: "No secret is because it does not exist",
  1639. args: args{
  1640. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1641. vLogical: &fake.Logical{
  1642. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1643. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1644. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1645. },
  1646. },
  1647. want: want{
  1648. err: nil,
  1649. },
  1650. },
  1651. "DeleteSecretNoOpKV2": {
  1652. reason: "No secret is because it does not exist",
  1653. args: args{
  1654. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1655. vLogical: &fake.Logical{
  1656. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1657. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1658. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1659. },
  1660. },
  1661. want: want{
  1662. err: nil,
  1663. },
  1664. },
  1665. "DeleteSecretFailIfErrorKV1": {
  1666. reason: "No secret is because it does not exist",
  1667. args: args{
  1668. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1669. vLogical: &fake.Logical{
  1670. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
  1671. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1672. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1673. },
  1674. },
  1675. want: want{
  1676. err: fmt.Errorf("failed to read"),
  1677. },
  1678. },
  1679. "DeleteSecretFailIfErrorKV2": {
  1680. reason: "No secret is because it does not exist",
  1681. args: args{
  1682. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1683. vLogical: &fake.Logical{
  1684. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
  1685. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1686. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1687. },
  1688. },
  1689. want: want{
  1690. err: fmt.Errorf("failed to read"),
  1691. },
  1692. },
  1693. "DeleteSecretNotManagedKV1": {
  1694. reason: "No secret is because it does not exist",
  1695. args: args{
  1696. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1697. vLogical: &fake.Logical{
  1698. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1699. "fake-key": "fake-value",
  1700. "custom_metadata": map[string]interface{}{
  1701. "managed-by": "another-secret-tool",
  1702. },
  1703. }, nil),
  1704. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1705. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1706. },
  1707. },
  1708. want: want{
  1709. err: nil,
  1710. },
  1711. },
  1712. "DeleteSecretNotManagedKV2": {
  1713. reason: "No secret is because it does not exist",
  1714. args: args{
  1715. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1716. vLogical: &fake.Logical{
  1717. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1718. "data": map[string]interface{}{
  1719. "fake-key": "fake-value",
  1720. },
  1721. "custom_metadata": map[string]interface{}{
  1722. "managed-by": "another-secret-tool",
  1723. },
  1724. }, nil),
  1725. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1726. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1727. },
  1728. },
  1729. want: want{
  1730. err: nil,
  1731. },
  1732. },
  1733. "DeleteSecretSuccessKV1": {
  1734. reason: "No secret is because it does not exist",
  1735. args: args{
  1736. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1737. vLogical: &fake.Logical{
  1738. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1739. "fake-key": "fake-value",
  1740. "custom_metadata": map[string]interface{}{
  1741. "managed-by": "external-secrets",
  1742. },
  1743. }, nil),
  1744. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1745. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1746. },
  1747. },
  1748. want: want{
  1749. err: nil,
  1750. },
  1751. },
  1752. "DeleteSecretSuccessKV2": {
  1753. reason: "No secret is because it does not exist",
  1754. args: args{
  1755. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1756. vLogical: &fake.Logical{
  1757. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1758. "data": map[string]interface{}{
  1759. "fake-key": "fake-value",
  1760. },
  1761. "custom_metadata": map[string]interface{}{
  1762. "managed-by": "external-secrets",
  1763. },
  1764. }, nil),
  1765. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1766. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1767. },
  1768. },
  1769. want: want{
  1770. err: nil,
  1771. },
  1772. },
  1773. "DeleteSecretErrorKV1": {
  1774. reason: "No secret is because it does not exist",
  1775. args: args{
  1776. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1777. vLogical: &fake.Logical{
  1778. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1779. "fake-key": "fake-value",
  1780. "custom_metadata": map[string]interface{}{
  1781. "managed-by": "external-secrets",
  1782. },
  1783. }, nil),
  1784. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1785. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
  1786. },
  1787. },
  1788. want: want{
  1789. err: fmt.Errorf("failed to delete"),
  1790. },
  1791. },
  1792. "DeleteSecretErrorKV2": {
  1793. reason: "No secret is because it does not exist",
  1794. args: args{
  1795. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1796. vLogical: &fake.Logical{
  1797. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1798. "data": map[string]interface{}{
  1799. "fake-key": "fake-value",
  1800. },
  1801. "custom_metadata": map[string]interface{}{
  1802. "managed-by": "external-secrets",
  1803. },
  1804. }, nil),
  1805. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1806. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
  1807. },
  1808. },
  1809. want: want{
  1810. err: fmt.Errorf("failed to delete"),
  1811. },
  1812. },
  1813. "DeleteSecretUpdatePropertyKV1": {
  1814. reason: "Secret should only be updated if Property is set",
  1815. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
  1816. args: args{
  1817. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1818. vLogical: &fake.Logical{
  1819. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1820. "fake-key": "fake-value",
  1821. "foo": "bar",
  1822. "custom_metadata": map[string]interface{}{
  1823. "managed-by": "external-secrets",
  1824. },
  1825. }, nil),
  1826. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  1827. "foo": "bar",
  1828. "custom_metadata": map[string]interface{}{
  1829. "managed-by": "external-secrets",
  1830. }}),
  1831. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1832. },
  1833. },
  1834. want: want{
  1835. err: nil,
  1836. },
  1837. },
  1838. "DeleteSecretUpdatePropertyKV2": {
  1839. reason: "Secret should only be updated if Property is set",
  1840. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
  1841. args: args{
  1842. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1843. vLogical: &fake.Logical{
  1844. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1845. "data": map[string]interface{}{
  1846. "fake-key": "fake-value",
  1847. "foo": "bar",
  1848. },
  1849. "custom_metadata": map[string]interface{}{
  1850. "managed-by": "external-secrets",
  1851. },
  1852. }, nil),
  1853. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "bar"}}),
  1854. DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
  1855. },
  1856. },
  1857. want: want{
  1858. err: nil,
  1859. },
  1860. },
  1861. "DeleteSecretIfNoOtherPropertiesKV1": {
  1862. reason: "Secret should only be deleted if no other properties are set",
  1863. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
  1864. args: args{
  1865. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1866. vLogical: &fake.Logical{
  1867. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1868. "foo": "bar",
  1869. "custom_metadata": map[string]interface{}{
  1870. "managed-by": "external-secrets",
  1871. },
  1872. }, nil),
  1873. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1874. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1875. },
  1876. },
  1877. want: want{
  1878. err: nil,
  1879. },
  1880. },
  1881. "DeleteSecretIfNoOtherPropertiesKV2": {
  1882. reason: "Secret should only be deleted if no other properties are set",
  1883. ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
  1884. args: args{
  1885. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1886. vLogical: &fake.Logical{
  1887. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  1888. "data": map[string]interface{}{
  1889. "foo": "bar",
  1890. },
  1891. "custom_metadata": map[string]interface{}{
  1892. "managed-by": "external-secrets",
  1893. },
  1894. }, nil),
  1895. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  1896. DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
  1897. },
  1898. },
  1899. want: want{
  1900. err: nil,
  1901. },
  1902. },
  1903. }
  1904. for name, tc := range tests {
  1905. t.Run(name, func(t *testing.T) {
  1906. ref := testingfake.PushSecretData{RemoteKey: "secret", Property: ""}
  1907. if tc.ref != nil {
  1908. ref = *tc.ref
  1909. }
  1910. client := &client{
  1911. logical: tc.args.vLogical,
  1912. store: tc.args.store,
  1913. }
  1914. err := client.DeleteSecret(context.Background(), ref)
  1915. // Error nil XOR tc.want.err nil
  1916. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  1917. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  1918. }
  1919. // if errors are the same type but their contents do not match
  1920. if err != nil && tc.want.err != nil {
  1921. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  1922. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  1923. }
  1924. }
  1925. })
  1926. }
  1927. }
  1928. func TestPushSecret(t *testing.T) {
  1929. secretKey := "secret-key"
  1930. noPermission := errors.New("no permission")
  1931. type args struct {
  1932. store *esv1beta1.VaultProvider
  1933. vLogical util.Logical
  1934. }
  1935. type want struct {
  1936. err error
  1937. }
  1938. tests := map[string]struct {
  1939. reason string
  1940. args args
  1941. want want
  1942. data *testingfake.PushSecretData
  1943. value []byte
  1944. }{
  1945. "SetSecretKV1": {
  1946. reason: "secret is successfully set, with no existing vault secret",
  1947. args: args{
  1948. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1949. vLogical: &fake.Logical{
  1950. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1951. WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
  1952. },
  1953. },
  1954. want: want{
  1955. err: nil,
  1956. },
  1957. },
  1958. "SetSecretKV2": {
  1959. reason: "secret is successfully set, with no existing vault secret",
  1960. args: args{
  1961. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1962. vLogical: &fake.Logical{
  1963. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1964. WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
  1965. },
  1966. },
  1967. want: want{
  1968. err: nil,
  1969. },
  1970. },
  1971. "SetSecretWithWriteErrorKV1": {
  1972. reason: "secret cannot be pushed if write fails",
  1973. args: args{
  1974. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  1975. vLogical: &fake.Logical{
  1976. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1977. WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
  1978. },
  1979. },
  1980. want: want{
  1981. err: noPermission,
  1982. },
  1983. },
  1984. "SetSecretWithWriteErrorKV2": {
  1985. reason: "secret cannot be pushed if write fails",
  1986. args: args{
  1987. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  1988. vLogical: &fake.Logical{
  1989. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
  1990. WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
  1991. },
  1992. },
  1993. want: want{
  1994. err: noPermission,
  1995. },
  1996. },
  1997. "SetSecretEqualsPushSecretV1": {
  1998. reason: "vault secret kv equals secret to push kv",
  1999. args: args{
  2000. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2001. vLogical: &fake.Logical{
  2002. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2003. "fake-key": "fake-value",
  2004. "custom_metadata": map[string]interface{}{
  2005. "managed-by": "external-secrets",
  2006. },
  2007. }, nil),
  2008. },
  2009. },
  2010. want: want{
  2011. err: nil,
  2012. },
  2013. },
  2014. "SetSecretEqualsPushSecretV2": {
  2015. reason: "vault secret kv equals secret to push kv",
  2016. args: args{
  2017. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2018. vLogical: &fake.Logical{
  2019. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2020. "data": map[string]interface{}{
  2021. "fake-key": "fake-value",
  2022. },
  2023. "custom_metadata": map[string]interface{}{
  2024. "managed-by": "external-secrets",
  2025. },
  2026. }, nil),
  2027. },
  2028. },
  2029. want: want{
  2030. err: nil,
  2031. },
  2032. },
  2033. "PushSecretPropertyKV1": {
  2034. reason: "push secret with property adds the property",
  2035. value: []byte("fake-value"),
  2036. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2037. args: args{
  2038. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2039. vLogical: &fake.Logical{
  2040. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2041. "fake-key": "fake-value",
  2042. "custom_metadata": map[string]interface{}{
  2043. "managed-by": "external-secrets",
  2044. },
  2045. }, nil),
  2046. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  2047. "fake-key": "fake-value",
  2048. "custom_metadata": map[string]string{
  2049. "managed-by": "external-secrets",
  2050. },
  2051. "foo": "fake-value",
  2052. }),
  2053. },
  2054. },
  2055. want: want{
  2056. err: nil,
  2057. },
  2058. },
  2059. "PushSecretPropertyKV2": {
  2060. reason: "push secret with property adds the property",
  2061. value: []byte("fake-value"),
  2062. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2063. args: args{
  2064. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2065. vLogical: &fake.Logical{
  2066. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2067. "data": map[string]interface{}{
  2068. "fake-key": "fake-value",
  2069. },
  2070. "custom_metadata": map[string]interface{}{
  2071. "managed-by": "external-secrets",
  2072. },
  2073. }, nil),
  2074. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"fake-key": "fake-value", "foo": "fake-value"}}),
  2075. },
  2076. },
  2077. want: want{
  2078. err: nil,
  2079. },
  2080. },
  2081. "PushSecretUpdatePropertyKV1": {
  2082. reason: "push secret with property only updates the property",
  2083. value: []byte("new-value"),
  2084. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2085. args: args{
  2086. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2087. vLogical: &fake.Logical{
  2088. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2089. "foo": "fake-value",
  2090. "custom_metadata": map[string]interface{}{
  2091. "managed-by": "external-secrets",
  2092. },
  2093. }, nil),
  2094. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
  2095. "foo": "new-value",
  2096. "custom_metadata": map[string]string{
  2097. "managed-by": "external-secrets",
  2098. },
  2099. }),
  2100. },
  2101. },
  2102. want: want{
  2103. err: nil,
  2104. },
  2105. },
  2106. "PushSecretUpdatePropertyKV2": {
  2107. reason: "push secret with property only updates the property",
  2108. value: []byte("new-value"),
  2109. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2110. args: args{
  2111. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2112. vLogical: &fake.Logical{
  2113. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2114. "data": map[string]interface{}{
  2115. "foo": "fake-value",
  2116. },
  2117. "custom_metadata": map[string]interface{}{
  2118. "managed-by": "external-secrets",
  2119. },
  2120. }, nil),
  2121. WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "new-value"}}),
  2122. },
  2123. },
  2124. want: want{
  2125. err: nil,
  2126. },
  2127. },
  2128. "PushSecretPropertyNoUpdateKV1": {
  2129. reason: "push secret with property only updates the property",
  2130. value: []byte("fake-value"),
  2131. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2132. args: args{
  2133. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2134. vLogical: &fake.Logical{
  2135. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2136. "foo": "fake-value",
  2137. "custom_metadata": map[string]interface{}{
  2138. "managed-by": "external-secrets",
  2139. },
  2140. }, nil),
  2141. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  2142. },
  2143. },
  2144. want: want{
  2145. err: nil,
  2146. },
  2147. },
  2148. "PushSecretPropertyNoUpdateKV2": {
  2149. reason: "push secret with property only updates the property",
  2150. value: []byte("fake-value"),
  2151. data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
  2152. args: args{
  2153. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2154. vLogical: &fake.Logical{
  2155. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2156. "data": map[string]interface{}{
  2157. "foo": "fake-value",
  2158. },
  2159. "custom_metadata": map[string]interface{}{
  2160. "managed-by": "external-secrets",
  2161. },
  2162. }, nil),
  2163. WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
  2164. },
  2165. },
  2166. want: want{
  2167. err: nil,
  2168. },
  2169. },
  2170. "SetSecretErrorReadingSecretKV1": {
  2171. reason: "error occurs if secret cannot be read",
  2172. args: args{
  2173. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2174. vLogical: &fake.Logical{
  2175. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
  2176. },
  2177. },
  2178. want: want{
  2179. err: fmt.Errorf(errReadSecret, noPermission),
  2180. },
  2181. },
  2182. "SetSecretErrorReadingSecretKV2": {
  2183. reason: "error occurs if secret cannot be read",
  2184. args: args{
  2185. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2186. vLogical: &fake.Logical{
  2187. ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
  2188. },
  2189. },
  2190. want: want{
  2191. err: fmt.Errorf(errReadSecret, noPermission),
  2192. },
  2193. },
  2194. "SetSecretNotManagedByESOV1": {
  2195. reason: "a secret not managed by ESO cannot be updated",
  2196. args: args{
  2197. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
  2198. vLogical: &fake.Logical{
  2199. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2200. "fake-key": "fake-value2",
  2201. "custom_metadata": map[string]interface{}{
  2202. "managed-by": "not-external-secrets",
  2203. },
  2204. }, nil),
  2205. },
  2206. },
  2207. want: want{
  2208. err: errors.New("secret not managed by external-secrets"),
  2209. },
  2210. },
  2211. "SetSecretNotManagedByESOV2": {
  2212. reason: "a secret not managed by ESO cannot be updated",
  2213. args: args{
  2214. store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
  2215. vLogical: &fake.Logical{
  2216. ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
  2217. "data": map[string]interface{}{
  2218. "fake-key": "fake-value2",
  2219. "custom_metadata": map[string]interface{}{
  2220. "managed-by": "not-external-secrets",
  2221. },
  2222. },
  2223. }, nil),
  2224. },
  2225. },
  2226. want: want{
  2227. err: errors.New("secret not managed by external-secrets"),
  2228. },
  2229. },
  2230. }
  2231. for name, tc := range tests {
  2232. t.Run(name, func(t *testing.T) {
  2233. data := testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: ""}
  2234. if tc.data != nil {
  2235. data = *tc.data
  2236. }
  2237. client := &client{
  2238. logical: tc.args.vLogical,
  2239. store: tc.args.store,
  2240. }
  2241. val := tc.value
  2242. if val == nil {
  2243. val = []byte(`{"fake-key":"fake-value"}`)
  2244. }
  2245. s := &corev1.Secret{Data: map[string][]byte{secretKey: val}}
  2246. err := client.PushSecret(context.Background(), s, data)
  2247. // Error nil XOR tc.want.err nil
  2248. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  2249. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  2250. }
  2251. // if errors are the same type but their contents do not match
  2252. if err != nil && tc.want.err != nil {
  2253. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  2254. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  2255. }
  2256. }
  2257. })
  2258. }
  2259. }
  2260. // EquateErrors returns true if the supplied errors are of the same type and
  2261. // produce identical strings. This mirrors the error comparison behavior of
  2262. // https://github.com/go-test/deep, which most Crossplane tests targeted before
  2263. // we switched to go-cmp.
  2264. //
  2265. // This differs from cmpopts.EquateErrors, which does not test for error strings
  2266. // and instead returns whether one error 'is' (in the errors.Is sense) the
  2267. // other.
  2268. func EquateErrors() cmp.Option {
  2269. return cmp.Comparer(func(a, b error) bool {
  2270. if a == nil || b == nil {
  2271. return a == nil && b == nil
  2272. }
  2273. av := reflect.ValueOf(a)
  2274. bv := reflect.ValueOf(b)
  2275. if av.Type() != bv.Type() {
  2276. return false
  2277. }
  2278. return a.Error() == b.Error()
  2279. })
  2280. }