index.html 102 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../multi-tenancy/">
  7. <link rel="next" href="../threat-model/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
  10. <title>Security Best Practices - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#security-best-practices" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. Security Best Practices
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  85. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item md-tabs__item--active">
  132. <a href="../introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item">
  137. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/gcr/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. Google Container Registry
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/vault/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Vault Dynamic Secret
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/password/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Password
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/fake/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Fake
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/webhook/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Webhook
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/github/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Github
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/uuid/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. UUID
  384. </span>
  385. </a>
  386. </li>
  387. </ul>
  388. </nav>
  389. </li>
  390. <li class="md-nav__item md-nav__item--nested">
  391. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  392. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  393. <span class="md-ellipsis">
  394. Reference Docs
  395. </span>
  396. <span class="md-nav__icon md-icon"></span>
  397. </label>
  398. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  399. <label class="md-nav__title" for="__nav_2_4">
  400. <span class="md-nav__icon md-icon"></span>
  401. Reference Docs
  402. </label>
  403. <ul class="md-nav__list" data-md-scrollfix>
  404. <li class="md-nav__item">
  405. <a href="../../api/spec/" class="md-nav__link">
  406. <span class="md-ellipsis">
  407. API specification
  408. </span>
  409. </a>
  410. </li>
  411. <li class="md-nav__item">
  412. <a href="../../api/controller-options/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. Controller Options
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../api/metrics/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Metrics
  422. </span>
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. </ul>
  429. </nav>
  430. </li>
  431. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  432. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  433. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
  434. <span class="md-ellipsis">
  435. Guides
  436. </span>
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  440. <label class="md-nav__title" for="__nav_3">
  441. <span class="md-nav__icon md-icon"></span>
  442. Guides
  443. </label>
  444. <ul class="md-nav__list" data-md-scrollfix>
  445. <li class="md-nav__item">
  446. <a href="../introduction/" class="md-nav__link">
  447. <span class="md-ellipsis">
  448. Introduction
  449. </span>
  450. </a>
  451. </li>
  452. <li class="md-nav__item md-nav__item--nested">
  453. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  454. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  455. <span class="md-ellipsis">
  456. External Secrets
  457. </span>
  458. <span class="md-nav__icon md-icon"></span>
  459. </label>
  460. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  461. <label class="md-nav__title" for="__nav_3_2">
  462. <span class="md-nav__icon md-icon"></span>
  463. External Secrets
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../all-keys-one-secret/" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. Extract structured data
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../getallsecrets/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Find Secrets by Name or Metadata
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../datafrom-rewrite/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Rewriting Keys
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item md-nav__item--nested">
  488. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  489. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  490. <span class="md-ellipsis">
  491. Advanced Templating
  492. </span>
  493. <span class="md-nav__icon md-icon"></span>
  494. </label>
  495. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  496. <label class="md-nav__title" for="__nav_3_2_4">
  497. <span class="md-nav__icon md-icon"></span>
  498. Advanced Templating
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../templating/" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. v2
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../templating-v1/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. v1
  512. </span>
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../common-k8s-secret-types/" class="md-nav__link">
  520. <span class="md-ellipsis">
  521. Kubernetes Secret Types
  522. </span>
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../ownership-deletion-policy/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Lifecycle: ownership & deletion
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../decoding-strategy/" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Decoding Strategies
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../controller-class/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Controller Classes
  543. </span>
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="../generator/" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. Generators
  553. </span>
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../pushsecrets/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Push Secrets
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  564. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" checked>
  565. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  566. <span class="md-ellipsis">
  567. Operations
  568. </span>
  569. <span class="md-nav__icon md-icon"></span>
  570. </label>
  571. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="true">
  572. <label class="md-nav__title" for="__nav_3_5">
  573. <span class="md-nav__icon md-icon"></span>
  574. Operations
  575. </label>
  576. <ul class="md-nav__list" data-md-scrollfix>
  577. <li class="md-nav__item">
  578. <a href="../multi-tenancy/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Multi Tenancy
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item md-nav__item--active">
  585. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  586. <label class="md-nav__link md-nav__link--active" for="__toc">
  587. <span class="md-ellipsis">
  588. Security Best Practices
  589. </span>
  590. <span class="md-nav__icon md-icon"></span>
  591. </label>
  592. <a href="./" class="md-nav__link md-nav__link--active">
  593. <span class="md-ellipsis">
  594. Security Best Practices
  595. </span>
  596. </a>
  597. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  598. <label class="md-nav__title" for="__toc">
  599. <span class="md-nav__icon md-icon"></span>
  600. Table of contents
  601. </label>
  602. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  603. <li class="md-nav__item">
  604. <a href="#security-functions-and-features" class="md-nav__link">
  605. <span class="md-ellipsis">
  606. Security Functions and Features
  607. </span>
  608. </a>
  609. <nav class="md-nav" aria-label="Security Functions and Features">
  610. <ul class="md-nav__list">
  611. <li class="md-nav__item">
  612. <a href="#1-namespace-isolation" class="md-nav__link">
  613. <span class="md-ellipsis">
  614. 1. Namespace Isolation
  615. </span>
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="#2-configure-clustersecretstore-match-conditions" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. 2. Configure ClusterSecretStore match conditions
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="#3-selectively-disable-reconciliation-of-cluster-wide-resources" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. 3. Selectively Disable Reconciliation of Cluster-Wide Resources
  629. </span>
  630. </a>
  631. </li>
  632. <li class="md-nav__item">
  633. <a href="#4-implement-namespace-scoped-installation" class="md-nav__link">
  634. <span class="md-ellipsis">
  635. 4. Implement Namespace-Scoped Installation
  636. </span>
  637. </a>
  638. </li>
  639. <li class="md-nav__item">
  640. <a href="#5-restrict-webhook-tls-ciphers" class="md-nav__link">
  641. <span class="md-ellipsis">
  642. 5. Restrict Webhook TLS Ciphers
  643. </span>
  644. </a>
  645. </li>
  646. </ul>
  647. </nav>
  648. </li>
  649. <li class="md-nav__item">
  650. <a href="#pod-security" class="md-nav__link">
  651. <span class="md-ellipsis">
  652. Pod Security
  653. </span>
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="#role-based-access-control-rbac" class="md-nav__link">
  658. <span class="md-ellipsis">
  659. Role-Based Access Control (RBAC)
  660. </span>
  661. </a>
  662. </li>
  663. <li class="md-nav__item">
  664. <a href="#network-traffic-and-security" class="md-nav__link">
  665. <span class="md-ellipsis">
  666. Network Traffic and Security
  667. </span>
  668. </a>
  669. <nav class="md-nav" aria-label="Network Traffic and Security">
  670. <ul class="md-nav__list">
  671. <li class="md-nav__item">
  672. <a href="#outbound-traffic-restrictions" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. Outbound Traffic Restrictions
  675. </span>
  676. </a>
  677. <nav class="md-nav" aria-label="Outbound Traffic Restrictions">
  678. <ul class="md-nav__list">
  679. <li class="md-nav__item">
  680. <a href="#core-controller" class="md-nav__link">
  681. <span class="md-ellipsis">
  682. Core Controller
  683. </span>
  684. </a>
  685. </li>
  686. <li class="md-nav__item">
  687. <a href="#webhook" class="md-nav__link">
  688. <span class="md-ellipsis">
  689. Webhook
  690. </span>
  691. </a>
  692. </li>
  693. <li class="md-nav__item">
  694. <a href="#cert-controller" class="md-nav__link">
  695. <span class="md-ellipsis">
  696. Cert Controller
  697. </span>
  698. </a>
  699. </li>
  700. </ul>
  701. </nav>
  702. </li>
  703. <li class="md-nav__item">
  704. <a href="#inbound-traffic-restrictions" class="md-nav__link">
  705. <span class="md-ellipsis">
  706. Inbound Traffic Restrictions
  707. </span>
  708. </a>
  709. <nav class="md-nav" aria-label="Inbound Traffic Restrictions">
  710. <ul class="md-nav__list">
  711. <li class="md-nav__item">
  712. <a href="#core-controller_1" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. Core Controller
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="#cert-controller_1" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. Cert Controller
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#webhook_1" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. Webhook
  729. </span>
  730. </a>
  731. </li>
  732. </ul>
  733. </nav>
  734. </li>
  735. </ul>
  736. </nav>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="#policy-engine-best-practices" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Policy Engine Best Practices
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#regular-patches" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Regular Patches
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="#verify-artefacts" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Verify Artefacts
  756. </span>
  757. </a>
  758. <nav class="md-nav" aria-label="Verify Artefacts">
  759. <ul class="md-nav__list">
  760. <li class="md-nav__item">
  761. <a href="#verify-container-images" class="md-nav__link">
  762. <span class="md-ellipsis">
  763. Verify Container Images
  764. </span>
  765. </a>
  766. </li>
  767. <li class="md-nav__item">
  768. <a href="#verifying-provenance" class="md-nav__link">
  769. <span class="md-ellipsis">
  770. Verifying Provenance
  771. </span>
  772. </a>
  773. </li>
  774. <li class="md-nav__item">
  775. <a href="#fetching-sbom" class="md-nav__link">
  776. <span class="md-ellipsis">
  777. Fetching SBOM
  778. </span>
  779. </a>
  780. </li>
  781. </ul>
  782. </nav>
  783. </li>
  784. </ul>
  785. </nav>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="../threat-model/" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. Threat Model
  791. </span>
  792. </a>
  793. </li>
  794. <li class="md-nav__item">
  795. <a href="../v1beta1/" class="md-nav__link">
  796. <span class="md-ellipsis">
  797. Upgrading to v1beta1
  798. </span>
  799. </a>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../using-latest-image/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Using Latest Image
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../disable-cluster-features/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Disable Cluster Features
  812. </span>
  813. </a>
  814. </li>
  815. </ul>
  816. </nav>
  817. </li>
  818. </ul>
  819. </nav>
  820. </li>
  821. <li class="md-nav__item md-nav__item--nested">
  822. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  823. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  824. <span class="md-ellipsis">
  825. Provider
  826. </span>
  827. <span class="md-nav__icon md-icon"></span>
  828. </label>
  829. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  830. <label class="md-nav__title" for="__nav_4">
  831. <span class="md-nav__icon md-icon"></span>
  832. Provider
  833. </label>
  834. <ul class="md-nav__list" data-md-scrollfix>
  835. <li class="md-nav__item">
  836. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. AWS Secrets Manager
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. AWS Parameter Store
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. Azure Key Vault
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../../provider/beyondtrust/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. BeyondTrust
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. Bitwarden Secrets Manager
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../../provider/chef/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Chef
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../../provider/conjur/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. CyberArk Conjur
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../../provider/device42/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Device42
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Google Cloud Secret Manager
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. HashiCorp Vault
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../../provider/kubernetes/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. Kubernetes
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. IBM Secrets Manager
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../../provider/akeyless/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. Akeyless
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Yandex Certificate Manager
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. Yandex Lockbox
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../../provider/alibaba/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. Alibaba Cloud
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. GitLab Variables
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../../provider/oracle-vault/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. Oracle Vault
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../../provider/1password-automation/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. 1Password Secrets Automation
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../../provider/webhook/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. Webhook
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../../provider/fake/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Fake
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. senhasegura DevOps Secrets Management (DSM)
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../../provider/doppler/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Doppler
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../provider/keeper-security/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Keeper Security
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../provider/cloak/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Cloak End 2 End Encrypted Secrets
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../provider/scaleway/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Scaleway
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../provider/delinea/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Delinea
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../provider/secretserver/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Secret Server
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../provider/passbolt/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Passbolt
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../../provider/pulumi/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Pulumi ESC
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../../provider/onboardbase/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Onboardbase
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="../../provider-passworddepot/" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Password Depot
  1056. </span>
  1057. </a>
  1058. </li>
  1059. <li class="md-nav__item">
  1060. <a href="../../provider/fortanix/" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Fortanix
  1063. </span>
  1064. </a>
  1065. </li>
  1066. <li class="md-nav__item">
  1067. <a href="../../provider/infisical/" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. Infisical
  1070. </span>
  1071. </a>
  1072. </li>
  1073. <li class="md-nav__item">
  1074. <a href="../../provider/previder/" class="md-nav__link">
  1075. <span class="md-ellipsis">
  1076. Previder
  1077. </span>
  1078. </a>
  1079. </li>
  1080. </ul>
  1081. </nav>
  1082. </li>
  1083. <li class="md-nav__item md-nav__item--nested">
  1084. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1085. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1086. <span class="md-ellipsis">
  1087. Examples
  1088. </span>
  1089. <span class="md-nav__icon md-icon"></span>
  1090. </label>
  1091. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1092. <label class="md-nav__title" for="__nav_5">
  1093. <span class="md-nav__icon md-icon"></span>
  1094. Examples
  1095. </label>
  1096. <ul class="md-nav__list" data-md-scrollfix>
  1097. <li class="md-nav__item">
  1098. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1099. <span class="md-ellipsis">
  1100. FluxCD
  1101. </span>
  1102. </a>
  1103. </li>
  1104. <li class="md-nav__item">
  1105. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1106. <span class="md-ellipsis">
  1107. Anchore Engine
  1108. </span>
  1109. </a>
  1110. </li>
  1111. <li class="md-nav__item">
  1112. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1113. <span class="md-ellipsis">
  1114. Jenkins
  1115. </span>
  1116. </a>
  1117. </li>
  1118. <li class="md-nav__item">
  1119. <a href="../../examples/bitwarden/" class="md-nav__link">
  1120. <span class="md-ellipsis">
  1121. BitWarden
  1122. </span>
  1123. </a>
  1124. </li>
  1125. </ul>
  1126. </nav>
  1127. </li>
  1128. <li class="md-nav__item md-nav__item--nested">
  1129. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1130. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1131. <span class="md-ellipsis">
  1132. Community
  1133. </span>
  1134. <span class="md-nav__icon md-icon"></span>
  1135. </label>
  1136. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1137. <label class="md-nav__title" for="__nav_6">
  1138. <span class="md-nav__icon md-icon"></span>
  1139. Community
  1140. </label>
  1141. <ul class="md-nav__list" data-md-scrollfix>
  1142. <li class="md-nav__item md-nav__item--nested">
  1143. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1144. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1145. <span class="md-ellipsis">
  1146. Contributing
  1147. </span>
  1148. <span class="md-nav__icon md-icon"></span>
  1149. </label>
  1150. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1151. <label class="md-nav__title" for="__nav_6_1">
  1152. <span class="md-nav__icon md-icon"></span>
  1153. Contributing
  1154. </label>
  1155. <ul class="md-nav__list" data-md-scrollfix>
  1156. <li class="md-nav__item">
  1157. <a href="../../contributing/devguide/" class="md-nav__link">
  1158. <span class="md-ellipsis">
  1159. Developer guide
  1160. </span>
  1161. </a>
  1162. </li>
  1163. <li class="md-nav__item">
  1164. <a href="../../contributing/process/" class="md-nav__link">
  1165. <span class="md-ellipsis">
  1166. Contributing Process
  1167. </span>
  1168. </a>
  1169. </li>
  1170. <li class="md-nav__item">
  1171. <a href="../../contributing/release/" class="md-nav__link">
  1172. <span class="md-ellipsis">
  1173. Release Process
  1174. </span>
  1175. </a>
  1176. </li>
  1177. <li class="md-nav__item">
  1178. <a href="../../contributing/coc/" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Code of Conduct
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="../../contributing/roadmap/" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Roadmap
  1188. </span>
  1189. </a>
  1190. </li>
  1191. </ul>
  1192. </nav>
  1193. </li>
  1194. <li class="md-nav__item md-nav__item--nested">
  1195. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1196. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1197. <span class="md-ellipsis">
  1198. External Resources
  1199. </span>
  1200. <span class="md-nav__icon md-icon"></span>
  1201. </label>
  1202. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1203. <label class="md-nav__title" for="__nav_6_2">
  1204. <span class="md-nav__icon md-icon"></span>
  1205. External Resources
  1206. </label>
  1207. <ul class="md-nav__list" data-md-scrollfix>
  1208. <li class="md-nav__item">
  1209. <a href="../../eso-talks/" class="md-nav__link">
  1210. <span class="md-ellipsis">
  1211. Talks
  1212. </span>
  1213. </a>
  1214. </li>
  1215. <li class="md-nav__item">
  1216. <a href="../../eso-demos/" class="md-nav__link">
  1217. <span class="md-ellipsis">
  1218. Demos
  1219. </span>
  1220. </a>
  1221. </li>
  1222. <li class="md-nav__item">
  1223. <a href="../../eso-blogs/" class="md-nav__link">
  1224. <span class="md-ellipsis">
  1225. Blogs
  1226. </span>
  1227. </a>
  1228. </li>
  1229. <li class="md-nav__item">
  1230. <a href="../../eso-tools/" class="md-nav__link">
  1231. <span class="md-ellipsis">
  1232. Tools
  1233. </span>
  1234. </a>
  1235. </li>
  1236. </ul>
  1237. </nav>
  1238. </li>
  1239. </ul>
  1240. </nav>
  1241. </li>
  1242. </ul>
  1243. </nav>
  1244. </div>
  1245. </div>
  1246. </div>
  1247. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1248. <div class="md-sidebar__scrollwrap">
  1249. <div class="md-sidebar__inner">
  1250. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1251. <label class="md-nav__title" for="__toc">
  1252. <span class="md-nav__icon md-icon"></span>
  1253. Table of contents
  1254. </label>
  1255. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1256. <li class="md-nav__item">
  1257. <a href="#security-functions-and-features" class="md-nav__link">
  1258. <span class="md-ellipsis">
  1259. Security Functions and Features
  1260. </span>
  1261. </a>
  1262. <nav class="md-nav" aria-label="Security Functions and Features">
  1263. <ul class="md-nav__list">
  1264. <li class="md-nav__item">
  1265. <a href="#1-namespace-isolation" class="md-nav__link">
  1266. <span class="md-ellipsis">
  1267. 1. Namespace Isolation
  1268. </span>
  1269. </a>
  1270. </li>
  1271. <li class="md-nav__item">
  1272. <a href="#2-configure-clustersecretstore-match-conditions" class="md-nav__link">
  1273. <span class="md-ellipsis">
  1274. 2. Configure ClusterSecretStore match conditions
  1275. </span>
  1276. </a>
  1277. </li>
  1278. <li class="md-nav__item">
  1279. <a href="#3-selectively-disable-reconciliation-of-cluster-wide-resources" class="md-nav__link">
  1280. <span class="md-ellipsis">
  1281. 3. Selectively Disable Reconciliation of Cluster-Wide Resources
  1282. </span>
  1283. </a>
  1284. </li>
  1285. <li class="md-nav__item">
  1286. <a href="#4-implement-namespace-scoped-installation" class="md-nav__link">
  1287. <span class="md-ellipsis">
  1288. 4. Implement Namespace-Scoped Installation
  1289. </span>
  1290. </a>
  1291. </li>
  1292. <li class="md-nav__item">
  1293. <a href="#5-restrict-webhook-tls-ciphers" class="md-nav__link">
  1294. <span class="md-ellipsis">
  1295. 5. Restrict Webhook TLS Ciphers
  1296. </span>
  1297. </a>
  1298. </li>
  1299. </ul>
  1300. </nav>
  1301. </li>
  1302. <li class="md-nav__item">
  1303. <a href="#pod-security" class="md-nav__link">
  1304. <span class="md-ellipsis">
  1305. Pod Security
  1306. </span>
  1307. </a>
  1308. </li>
  1309. <li class="md-nav__item">
  1310. <a href="#role-based-access-control-rbac" class="md-nav__link">
  1311. <span class="md-ellipsis">
  1312. Role-Based Access Control (RBAC)
  1313. </span>
  1314. </a>
  1315. </li>
  1316. <li class="md-nav__item">
  1317. <a href="#network-traffic-and-security" class="md-nav__link">
  1318. <span class="md-ellipsis">
  1319. Network Traffic and Security
  1320. </span>
  1321. </a>
  1322. <nav class="md-nav" aria-label="Network Traffic and Security">
  1323. <ul class="md-nav__list">
  1324. <li class="md-nav__item">
  1325. <a href="#outbound-traffic-restrictions" class="md-nav__link">
  1326. <span class="md-ellipsis">
  1327. Outbound Traffic Restrictions
  1328. </span>
  1329. </a>
  1330. <nav class="md-nav" aria-label="Outbound Traffic Restrictions">
  1331. <ul class="md-nav__list">
  1332. <li class="md-nav__item">
  1333. <a href="#core-controller" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. Core Controller
  1336. </span>
  1337. </a>
  1338. </li>
  1339. <li class="md-nav__item">
  1340. <a href="#webhook" class="md-nav__link">
  1341. <span class="md-ellipsis">
  1342. Webhook
  1343. </span>
  1344. </a>
  1345. </li>
  1346. <li class="md-nav__item">
  1347. <a href="#cert-controller" class="md-nav__link">
  1348. <span class="md-ellipsis">
  1349. Cert Controller
  1350. </span>
  1351. </a>
  1352. </li>
  1353. </ul>
  1354. </nav>
  1355. </li>
  1356. <li class="md-nav__item">
  1357. <a href="#inbound-traffic-restrictions" class="md-nav__link">
  1358. <span class="md-ellipsis">
  1359. Inbound Traffic Restrictions
  1360. </span>
  1361. </a>
  1362. <nav class="md-nav" aria-label="Inbound Traffic Restrictions">
  1363. <ul class="md-nav__list">
  1364. <li class="md-nav__item">
  1365. <a href="#core-controller_1" class="md-nav__link">
  1366. <span class="md-ellipsis">
  1367. Core Controller
  1368. </span>
  1369. </a>
  1370. </li>
  1371. <li class="md-nav__item">
  1372. <a href="#cert-controller_1" class="md-nav__link">
  1373. <span class="md-ellipsis">
  1374. Cert Controller
  1375. </span>
  1376. </a>
  1377. </li>
  1378. <li class="md-nav__item">
  1379. <a href="#webhook_1" class="md-nav__link">
  1380. <span class="md-ellipsis">
  1381. Webhook
  1382. </span>
  1383. </a>
  1384. </li>
  1385. </ul>
  1386. </nav>
  1387. </li>
  1388. </ul>
  1389. </nav>
  1390. </li>
  1391. <li class="md-nav__item">
  1392. <a href="#policy-engine-best-practices" class="md-nav__link">
  1393. <span class="md-ellipsis">
  1394. Policy Engine Best Practices
  1395. </span>
  1396. </a>
  1397. </li>
  1398. <li class="md-nav__item">
  1399. <a href="#regular-patches" class="md-nav__link">
  1400. <span class="md-ellipsis">
  1401. Regular Patches
  1402. </span>
  1403. </a>
  1404. </li>
  1405. <li class="md-nav__item">
  1406. <a href="#verify-artefacts" class="md-nav__link">
  1407. <span class="md-ellipsis">
  1408. Verify Artefacts
  1409. </span>
  1410. </a>
  1411. <nav class="md-nav" aria-label="Verify Artefacts">
  1412. <ul class="md-nav__list">
  1413. <li class="md-nav__item">
  1414. <a href="#verify-container-images" class="md-nav__link">
  1415. <span class="md-ellipsis">
  1416. Verify Container Images
  1417. </span>
  1418. </a>
  1419. </li>
  1420. <li class="md-nav__item">
  1421. <a href="#verifying-provenance" class="md-nav__link">
  1422. <span class="md-ellipsis">
  1423. Verifying Provenance
  1424. </span>
  1425. </a>
  1426. </li>
  1427. <li class="md-nav__item">
  1428. <a href="#fetching-sbom" class="md-nav__link">
  1429. <span class="md-ellipsis">
  1430. Fetching SBOM
  1431. </span>
  1432. </a>
  1433. </li>
  1434. </ul>
  1435. </nav>
  1436. </li>
  1437. </ul>
  1438. </nav>
  1439. </div>
  1440. </div>
  1441. </div>
  1442. <div class="md-content" data-md-component="content">
  1443. <article class="md-content__inner md-typeset">
  1444. <h1 id="security-best-practices">Security Best Practices</h1>
  1445. <p>The purpose of this document is to outline a set of best practices for securing the External Secrets Operator (ESO). These practices aim to mitigate the risk of successful attacks against ESO and the Kubernetes cluster it integrates with.</p>
  1446. <h2 id="security-functions-and-features">Security Functions and Features</h2>
  1447. <h3 id="1-namespace-isolation">1. Namespace Isolation</h3>
  1448. <p>To maintain security boundaries, ESO ensures that namespaced resources like <code>SecretStore</code> and <code>ExternalSecret</code> are limited to their respective namespaces. The following rules apply:</p>
  1449. <ol>
  1450. <li><code>ExternalSecret</code> resources must not have cross-namespace references of <code>Kind=SecretStore</code> or <code>Kind=Secret</code> resources</li>
  1451. <li><code>SecretStore</code> resources must not have cross-namespace references of <code>Kind=Secret</code> or others</li>
  1452. </ol>
  1453. <p>For cluster-wide resources like <code>ClusterSecretStore</code> and <code>ClusterExternalSecret</code>, exercise caution since they have access to Secret resources across all namespaces. Minimize RBAC permissions for administrators and developers to the necessary minimum. If cluster-wide resources are not required, it is recommended to disable them.</p>
  1454. <h3 id="2-configure-clustersecretstore-match-conditions">2. Configure ClusterSecretStore match conditions</h3>
  1455. <p>Utilize the ClusterSecretStore resource to define specific match conditions using <code>namespaceSelector</code> or an explicit namespaces list. This restricts the usage of the <code>ClusterSecretStore</code> to a predetermined list of namespaces or a namespace that matches a predefined label. Here's an example:</p>
  1456. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1457. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1458. <span class="nt">metadata</span><span class="p">:</span>
  1459. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">fake</span>
  1460. <span class="nt">spec</span><span class="p">:</span>
  1461. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1462. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaceSelector</span><span class="p">:</span>
  1463. <span class="w"> </span><span class="nt">matchLabels</span><span class="p">:</span>
  1464. <span class="w"> </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">frontend</span>
  1465. </code></pre></div>
  1466. <h3 id="3-selectively-disable-reconciliation-of-cluster-wide-resources">3. Selectively Disable Reconciliation of Cluster-Wide Resources</h3>
  1467. <p>ESO allows you to selectively disable the reconciliation of cluster-wide resources such as <code>ClusterSecretStore</code>, <code>ClusterExternalSecret</code>, and <code>PushSecret</code>. You can disable the installation of CRDs in the Helm chart or disable reconciliation in the core-controller using the following options:</p>
  1468. <p>To disable CRD installation:</p>
  1469. <div class="highlight"><pre><span></span><code><span class="c1"># disable cluster-wide resources &amp; push secret</span>
  1470. <span class="nt">crds</span><span class="p">:</span>
  1471. <span class="w"> </span><span class="nt">createClusterExternalSecret</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  1472. <span class="w"> </span><span class="nt">createClusterSecretStore</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  1473. <span class="w"> </span><span class="nt">createPushSecret</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
  1474. </code></pre></div>
  1475. <p>To disable reconciliation in the core-controller:</p>
  1476. <div class="highlight"><pre><span></span><code>--enable-cluster-external-secret-reconciler
  1477. --enable-cluster-store-reconciler
  1478. </code></pre></div>
  1479. <h3 id="4-implement-namespace-scoped-installation">4. Implement Namespace-Scoped Installation</h3>
  1480. <p>To further enhance security, consider installing ESO into a specific namespace with restricted access to only that namespace's resources. This prevents access to cluster-wide secrets. Use the following Helm values to scope the controller to a specific namespace:</p>
  1481. <div class="highlight"><pre><span></span><code><span class="c1"># If set to true, create scoped RBAC roles under the scoped namespace</span>
  1482. <span class="c1"># and implicitly disable cluster stores and cluster external secrets</span>
  1483. <span class="nt">scopedRBAC</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1484. <span class="c1"># Specify the namespace where external secrets should be reconciled</span>
  1485. <span class="nt">scopedNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-namespace</span>
  1486. </code></pre></div>
  1487. <h3 id="5-restrict-webhook-tls-ciphers">5. Restrict Webhook TLS Ciphers</h3>
  1488. <p>Consider installing ESO restricting webhook ciphers. Use the following Helm values to scope webhook for specific TLS ciphers:
  1489. <div class="highlight"><pre><span></span><code><span class="nt">webhook</span><span class="p">:</span>
  1490. <span class="w"> </span><span class="nt">extraArgs</span><span class="p">:</span>
  1491. <span class="w"> </span><span class="nt">tls-ciphers</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256&quot;</span>
  1492. </code></pre></div></p>
  1493. <h2 id="pod-security">Pod Security</h2>
  1494. <p>The Pods of the External Secrets Operator have been configured to meet the <a href="https://kubernetes.io/docs/concepts/security/pod-security-standards/">Pod Security Standards</a>, specifically the restricted profile. This configuration ensures a strong security posture by implementing recommended best practices for hardening Pods, including those outlined in the <a href="https://media.defense.gov/2022/Aug/29/2003066362/-1/-1/0/CTR_KUBERNETES_HARDENING_GUIDANCE_1.2_20220829.PDF">NSA Kubernetes Hardening Guide</a>.</p>
  1495. <p>By adhering to these standards, the External Secrets Operator benefits from a secure and resilient operating environment. The restricted profile has been set as the default configuration since version <code>v0.8.2</code>, and it is recommended to maintain this setting to align with the principle of least privilege.</p>
  1496. <h2 id="role-based-access-control-rbac">Role-Based Access Control (RBAC)</h2>
  1497. <p>The External Secrets Operator operates with elevated privileges within your Kubernetes cluster, allowing it to read and write to all secrets across all namespaces. It is crucial to properly restrict access to ESO resources such as <code>ExternalSecret</code> and <code>SecretStore</code> where necessary. This is particularly important for cluster-scoped resources like <code>ClusterExternalSecret</code> and <code>ClusterSecretStore</code>. Unauthorized tampering with these resources by an attacker could lead to unauthorized access to secrets or potential data exfiltration from your system.</p>
  1498. <p>In most scenarios, the External Secrets Operator is deployed cluster-wide. However, if you prefer to run it on a per-namespace basis, you can scope it to a specific namespace using the <code>scopedRBAC</code> and <code>scopedNamespace</code> options in the helm chart.</p>
  1499. <p>To ensure a secure RBAC configuration, consider the following checklist:</p>
  1500. <ul>
  1501. <li>Restrict access to execute shell commands (pods/exec) within the External Secrets Operator Pod.</li>
  1502. <li>Restrict access to (Cluster)ExternalSecret and (Cluster)SecretStore resources.</li>
  1503. <li>Limit access to aggregated ClusterRoles (view/edit/admin) as needed.</li>
  1504. <li>If necessary, deploy ESO with scoped RBAC or within a specific namespace.</li>
  1505. </ul>
  1506. <p>By carefully managing RBAC permissions and scoping the External Secrets Operator appropriately, you can enhance the security of your Kubernetes cluster.</p>
  1507. <h2 id="network-traffic-and-security">Network Traffic and Security</h2>
  1508. <p>To ensure a secure network environment, it is recommended to restrict network traffic to and from the External Secrets Operator using <code>NetworkPolicies</code> or similar mechanisms. By default, the External Secrets Operator does not include pre-defined Network Policies.</p>
  1509. <p>To implement network restrictions effectively, consider the following steps:</p>
  1510. <ul>
  1511. <li>Define and apply appropriate NetworkPolicies to limit inbound and outbound traffic for the External Secrets Operator.</li>
  1512. <li>Specify a "deny all" policy by default and selectively permit necessary communication based on your specific requirements.</li>
  1513. <li>Restrict access to only the required endpoints and protocols for the External Secrets Operator, such as communication with the Kubernetes API server or external secret providers.</li>
  1514. <li>Regularly review and update the Network Policies to align with changes in your network infrastructure and security requirements.</li>
  1515. </ul>
  1516. <p>It is the responsibility of the user to define and configure Network Policies tailored to their specific environment and security needs. By implementing proper network restrictions, you can enhance the overall security posture of the External Secrets Operator within your Kubernetes cluster.</p>
  1517. <div class="admonition danger">
  1518. <p class="admonition-title">Data Exfiltration Risk</p>
  1519. <p>If not configured properly ESO may be used to exfiltrate data out of your cluster.
  1520. It is advised to create tight NetworkPolicies and use a policy engine such as kyverno to prevent data exfiltration.</p>
  1521. </div>
  1522. <h3 id="outbound-traffic-restrictions">Outbound Traffic Restrictions</h3>
  1523. <h4 id="core-controller">Core Controller</h4>
  1524. <p>Restrict outbound traffic from the core controller component to the following destinations:</p>
  1525. <ul>
  1526. <li><code>kube-apiserver</code>: The Kubernetes API server.</li>
  1527. <li>Secret provider (e.g., AWS, GCP): Whenever possible, use private endpoints to establish secure and private communication.</li>
  1528. </ul>
  1529. <h4 id="webhook">Webhook</h4>
  1530. <ul>
  1531. <li>Restrict outbound traffic from the webhook component to the <code>kube-apiserver</code>.</li>
  1532. </ul>
  1533. <h4 id="cert-controller">Cert Controller</h4>
  1534. <ul>
  1535. <li>Restrict outbound traffic from the cert controller component to the <code>kube-apiserver</code>.</li>
  1536. </ul>
  1537. <h3 id="inbound-traffic-restrictions">Inbound Traffic Restrictions</h3>
  1538. <h4 id="core-controller_1">Core Controller</h4>
  1539. <ul>
  1540. <li>Restrict inbound traffic to the core controller component by allowing communication on port <code>8080</code> from your monitoring agent.</li>
  1541. </ul>
  1542. <h4 id="cert-controller_1">Cert Controller</h4>
  1543. <ul>
  1544. <li>Restrict inbound traffic to the cert controller component by allowing communication on port <code>8080</code> from your monitoring agent.</li>
  1545. <li>Additionally, permit inbound traffic on port <code>8081</code> from the kubelet for health check endpoints (healthz/readyz).</li>
  1546. </ul>
  1547. <h4 id="webhook_1">Webhook</h4>
  1548. <p>Restrict inbound traffic to the webhook component as follows:</p>
  1549. <ul>
  1550. <li>Allow communication on port <code>10250</code> from the kube-apiserver.</li>
  1551. <li>Allow communication on port <code>8080</code> from your monitoring agent.</li>
  1552. <li>Permit inbound traffic on port <code>8081</code> from the kubelet for health check endpoints (healthz/readyz).</li>
  1553. </ul>
  1554. <h2 id="policy-engine-best-practices">Policy Engine Best Practices</h2>
  1555. <p>To enhance the security and enforce specific policies for External Secrets Operator (ESO) resources such as SecretStore and ExternalSecret, it is recommended to utilize a policy engine like <a href="http://kyverno.io/">Kyverno</a> or <a href="https://github.com/open-policy-agent/gatekeeper">OPA Gatekeeper</a>. These policy engines provide a way to define and enforce custom policies that restrict changes made to ESO resources.</p>
  1556. <div class="admonition danger">
  1557. <p class="admonition-title">Data Exfiltration Risk</p>
  1558. <p>ESO could be used to exfiltrate data out of your cluster. You should disable all providers you don't need.
  1559. Further, you should implement <code>NetworkPolicies</code> to restrict network access to known entities (see above), to prevent data exfiltration.</p>
  1560. </div>
  1561. <p>Here are some recommendations to consider when configuring your policies:</p>
  1562. <ol>
  1563. <li><strong>Explicitly Deny Unused Providers</strong>: Create policies that explicitly deny the usage of secret providers that are not required in your environment. This prevents unauthorized access to unnecessary providers and reduces the attack surface.</li>
  1564. <li><strong>Restrict Access to Secrets</strong>: Implement policies that restrict access to secrets based on specific conditions. For example, you can define policies to allow access to secrets only if they have a particular prefix in the <code>.spec.data[].remoteRef.key</code> field. This helps ensure that only authorized entities can access sensitive information.</li>
  1565. <li><strong>Restrict <code>ClusterSecretStore</code> References</strong>: Define policies to restrict the usage of ClusterSecretStore references within ExternalSecret resources. This ensures that the resources are properly scoped and prevent potential unauthorized access to secrets across namespaces.</li>
  1566. </ol>
  1567. <p>By leveraging a policy engine, you can implement these recommendations and enforce custom policies that align with your organization's security requirements. Please refer to the documentation of the chosen policy engine (e.g., Kyverno or OPA Gatekeeper) for detailed instructions on how to define and enforce policies for ESO resources.</p>
  1568. <div class="admonition note">
  1569. <p class="admonition-title">Provider Validation Example Policy</p>
  1570. <p>The following policy validates the usage of the <code>provider</code> field in the SecretStore manifest.</p>
  1571. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kyverno.io/v1</span>
  1572. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterPolicy</span>
  1573. <span class="nt">metadata</span><span class="p">:</span>
  1574. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">require-secretstore-aws-provider</span>
  1575. <span class="nt">spec</span><span class="p">:</span>
  1576. <span class="w"> </span><span class="nt">validationFailureAction</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Enforce</span>
  1577. <span class="w"> </span><span class="nt">rules</span><span class="p">:</span>
  1578. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">require-secretstore-aws-provider</span>
  1579. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1580. <span class="w"> </span><span class="nt">any</span><span class="p">:</span>
  1581. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1582. <span class="w"> </span><span class="nt">kinds</span><span class="p">:</span>
  1583. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1584. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1585. <span class="w"> </span><span class="nt">validate</span><span class="p">:</span>
  1586. <span class="w"> </span><span class="nt">message</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;You</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">only</span><span class="nv"> </span><span class="s">use</span><span class="nv"> </span><span class="s">AWS</span><span class="nv"> </span><span class="s">SecretsManager&quot;</span>
  1587. <span class="w"> </span><span class="nt">pattern</span><span class="p">:</span>
  1588. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1589. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1590. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1591. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1592. </code></pre></div>
  1593. </div>
  1594. <h2 id="regular-patches">Regular Patches</h2>
  1595. <p>To maintain a secure environment, it is crucial to regularly patch and update all software components of External Secrets Operator and the underlying cluster. By doing so, known vulnerabilities can be addressed, and the overall system's security can be improved. Here are some recommended practices for ensuring timely updates:</p>
  1596. <ol>
  1597. <li><strong>Automated Patching and Updating</strong>: Utilize automated patching and updating tools to streamline the process of keeping software components up-to-date</li>
  1598. <li><strong>Regular Update ESO</strong>: Stay informed about the latest updates and releases provided for ESO. The development team regularly releases updates to improve stability, performance, and security. Please refer to the <a href="../../introduction/stability-support/">Stability and Support</a> documentation for more information on the available updates</li>
  1599. <li><strong>Cluster-wide Updates</strong>: Apart from ESO, ensure that all other software components within your cluster, such as the operating system, container runtime, and Kubernetes itself, are regularly patched and updated.</li>
  1600. </ol>
  1601. <p>By adhering to a regular patching and updating schedule, you can proactively mitigate security risks associated with known vulnerabilities and ensure the overall stability and security of your ESO deployment.</p>
  1602. <h2 id="verify-artefacts">Verify Artefacts</h2>
  1603. <h3 id="verify-container-images">Verify Container Images</h3>
  1604. <p>The container images of External Secrets Operator are signed using Cosign and the keyless signing feature. To ensure the authenticity and integrity of the container image, you can follow the steps outlined below:</p>
  1605. <div class="highlight"><pre><span></span><code><span class="c1"># Retrieve Image Signature</span>
  1606. $<span class="w"> </span>crane<span class="w"> </span>digest<span class="w"> </span>ghcr.io/external-secrets/external-secrets:v0.8.1
  1607. sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554
  1608. <span class="c1"># verify signature</span>
  1609. $<span class="w"> </span><span class="nv">COSIGN_EXPERIMENTAL</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>cosign<span class="w"> </span>verify<span class="w"> </span>ghcr.io/external-secrets/external-secrets@sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
  1610. <span class="c1"># ...</span>
  1611. <span class="o">[</span>
  1612. <span class="w"> </span><span class="o">{</span>
  1613. <span class="w"> </span><span class="s2">&quot;critical&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1614. <span class="w"> </span><span class="s2">&quot;identity&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1615. <span class="w"> </span><span class="s2">&quot;docker-reference&quot;</span>:<span class="w"> </span><span class="s2">&quot;ghcr.io/external-secrets/external-secrets&quot;</span>
  1616. <span class="w"> </span><span class="o">}</span>,
  1617. <span class="w"> </span><span class="s2">&quot;image&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1618. <span class="w"> </span><span class="s2">&quot;docker-manifest-digest&quot;</span>:<span class="w"> </span><span class="s2">&quot;sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554&quot;</span>
  1619. <span class="w"> </span><span class="o">}</span>,
  1620. <span class="w"> </span><span class="s2">&quot;type&quot;</span>:<span class="w"> </span><span class="s2">&quot;cosign container image signature&quot;</span>
  1621. <span class="w"> </span><span class="o">}</span>,
  1622. <span class="w"> </span><span class="s2">&quot;optional&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1623. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.1&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://token.actions.githubusercontent.com&quot;</span>,
  1624. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.2&quot;</span>:<span class="w"> </span><span class="s2">&quot;workflow_dispatch&quot;</span>,
  1625. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.3&quot;</span>:<span class="w"> </span><span class="s2">&quot;a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad&quot;</span>,
  1626. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.4&quot;</span>:<span class="w"> </span><span class="s2">&quot;Create Release&quot;</span>,
  1627. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.5&quot;</span>:<span class="w"> </span><span class="s2">&quot;external-secrets/external-secrets&quot;</span>,
  1628. <span class="w"> </span><span class="s2">&quot;1.3.6.1.4.1.57264.1.6&quot;</span>:<span class="w"> </span><span class="s2">&quot;refs/heads/main&quot;</span>,
  1629. <span class="w"> </span><span class="s2">&quot;Bundle&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1630. <span class="w"> </span><span class="c1"># ...</span>
  1631. <span class="w"> </span><span class="o">}</span>,
  1632. <span class="w"> </span><span class="s2">&quot;GITHUB_ACTOR&quot;</span>:<span class="w"> </span><span class="s2">&quot;gusfcarvalho&quot;</span>,
  1633. <span class="w"> </span><span class="s2">&quot;Issuer&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://token.actions.githubusercontent.com&quot;</span>,
  1634. <span class="w"> </span><span class="s2">&quot;Subject&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://github.com/external-secrets/external-secrets/.github/workflows/release.yml@refs/heads/main&quot;</span>,
  1635. <span class="w"> </span><span class="s2">&quot;githubWorkflowName&quot;</span>:<span class="w"> </span><span class="s2">&quot;Create Release&quot;</span>,
  1636. <span class="w"> </span><span class="s2">&quot;githubWorkflowRef&quot;</span>:<span class="w"> </span><span class="s2">&quot;refs/heads/main&quot;</span>,
  1637. <span class="w"> </span><span class="s2">&quot;githubWorkflowRepository&quot;</span>:<span class="w"> </span><span class="s2">&quot;external-secrets/external-secrets&quot;</span>,
  1638. <span class="w"> </span><span class="s2">&quot;githubWorkflowSha&quot;</span>:<span class="w"> </span><span class="s2">&quot;a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad&quot;</span>,
  1639. <span class="w"> </span><span class="s2">&quot;githubWorkflowTrigger&quot;</span>:<span class="w"> </span><span class="s2">&quot;workflow_dispatch&quot;</span>
  1640. <span class="w"> </span><span class="o">}</span>
  1641. <span class="w"> </span><span class="o">}</span>
  1642. <span class="o">]</span>
  1643. </code></pre></div>
  1644. <p>In the output of the verification process, pay close attention to the <code>optional.Issuer</code> and <code>optional.Subject</code> fields. These fields contain important information about the image's authenticity. Verify that the values of Issuer and Subject match the expected values for the ESO container image. If they do not match, it indicates that the image is not legitimate and should not be used.</p>
  1645. <p>By following these steps and confirming that the Issuer and Subject fields align with the expected values for the ESO container image, you can ensure that the image has not been tampered with and is safe to use.</p>
  1646. <h3 id="verifying-provenance">Verifying Provenance</h3>
  1647. <p>The External Secrets Operator employs the <a href="https://slsa.dev/provenance/v0.1">SLSA</a> (Supply Chain Levels for Software Artifacts) standard to create and attest to the provenance of its builds. Provenance verification is essential to ensure the integrity and trustworthiness of the software supply chain. This outlines the process of verifying the attested provenance of External Secrets Operator builds using the cosign tool.</p>
  1648. <div class="highlight"><pre><span></span><code>$<span class="w"> </span><span class="nv">COSIGN_EXPERIMENTAL</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>cosign<span class="w"> </span>verify-attestation<span class="w"> </span>--type<span class="w"> </span>slsaprovenance<span class="w"> </span>ghcr.io/external-secrets/external-secrets:v0.8.1<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>.payload<span class="w"> </span>-r<span class="w"> </span><span class="p">|</span><span class="w"> </span>base64<span class="w"> </span>--decode<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
  1649. Verification<span class="w"> </span><span class="k">for</span><span class="w"> </span>ghcr.io/external-secrets/external-secrets:v0.8.1<span class="w"> </span>--
  1650. The<span class="w"> </span>following<span class="w"> </span>checks<span class="w"> </span>were<span class="w"> </span>performed<span class="w"> </span>on<span class="w"> </span>each<span class="w"> </span>of<span class="w"> </span>these<span class="w"> </span>signatures:
  1651. <span class="w"> </span>-<span class="w"> </span>The<span class="w"> </span>cosign<span class="w"> </span>claims<span class="w"> </span>were<span class="w"> </span>validated
  1652. <span class="w"> </span>-<span class="w"> </span>Existence<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>claims<span class="w"> </span><span class="k">in</span><span class="w"> </span>the<span class="w"> </span>transparency<span class="w"> </span>log<span class="w"> </span>was<span class="w"> </span>verified<span class="w"> </span>offline
  1653. <span class="w"> </span>-<span class="w"> </span>Any<span class="w"> </span>certificates<span class="w"> </span>were<span class="w"> </span>verified<span class="w"> </span>against<span class="w"> </span>the<span class="w"> </span>Fulcio<span class="w"> </span>roots.
  1654. Certificate<span class="w"> </span>subject:<span class="w"> </span>https://github.com/external-secrets/external-secrets/.github/workflows/release.yml@refs/heads/main
  1655. Certificate<span class="w"> </span>issuer<span class="w"> </span>URL:<span class="w"> </span>https://token.actions.githubusercontent.com
  1656. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Trigger:<span class="w"> </span>workflow_dispatch
  1657. GitHub<span class="w"> </span>Workflow<span class="w"> </span>SHA:<span class="w"> </span>a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad
  1658. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Name:<span class="w"> </span>Create<span class="w"> </span>Release
  1659. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Trigger<span class="w"> </span>external-secrets/external-secrets
  1660. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Ref:<span class="w"> </span>refs/heads/main
  1661. <span class="o">{</span>
  1662. <span class="w"> </span><span class="s2">&quot;_type&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://in-toto.io/Statement/v0.1&quot;</span>,
  1663. <span class="w"> </span><span class="s2">&quot;predicateType&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://slsa.dev/provenance/v0.2&quot;</span>,
  1664. <span class="w"> </span><span class="s2">&quot;subject&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1665. <span class="w"> </span><span class="o">{</span>
  1666. <span class="w"> </span><span class="s2">&quot;name&quot;</span>:<span class="w"> </span><span class="s2">&quot;ghcr.io/external-secrets/external-secrets&quot;</span>,
  1667. <span class="w"> </span><span class="s2">&quot;digest&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1668. <span class="w"> </span><span class="s2">&quot;sha256&quot;</span>:<span class="w"> </span><span class="s2">&quot;36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554&quot;</span>
  1669. <span class="w"> </span><span class="o">}</span>
  1670. <span class="w"> </span><span class="o">}</span>
  1671. <span class="w"> </span><span class="o">]</span>,
  1672. <span class="w"> </span><span class="s2">&quot;predicate&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1673. <span class="w"> </span><span class="s2">&quot;builder&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1674. <span class="w"> </span><span class="s2">&quot;id&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://github.com/external-secrets/external-secrets/Attestations/GitHubHostedActions@v1&quot;</span>
  1675. <span class="w"> </span><span class="o">}</span>,
  1676. <span class="w"> </span><span class="s2">&quot;buildType&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://github.com/Attestations/GitHubActionsWorkflow@v1&quot;</span>,
  1677. <span class="w"> </span><span class="s2">&quot;invocation&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1678. <span class="w"> </span><span class="s2">&quot;configSource&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1679. <span class="w"> </span><span class="s2">&quot;uri&quot;</span>:<span class="w"> </span><span class="s2">&quot;git+https://github.com/external-secrets/external-secrets&quot;</span>,
  1680. <span class="w"> </span><span class="s2">&quot;digest&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1681. <span class="w"> </span><span class="s2">&quot;sha1&quot;</span>:<span class="w"> </span><span class="s2">&quot;a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad&quot;</span>
  1682. <span class="w"> </span><span class="o">}</span>,
  1683. <span class="w"> </span><span class="s2">&quot;entryPoint&quot;</span>:<span class="w"> </span><span class="s2">&quot;Create Release&quot;</span>
  1684. <span class="w"> </span><span class="o">}</span>,
  1685. <span class="w"> </span><span class="s2">&quot;parameters&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1686. <span class="w"> </span><span class="s2">&quot;version&quot;</span>:<span class="w"> </span><span class="s2">&quot;v0.8.1&quot;</span>
  1687. <span class="w"> </span><span class="o">}</span>
  1688. <span class="w"> </span><span class="o">}</span>,
  1689. <span class="w"> </span><span class="o">[</span>...<span class="o">]</span>
  1690. <span class="w"> </span><span class="o">}</span>
  1691. <span class="o">}</span>
  1692. </code></pre></div>
  1693. <h3 id="fetching-sbom">Fetching SBOM</h3>
  1694. <p>Every External Secrets Operator image is accompanied by an SBOM (Software Bill of Materials) in SPDX JSON format. The SBOM provides detailed information about the software components and dependencies used in the image. This technical documentation explains the process of downloading and verifying the SBOM for a specific version of External Secrets Operator using the Cosign tool.</p>
  1695. <div class="highlight"><pre><span></span><code>$<span class="w"> </span>crane<span class="w"> </span>digest<span class="w"> </span>ghcr.io/external-secrets/external-secrets:v0.8.1
  1696. sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554
  1697. $<span class="w"> </span><span class="nv">COSIGN_EXPERIMENTAL</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>cosign<span class="w"> </span>verify-attestation<span class="w"> </span>--type<span class="w"> </span>spdx<span class="w"> </span>ghcr.io/external-secrets/external-secrets@sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span><span class="s1">&#39;.payload |= @base64d | .payload | fromjson&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span><span class="s1">&#39;.predicate.Data | fromjson&#39;</span>
  1698. <span class="o">[</span>...<span class="o">]</span>
  1699. <span class="o">{</span>
  1700. <span class="w"> </span><span class="s2">&quot;SPDXID&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDXRef-DOCUMENT&quot;</span>,
  1701. <span class="w"> </span><span class="s2">&quot;name&quot;</span>:<span class="w"> </span><span class="s2">&quot;ghcr.io/external-secrets/external-secrets@sha256-36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554&quot;</span>,
  1702. <span class="w"> </span><span class="s2">&quot;spdxVersion&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDX-2.2&quot;</span>,
  1703. <span class="w"> </span><span class="s2">&quot;creationInfo&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1704. <span class="w"> </span><span class="s2">&quot;created&quot;</span>:<span class="w"> </span><span class="s2">&quot;2023-03-17T23:17:01.568002344Z&quot;</span>,
  1705. <span class="w"> </span><span class="s2">&quot;creators&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1706. <span class="w"> </span><span class="s2">&quot;Organization: Anchore, Inc&quot;</span>,
  1707. <span class="w"> </span><span class="s2">&quot;Tool: syft-0.40.1&quot;</span>
  1708. <span class="w"> </span><span class="o">]</span>,
  1709. <span class="w"> </span><span class="s2">&quot;licenseListVersion&quot;</span>:<span class="w"> </span><span class="s2">&quot;3.16&quot;</span>
  1710. <span class="w"> </span><span class="o">}</span>,
  1711. <span class="w"> </span><span class="s2">&quot;dataLicense&quot;</span>:<span class="w"> </span><span class="s2">&quot;CC0-1.0&quot;</span>,
  1712. <span class="w"> </span><span class="s2">&quot;documentNamespace&quot;</span>:<span class="w"> </span><span class="s2">&quot;https://anchore.com/syft/image/ghcr.io/external-secrets/external-secrets@sha256-36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554-83484ebb-b469-45fa-8fcc-9290c4ea4f6f&quot;</span>,
  1713. <span class="w"> </span><span class="s2">&quot;packages&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1714. <span class="w"> </span><span class="o">[</span>...<span class="o">]</span>
  1715. <span class="w"> </span><span class="o">{</span>
  1716. <span class="w"> </span><span class="s2">&quot;SPDXID&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDXRef-c809070b0beb099e&quot;</span>,
  1717. <span class="w"> </span><span class="s2">&quot;name&quot;</span>:<span class="w"> </span><span class="s2">&quot;tzdata&quot;</span>,
  1718. <span class="w"> </span><span class="s2">&quot;licenseConcluded&quot;</span>:<span class="w"> </span><span class="s2">&quot;NONE&quot;</span>,
  1719. <span class="w"> </span><span class="s2">&quot;downloadLocation&quot;</span>:<span class="w"> </span><span class="s2">&quot;NOASSERTION&quot;</span>,
  1720. <span class="w"> </span><span class="s2">&quot;externalRefs&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1721. <span class="w"> </span><span class="o">{</span>
  1722. <span class="w"> </span><span class="s2">&quot;referenceCategory&quot;</span>:<span class="w"> </span><span class="s2">&quot;SECURITY&quot;</span>,
  1723. <span class="w"> </span><span class="s2">&quot;referenceLocator&quot;</span>:<span class="w"> </span><span class="s2">&quot;cpe:2.3:a:tzdata:tzdata:2021a-1\\+deb11u8:*:*:*:*:*:*:*&quot;</span>,
  1724. <span class="w"> </span><span class="s2">&quot;referenceType&quot;</span>:<span class="w"> </span><span class="s2">&quot;cpe23Type&quot;</span>
  1725. <span class="w"> </span><span class="o">}</span>,
  1726. <span class="w"> </span><span class="o">{</span>
  1727. <span class="w"> </span><span class="s2">&quot;referenceCategory&quot;</span>:<span class="w"> </span><span class="s2">&quot;PACKAGE_MANAGER&quot;</span>,
  1728. <span class="w"> </span><span class="s2">&quot;referenceLocator&quot;</span>:<span class="w"> </span><span class="s2">&quot;pkg:deb/debian/tzdata@2021a-1+deb11u8?arch=all&amp;distro=debian-11&quot;</span>,
  1729. <span class="w"> </span><span class="s2">&quot;referenceType&quot;</span>:<span class="w"> </span><span class="s2">&quot;purl&quot;</span>
  1730. <span class="w"> </span><span class="o">}</span>
  1731. <span class="w"> </span><span class="o">]</span>,
  1732. <span class="w"> </span><span class="s2">&quot;filesAnalyzed&quot;</span>:<span class="w"> </span>false,
  1733. <span class="w"> </span><span class="s2">&quot;licenseDeclared&quot;</span>:<span class="w"> </span><span class="s2">&quot;NONE&quot;</span>,
  1734. <span class="w"> </span><span class="s2">&quot;originator&quot;</span>:<span class="w"> </span><span class="s2">&quot;Person: GNU Libc Maintainers &lt;debian-glibc@lists.debian.org&gt;&quot;</span>,
  1735. <span class="w"> </span><span class="s2">&quot;sourceInfo&quot;</span>:<span class="w"> </span><span class="s2">&quot;acquired package info from DPKG DB: /var/lib/dpkg/status.d/tzdata, /usr/share/doc/tzdata/copyright&quot;</span>,
  1736. <span class="w"> </span><span class="s2">&quot;versionInfo&quot;</span>:<span class="w"> </span><span class="s2">&quot;2021a-1+deb11u8&quot;</span>
  1737. <span class="w"> </span><span class="o">}</span>
  1738. <span class="w"> </span><span class="o">]</span>
  1739. <span class="o">}</span>
  1740. </code></pre></div>
  1741. </article>
  1742. </div>
  1743. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1744. </div>
  1745. </main>
  1746. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1747. <footer class="md-footer">
  1748. <div class="md-footer-meta md-typeset">
  1749. <div class="md-footer-meta__inner md-grid">
  1750. <div class="md-copyright">
  1751. <div class="md-copyright__highlight">
  1752. &copy; 2024 The external-secrets Authors.<br/>
  1753. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1754. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1755. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1756. </div>
  1757. Made with
  1758. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1759. Material for MkDocs
  1760. </a>
  1761. </div>
  1762. </div>
  1763. </div>
  1764. </footer>
  1765. </div>
  1766. <div class="md-dialog" data-md-component="dialog">
  1767. <div class="md-dialog__inner md-typeset"></div>
  1768. </div>
  1769. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1770. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1771. </body>
  1772. </html>