| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342 |
- /*
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package vault
- import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "reflect"
- "strings"
- "testing"
- "github.com/google/go-cmp/cmp"
- vault "github.com/hashicorp/vault/api"
- corev1 "k8s.io/api/core/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
- pointer "k8s.io/utils/ptr"
- kclient "sigs.k8s.io/controller-runtime/pkg/client"
- clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
- esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
- esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
- testingfake "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
- utilfake "github.com/external-secrets/external-secrets/pkg/provider/util/fake"
- "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
- "github.com/external-secrets/external-secrets/pkg/provider/vault/util"
- )
- const (
- tokenSecretName = "example-secret-token"
- secretDataString = "some-creds"
- )
- var (
- secretStorePath = "secret"
- )
- func makeValidSecretStoreWithVersion(v esv1beta1.VaultKVStoreVersion) *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: v,
- Auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- Path: "kubernetes",
- Role: "kubernetes-auth-role",
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Name: "example-sa",
- },
- },
- },
- },
- },
- },
- }
- }
- func makeValidSecretStore() *esv1beta1.SecretStore {
- return makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2)
- }
- func makeValidSecretStoreWithCerts() *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: esv1beta1.VaultKVStoreV2,
- Auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- ClientCert: esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- Key: "tls.crt",
- },
- SecretRef: esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- Key: "tls.key",
- },
- },
- },
- },
- },
- },
- }
- }
- func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1beta1.SecretStore {
- store := makeSecretStore()
- caProvider := &esv1beta1.CAProvider{
- Name: "vault-cert",
- Key: "cert",
- }
- if isSecret {
- caProvider.Type = "Secret"
- } else {
- caProvider.Type = "ConfigMap"
- }
- store.Spec.Provider.Vault.CAProvider = caProvider
- return store
- }
- func makeInvalidClusterSecretStoreWithK8sCerts() *esv1beta1.ClusterSecretStore {
- return &esv1beta1.ClusterSecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "ClusterSecretStore",
- },
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: "v2",
- Auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- Path: "kubernetes",
- Role: "kubernetes-auth-role",
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Name: "example-sa",
- },
- },
- },
- CAProvider: &esv1beta1.CAProvider{
- Name: "vault-cert",
- Key: "cert",
- Type: "Secret",
- },
- },
- },
- },
- }
- }
- func makeValidSecretStoreWithIamAuthSecret() *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "https://vault.example.com:8200",
- Path: &secretStorePath,
- Version: esv1beta1.VaultKVStoreV2,
- Auth: esv1beta1.VaultAuth{
- Iam: &esv1beta1.VaultIamAuth{
- Path: "aws",
- Region: "us-east-1",
- Role: "vault-role",
- SecretRef: &esv1beta1.VaultAwsAuthSecretRef{
- AccessKeyID: esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "access-key",
- },
- SecretAccessKey: esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "secret-access-key",
- },
- SessionToken: &esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "secret-session-token",
- },
- },
- },
- },
- },
- },
- },
- }
- }
- type secretStoreTweakFn func(s *esv1beta1.SecretStore)
- func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1beta1.SecretStore {
- store := makeValidSecretStore()
- for _, fn := range tweaks {
- fn(store)
- }
- return store
- }
- type args struct {
- newClientFunc func(c *vault.Config) (util.Client, error)
- store esv1beta1.GenericStore
- kube kclient.Client
- corev1 typedcorev1.CoreV1Interface
- ns string
- }
- type want struct {
- err error
- }
- type testCase struct {
- reason string
- args args
- want want
- }
- func TestNewVault(t *testing.T) {
- errBoom := errors.New("boom")
- secretClientKey := []byte(`-----BEGIN PRIVATE KEY-----
- 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==
- -----END PRIVATE KEY-----`)
- clientCrt := []byte(`-----BEGIN CERTIFICATE-----
- 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==
- -----END CERTIFICATE-----`)
- secretData := []byte(secretDataString)
- cases := map[string]testCase{
- "InvalidVaultStore": {
- reason: "Should return error if given an invalid vault store.",
- args: args{
- store: &esv1beta1.SecretStore{},
- },
- want: want{
- err: errors.New(errVaultStore),
- },
- },
- "InvalidRetrySettings": {
- reason: "Should return error if given an invalid Retry Interval.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
- MaxRetries: pointer.To(int32(3)),
- RetryInterval: pointer.To("not-an-interval"),
- }
- }),
- },
- want: want{
- err: errors.New("time: invalid duration \"not-an-interval\""),
- },
- },
- "ValidRetrySettings": {
- reason: "Should return a Vault provider with custom retry settings",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
- MaxRetries: pointer.To(int32(3)),
- RetryInterval: pointer.To("10m"),
- }
- }),
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "AddVaultStoreCertsError": {
- reason: "Should return error if given an invalid CA certificate.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
- }),
- },
- want: want{
- err: fmt.Errorf(errVaultCert, errors.New("failed to parse certificates from CertPool")),
- },
- },
- "VaultAuthFormatError": {
- reason: "Should return error if no valid authentication method is given.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.Auth = esv1beta1.VaultAuth{}
- }),
- },
- want: want{
- err: errors.New(errAuthFormat),
- },
- },
- "GetKubeServiceAccountError": {
- reason: "Should return error if fetching kubernetes secret fails.",
- args: args{
- newClientFunc: fake.ClientWithLoginMock,
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- store: makeSecretStore(),
- corev1: utilfake.NewCreateTokenMock().WithError(errBoom),
- },
- want: want{
- err: fmt.Errorf(errGetKubeSATokenRequest, "example-sa", errBoom),
- },
- },
- "GetKubeSecretError": {
- reason: "Should return error if fetching kubernetes secret fails.",
- args: args{
- ns: "default",
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
- s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
- Name: "vault-secret",
- Key: "key",
- }
- }),
- kube: clientfake.NewClientBuilder().Build(),
- },
- want: want{
- err: fmt.Errorf(errGetKubeSecret, "vault-secret", errors.New("secrets \"vault-secret\" not found")),
- },
- },
- "SuccessfulVaultStoreWithCertAuth": {
- reason: "Should return a Vault provider successfully",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": secretClientKey,
- "tls.crt": clientCrt,
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "SuccessfulVaultStoreWithK8sCertSecret": {
- reason: "Should return a Vault provider with the cert from k8s",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(true),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "cert": clientCrt,
- "token": secretData,
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "GetCertNamespaceMissingError": {
- reason: "Should return an error if namespace is missing and is a ClusterSecretStore",
- args: args{
- store: makeInvalidClusterSecretStoreWithK8sCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- },
- want: want{
- err: errors.New(errCANamespace),
- },
- },
- "GetCertSecretKeyMissingError": {
- reason: "Should return an error if the secret key is missing",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(true),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string][]byte{},
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
- },
- },
- "SuccessfulVaultStoreWithIamAuthSecret": {
- reason: "Should return a Vault provider successfully",
- args: args{
- store: makeValidSecretStoreWithIamAuthSecret(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-iam-creds-secret",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "access-key": []byte("TESTING"),
- "secret-access-key": []byte("ABCDEF"),
- "secret-session-token": []byte("c2VjcmV0LXNlc3Npb24tdG9rZW4K"),
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "SuccessfulVaultStoreWithK8sCertConfigMap": {
- reason: "Should return a Vault prodvider with the cert from k8s",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(false),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string]string{
- "cert": string(clientCrt),
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "GetCertConfigMapMissingError": {
- reason: "Should return an error if the config map key is missing",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(false),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
- ObjectMeta: metav1.ObjectMeta{
- Name: "example-sa",
- Namespace: "default",
- },
- Secrets: []corev1.ObjectReference{
- {
- Name: tokenSecretName,
- },
- },
- }, &corev1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string]string{},
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errConfigMapFmt, "cert"),
- },
- },
- "GetCertificateFormatError": {
- reason: "Should return error if client certificate is in wrong format.",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": secretClientKey,
- "tls.crt": []byte("cert with mistak"),
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
- },
- },
- "GetKeyFormatError": {
- reason: "Should return error if client key is in wrong format.",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": []byte("key with mistake"),
- "tls.crt": clientCrt,
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vaultTest(t, name, tc)
- })
- }
- }
- func vaultTest(t *testing.T, _ string, tc testCase) {
- conn := &Connector{
- NewVaultClient: tc.args.newClientFunc,
- }
- if tc.args.newClientFunc == nil {
- conn.NewVaultClient = NewVaultClient
- }
- _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- }
- func TestGetSecret(t *testing.T) {
- errBoom := errors.New("boom")
- secret := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- }
- secretWithNilVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "token": nil,
- }
- secretWithNestedVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "nested.bar": "something different",
- "nested": map[string]string{
- "foo": "oke",
- "bar": "also ok?",
- },
- "list_of_values": []string{
- "first_value",
- "second_value",
- "third_value",
- },
- "json_number": json.Number("42"),
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vLogical util.Logical
- ns string
- data esv1beta1.ExternalSecretDataRemoteRef
- }
- type want struct {
- err error
- val []byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "ReadSecret": {
- reason: "Should return the secret with property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "ReadSecretWithNil": {
- reason: "Should return the secret with property if it has a nil val",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "ReadSecretWithoutProperty": {
- reason: "Should return the json encoded secret without property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{},
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
- },
- },
- "ReadSecretWithNestedValue": {
- reason: "Should return a nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested.foo",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("oke"),
- },
- },
- "ReadSecretWithNestedValueFromData": {
- reason: "Should return a nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- //
- Property: "nested.bar",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("something different"),
- },
- },
- "ReadSecretWithMissingValueFromData": {
- reason: "Should return a NoSecretErr",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "not-relevant",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- },
- },
- want: want{
- err: esv1beta1.NoSecretErr,
- val: nil,
- },
- },
- "ReadSecretWithSliceValue": {
- reason: "Should return property as a joined slice",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "list_of_values",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("first_value\nsecond_value\nthird_value"),
- },
- },
- "ReadSecretWithJsonNumber": {
- reason: "Should return parsed json.Number property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "json_number",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("42"),
- },
- },
- "NonexistentProperty": {
- reason: "Should return error property does not exist.",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nop.doesnt.exist",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
- },
- },
- "ReadSecretError": {
- reason: "Should return error if vault client fails to read secret.",
- args: args{
- store: makeSecretStore().Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, errBoom),
- },
- },
- "ReadSecretNotFound": {
- reason: "Secret doesn't exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
- return nil, nil
- },
- },
- },
- want: want{
- err: esv1beta1.NoSecretError{},
- },
- },
- "ReadSecretMetadataWithoutProperty": {
- reason: "Should return the json encoded metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
- },
- },
- "ReadSecretMetadataWithProperty": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "FailReadSecretMetadataInvalidProperty": {
- reason: "Should return error of non existent key inmetadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- Property: "does_not_exist",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errSecretKeyFmt, "does_not_exist"),
- },
- },
- "FailReadSecretMetadataNoMetadata": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errNotFound),
- },
- },
- "FailReadSecretMetadataWrongVersion": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errUnsupportedMetadataKvVersion),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- kube: tc.args.kube,
- logical: tc.args.vLogical,
- store: tc.args.store,
- namespace: tc.args.ns,
- }
- val, err := vStore.GetSecret(context.Background(), tc.args.data)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
- t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestGetSecretMap(t *testing.T) {
- errBoom := errors.New("boom")
- secret := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- }
- secretWithSpecialCharacter := map[string]interface{}{
- "access_key": "acc<ess_&ke.,y",
- "access_secret": "acce&?ss_s>ecret",
- }
- secretWithNilVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "token": nil,
- }
- secretWithNestedVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "nested": map[string]interface{}{
- "foo": map[string]string{
- "oke": "yup",
- "mhkeih": "yada yada",
- },
- },
- }
- secretWithTypes := map[string]interface{}{
- "access_secret": "access_secret",
- "f32": float32(2.12),
- "f64": float64(2.1234534153423423),
- "int": 42,
- "bool": true,
- "bt": []byte("foobar"),
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vClient util.Logical
- ns string
- data esv1beta1.ExternalSecretDataRemoteRef
- }
- type want struct {
- err error
- val map[string][]byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "ReadSecretKV1": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- },
- },
- },
- "ReadSecretKV2": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secret,
- }, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- },
- },
- },
- "ReadSecretWithSpecialCharactersKV1": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithSpecialCharacter, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("acc<ess_&ke.,y"),
- "access_secret": []byte("acce&?ss_s>ecret"),
- },
- },
- },
- "ReadSecretWithSpecialCharactersKV2": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithSpecialCharacter,
- }, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("acc<ess_&ke.,y"),
- "access_secret": []byte("acce&?ss_s>ecret"),
- },
- },
- },
- "ReadSecretWithNilValueKV1": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- "token": []byte(nil),
- },
- },
- },
- "ReadSecretWithNilValueKV2": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNilVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- "token": []byte(nil),
- },
- },
- },
- "ReadSecretWithTypesKV2": {
- reason: "Should map the secret even if it has other types",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithTypes}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_secret": []byte("access_secret"),
- "f32": []byte("2.12"),
- "f64": []byte("2.1234534153423423"),
- "int": []byte("42"),
- "bool": []byte("true"),
- "bt": []byte("Zm9vYmFy"), // base64
- },
- },
- },
- "ReadNestedSecret": {
- reason: "Should map the secret for deeply nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested",
- },
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNestedVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
- },
- },
- },
- "ReadDeeplyNestedSecret": {
- reason: "Should map the secret for deeply nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested.foo",
- },
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNestedVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "oke": []byte("yup"),
- "mhkeih": []byte("yada yada"),
- },
- },
- },
- "ReadSecretError": {
- reason: "Should return error if vault client fails to read secret.",
- args: args{
- store: makeSecretStore().Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, errBoom),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- kube: tc.args.kube,
- logical: tc.args.vClient,
- store: tc.args.store,
- namespace: tc.args.ns,
- }
- val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(tc.want.val, val); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
- return func(ctx context.Context, path string) (*vault.Secret, error) {
- path = strings.TrimPrefix(path, "secret/metadata/")
- if path == "" {
- path = "default"
- }
- data, ok := secrets[path]
- if !ok {
- return nil, errors.New("Secret not found")
- }
- meta := data.(map[string]interface{})
- ans := meta["metadata"].(map[string]interface{})
- secret := &vault.Secret{
- Data: map[string]interface{}{
- "keys": ans["keys"],
- },
- }
- return secret, nil
- }
- }
- func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
- return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
- path = strings.TrimPrefix(path, "secret/data/")
- path = strings.TrimPrefix(path, "secret/metadata/")
- if path == "" {
- path = "default"
- }
- data, ok := secrets[path]
- if !ok {
- return nil, errors.New("Secret not found")
- }
- meta := data.(map[string]interface{})
- metadata := meta["metadata"].(map[string]interface{})
- content := map[string]interface{}{
- "data": meta["data"],
- "custom_metadata": metadata["custom_metadata"],
- }
- secret := &vault.Secret{
- Data: content,
- }
- return secret, nil
- }
- }
- func TestGetAllSecrets(t *testing.T) {
- secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
- secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
- path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
- path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
- tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
- path := "path"
- secret := map[string]interface{}{
- "secret1": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "bar",
- },
- },
- "data": map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- },
- },
- "secret2": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": map[string]interface{}{
- "access_key": "access_key2",
- "access_secret": "access_secret2",
- },
- },
- "secret3": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": nil,
- },
- "tag": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": map[string]interface{}{
- "access_key": "unfetched",
- "access_secret": "unfetched",
- },
- },
- "path/1": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "path",
- },
- },
- "data": map[string]interface{}{
- "access_key": "path1",
- "access_secret": "path1",
- },
- },
- "path/2": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "path",
- },
- },
- "data": map[string]interface{}{
- "access_key": "path2",
- "access_secret": "path2",
- },
- },
- "default": map[string]interface{}{
- "data": map[string]interface{}{
- "empty": "true",
- },
- "metadata": map[string]interface{}{
- "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
- },
- },
- "path/": map[string]interface{}{
- "data": map[string]interface{}{
- "empty": "true",
- },
- "metadata": map[string]interface{}{
- "keys": []interface{}{"1", "2"},
- },
- },
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vLogical util.Logical
- ns string
- data esv1beta1.ExternalSecretFind
- }
- type want struct {
- err error
- val map[string][]byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "FindByName": {
- reason: "should map multiple secrets matching name",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Name: &esv1beta1.FindName{
- RegExp: "secret.*",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "secret1": secret1Bytes,
- "secret2": secret2Bytes,
- },
- },
- },
- "FindByTag": {
- reason: "should map multiple secrets matching tags",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Tags: map[string]string{
- "foo": "baz",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "tag": tagBytes,
- "secret2": secret2Bytes,
- },
- },
- },
- "FilterByPath": {
- reason: "should filter secrets based on path",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Path: &path,
- Tags: map[string]string{
- "foo": "path",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "path/1": path1Bytes,
- "path/2": path2Bytes,
- },
- },
- },
- "FailIfKv1": {
- reason: "should not work if using kv1 store",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Tags: map[string]string{
- "foo": "baz",
- },
- },
- },
- want: want{
- err: errors.New(errUnsupportedKvVersion),
- },
- },
- "MetadataNotFound": {
- reason: "metadata secret not found",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
- return nil, nil
- },
- },
- data: esv1beta1.ExternalSecretFind{
- Tags: map[string]string{
- "foo": "baz",
- },
- },
- },
- want: want{
- err: errors.New(errNotFound),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- kube: tc.args.kube,
- logical: tc.args.vLogical,
- store: tc.args.store,
- namespace: tc.args.ns,
- }
- val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(tc.want.val, val); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestGetSecretPath(t *testing.T) {
- storeV2 := makeValidSecretStore()
- storeV2NoPath := storeV2.DeepCopy()
- multiPath := "secret/path"
- storeV2.Spec.Provider.Vault.Path = &multiPath
- storeV2NoPath.Spec.Provider.Vault.Path = nil
- storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
- storeV1NoPath := storeV1.DeepCopy()
- storeV1.Spec.Provider.Vault.Path = &multiPath
- storeV1NoPath.Spec.Provider.Vault.Path = nil
- type args struct {
- store *esv1beta1.VaultProvider
- path string
- expected string
- }
- cases := map[string]struct {
- reason string
- args args
- }{
- "PathWithoutFormatV2": {
- reason: "path should compose with mount point if set",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "secret/path/data/test",
- expected: "secret/path/data/test",
- },
- },
- "PathWithoutFormatV2_NoData": {
- reason: "path should compose with mount point if set without data",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "secret/path/test",
- expected: "secret/path/data/test",
- },
- },
- "PathWithoutFormatV2_NoPath": {
- reason: "if no mountpoint and no data available, needs to be set in second element",
- args: args{
- store: storeV2NoPath.Spec.Provider.Vault,
- path: "secret/test/big/path",
- expected: "secret/data/test/big/path",
- },
- },
- "PathWithoutFormatV2_NoPathWithData": {
- reason: "if data is available, should respect order",
- args: args{
- store: storeV2NoPath.Spec.Provider.Vault,
- path: "secret/test/data/not/the/first/and/data/twice",
- expected: "secret/test/data/not/the/first/and/data/twice",
- },
- },
- "PathWithoutFormatV1": {
- reason: "v1 mountpoint should be added but not enforce 'data'",
- args: args{
- store: storeV1.Spec.Provider.Vault,
- path: "secret/path/test",
- expected: "secret/path/test",
- },
- },
- "PathWithoutFormatV1_NoPath": {
- reason: "Should not append any path information if v1 with no mountpoint",
- args: args{
- store: storeV1NoPath.Spec.Provider.Vault,
- path: "secret/test",
- expected: "secret/test",
- },
- },
- "WithoutPathButMountpointV2": {
- reason: "Mountpoint needs to be set in addition to data",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "test",
- expected: "secret/path/data/test",
- },
- },
- "WithoutPathButMountpointV1": {
- reason: "Mountpoint needs to be set in addition to data",
- args: args{
- store: storeV1.Spec.Provider.Vault,
- path: "test",
- expected: "secret/path/test",
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- store: tc.args.store,
- }
- want := vStore.buildPath(tc.args.path)
- if diff := cmp.Diff(want, tc.args.expected); diff != "" {
- t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestValidateStore(t *testing.T) {
- type args struct {
- auth esv1beta1.VaultAuth
- }
- tests := []struct {
- name string
- args args
- wantErr bool
- }{
- {
- name: "empty auth",
- args: args{},
- },
- {
- name: "invalid approle with namespace",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleID: "",
- RoleRef: nil,
- },
- },
- },
- wantErr: true,
- },
- {
- name: "valid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleID: "fake-value",
- },
- },
- },
- wantErr: false,
- },
- {
- name: "valid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleRef: &esmeta.SecretKeySelector{
- Name: "fake-value",
- },
- },
- },
- },
- wantErr: false,
- },
- {
- name: "invalid clientcert",
- args: args{
- auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- ClientCert: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid cert secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid jwt secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Jwt: &esv1beta1.VaultJwtAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes sa",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid ldap secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Ldap: &esv1beta1.VaultLdapAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid userpass secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- UserPass: &esv1beta1.VaultUserPassAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid token secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- TokenSecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- c := &Connector{
- NewVaultClient: nil,
- }
- store := &esv1beta1.SecretStore{
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Auth: tt.args.auth,
- },
- },
- },
- }
- if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
- t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
- }
- })
- }
- }
- func TestDeleteSecret(t *testing.T) {
- type args struct {
- store *esv1beta1.VaultProvider
- vLogical util.Logical
- }
- type want struct {
- err error
- }
- tests := map[string]struct {
- reason string
- args args
- ref *testingfake.PushSecretData
- want want
- value []byte
- }{
- "DeleteSecretNoOpKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretNoOpKV2": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretFailIfErrorKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: fmt.Errorf("failed to read"),
- },
- },
- "DeleteSecretFailIfErrorKV2": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: fmt.Errorf("failed to read"),
- },
- },
- "DeleteSecretNotManagedKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "another-secret-tool",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretNotManagedKV2": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "another-secret-tool",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretSuccessKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretSuccessKV2": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretErrorKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
- },
- },
- want: want{
- err: fmt.Errorf("failed to delete"),
- },
- },
- "DeleteSecretErrorKV2": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
- },
- },
- want: want{
- err: fmt.Errorf("failed to delete"),
- },
- },
- "DeleteSecretUpdatePropertyKV1": {
- reason: "Secret should only be updated if Property is set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "foo": "bar",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
- "foo": "bar",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- }}),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretUpdatePropertyKV2": {
- reason: "Secret should only be updated if Property is set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- "foo": "bar",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "bar"}}),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretIfNoOtherPropertiesKV1": {
- reason: "Secret should only be deleted if no other properties are set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "foo": "bar",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretIfNoOtherPropertiesKV2": {
- reason: "Secret should only be deleted if no other properties are set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "bar",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- }
- for name, tc := range tests {
- t.Run(name, func(t *testing.T) {
- ref := testingfake.PushSecretData{RemoteKey: "secret", Property: ""}
- if tc.ref != nil {
- ref = *tc.ref
- }
- client := &client{
- logical: tc.args.vLogical,
- store: tc.args.store,
- }
- err := client.DeleteSecret(context.Background(), ref)
- // Error nil XOR tc.want.err nil
- if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
- t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
- }
- // if errors are the same type but their contents do not match
- if err != nil && tc.want.err != nil {
- if !strings.Contains(err.Error(), tc.want.err.Error()) {
- t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
- }
- }
- })
- }
- }
- func TestPushSecret(t *testing.T) {
- secretKey := "secret-key"
- noPermission := errors.New("no permission")
- type args struct {
- store *esv1beta1.VaultProvider
- vLogical util.Logical
- }
- type want struct {
- err error
- }
- tests := map[string]struct {
- reason string
- args args
- want want
- data *testingfake.PushSecretData
- value []byte
- }{
- "SetSecretKV1": {
- reason: "secret is successfully set, with no existing vault secret",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretKV2": {
- reason: "secret is successfully set, with no existing vault secret",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretWithWriteErrorKV1": {
- reason: "secret cannot be pushed if write fails",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: noPermission,
- },
- },
- "SetSecretWithWriteErrorKV2": {
- reason: "secret cannot be pushed if write fails",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: noPermission,
- },
- },
- "SetSecretEqualsPushSecretV1": {
- reason: "vault secret kv equals secret to push kv",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretEqualsPushSecretV2": {
- reason: "vault secret kv equals secret to push kv",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyKV1": {
- reason: "push secret with property adds the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]string{
- "managed-by": "external-secrets",
- },
- "foo": "fake-value",
- }),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyKV2": {
- reason: "push secret with property adds the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"fake-key": "fake-value", "foo": "fake-value"}}),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretUpdatePropertyKV1": {
- reason: "push secret with property only updates the property",
- value: []byte("new-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "foo": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
- "foo": "new-value",
- "custom_metadata": map[string]string{
- "managed-by": "external-secrets",
- },
- }),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretUpdatePropertyKV2": {
- reason: "push secret with property only updates the property",
- value: []byte("new-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "new-value"}}),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyNoUpdateKV1": {
- reason: "push secret with property only updates the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "foo": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyNoUpdateKV2": {
- reason: "push secret with property only updates the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretErrorReadingSecretKV1": {
- reason: "error occurs if secret cannot be read",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, noPermission),
- },
- },
- "SetSecretErrorReadingSecretKV2": {
- reason: "error occurs if secret cannot be read",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, noPermission),
- },
- },
- "SetSecretNotManagedByESOV1": {
- reason: "a secret not managed by ESO cannot be updated",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value2",
- "custom_metadata": map[string]interface{}{
- "managed-by": "not-external-secrets",
- },
- }, nil),
- },
- },
- want: want{
- err: errors.New("secret not managed by external-secrets"),
- },
- },
- "SetSecretNotManagedByESOV2": {
- reason: "a secret not managed by ESO cannot be updated",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value2",
- "custom_metadata": map[string]interface{}{
- "managed-by": "not-external-secrets",
- },
- },
- }, nil),
- },
- },
- want: want{
- err: errors.New("secret not managed by external-secrets"),
- },
- },
- }
- for name, tc := range tests {
- t.Run(name, func(t *testing.T) {
- data := testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: ""}
- if tc.data != nil {
- data = *tc.data
- }
- client := &client{
- logical: tc.args.vLogical,
- store: tc.args.store,
- }
- val := tc.value
- if val == nil {
- val = []byte(`{"fake-key":"fake-value"}`)
- }
- s := &corev1.Secret{Data: map[string][]byte{secretKey: val}}
- err := client.PushSecret(context.Background(), s, data)
- // Error nil XOR tc.want.err nil
- if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
- t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
- }
- // if errors are the same type but their contents do not match
- if err != nil && tc.want.err != nil {
- if !strings.Contains(err.Error(), tc.want.err.Error()) {
- t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
- }
- }
- })
- }
- }
- // EquateErrors returns true if the supplied errors are of the same type and
- // produce identical strings. This mirrors the error comparison behavior of
- // https://github.com/go-test/deep, which most Crossplane tests targeted before
- // we switched to go-cmp.
- //
- // This differs from cmpopts.EquateErrors, which does not test for error strings
- // and instead returns whether one error 'is' (in the errors.Is sense) the
- // other.
- func EquateErrors() cmp.Option {
- return cmp.Comparer(func(a, b error) bool {
- if a == nil || b == nil {
- return a == nil && b == nil
- }
- av := reflect.ValueOf(a)
- bv := reflect.ValueOf(b)
- if av.Type() != bv.Type() {
- return false
- }
- return a.Error() == b.Error()
- })
- }
|