index.html 77 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936
  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="../security-best-practices/">
  7. <link rel="next" href="../v1beta1/">
  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>Threat Model - 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="#background" 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. Threat Model
  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">
  585. <a href="../security-best-practices/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Security Best Practices
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item md-nav__item--active">
  592. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  593. <label class="md-nav__link md-nav__link--active" for="__toc">
  594. <span class="md-ellipsis">
  595. Threat Model
  596. </span>
  597. <span class="md-nav__icon md-icon"></span>
  598. </label>
  599. <a href="./" class="md-nav__link md-nav__link--active">
  600. <span class="md-ellipsis">
  601. Threat Model
  602. </span>
  603. </a>
  604. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  605. <label class="md-nav__title" for="__toc">
  606. <span class="md-nav__icon md-icon"></span>
  607. Table of contents
  608. </label>
  609. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  610. <li class="md-nav__item">
  611. <a href="#background" class="md-nav__link">
  612. <span class="md-ellipsis">
  613. Background
  614. </span>
  615. </a>
  616. <nav class="md-nav" aria-label="Background">
  617. <ul class="md-nav__list">
  618. <li class="md-nav__item">
  619. <a href="#summary" class="md-nav__link">
  620. <span class="md-ellipsis">
  621. Summary
  622. </span>
  623. </a>
  624. </li>
  625. <li class="md-nav__item">
  626. <a href="#components" class="md-nav__link">
  627. <span class="md-ellipsis">
  628. Components
  629. </span>
  630. </a>
  631. </li>
  632. </ul>
  633. </nav>
  634. </li>
  635. <li class="md-nav__item">
  636. <a href="#overview" class="md-nav__link">
  637. <span class="md-ellipsis">
  638. Overview
  639. </span>
  640. </a>
  641. <nav class="md-nav" aria-label="Overview">
  642. <ul class="md-nav__list">
  643. <li class="md-nav__item">
  644. <a href="#scope" class="md-nav__link">
  645. <span class="md-ellipsis">
  646. Scope
  647. </span>
  648. </a>
  649. </li>
  650. <li class="md-nav__item">
  651. <a href="#assets" class="md-nav__link">
  652. <span class="md-ellipsis">
  653. Assets
  654. </span>
  655. </a>
  656. <nav class="md-nav" aria-label="Assets">
  657. <ul class="md-nav__list">
  658. <li class="md-nav__item">
  659. <a href="#a01-cluster-level-access-to-secrets" class="md-nav__link">
  660. <span class="md-ellipsis">
  661. A01: Cluster-Level access to secrets
  662. </span>
  663. </a>
  664. </li>
  665. <li class="md-nav__item">
  666. <a href="#a02-crd-and-webhook-write-access" class="md-nav__link">
  667. <span class="md-ellipsis">
  668. A02: CRD and Webhook Write access
  669. </span>
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="#a03-secret-provider-access" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. A03: secret provider access
  676. </span>
  677. </a>
  678. </li>
  679. <li class="md-nav__item">
  680. <a href="#a04-capability-to-modify-resources" class="md-nav__link">
  681. <span class="md-ellipsis">
  682. A04: capability to modify resources
  683. </span>
  684. </a>
  685. </li>
  686. </ul>
  687. </nav>
  688. </li>
  689. <li class="md-nav__item">
  690. <a href="#threats" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Threats
  693. </span>
  694. </a>
  695. <nav class="md-nav" aria-label="Threats">
  696. <ul class="md-nav__list">
  697. <li class="md-nav__item">
  698. <a href="#t01-tampering-with-resources-through-mitm" class="md-nav__link">
  699. <span class="md-ellipsis">
  700. T01: Tampering with resources through MITM
  701. </span>
  702. </a>
  703. </li>
  704. <li class="md-nav__item">
  705. <a href="#t02-webhook-dos" class="md-nav__link">
  706. <span class="md-ellipsis">
  707. T02: Webhook DOS
  708. </span>
  709. </a>
  710. </li>
  711. <li class="md-nav__item">
  712. <a href="#t03-unauthorized-access-to-cluster-secrets" class="md-nav__link">
  713. <span class="md-ellipsis">
  714. T03: Unauthorized access to cluster secrets
  715. </span>
  716. </a>
  717. </li>
  718. <li class="md-nav__item">
  719. <a href="#t04-unauthorized-access-to-secret-provider-credentials" class="md-nav__link">
  720. <span class="md-ellipsis">
  721. T04: unauthorized access to secret provider credentials
  722. </span>
  723. </a>
  724. </li>
  725. <li class="md-nav__item">
  726. <a href="#t05-data-exfiltration-through-malicious-resources" class="md-nav__link">
  727. <span class="md-ellipsis">
  728. T05: data exfiltration through malicious resources
  729. </span>
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="#t06-supply-chain-attacks" class="md-nav__link">
  734. <span class="md-ellipsis">
  735. T06: supply chain attacks
  736. </span>
  737. </a>
  738. </li>
  739. <li class="md-nav__item">
  740. <a href="#t07-malicious-workloads-in-eso-namespace" class="md-nav__link">
  741. <span class="md-ellipsis">
  742. T07: malicious workloads in eso namespace
  743. </span>
  744. </a>
  745. </li>
  746. </ul>
  747. </nav>
  748. </li>
  749. <li class="md-nav__item">
  750. <a href="#controls" class="md-nav__link">
  751. <span class="md-ellipsis">
  752. Controls
  753. </span>
  754. </a>
  755. <nav class="md-nav" aria-label="Controls">
  756. <ul class="md-nav__list">
  757. <li class="md-nav__item">
  758. <a href="#c01-network-security-policy" class="md-nav__link">
  759. <span class="md-ellipsis">
  760. C01: Network Security Policy
  761. </span>
  762. </a>
  763. </li>
  764. <li class="md-nav__item">
  765. <a href="#c02-least-privilege-rbac" class="md-nav__link">
  766. <span class="md-ellipsis">
  767. C02: Least Privilege RBAC
  768. </span>
  769. </a>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="#c03-policy-enforcement" class="md-nav__link">
  773. <span class="md-ellipsis">
  774. C03: Policy Enforcement
  775. </span>
  776. </a>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#c04-provider-access-policy" class="md-nav__link">
  780. <span class="md-ellipsis">
  781. C04: Provider Access Policy
  782. </span>
  783. </a>
  784. </li>
  785. <li class="md-nav__item">
  786. <a href="#c05-entirely-disable-crds" class="md-nav__link">
  787. <span class="md-ellipsis">
  788. C05: Entirely disable CRDs
  789. </span>
  790. </a>
  791. </li>
  792. </ul>
  793. </nav>
  794. </li>
  795. </ul>
  796. </nav>
  797. </li>
  798. </ul>
  799. </nav>
  800. </li>
  801. <li class="md-nav__item">
  802. <a href="../v1beta1/" class="md-nav__link">
  803. <span class="md-ellipsis">
  804. Upgrading to v1beta1
  805. </span>
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="../using-latest-image/" class="md-nav__link">
  810. <span class="md-ellipsis">
  811. Using Latest Image
  812. </span>
  813. </a>
  814. </li>
  815. <li class="md-nav__item">
  816. <a href="../disable-cluster-features/" class="md-nav__link">
  817. <span class="md-ellipsis">
  818. Disable Cluster Features
  819. </span>
  820. </a>
  821. </li>
  822. </ul>
  823. </nav>
  824. </li>
  825. </ul>
  826. </nav>
  827. </li>
  828. <li class="md-nav__item md-nav__item--nested">
  829. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
  830. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  831. <span class="md-ellipsis">
  832. Provider
  833. </span>
  834. <span class="md-nav__icon md-icon"></span>
  835. </label>
  836. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  837. <label class="md-nav__title" for="__nav_4">
  838. <span class="md-nav__icon md-icon"></span>
  839. Provider
  840. </label>
  841. <ul class="md-nav__list" data-md-scrollfix>
  842. <li class="md-nav__item">
  843. <a href="../../provider/aws-secrets-manager/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. AWS Secrets Manager
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../../provider/aws-parameter-store/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. AWS Parameter Store
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../../provider/azure-key-vault/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. Azure Key Vault
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../../provider/beyondtrust/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. BeyondTrust
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../../provider/bitwarden-secrets-manager/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. Bitwarden Secrets Manager
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../../provider/chef/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Chef
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../../provider/conjur/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. CyberArk Conjur
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../../provider/device42/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Device42
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../../provider/google-secrets-manager/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Google Cloud Secret Manager
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../../provider/hashicorp-vault/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. HashiCorp Vault
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../../provider/kubernetes/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. Kubernetes
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../../provider/ibm-secrets-manager/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. IBM Secrets Manager
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../../provider/akeyless/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Akeyless
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../../provider/yandex-certificate-manager/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. Yandex Certificate Manager
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../../provider/yandex-lockbox/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. Yandex Lockbox
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../../provider/alibaba/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. Alibaba Cloud
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../../provider/gitlab-variables/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. GitLab Variables
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../../provider/oracle-vault/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Oracle Vault
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../../provider/1password-automation/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. 1Password Secrets Automation
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../../provider/webhook/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Webhook
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../../provider/fake/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Fake
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../../provider/senhasegura-dsm/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. senhasegura DevOps Secrets Management (DSM)
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../../provider/doppler/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Doppler
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../../provider/keeper-security/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Keeper Security
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../provider/cloak/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Cloak End 2 End Encrypted Secrets
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../../provider/scaleway/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Scaleway
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../../provider/delinea/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Delinea
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../../provider/secretserver/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Secret Server
  1035. </span>
  1036. </a>
  1037. </li>
  1038. <li class="md-nav__item">
  1039. <a href="../../provider/passbolt/" class="md-nav__link">
  1040. <span class="md-ellipsis">
  1041. Passbolt
  1042. </span>
  1043. </a>
  1044. </li>
  1045. <li class="md-nav__item">
  1046. <a href="../../provider/pulumi/" class="md-nav__link">
  1047. <span class="md-ellipsis">
  1048. Pulumi ESC
  1049. </span>
  1050. </a>
  1051. </li>
  1052. <li class="md-nav__item">
  1053. <a href="../../provider/onboardbase/" class="md-nav__link">
  1054. <span class="md-ellipsis">
  1055. Onboardbase
  1056. </span>
  1057. </a>
  1058. </li>
  1059. <li class="md-nav__item">
  1060. <a href="../../provider-passworddepot/" class="md-nav__link">
  1061. <span class="md-ellipsis">
  1062. Password Depot
  1063. </span>
  1064. </a>
  1065. </li>
  1066. <li class="md-nav__item">
  1067. <a href="../../provider/fortanix/" class="md-nav__link">
  1068. <span class="md-ellipsis">
  1069. Fortanix
  1070. </span>
  1071. </a>
  1072. </li>
  1073. <li class="md-nav__item">
  1074. <a href="../../provider/infisical/" class="md-nav__link">
  1075. <span class="md-ellipsis">
  1076. Infisical
  1077. </span>
  1078. </a>
  1079. </li>
  1080. <li class="md-nav__item">
  1081. <a href="../../provider/previder/" class="md-nav__link">
  1082. <span class="md-ellipsis">
  1083. Previder
  1084. </span>
  1085. </a>
  1086. </li>
  1087. </ul>
  1088. </nav>
  1089. </li>
  1090. <li class="md-nav__item md-nav__item--nested">
  1091. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1092. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1093. <span class="md-ellipsis">
  1094. Examples
  1095. </span>
  1096. <span class="md-nav__icon md-icon"></span>
  1097. </label>
  1098. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1099. <label class="md-nav__title" for="__nav_5">
  1100. <span class="md-nav__icon md-icon"></span>
  1101. Examples
  1102. </label>
  1103. <ul class="md-nav__list" data-md-scrollfix>
  1104. <li class="md-nav__item">
  1105. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1106. <span class="md-ellipsis">
  1107. FluxCD
  1108. </span>
  1109. </a>
  1110. </li>
  1111. <li class="md-nav__item">
  1112. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1113. <span class="md-ellipsis">
  1114. Anchore Engine
  1115. </span>
  1116. </a>
  1117. </li>
  1118. <li class="md-nav__item">
  1119. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1120. <span class="md-ellipsis">
  1121. Jenkins
  1122. </span>
  1123. </a>
  1124. </li>
  1125. <li class="md-nav__item">
  1126. <a href="../../examples/bitwarden/" class="md-nav__link">
  1127. <span class="md-ellipsis">
  1128. BitWarden
  1129. </span>
  1130. </a>
  1131. </li>
  1132. </ul>
  1133. </nav>
  1134. </li>
  1135. <li class="md-nav__item md-nav__item--nested">
  1136. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1137. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1138. <span class="md-ellipsis">
  1139. Community
  1140. </span>
  1141. <span class="md-nav__icon md-icon"></span>
  1142. </label>
  1143. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1144. <label class="md-nav__title" for="__nav_6">
  1145. <span class="md-nav__icon md-icon"></span>
  1146. Community
  1147. </label>
  1148. <ul class="md-nav__list" data-md-scrollfix>
  1149. <li class="md-nav__item md-nav__item--nested">
  1150. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1151. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1152. <span class="md-ellipsis">
  1153. Contributing
  1154. </span>
  1155. <span class="md-nav__icon md-icon"></span>
  1156. </label>
  1157. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1158. <label class="md-nav__title" for="__nav_6_1">
  1159. <span class="md-nav__icon md-icon"></span>
  1160. Contributing
  1161. </label>
  1162. <ul class="md-nav__list" data-md-scrollfix>
  1163. <li class="md-nav__item">
  1164. <a href="../../contributing/devguide/" class="md-nav__link">
  1165. <span class="md-ellipsis">
  1166. Developer guide
  1167. </span>
  1168. </a>
  1169. </li>
  1170. <li class="md-nav__item">
  1171. <a href="../../contributing/process/" class="md-nav__link">
  1172. <span class="md-ellipsis">
  1173. Contributing Process
  1174. </span>
  1175. </a>
  1176. </li>
  1177. <li class="md-nav__item">
  1178. <a href="../../contributing/release/" class="md-nav__link">
  1179. <span class="md-ellipsis">
  1180. Release Process
  1181. </span>
  1182. </a>
  1183. </li>
  1184. <li class="md-nav__item">
  1185. <a href="../../contributing/coc/" class="md-nav__link">
  1186. <span class="md-ellipsis">
  1187. Code of Conduct
  1188. </span>
  1189. </a>
  1190. </li>
  1191. <li class="md-nav__item">
  1192. <a href="../../contributing/roadmap/" class="md-nav__link">
  1193. <span class="md-ellipsis">
  1194. Roadmap
  1195. </span>
  1196. </a>
  1197. </li>
  1198. </ul>
  1199. </nav>
  1200. </li>
  1201. <li class="md-nav__item md-nav__item--nested">
  1202. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1203. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1204. <span class="md-ellipsis">
  1205. External Resources
  1206. </span>
  1207. <span class="md-nav__icon md-icon"></span>
  1208. </label>
  1209. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1210. <label class="md-nav__title" for="__nav_6_2">
  1211. <span class="md-nav__icon md-icon"></span>
  1212. External Resources
  1213. </label>
  1214. <ul class="md-nav__list" data-md-scrollfix>
  1215. <li class="md-nav__item">
  1216. <a href="../../eso-talks/" class="md-nav__link">
  1217. <span class="md-ellipsis">
  1218. Talks
  1219. </span>
  1220. </a>
  1221. </li>
  1222. <li class="md-nav__item">
  1223. <a href="../../eso-demos/" class="md-nav__link">
  1224. <span class="md-ellipsis">
  1225. Demos
  1226. </span>
  1227. </a>
  1228. </li>
  1229. <li class="md-nav__item">
  1230. <a href="../../eso-blogs/" class="md-nav__link">
  1231. <span class="md-ellipsis">
  1232. Blogs
  1233. </span>
  1234. </a>
  1235. </li>
  1236. <li class="md-nav__item">
  1237. <a href="../../eso-tools/" class="md-nav__link">
  1238. <span class="md-ellipsis">
  1239. Tools
  1240. </span>
  1241. </a>
  1242. </li>
  1243. </ul>
  1244. </nav>
  1245. </li>
  1246. </ul>
  1247. </nav>
  1248. </li>
  1249. </ul>
  1250. </nav>
  1251. </div>
  1252. </div>
  1253. </div>
  1254. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
  1255. <div class="md-sidebar__scrollwrap">
  1256. <div class="md-sidebar__inner">
  1257. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1258. <label class="md-nav__title" for="__toc">
  1259. <span class="md-nav__icon md-icon"></span>
  1260. Table of contents
  1261. </label>
  1262. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1263. <li class="md-nav__item">
  1264. <a href="#background" class="md-nav__link">
  1265. <span class="md-ellipsis">
  1266. Background
  1267. </span>
  1268. </a>
  1269. <nav class="md-nav" aria-label="Background">
  1270. <ul class="md-nav__list">
  1271. <li class="md-nav__item">
  1272. <a href="#summary" class="md-nav__link">
  1273. <span class="md-ellipsis">
  1274. Summary
  1275. </span>
  1276. </a>
  1277. </li>
  1278. <li class="md-nav__item">
  1279. <a href="#components" class="md-nav__link">
  1280. <span class="md-ellipsis">
  1281. Components
  1282. </span>
  1283. </a>
  1284. </li>
  1285. </ul>
  1286. </nav>
  1287. </li>
  1288. <li class="md-nav__item">
  1289. <a href="#overview" class="md-nav__link">
  1290. <span class="md-ellipsis">
  1291. Overview
  1292. </span>
  1293. </a>
  1294. <nav class="md-nav" aria-label="Overview">
  1295. <ul class="md-nav__list">
  1296. <li class="md-nav__item">
  1297. <a href="#scope" class="md-nav__link">
  1298. <span class="md-ellipsis">
  1299. Scope
  1300. </span>
  1301. </a>
  1302. </li>
  1303. <li class="md-nav__item">
  1304. <a href="#assets" class="md-nav__link">
  1305. <span class="md-ellipsis">
  1306. Assets
  1307. </span>
  1308. </a>
  1309. <nav class="md-nav" aria-label="Assets">
  1310. <ul class="md-nav__list">
  1311. <li class="md-nav__item">
  1312. <a href="#a01-cluster-level-access-to-secrets" class="md-nav__link">
  1313. <span class="md-ellipsis">
  1314. A01: Cluster-Level access to secrets
  1315. </span>
  1316. </a>
  1317. </li>
  1318. <li class="md-nav__item">
  1319. <a href="#a02-crd-and-webhook-write-access" class="md-nav__link">
  1320. <span class="md-ellipsis">
  1321. A02: CRD and Webhook Write access
  1322. </span>
  1323. </a>
  1324. </li>
  1325. <li class="md-nav__item">
  1326. <a href="#a03-secret-provider-access" class="md-nav__link">
  1327. <span class="md-ellipsis">
  1328. A03: secret provider access
  1329. </span>
  1330. </a>
  1331. </li>
  1332. <li class="md-nav__item">
  1333. <a href="#a04-capability-to-modify-resources" class="md-nav__link">
  1334. <span class="md-ellipsis">
  1335. A04: capability to modify resources
  1336. </span>
  1337. </a>
  1338. </li>
  1339. </ul>
  1340. </nav>
  1341. </li>
  1342. <li class="md-nav__item">
  1343. <a href="#threats" class="md-nav__link">
  1344. <span class="md-ellipsis">
  1345. Threats
  1346. </span>
  1347. </a>
  1348. <nav class="md-nav" aria-label="Threats">
  1349. <ul class="md-nav__list">
  1350. <li class="md-nav__item">
  1351. <a href="#t01-tampering-with-resources-through-mitm" class="md-nav__link">
  1352. <span class="md-ellipsis">
  1353. T01: Tampering with resources through MITM
  1354. </span>
  1355. </a>
  1356. </li>
  1357. <li class="md-nav__item">
  1358. <a href="#t02-webhook-dos" class="md-nav__link">
  1359. <span class="md-ellipsis">
  1360. T02: Webhook DOS
  1361. </span>
  1362. </a>
  1363. </li>
  1364. <li class="md-nav__item">
  1365. <a href="#t03-unauthorized-access-to-cluster-secrets" class="md-nav__link">
  1366. <span class="md-ellipsis">
  1367. T03: Unauthorized access to cluster secrets
  1368. </span>
  1369. </a>
  1370. </li>
  1371. <li class="md-nav__item">
  1372. <a href="#t04-unauthorized-access-to-secret-provider-credentials" class="md-nav__link">
  1373. <span class="md-ellipsis">
  1374. T04: unauthorized access to secret provider credentials
  1375. </span>
  1376. </a>
  1377. </li>
  1378. <li class="md-nav__item">
  1379. <a href="#t05-data-exfiltration-through-malicious-resources" class="md-nav__link">
  1380. <span class="md-ellipsis">
  1381. T05: data exfiltration through malicious resources
  1382. </span>
  1383. </a>
  1384. </li>
  1385. <li class="md-nav__item">
  1386. <a href="#t06-supply-chain-attacks" class="md-nav__link">
  1387. <span class="md-ellipsis">
  1388. T06: supply chain attacks
  1389. </span>
  1390. </a>
  1391. </li>
  1392. <li class="md-nav__item">
  1393. <a href="#t07-malicious-workloads-in-eso-namespace" class="md-nav__link">
  1394. <span class="md-ellipsis">
  1395. T07: malicious workloads in eso namespace
  1396. </span>
  1397. </a>
  1398. </li>
  1399. </ul>
  1400. </nav>
  1401. </li>
  1402. <li class="md-nav__item">
  1403. <a href="#controls" class="md-nav__link">
  1404. <span class="md-ellipsis">
  1405. Controls
  1406. </span>
  1407. </a>
  1408. <nav class="md-nav" aria-label="Controls">
  1409. <ul class="md-nav__list">
  1410. <li class="md-nav__item">
  1411. <a href="#c01-network-security-policy" class="md-nav__link">
  1412. <span class="md-ellipsis">
  1413. C01: Network Security Policy
  1414. </span>
  1415. </a>
  1416. </li>
  1417. <li class="md-nav__item">
  1418. <a href="#c02-least-privilege-rbac" class="md-nav__link">
  1419. <span class="md-ellipsis">
  1420. C02: Least Privilege RBAC
  1421. </span>
  1422. </a>
  1423. </li>
  1424. <li class="md-nav__item">
  1425. <a href="#c03-policy-enforcement" class="md-nav__link">
  1426. <span class="md-ellipsis">
  1427. C03: Policy Enforcement
  1428. </span>
  1429. </a>
  1430. </li>
  1431. <li class="md-nav__item">
  1432. <a href="#c04-provider-access-policy" class="md-nav__link">
  1433. <span class="md-ellipsis">
  1434. C04: Provider Access Policy
  1435. </span>
  1436. </a>
  1437. </li>
  1438. <li class="md-nav__item">
  1439. <a href="#c05-entirely-disable-crds" class="md-nav__link">
  1440. <span class="md-ellipsis">
  1441. C05: Entirely disable CRDs
  1442. </span>
  1443. </a>
  1444. </li>
  1445. </ul>
  1446. </nav>
  1447. </li>
  1448. </ul>
  1449. </nav>
  1450. </li>
  1451. </ul>
  1452. </nav>
  1453. </div>
  1454. </div>
  1455. </div>
  1456. <div class="md-content" data-md-component="content">
  1457. <article class="md-content__inner md-typeset">
  1458. <h1>Threat Model</h1>
  1459. <h2 id="background">Background</h2>
  1460. <p>The External Secrets Operator is a Kubernetes Operator that seamlessly incorporates external secret management systems into Kubernetes. This Operator retrieves data from the external API and generates Kubernetes Secret resources using the corresponding secret values. This process occurs continuously in the background through regular polling of the external API. Consequently, whenever a secret undergoes changes in the external API, the corresponding Kubernetes Secret will also be updated accordingly.</p>
  1461. <h3 id="summary">Summary</h3>
  1462. <table>
  1463. <thead>
  1464. <tr>
  1465. <th>Purpose</th>
  1466. <th>Description</th>
  1467. </tr>
  1468. </thead>
  1469. <tbody>
  1470. <tr>
  1471. <td>Intended Usage</td>
  1472. <td>Sync Secrets into Kubernetes</td>
  1473. </tr>
  1474. <tr>
  1475. <td>Data Classifiation</td>
  1476. <td>Critical</td>
  1477. </tr>
  1478. <tr>
  1479. <td>Highest Risk Impact</td>
  1480. <td>Organisation takeover</td>
  1481. </tr>
  1482. </tbody>
  1483. </table>
  1484. <h3 id="components">Components</h3>
  1485. <p>ESO comprises three main components: <code>webhook</code>, <code>cert controller</code> and a <code>core controller</code>. For more detailed information, please refer to the documentation on <a href="../../api/components/">components</a>.</p>
  1486. <h2 id="overview">Overview</h2>
  1487. <p>This section provides an overview of the security aspects of the External Secrets Operator (ESO) and includes information on assets, threats, and controls involved in its operation.</p>
  1488. <p>The following diagram illustrates the security perspective of how ESO functions, highlighting the assets (items to protect), threats (potential risks), and controls (measures to mitigate threats).</p>
  1489. <p><img alt="Overview" src="../../pictures/eso-threat-model-overview.drawio.png" /></p>
  1490. <h3 id="scope">Scope</h3>
  1491. <p>For the purpose of this threat model, we assume an ESO installation using helm and default settings on a public cloud provider. It is important to note that the <a href="https://github.com/kubernetes/community/tree/master/sig-security">Kubernetes SIG Security</a> team has defined an <a href="https://github.com/kubernetes/sig-security/blob/main/sig-security-docs/papers/admission-control/kubernetes-admission-control-threat-model.md">Admission Control Threat Model</a>, which is recommended reading for a better understanding of the security aspects that partially apply to External Secrets Operator.</p>
  1492. <p>ESO utilizes the <code>ValidatingWebhookConfiguration</code> mechanism to validate <code>(Cluster)SecretStore</code> and <code>(Cluster)ExternalSecret</code> resources. However, it is essential to understand that this validation process does not serve as a security control mechanism. Instead, ESO performs validation by enforcing additional rules that go beyond the <a href="https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation">CustomResourceDefinition OpenAPI v3 Validation schema</a>.</p>
  1493. <h3 id="assets">Assets</h3>
  1494. <h4 id="a01-cluster-level-access-to-secrets">A01: Cluster-Level access to secrets</h4>
  1495. <p>The controller possesses privileged access to the <code>kube-apiserver</code> and is authorized to read and write secret resources across all namespaces within a cluster.</p>
  1496. <h4 id="a02-crd-and-webhook-write-access">A02: CRD and Webhook Write access</h4>
  1497. <p>The cert-controller component has read/write access to <code>ValidatingWebhookConfigurations</code> and <code>CustomResourceDefinitions</code> resources. This access is necessary to inject/modify the caBundle property.</p>
  1498. <h4 id="a03-secret-provider-access">A03: secret provider access</h4>
  1499. <p>The <code>core-controller</code> component accesses a secret provider using user-supplied credentials. These credentials can be derived from environment variables, mounted service account tokens, files within the controller container, or fetched from the Kubernetes API (e.g., <code>Kind=Secret</code>). The scope of these credentials may vary, potentially providing full access to a cloud provider.</p>
  1500. <h4 id="a04-capability-to-modify-resources">A04: capability to modify resources</h4>
  1501. <p>The webhook component validates and converts ExternalSecret and SecretStore resources. The conversion webhook is essential for migrating resources from the old version <code>v1alpha1</code> to the new version <code>v1beta1</code>. The webhook component possesses the ability to modify resources during runtime.</p>
  1502. <h3 id="threats">Threats</h3>
  1503. <h4 id="t01-tampering-with-resources-through-mitm">T01: Tampering with resources through MITM</h4>
  1504. <p>An adversary could launch a Man-in-the-Middle (MITM) attack to hijack the webhook pod, enabling them to manipulate the data of the conversion webhook. This could involve injecting malicious resources or causing a Denial-of-Service (DoS) attack. To mitigate this threat, a mutual authentication mechanism should be enforced for the connection between the Kubernetes API server and the webhook service to ensure that only authenticated endpoints can communicate.</p>
  1505. <h4 id="t02-webhook-dos">T02: Webhook DOS</h4>
  1506. <p>Currently, ESO generates an X.509 certificate for webhook registration without authenticating the kube-apiserver. Consequently, if an attacker gains network access to the webhook Pod, they can overload the webhook server and initiate a DoS attack. As a result, modifications to ESO resources may fail, and the ESO core controller may be impacted due to the unavailability of the conversion webhook.</p>
  1507. <h4 id="t03-unauthorized-access-to-cluster-secrets">T03: Unauthorized access to cluster secrets</h4>
  1508. <p>An attacker can gain unauthorized access to secrets by utilizing the service account token of the ESO core controller Pod or exploiting software vulnerabilities. This unauthorized access allows the attacker to read secrets within the cluster, potentially leading to a cluster takeover.</p>
  1509. <h4 id="t04-unauthorized-access-to-secret-provider-credentials">T04: unauthorized access to secret provider credentials</h4>
  1510. <p>An attacker can gain unauthorized access to credentials that provide access to external APIs storing secrets. If the credentials have overly broad permissions, this could result in an organization takeover.</p>
  1511. <h4 id="t05-data-exfiltration-through-malicious-resources">T05: data exfiltration through malicious resources</h4>
  1512. <p>An attacker can exfiltrate data from the cluster by utilizing maliciously crafted resources. Multiple attack vectors can be employed, e.g.:</p>
  1513. <ol>
  1514. <li>copying data from a namespace to an unauthorized namespace</li>
  1515. <li>exfiltrating data to an unauthorized secret provider</li>
  1516. <li>exfiltrating data through an authorized secret provider to a malicious provider account</li>
  1517. </ol>
  1518. <p>Successful data exfiltration can lead to intellectual property loss, information misuse, loss of customer trust, and damage to the brand or reputation.</p>
  1519. <h4 id="t06-supply-chain-attacks">T06: supply chain attacks</h4>
  1520. <p>An attack can infiltrate the ESO container through various attack vectors. The following are some potential entry points, although this is not an exhaustive list. For a comprehensive analysis, refer to <a href="https://slsa.dev/spec/v0.1/threats">SLSA Threats and mitigations</a> or <a href="https://cloud.google.com/software-supply-chain-security/docs/attack-vectors">GCP software supply chain threats</a>.</p>
  1521. <ol>
  1522. <li>Source Threats: Unauthorized changes or inclusion of vulnerable code in ESO through code submissions.</li>
  1523. <li>Build Threats: Creation and distribution of malicious builds of ESO, such as in container registries, Artifact Hub, or Operator Hub.</li>
  1524. <li>Dependency Threats: Introduction of vulnerable code into ESO dependencies.</li>
  1525. <li>Deployment and Runtime Threats: Injection of malicious code through compromised deployment processes.</li>
  1526. </ol>
  1527. <h4 id="t07-malicious-workloads-in-eso-namespace">T07: malicious workloads in eso namespace</h4>
  1528. <p>An attacker can deploy malicious workloads within the external-secrets namespace, taking advantage of the ESO service account with potentially cluster-wide privileges.</p>
  1529. <h3 id="controls">Controls</h3>
  1530. <h4 id="c01-network-security-policy">C01: Network Security Policy</h4>
  1531. <p>Implement a NetworkPolicy to restrict traffic in both inbound and outbound directions on all networks. Employ a "deny all" / "permit by exception" approach for inbound and outbound network traffic. The specific network policies for the core-controller depend on the chosen provider. The webhook and cert-controller have well-defined sets of endpoints they communicate with. Refer to the <a href="../security-best-practices/">Security Best Practices</a> documentation for inbound and outbound network requirements.</p>
  1532. <p>Please note that ESO does not provide pre-packaged network policies, and it is the user's responsibility to implement the necessary security controls.</p>
  1533. <h4 id="c02-least-privilege-rbac">C02: Least Privilege RBAC</h4>
  1534. <p>Adhere to the principle of least privilege by configuring Role-Based Access Control (RBAC) permissions not only for the ESO workload but also for all users interacting with it. Ensure that RBAC permissions on provider side are appropriate according to your setup, by for example limiting which sensitive information a given credential can have access to. Ensure that kubernetes RBAC are set up to grant access to ESO resources only where necessary. For example, allowing write access to <code>ClusterSecretStore</code>/<code>ExternalSecret</code> may be sufficient for a threat to become a reality.</p>
  1535. <h4 id="c03-policy-enforcement">C03: Policy Enforcement</h4>
  1536. <p>Implement a Policy Engine such as Kyverno or OPA to enforce restrictions on changes to ESO resources. The specific policies to be enforced depend on the environment. Here are a few suggestions:</p>
  1537. <ol>
  1538. <li>(Cluster)SecretStore: Restrict the allowed secret providers, disallowing unused or undesired providers (e.g. Webhook).</li>
  1539. <li>(Cluster)SecretStore: Restrict the permitted authentication mechanisms (e.g. prevent usage of <code>secretRef</code>).</li>
  1540. <li>(Cluster)SecretStore: Enforce limitations on modifications to provider-specific fields relevant for security, such as <code>caBundle</code>, <code>caProvider</code>, <code>region</code>, <code>role</code>, <code>url</code>, <code>environmentType</code>, <code>identityId</code>, and <code>others</code>.</li>
  1541. <li>ClusterSecretStore: Control the usage of <code>namespaceSelector</code>, such as forbidding or mandating the usage of the <code>kube-system</code> namespace.</li>
  1542. <li>ClusterExternalSecret: Restrict the usage of <code>namespaceSelector</code>.</li>
  1543. </ol>
  1544. <p>Please note that ESO does not provide pre-packaged policies, and it is the user's responsibility to implement the necessary security controls.</p>
  1545. <h4 id="c04-provider-access-policy">C04: Provider Access Policy</h4>
  1546. <p>Configure fine-grained access control on the HTTP endpoint of the secret provider to prevent data exfiltration across accounts or organizations. Consult the documentation of your specific provider (e.g.: <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/vpc-endpoint-overview.html">AWS Secrets Manager VPC Endpoint Policies</a>, <a href="https://cloud.google.com/vpc/docs/private-service-connect">GCP Private Service Connect</a>, or <a href="https://learn.microsoft.com/en-us/azure/key-vault/general/private-link-service">Azure Private Link</a>) for guidance on setting up access policies.</p>
  1547. <h4 id="c05-entirely-disable-crds">C05: Entirely disable CRDs</h4>
  1548. <p>You should disable unused CRDs to narrow down your attack surface. Not all users require the use of <code>PushSecret</code>, <code>ClusterSecretStore</code> or <code>ClusterExternalSecret</code> resources.</p>
  1549. </article>
  1550. </div>
  1551. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1552. </div>
  1553. </main>
  1554. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1555. <footer class="md-footer">
  1556. <div class="md-footer-meta md-typeset">
  1557. <div class="md-footer-meta__inner md-grid">
  1558. <div class="md-copyright">
  1559. <div class="md-copyright__highlight">
  1560. &copy; 2024 The external-secrets Authors.<br/>
  1561. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1562. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1563. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1564. </div>
  1565. Made with
  1566. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1567. Material for MkDocs
  1568. </a>
  1569. </div>
  1570. </div>
  1571. </div>
  1572. </footer>
  1573. </div>
  1574. <div class="md-dialog" data-md-component="dialog">
  1575. <div class="md-dialog__inner md-typeset"></div>
  1576. </div>
  1577. <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>
  1578. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1579. </body>
  1580. </html>