index.html 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869
  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="../../assets/images/favicon.png">
  9. <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.9">
  10. <title>Security Best Practices - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.85bb2934.min.css">
  12. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  13. <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">
  14. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  15. <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>
  16. <script id="__analytics">function __md_analytics(){function n(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],n("js",new Date),n("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&n("event","search",{search_term:this.value})}),document$.subscribe(function(){var a=document.forms.feedback;if(void 0!==a)for(var e of a.querySelectorAll("[type=submit]"))e.addEventListener("click",function(e){e.preventDefault();var t=document.location.pathname,e=this.getAttribute("data-md-value");n("event","feedback",{page:t,data:e}),a.firstElementChild.disabled=!0;e=a.querySelector(".md-feedback__note [data-md-value='"+e+"']");e&&(e.hidden=!1)}),a.hidden=!1}),location$.subscribe(function(e){n("config","G-QP38TD8K7V",{page_path:e.pathname})})});var e=document.createElement("script");e.async=!0,e.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",e)}</script>
  17. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  18. </head>
  19. <body dir="ltr">
  20. <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
  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. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  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 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></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. <label class="md-header__button md-icon" for="__search">
  65. <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.516 6.516 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 5Z"/></svg>
  66. </label>
  67. <div class="md-search" data-md-component="search" role="dialog">
  68. <label class="md-search__overlay" for="__search"></label>
  69. <div class="md-search__inner" role="search">
  70. <form class="md-search__form" name="search">
  71. <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>
  72. <label class="md-search__icon md-icon" for="__search">
  73. <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.516 6.516 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 5Z"/></svg>
  74. <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 11h12Z"/></svg>
  75. </label>
  76. <nav class="md-search__options" aria-label="Search">
  77. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  78. <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 12 19 6.41Z"/></svg>
  79. </button>
  80. </nav>
  81. </form>
  82. <div class="md-search__output">
  83. <div class="md-search__scrollwrap" data-md-scrollfix>
  84. <div class="md-search-result" data-md-component="search-result">
  85. <div class="md-search-result__meta">
  86. Initializing search
  87. </div>
  88. <ol class="md-search-result__list" role="presentation"></ol>
  89. </div>
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <div class="md-header__source">
  95. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  96. <div class="md-source__icon md-icon">
  97. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.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 2023 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.81z"/></svg>
  98. </div>
  99. <div class="md-source__repository">
  100. External Secrets Operator
  101. </div>
  102. </a>
  103. </div>
  104. </nav>
  105. </header>
  106. <div class="md-container" data-md-component="container">
  107. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  108. <div class="md-grid">
  109. <ul class="md-tabs__list">
  110. <li class="md-tabs__item">
  111. <a href="../.." class="md-tabs__link">
  112. Introduction
  113. </a>
  114. </li>
  115. <li class="md-tabs__item">
  116. <a href="../../api/components/" class="md-tabs__link">
  117. API
  118. </a>
  119. </li>
  120. <li class="md-tabs__item">
  121. <a href="../introduction/" class="md-tabs__link md-tabs__link--active">
  122. Guides
  123. </a>
  124. </li>
  125. <li class="md-tabs__item">
  126. <a href="../../provider/aws-secrets-manager/" class="md-tabs__link">
  127. Provider
  128. </a>
  129. </li>
  130. <li class="md-tabs__item">
  131. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  132. Examples
  133. </a>
  134. </li>
  135. <li class="md-tabs__item">
  136. <a href="../../contributing/devguide/" class="md-tabs__link">
  137. Community
  138. </a>
  139. </li>
  140. </ul>
  141. </div>
  142. </nav>
  143. <main class="md-main" data-md-component="main">
  144. <div class="md-main__inner md-grid">
  145. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  146. <div class="md-sidebar__scrollwrap">
  147. <div class="md-sidebar__inner">
  148. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  149. <label class="md-nav__title" for="__drawer">
  150. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  151. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
  152. </a>
  153. External Secrets Operator
  154. </label>
  155. <div class="md-nav__source">
  156. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  157. <div class="md-source__icon md-icon">
  158. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.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 2023 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.81z"/></svg>
  159. </div>
  160. <div class="md-source__repository">
  161. External Secrets Operator
  162. </div>
  163. </a>
  164. </div>
  165. <ul class="md-nav__list" data-md-scrollfix>
  166. <li class="md-nav__item md-nav__item--nested">
  167. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  168. <div class="md-nav__link md-nav__link--index ">
  169. <a href="../..">Introduction</a>
  170. <label for="__nav_1">
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. </div>
  174. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  175. <label class="md-nav__title" for="__nav_1">
  176. <span class="md-nav__icon md-icon"></span>
  177. Introduction
  178. </label>
  179. <ul class="md-nav__list" data-md-scrollfix>
  180. <li class="md-nav__item">
  181. <a href="../../introduction/overview/" class="md-nav__link">
  182. Overview
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="../../introduction/getting-started/" class="md-nav__link">
  187. Getting started
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../../introduction/faq/" class="md-nav__link">
  192. FAQ
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/stability-support/" class="md-nav__link">
  197. Stability and Support
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  202. Deprecation Policy
  203. </a>
  204. </li>
  205. </ul>
  206. </nav>
  207. </li>
  208. <li class="md-nav__item md-nav__item--nested">
  209. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  210. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  211. API
  212. <span class="md-nav__icon md-icon"></span>
  213. </label>
  214. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  215. <label class="md-nav__title" for="__nav_2">
  216. <span class="md-nav__icon md-icon"></span>
  217. API
  218. </label>
  219. <ul class="md-nav__list" data-md-scrollfix>
  220. <li class="md-nav__item">
  221. <a href="../../api/components/" class="md-nav__link">
  222. Components
  223. </a>
  224. </li>
  225. <li class="md-nav__item md-nav__item--nested">
  226. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  227. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  228. Core Resources
  229. <span class="md-nav__icon md-icon"></span>
  230. </label>
  231. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  232. <label class="md-nav__title" for="__nav_2_2">
  233. <span class="md-nav__icon md-icon"></span>
  234. Core Resources
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="../../api/externalsecret/" class="md-nav__link">
  239. ExternalSecret
  240. </a>
  241. </li>
  242. <li class="md-nav__item">
  243. <a href="../../api/secretstore/" class="md-nav__link">
  244. SecretStore
  245. </a>
  246. </li>
  247. <li class="md-nav__item">
  248. <a href="../../api/clustersecretstore/" class="md-nav__link">
  249. ClusterSecretStore
  250. </a>
  251. </li>
  252. <li class="md-nav__item">
  253. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  254. ClusterExternalSecret
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../../api/pushsecret/" class="md-nav__link">
  259. PushSecret
  260. </a>
  261. </li>
  262. </ul>
  263. </nav>
  264. </li>
  265. <li class="md-nav__item md-nav__item--nested">
  266. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  267. <div class="md-nav__link md-nav__link--index ">
  268. <a href="../../api/generator/">Generators</a>
  269. <label for="__nav_2_3">
  270. <span class="md-nav__icon md-icon"></span>
  271. </label>
  272. </div>
  273. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  274. <label class="md-nav__title" for="__nav_2_3">
  275. <span class="md-nav__icon md-icon"></span>
  276. Generators
  277. </label>
  278. <ul class="md-nav__list" data-md-scrollfix>
  279. <li class="md-nav__item">
  280. <a href="../../api/generator/acr/" class="md-nav__link">
  281. Azure Container Registry
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="../../api/generator/ecr/" class="md-nav__link">
  286. AWS Elastic Container Registry
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/generator/gcr/" class="md-nav__link">
  291. Google Container Registry
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="../../api/generator/vault/" class="md-nav__link">
  296. Vault Dynamic Secret
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../../api/generator/password/" class="md-nav__link">
  301. Password
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="../../api/generator/fake/" class="md-nav__link">
  306. Fake
  307. </a>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--nested">
  313. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  314. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  315. Reference Docs
  316. <span class="md-nav__icon md-icon"></span>
  317. </label>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_4">
  320. <span class="md-nav__icon md-icon"></span>
  321. Reference Docs
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/spec/" class="md-nav__link">
  326. API specification
  327. </a>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="../../api/controller-options/" class="md-nav__link">
  331. Controller Options
  332. </a>
  333. </li>
  334. <li class="md-nav__item">
  335. <a href="../../api/metrics/" class="md-nav__link">
  336. Metrics
  337. </a>
  338. </li>
  339. </ul>
  340. </nav>
  341. </li>
  342. </ul>
  343. </nav>
  344. </li>
  345. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  346. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  347. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  348. Guides
  349. <span class="md-nav__icon md-icon"></span>
  350. </label>
  351. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  352. <label class="md-nav__title" for="__nav_3">
  353. <span class="md-nav__icon md-icon"></span>
  354. Guides
  355. </label>
  356. <ul class="md-nav__list" data-md-scrollfix>
  357. <li class="md-nav__item">
  358. <a href="../introduction/" class="md-nav__link">
  359. Introduction
  360. </a>
  361. </li>
  362. <li class="md-nav__item md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  364. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  365. External Secrets
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  369. <label class="md-nav__title" for="__nav_3_2">
  370. <span class="md-nav__icon md-icon"></span>
  371. External Secrets
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../all-keys-one-secret/" class="md-nav__link">
  376. Extract structured data
  377. </a>
  378. </li>
  379. <li class="md-nav__item">
  380. <a href="../getallsecrets/" class="md-nav__link">
  381. Find Secrets by Name or Metadata
  382. </a>
  383. </li>
  384. <li class="md-nav__item">
  385. <a href="../datafrom-rewrite/" class="md-nav__link">
  386. Rewriting Keys
  387. </a>
  388. </li>
  389. <li class="md-nav__item md-nav__item--nested">
  390. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  391. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  392. Advanced Templating
  393. <span class="md-nav__icon md-icon"></span>
  394. </label>
  395. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  396. <label class="md-nav__title" for="__nav_3_2_4">
  397. <span class="md-nav__icon md-icon"></span>
  398. Advanced Templating
  399. </label>
  400. <ul class="md-nav__list" data-md-scrollfix>
  401. <li class="md-nav__item">
  402. <a href="../templating/" class="md-nav__link">
  403. v2
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../templating-v1/" class="md-nav__link">
  408. v1
  409. </a>
  410. </li>
  411. </ul>
  412. </nav>
  413. </li>
  414. <li class="md-nav__item">
  415. <a href="../common-k8s-secret-types/" class="md-nav__link">
  416. Kubernetes Secret Types
  417. </a>
  418. </li>
  419. <li class="md-nav__item">
  420. <a href="../ownership-deletion-policy/" class="md-nav__link">
  421. Lifecycle: ownership & deletion
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="../decoding-strategy/" class="md-nav__link">
  426. Decoding Strategies
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../controller-class/" class="md-nav__link">
  431. Controller Classes
  432. </a>
  433. </li>
  434. </ul>
  435. </nav>
  436. </li>
  437. <li class="md-nav__item">
  438. <a href="../generator/" class="md-nav__link">
  439. Generators
  440. </a>
  441. </li>
  442. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  443. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" checked>
  444. <label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
  445. Operations
  446. <span class="md-nav__icon md-icon"></span>
  447. </label>
  448. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="true">
  449. <label class="md-nav__title" for="__nav_3_4">
  450. <span class="md-nav__icon md-icon"></span>
  451. Operations
  452. </label>
  453. <ul class="md-nav__list" data-md-scrollfix>
  454. <li class="md-nav__item">
  455. <a href="../multi-tenancy/" class="md-nav__link">
  456. Multi Tenancy
  457. </a>
  458. </li>
  459. <li class="md-nav__item md-nav__item--active">
  460. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  461. <label class="md-nav__link md-nav__link--active" for="__toc">
  462. Security Best Practices
  463. <span class="md-nav__icon md-icon"></span>
  464. </label>
  465. <a href="./" class="md-nav__link md-nav__link--active">
  466. Security Best Practices
  467. </a>
  468. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  469. <label class="md-nav__title" for="__toc">
  470. <span class="md-nav__icon md-icon"></span>
  471. Table of contents
  472. </label>
  473. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  474. <li class="md-nav__item">
  475. <a href="#security-functions-and-features" class="md-nav__link">
  476. Security Functions and Features
  477. </a>
  478. <nav class="md-nav" aria-label="Security Functions and Features">
  479. <ul class="md-nav__list">
  480. <li class="md-nav__item">
  481. <a href="#1-namespace-isolation" class="md-nav__link">
  482. 1. Namespace Isolation
  483. </a>
  484. </li>
  485. <li class="md-nav__item">
  486. <a href="#2-configure-clustersecretstore-match-conditions" class="md-nav__link">
  487. 2. Configure ClusterSecretStore match conditions
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="#3-selectively-disable-reconciliation-of-cluster-wide-resources" class="md-nav__link">
  492. 3. Selectively Disable Reconciliation of Cluster-Wide Resources
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="#4-implement-namespace-scoped-installation" class="md-nav__link">
  497. 4. Implement Namespace-Scoped Installation
  498. </a>
  499. </li>
  500. </ul>
  501. </nav>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="#pod-security" class="md-nav__link">
  505. Pod Security
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="#role-based-access-control-rbac" class="md-nav__link">
  510. Role-Based Access Control (RBAC)
  511. </a>
  512. </li>
  513. <li class="md-nav__item">
  514. <a href="#network-traffic-and-security" class="md-nav__link">
  515. Network Traffic and Security
  516. </a>
  517. <nav class="md-nav" aria-label="Network Traffic and Security">
  518. <ul class="md-nav__list">
  519. <li class="md-nav__item">
  520. <a href="#outbound-traffic-restrictions" class="md-nav__link">
  521. Outbound Traffic Restrictions
  522. </a>
  523. <nav class="md-nav" aria-label="Outbound Traffic Restrictions">
  524. <ul class="md-nav__list">
  525. <li class="md-nav__item">
  526. <a href="#core-controller" class="md-nav__link">
  527. Core Controller
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="#webhook" class="md-nav__link">
  532. Webhook
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="#cert-controller" class="md-nav__link">
  537. Cert Controller
  538. </a>
  539. </li>
  540. </ul>
  541. </nav>
  542. </li>
  543. <li class="md-nav__item">
  544. <a href="#inbound-traffic-restrictions" class="md-nav__link">
  545. Inbound Traffic Restrictions
  546. </a>
  547. <nav class="md-nav" aria-label="Inbound Traffic Restrictions">
  548. <ul class="md-nav__list">
  549. <li class="md-nav__item">
  550. <a href="#core-controller_1" class="md-nav__link">
  551. Core Controller
  552. </a>
  553. </li>
  554. <li class="md-nav__item">
  555. <a href="#cert-controller_1" class="md-nav__link">
  556. Cert Controller
  557. </a>
  558. </li>
  559. <li class="md-nav__item">
  560. <a href="#webhook_1" class="md-nav__link">
  561. Webhook
  562. </a>
  563. </li>
  564. </ul>
  565. </nav>
  566. </li>
  567. </ul>
  568. </nav>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#policy-engine-best-practices" class="md-nav__link">
  572. Policy Engine Best Practices
  573. </a>
  574. </li>
  575. <li class="md-nav__item">
  576. <a href="#regular-patches" class="md-nav__link">
  577. Regular Patches
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#verify-artefacts" class="md-nav__link">
  582. Verify Artefacts
  583. </a>
  584. <nav class="md-nav" aria-label="Verify Artefacts">
  585. <ul class="md-nav__list">
  586. <li class="md-nav__item">
  587. <a href="#verify-container-images" class="md-nav__link">
  588. Verify Container Images
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="#verifying-provenance" class="md-nav__link">
  593. Verifying Provenance
  594. </a>
  595. </li>
  596. <li class="md-nav__item">
  597. <a href="#fetching-sbom" class="md-nav__link">
  598. Fetching SBOM
  599. </a>
  600. </li>
  601. </ul>
  602. </nav>
  603. </li>
  604. </ul>
  605. </nav>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../threat-model/" class="md-nav__link">
  609. Threat Model
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../v1beta1/" class="md-nav__link">
  614. Upgrading to v1beta1
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../using-latest-image/" class="md-nav__link">
  619. Using Latest Image
  620. </a>
  621. </li>
  622. <li class="md-nav__item">
  623. <a href="../disable-cluster-features/" class="md-nav__link">
  624. Disable Cluster Features
  625. </a>
  626. </li>
  627. </ul>
  628. </nav>
  629. </li>
  630. </ul>
  631. </nav>
  632. </li>
  633. <li class="md-nav__item md-nav__item--nested">
  634. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  635. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  636. Provider
  637. <span class="md-nav__icon md-icon"></span>
  638. </label>
  639. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  640. <label class="md-nav__title" for="__nav_4">
  641. <span class="md-nav__icon md-icon"></span>
  642. Provider
  643. </label>
  644. <ul class="md-nav__list" data-md-scrollfix>
  645. <li class="md-nav__item">
  646. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  647. AWS Secrets Manager
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  652. AWS Parameter Store
  653. </a>
  654. </li>
  655. <li class="md-nav__item">
  656. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  657. Azure Key Vault
  658. </a>
  659. </li>
  660. <li class="md-nav__item">
  661. <a href="../../provider/conjur/" class="md-nav__link">
  662. CyberArk Conjur
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  667. Google Cloud Secret Manager
  668. </a>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  672. HashiCorp Vault
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../../provider/kubernetes/" class="md-nav__link">
  677. Kubernetes
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  682. IBM Secrets Manager
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../provider/akeyless/" class="md-nav__link">
  687. Akeyless
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  692. Yandex Certificate Manager
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  697. Yandex Lockbox
  698. </a>
  699. </li>
  700. <li class="md-nav__item">
  701. <a href="../../provider/alibaba/" class="md-nav__link">
  702. Alibaba Cloud
  703. </a>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  707. GitLab Variables
  708. </a>
  709. </li>
  710. <li class="md-nav__item">
  711. <a href="../../provider/oracle-vault/" class="md-nav__link">
  712. Oracle Vault
  713. </a>
  714. </li>
  715. <li class="md-nav__item">
  716. <a href="../../provider/1password-automation/" class="md-nav__link">
  717. 1Password Secrets Automation
  718. </a>
  719. </li>
  720. <li class="md-nav__item">
  721. <a href="../../provider/webhook/" class="md-nav__link">
  722. Webhook
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="../../provider/fake/" class="md-nav__link">
  727. Fake
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  732. senhasegura DevOps Secrets Management (DSM)
  733. </a>
  734. </li>
  735. <li class="md-nav__item">
  736. <a href="../../provider/doppler/" class="md-nav__link">
  737. Doppler
  738. </a>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="../../provider/keeper-security/" class="md-nav__link">
  742. Keeper Security
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="../../provider/cloak/" class="md-nav__link">
  747. Cloak End 2 End Encrypted Secrets
  748. </a>
  749. </li>
  750. <li class="md-nav__item">
  751. <a href="../../provider/scaleway/" class="md-nav__link">
  752. Scaleway
  753. </a>
  754. </li>
  755. <li class="md-nav__item">
  756. <a href="../../provider/delinea/" class="md-nav__link">
  757. Delinea
  758. </a>
  759. </li>
  760. </ul>
  761. </nav>
  762. </li>
  763. <li class="md-nav__item md-nav__item--nested">
  764. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  765. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  766. Examples
  767. <span class="md-nav__icon md-icon"></span>
  768. </label>
  769. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  770. <label class="md-nav__title" for="__nav_5">
  771. <span class="md-nav__icon md-icon"></span>
  772. Examples
  773. </label>
  774. <ul class="md-nav__list" data-md-scrollfix>
  775. <li class="md-nav__item">
  776. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  777. FluxCD
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  782. Anchore Engine
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  787. Jenkins
  788. </a>
  789. </li>
  790. <li class="md-nav__item">
  791. <a href="../../examples/bitwarden/" class="md-nav__link">
  792. BitWarden
  793. </a>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. <li class="md-nav__item md-nav__item--nested">
  799. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  800. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  801. Community
  802. <span class="md-nav__icon md-icon"></span>
  803. </label>
  804. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  805. <label class="md-nav__title" for="__nav_6">
  806. <span class="md-nav__icon md-icon"></span>
  807. Community
  808. </label>
  809. <ul class="md-nav__list" data-md-scrollfix>
  810. <li class="md-nav__item md-nav__item--nested">
  811. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  812. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  813. Contributing
  814. <span class="md-nav__icon md-icon"></span>
  815. </label>
  816. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  817. <label class="md-nav__title" for="__nav_6_1">
  818. <span class="md-nav__icon md-icon"></span>
  819. Contributing
  820. </label>
  821. <ul class="md-nav__list" data-md-scrollfix>
  822. <li class="md-nav__item">
  823. <a href="../../contributing/devguide/" class="md-nav__link">
  824. Developer guide
  825. </a>
  826. </li>
  827. <li class="md-nav__item">
  828. <a href="../../contributing/process/" class="md-nav__link">
  829. Contributing Process
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="../../contributing/release/" class="md-nav__link">
  834. Release Process
  835. </a>
  836. </li>
  837. <li class="md-nav__item">
  838. <a href="../../contributing/coc/" class="md-nav__link">
  839. Code of Conduct
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../../contributing/roadmap/" class="md-nav__link">
  844. Roadmap
  845. </a>
  846. </li>
  847. </ul>
  848. </nav>
  849. </li>
  850. <li class="md-nav__item md-nav__item--nested">
  851. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  852. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  853. External Resources
  854. <span class="md-nav__icon md-icon"></span>
  855. </label>
  856. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  857. <label class="md-nav__title" for="__nav_6_2">
  858. <span class="md-nav__icon md-icon"></span>
  859. External Resources
  860. </label>
  861. <ul class="md-nav__list" data-md-scrollfix>
  862. <li class="md-nav__item">
  863. <a href="../../eso-talks/" class="md-nav__link">
  864. Talks
  865. </a>
  866. </li>
  867. <li class="md-nav__item">
  868. <a href="../../eso-demos/" class="md-nav__link">
  869. Demos
  870. </a>
  871. </li>
  872. <li class="md-nav__item">
  873. <a href="../../eso-blogs/" class="md-nav__link">
  874. Blogs
  875. </a>
  876. </li>
  877. </ul>
  878. </nav>
  879. </li>
  880. </ul>
  881. </nav>
  882. </li>
  883. </ul>
  884. </nav>
  885. </div>
  886. </div>
  887. </div>
  888. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  889. <div class="md-sidebar__scrollwrap">
  890. <div class="md-sidebar__inner">
  891. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  892. <label class="md-nav__title" for="__toc">
  893. <span class="md-nav__icon md-icon"></span>
  894. Table of contents
  895. </label>
  896. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  897. <li class="md-nav__item">
  898. <a href="#security-functions-and-features" class="md-nav__link">
  899. Security Functions and Features
  900. </a>
  901. <nav class="md-nav" aria-label="Security Functions and Features">
  902. <ul class="md-nav__list">
  903. <li class="md-nav__item">
  904. <a href="#1-namespace-isolation" class="md-nav__link">
  905. 1. Namespace Isolation
  906. </a>
  907. </li>
  908. <li class="md-nav__item">
  909. <a href="#2-configure-clustersecretstore-match-conditions" class="md-nav__link">
  910. 2. Configure ClusterSecretStore match conditions
  911. </a>
  912. </li>
  913. <li class="md-nav__item">
  914. <a href="#3-selectively-disable-reconciliation-of-cluster-wide-resources" class="md-nav__link">
  915. 3. Selectively Disable Reconciliation of Cluster-Wide Resources
  916. </a>
  917. </li>
  918. <li class="md-nav__item">
  919. <a href="#4-implement-namespace-scoped-installation" class="md-nav__link">
  920. 4. Implement Namespace-Scoped Installation
  921. </a>
  922. </li>
  923. </ul>
  924. </nav>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="#pod-security" class="md-nav__link">
  928. Pod Security
  929. </a>
  930. </li>
  931. <li class="md-nav__item">
  932. <a href="#role-based-access-control-rbac" class="md-nav__link">
  933. Role-Based Access Control (RBAC)
  934. </a>
  935. </li>
  936. <li class="md-nav__item">
  937. <a href="#network-traffic-and-security" class="md-nav__link">
  938. Network Traffic and Security
  939. </a>
  940. <nav class="md-nav" aria-label="Network Traffic and Security">
  941. <ul class="md-nav__list">
  942. <li class="md-nav__item">
  943. <a href="#outbound-traffic-restrictions" class="md-nav__link">
  944. Outbound Traffic Restrictions
  945. </a>
  946. <nav class="md-nav" aria-label="Outbound Traffic Restrictions">
  947. <ul class="md-nav__list">
  948. <li class="md-nav__item">
  949. <a href="#core-controller" class="md-nav__link">
  950. Core Controller
  951. </a>
  952. </li>
  953. <li class="md-nav__item">
  954. <a href="#webhook" class="md-nav__link">
  955. Webhook
  956. </a>
  957. </li>
  958. <li class="md-nav__item">
  959. <a href="#cert-controller" class="md-nav__link">
  960. Cert Controller
  961. </a>
  962. </li>
  963. </ul>
  964. </nav>
  965. </li>
  966. <li class="md-nav__item">
  967. <a href="#inbound-traffic-restrictions" class="md-nav__link">
  968. Inbound Traffic Restrictions
  969. </a>
  970. <nav class="md-nav" aria-label="Inbound Traffic Restrictions">
  971. <ul class="md-nav__list">
  972. <li class="md-nav__item">
  973. <a href="#core-controller_1" class="md-nav__link">
  974. Core Controller
  975. </a>
  976. </li>
  977. <li class="md-nav__item">
  978. <a href="#cert-controller_1" class="md-nav__link">
  979. Cert Controller
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="#webhook_1" class="md-nav__link">
  984. Webhook
  985. </a>
  986. </li>
  987. </ul>
  988. </nav>
  989. </li>
  990. </ul>
  991. </nav>
  992. </li>
  993. <li class="md-nav__item">
  994. <a href="#policy-engine-best-practices" class="md-nav__link">
  995. Policy Engine Best Practices
  996. </a>
  997. </li>
  998. <li class="md-nav__item">
  999. <a href="#regular-patches" class="md-nav__link">
  1000. Regular Patches
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="#verify-artefacts" class="md-nav__link">
  1005. Verify Artefacts
  1006. </a>
  1007. <nav class="md-nav" aria-label="Verify Artefacts">
  1008. <ul class="md-nav__list">
  1009. <li class="md-nav__item">
  1010. <a href="#verify-container-images" class="md-nav__link">
  1011. Verify Container Images
  1012. </a>
  1013. </li>
  1014. <li class="md-nav__item">
  1015. <a href="#verifying-provenance" class="md-nav__link">
  1016. Verifying Provenance
  1017. </a>
  1018. </li>
  1019. <li class="md-nav__item">
  1020. <a href="#fetching-sbom" class="md-nav__link">
  1021. Fetching SBOM
  1022. </a>
  1023. </li>
  1024. </ul>
  1025. </nav>
  1026. </li>
  1027. </ul>
  1028. </nav>
  1029. </div>
  1030. </div>
  1031. </div>
  1032. <div class="md-content" data-md-component="content">
  1033. <article class="md-content__inner md-typeset">
  1034. <h1 id="security-best-practices">Security Best Practices</h1>
  1035. <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>
  1036. <h2 id="security-functions-and-features">Security Functions and Features</h2>
  1037. <h3 id="1-namespace-isolation">1. Namespace Isolation</h3>
  1038. <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>
  1039. <ol>
  1040. <li><code>ExternalSecret</code> resources must not have cross-namespace references of <code>Kind=SecretStore</code> or <code>Kind=Secret</code> resources</li>
  1041. <li><code>SecretStore</code> resources must not have cross-namespace references of <code>Kind=Secret</code> or others</li>
  1042. </ol>
  1043. <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>
  1044. <h3 id="2-configure-clustersecretstore-match-conditions">2. Configure ClusterSecretStore match conditions</h3>
  1045. <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>
  1046. <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>
  1047. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1048. <span class="nt">metadata</span><span class="p">:</span>
  1049. <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>
  1050. <span class="nt">spec</span><span class="p">:</span>
  1051. <span class="w"> </span><span class="nt">conditions</span><span class="p">:</span>
  1052. <span class="w"> </span><span class="nt">namespaceSelector</span><span class="p">:</span>
  1053. <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>
  1054. </code></pre></div>
  1055. <h3 id="3-selectively-disable-reconciliation-of-cluster-wide-resources">3. Selectively Disable Reconciliation of Cluster-Wide Resources</h3>
  1056. <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>
  1057. <p>To disable CRD installation:</p>
  1058. <div class="highlight"><pre><span></span><code><span class="c1"># disable cluster-wide resources &amp; push secret</span>
  1059. <span class="nt">crds</span><span class="p">:</span>
  1060. <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>
  1061. <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>
  1062. <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>
  1063. </code></pre></div>
  1064. <p>To disable reconciliation in the core-controller:</p>
  1065. <div class="highlight"><pre><span></span><code>--enable-cluster-external-secret-reconciler
  1066. --enable-cluster-store-reconciler
  1067. </code></pre></div>
  1068. <h3 id="4-implement-namespace-scoped-installation">4. Implement Namespace-Scoped Installation</h3>
  1069. <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>
  1070. <div class="highlight"><pre><span></span><code><span class="c1"># If set to true, create scoped RBAC roles under the scoped namespace</span>
  1071. <span class="c1"># and implicitly disable cluster stores and cluster external secrets</span>
  1072. <span class="nt">scopedRBAC</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
  1073. <span class="c1"># Specify the namespace where external secrets should be reconciled</span>
  1074. <span class="nt">scopedNamespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-namespace</span>
  1075. </code></pre></div>
  1076. <h2 id="pod-security">Pod Security</h2>
  1077. <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>
  1078. <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>
  1079. <h2 id="role-based-access-control-rbac">Role-Based Access Control (RBAC)</h2>
  1080. <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>
  1081. <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>
  1082. <p>To ensure a secure RBAC configuration, consider the following checklist:</p>
  1083. <ul>
  1084. <li>Restrict access to execute shell commands (pods/exec) within the External Secrets Operator Pod.</li>
  1085. <li>Restrict access to (Cluster)ExternalSecret and (Cluster)SecretStore resources.</li>
  1086. <li>Limit access to aggregated ClusterRoles (view/edit/admin) as needed.</li>
  1087. <li>If necessary, deploy ESO with scoped RBAC or within a specific namespace.</li>
  1088. </ul>
  1089. <p>By carefully managing RBAC permissions and scoping the External Secrets Operator appropriately, you can enhance the security of your Kubernetes cluster.</p>
  1090. <h2 id="network-traffic-and-security">Network Traffic and Security</h2>
  1091. <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>
  1092. <p>To implement network restrictions effectively, consider the following steps:</p>
  1093. <ul>
  1094. <li>Define and apply appropriate NetworkPolicies to limit inbound and outbound traffic for the External Secrets Operator.</li>
  1095. <li>Specify a "deny all" policy by default and selectively permit necessary communication based on your specific requirements.</li>
  1096. <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>
  1097. <li>Regularly review and update the Network Policies to align with changes in your network infrastructure and security requirements.</li>
  1098. </ul>
  1099. <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>
  1100. <div class="admonition danger">
  1101. <p class="admonition-title">Data Exfiltration Risk</p>
  1102. <p>If not configured properly ESO may be used to exfiltrate data out of your cluster.
  1103. It is advised to create tight NetworkPolicies and use a policy engine such as kyverno to prevent data exfiltration.</p>
  1104. </div>
  1105. <h3 id="outbound-traffic-restrictions">Outbound Traffic Restrictions</h3>
  1106. <h4 id="core-controller">Core Controller</h4>
  1107. <p>Restrict outbound traffic from the core controller component to the following destinations:</p>
  1108. <ul>
  1109. <li><code>kube-apiserver</code>: The Kubernetes API server.</li>
  1110. <li>Secret provider (e.g., AWS, GCP): Whenever possible, use private endpoints to establish secure and private communication.</li>
  1111. </ul>
  1112. <h4 id="webhook">Webhook</h4>
  1113. <ul>
  1114. <li>Restrict outbound traffic from the webhook component to the <code>kube-apiserver</code>.</li>
  1115. </ul>
  1116. <h4 id="cert-controller">Cert Controller</h4>
  1117. <ul>
  1118. <li>Restrict outbound traffic from the cert controller component to the <code>kube-apiserver</code>.</li>
  1119. </ul>
  1120. <h3 id="inbound-traffic-restrictions">Inbound Traffic Restrictions</h3>
  1121. <h4 id="core-controller_1">Core Controller</h4>
  1122. <ul>
  1123. <li>Restrict inbound traffic to the core controller component by allowing communication on port <code>8080</code> from your monitoring agent.</li>
  1124. </ul>
  1125. <h4 id="cert-controller_1">Cert Controller</h4>
  1126. <ul>
  1127. <li>Restrict inbound traffic to the cert controller component by allowing communication on port <code>8080</code> from your monitoring agent.</li>
  1128. <li>Additionally, permit inbound traffic on port <code>8081</code> from the kubelet for health check endpoints (healthz/readyz).</li>
  1129. </ul>
  1130. <h4 id="webhook_1">Webhook</h4>
  1131. <p>Restrict inbound traffic to the webhook component as follows:</p>
  1132. <ul>
  1133. <li>Allow communication on port <code>10250</code> from the kube-apiserver.</li>
  1134. <li>Allow communication on port <code>8080</code> from your monitoring agent.</li>
  1135. <li>Permit inbound traffic on port <code>8081</code> from the kubelet for health check endpoints (healthz/readyz).</li>
  1136. </ul>
  1137. <h2 id="policy-engine-best-practices">Policy Engine Best Practices</h2>
  1138. <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>
  1139. <div class="admonition danger">
  1140. <p class="admonition-title">Data Exfiltration Risk</p>
  1141. <p>ESO could be used to exfiltrate data out of your cluster. You should disable all providers you don't need.
  1142. Further, you should implement <code>NetworkPolicies</code> to restrict network access to known entities (see above), to prevent data exfiltration.</p>
  1143. </div>
  1144. <p>Here are some recommendations to consider when configuring your policies:</p>
  1145. <ol>
  1146. <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>
  1147. <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>
  1148. <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>
  1149. </ol>
  1150. <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>
  1151. <div class="admonition note">
  1152. <p class="admonition-title">Provider Validation Example Policy</p>
  1153. <p>The following policy validates the usage of the <code>provider</code> field in the SecretStore manifest.</p>
  1154. <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>
  1155. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterPolicy</span>
  1156. <span class="nt">metadata</span><span class="p">:</span>
  1157. <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>
  1158. <span class="nt">spec</span><span class="p">:</span>
  1159. <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>
  1160. <span class="w"> </span><span class="nt">rules</span><span class="p">:</span>
  1161. <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>
  1162. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1163. <span class="w"> </span><span class="nt">any</span><span class="p">:</span>
  1164. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">resources</span><span class="p">:</span>
  1165. <span class="w"> </span><span class="nt">kinds</span><span class="p">:</span>
  1166. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1167. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ClusterSecretStore</span>
  1168. <span class="w"> </span><span class="nt">validate</span><span class="p">:</span>
  1169. <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>
  1170. <span class="w"> </span><span class="nt">pattern</span><span class="p">:</span>
  1171. <span class="w"> </span><span class="nt">spec</span><span class="p">:</span>
  1172. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1173. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1174. <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>
  1175. </code></pre></div>
  1176. </div>
  1177. <h2 id="regular-patches">Regular Patches</h2>
  1178. <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>
  1179. <ol>
  1180. <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>
  1181. <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>
  1182. <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>
  1183. </ol>
  1184. <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>
  1185. <h2 id="verify-artefacts">Verify Artefacts</h2>
  1186. <h3 id="verify-container-images">Verify Container Images</h3>
  1187. <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>
  1188. <div class="highlight"><pre><span></span><code><span class="c1"># Retrieve Image Signature</span>
  1189. $<span class="w"> </span>crane<span class="w"> </span>digest<span class="w"> </span>ghcr.io/external-secrets/external-secrets:v0.8.1
  1190. sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554
  1191. <span class="c1"># verify signature</span>
  1192. $<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
  1193. <span class="c1"># ...</span>
  1194. <span class="o">[</span>
  1195. <span class="w"> </span><span class="o">{</span>
  1196. <span class="w"> </span><span class="s2">&quot;critical&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1197. <span class="w"> </span><span class="s2">&quot;identity&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1198. <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>
  1199. <span class="w"> </span><span class="o">}</span>,
  1200. <span class="w"> </span><span class="s2">&quot;image&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1201. <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>
  1202. <span class="w"> </span><span class="o">}</span>,
  1203. <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>
  1204. <span class="w"> </span><span class="o">}</span>,
  1205. <span class="w"> </span><span class="s2">&quot;optional&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1206. <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>,
  1207. <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>,
  1208. <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>,
  1209. <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>,
  1210. <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>,
  1211. <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>,
  1212. <span class="w"> </span><span class="s2">&quot;Bundle&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1213. <span class="w"> </span><span class="c1"># ...</span>
  1214. <span class="w"> </span><span class="o">}</span>,
  1215. <span class="w"> </span><span class="s2">&quot;GITHUB_ACTOR&quot;</span>:<span class="w"> </span><span class="s2">&quot;gusfcarvalho&quot;</span>,
  1216. <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>,
  1217. <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>,
  1218. <span class="w"> </span><span class="s2">&quot;githubWorkflowName&quot;</span>:<span class="w"> </span><span class="s2">&quot;Create Release&quot;</span>,
  1219. <span class="w"> </span><span class="s2">&quot;githubWorkflowRef&quot;</span>:<span class="w"> </span><span class="s2">&quot;refs/heads/main&quot;</span>,
  1220. <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>,
  1221. <span class="w"> </span><span class="s2">&quot;githubWorkflowSha&quot;</span>:<span class="w"> </span><span class="s2">&quot;a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad&quot;</span>,
  1222. <span class="w"> </span><span class="s2">&quot;githubWorkflowTrigger&quot;</span>:<span class="w"> </span><span class="s2">&quot;workflow_dispatch&quot;</span>
  1223. <span class="w"> </span><span class="o">}</span>
  1224. <span class="w"> </span><span class="o">}</span>
  1225. <span class="o">]</span>
  1226. </code></pre></div>
  1227. <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>
  1228. <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>
  1229. <h3 id="verifying-provenance">Verifying Provenance</h3>
  1230. <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>
  1231. <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
  1232. 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>--
  1233. 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:
  1234. <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
  1235. <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
  1236. <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.
  1237. Certificate<span class="w"> </span>subject:<span class="w"> </span>https://github.com/external-secrets/external-secrets/.github/workflows/release.yml@refs/heads/main
  1238. Certificate<span class="w"> </span>issuer<span class="w"> </span>URL:<span class="w"> </span>https://token.actions.githubusercontent.com
  1239. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Trigger:<span class="w"> </span>workflow_dispatch
  1240. GitHub<span class="w"> </span>Workflow<span class="w"> </span>SHA:<span class="w"> </span>a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad
  1241. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Name:<span class="w"> </span>Create<span class="w"> </span>Release
  1242. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Trigger<span class="w"> </span>external-secrets/external-secrets
  1243. GitHub<span class="w"> </span>Workflow<span class="w"> </span>Ref:<span class="w"> </span>refs/heads/main
  1244. <span class="o">{</span>
  1245. <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>,
  1246. <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>,
  1247. <span class="w"> </span><span class="s2">&quot;subject&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1248. <span class="w"> </span><span class="o">{</span>
  1249. <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>,
  1250. <span class="w"> </span><span class="s2">&quot;digest&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1251. <span class="w"> </span><span class="s2">&quot;sha256&quot;</span>:<span class="w"> </span><span class="s2">&quot;36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554&quot;</span>
  1252. <span class="w"> </span><span class="o">}</span>
  1253. <span class="w"> </span><span class="o">}</span>
  1254. <span class="w"> </span><span class="o">]</span>,
  1255. <span class="w"> </span><span class="s2">&quot;predicate&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1256. <span class="w"> </span><span class="s2">&quot;builder&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1257. <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>
  1258. <span class="w"> </span><span class="o">}</span>,
  1259. <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>,
  1260. <span class="w"> </span><span class="s2">&quot;invocation&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1261. <span class="w"> </span><span class="s2">&quot;configSource&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1262. <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>,
  1263. <span class="w"> </span><span class="s2">&quot;digest&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1264. <span class="w"> </span><span class="s2">&quot;sha1&quot;</span>:<span class="w"> </span><span class="s2">&quot;a0d2aef2e35c259c9ee75d65f7587e6ed71ef2ad&quot;</span>
  1265. <span class="w"> </span><span class="o">}</span>,
  1266. <span class="w"> </span><span class="s2">&quot;entryPoint&quot;</span>:<span class="w"> </span><span class="s2">&quot;Create Release&quot;</span>
  1267. <span class="w"> </span><span class="o">}</span>,
  1268. <span class="w"> </span><span class="s2">&quot;parameters&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1269. <span class="w"> </span><span class="s2">&quot;version&quot;</span>:<span class="w"> </span><span class="s2">&quot;v0.8.1&quot;</span>
  1270. <span class="w"> </span><span class="o">}</span>
  1271. <span class="w"> </span><span class="o">}</span>,
  1272. <span class="w"> </span><span class="o">[</span>...<span class="o">]</span>
  1273. <span class="w"> </span><span class="o">}</span>
  1274. <span class="o">}</span>
  1275. </code></pre></div>
  1276. <h3 id="fetching-sbom">Fetching SBOM</h3>
  1277. <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>
  1278. <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
  1279. sha256:36e606279dbebac51b4b9300b9fa85e8c08c1c673ba3ecc38af1402a0b035554
  1280. $<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>
  1281. <span class="o">[</span>...<span class="o">]</span>
  1282. <span class="o">{</span>
  1283. <span class="w"> </span><span class="s2">&quot;SPDXID&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDXRef-DOCUMENT&quot;</span>,
  1284. <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>,
  1285. <span class="w"> </span><span class="s2">&quot;spdxVersion&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDX-2.2&quot;</span>,
  1286. <span class="w"> </span><span class="s2">&quot;creationInfo&quot;</span>:<span class="w"> </span><span class="o">{</span>
  1287. <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>,
  1288. <span class="w"> </span><span class="s2">&quot;creators&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1289. <span class="w"> </span><span class="s2">&quot;Organization: Anchore, Inc&quot;</span>,
  1290. <span class="w"> </span><span class="s2">&quot;Tool: syft-0.40.1&quot;</span>
  1291. <span class="w"> </span><span class="o">]</span>,
  1292. <span class="w"> </span><span class="s2">&quot;licenseListVersion&quot;</span>:<span class="w"> </span><span class="s2">&quot;3.16&quot;</span>
  1293. <span class="w"> </span><span class="o">}</span>,
  1294. <span class="w"> </span><span class="s2">&quot;dataLicense&quot;</span>:<span class="w"> </span><span class="s2">&quot;CC0-1.0&quot;</span>,
  1295. <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>,
  1296. <span class="w"> </span><span class="s2">&quot;packages&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1297. <span class="w"> </span><span class="o">[</span>...<span class="o">]</span>
  1298. <span class="w"> </span><span class="o">{</span>
  1299. <span class="w"> </span><span class="s2">&quot;SPDXID&quot;</span>:<span class="w"> </span><span class="s2">&quot;SPDXRef-c809070b0beb099e&quot;</span>,
  1300. <span class="w"> </span><span class="s2">&quot;name&quot;</span>:<span class="w"> </span><span class="s2">&quot;tzdata&quot;</span>,
  1301. <span class="w"> </span><span class="s2">&quot;licenseConcluded&quot;</span>:<span class="w"> </span><span class="s2">&quot;NONE&quot;</span>,
  1302. <span class="w"> </span><span class="s2">&quot;downloadLocation&quot;</span>:<span class="w"> </span><span class="s2">&quot;NOASSERTION&quot;</span>,
  1303. <span class="w"> </span><span class="s2">&quot;externalRefs&quot;</span>:<span class="w"> </span><span class="o">[</span>
  1304. <span class="w"> </span><span class="o">{</span>
  1305. <span class="w"> </span><span class="s2">&quot;referenceCategory&quot;</span>:<span class="w"> </span><span class="s2">&quot;SECURITY&quot;</span>,
  1306. <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>,
  1307. <span class="w"> </span><span class="s2">&quot;referenceType&quot;</span>:<span class="w"> </span><span class="s2">&quot;cpe23Type&quot;</span>
  1308. <span class="w"> </span><span class="o">}</span>,
  1309. <span class="w"> </span><span class="o">{</span>
  1310. <span class="w"> </span><span class="s2">&quot;referenceCategory&quot;</span>:<span class="w"> </span><span class="s2">&quot;PACKAGE_MANAGER&quot;</span>,
  1311. <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>,
  1312. <span class="w"> </span><span class="s2">&quot;referenceType&quot;</span>:<span class="w"> </span><span class="s2">&quot;purl&quot;</span>
  1313. <span class="w"> </span><span class="o">}</span>
  1314. <span class="w"> </span><span class="o">]</span>,
  1315. <span class="w"> </span><span class="s2">&quot;filesAnalyzed&quot;</span>:<span class="w"> </span>false,
  1316. <span class="w"> </span><span class="s2">&quot;licenseDeclared&quot;</span>:<span class="w"> </span><span class="s2">&quot;NONE&quot;</span>,
  1317. <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>,
  1318. <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>,
  1319. <span class="w"> </span><span class="s2">&quot;versionInfo&quot;</span>:<span class="w"> </span><span class="s2">&quot;2021a-1+deb11u8&quot;</span>
  1320. <span class="w"> </span><span class="o">}</span>
  1321. <span class="w"> </span><span class="o">]</span>
  1322. <span class="o">}</span>
  1323. </code></pre></div>
  1324. </article>
  1325. </div>
  1326. </div>
  1327. </main>
  1328. <footer class="md-footer">
  1329. <div class="md-footer-meta md-typeset">
  1330. <div class="md-footer-meta__inner md-grid">
  1331. <div class="md-copyright">
  1332. <div class="md-copyright__highlight">
  1333. &copy; 2023 The external-secrets Authors.<br/>
  1334. &copy; 2023 The Linux Foundation. All rights reserved.<br/><br/>
  1335. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1336. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1337. </div>
  1338. Made with
  1339. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1340. Material for MkDocs
  1341. </a>
  1342. </div>
  1343. </div>
  1344. </div>
  1345. </footer>
  1346. </div>
  1347. <div class="md-dialog" data-md-component="dialog">
  1348. <div class="md-dialog__inner md-typeset"></div>
  1349. </div>
  1350. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.208ed371.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>
  1351. <script src="../../assets/javascripts/bundle.fac441b0.min.js"></script>
  1352. </body>
  1353. </html>