index.html 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832
  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="icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.10">
  8. <title>Decoding Strategies - External Secrets Operator</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.d6be258b.min.css">
  10. <link rel="stylesheet" href="../assets/stylesheets/palette.e6a45f82.min.css">
  11. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  12. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  13. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  14. <script>__md_scope=new URL("..",location),__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>
  15. <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-QP38TD8K7V",{page_path:e.pathname})})})</script>
  16. <script async src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V"></script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#decoding-strategies" class="md-skip">
  24. Skip to content
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <div data-md-component="outdated" hidden>
  30. <aside class="md-banner md-banner--warning">
  31. <div class="md-banner__inner md-grid md-typeset">
  32. You're not viewing the latest version.
  33. <a href="../..">
  34. <strong>Click here to go to latest.</strong>
  35. </a>
  36. </div>
  37. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  38. </aside>
  39. </div>
  40. <header class="md-header" data-md-component="header">
  41. <nav class="md-header__inner md-grid" aria-label="Header">
  42. <a href=".." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  43. <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>
  44. </a>
  45. <label class="md-header__button md-icon" for="__drawer">
  46. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  47. </label>
  48. <div class="md-header__title" data-md-component="header-title">
  49. <div class="md-header__ellipsis">
  50. <div class="md-header__topic">
  51. <span class="md-ellipsis">
  52. External Secrets Operator
  53. </span>
  54. </div>
  55. <div class="md-header__topic" data-md-component="header-topic">
  56. <span class="md-ellipsis">
  57. Decoding Strategies
  58. </span>
  59. </div>
  60. </div>
  61. </div>
  62. <label class="md-header__button md-icon" for="__search">
  63. <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>
  64. </label>
  65. <div class="md-search" data-md-component="search" role="dialog">
  66. <label class="md-search__overlay" for="__search"></label>
  67. <div class="md-search__inner" role="search">
  68. <form class="md-search__form" name="search">
  69. <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>
  70. <label class="md-search__icon md-icon" for="__search">
  71. <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>
  72. <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>
  73. </label>
  74. <nav class="md-search__options" aria-label="Search">
  75. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
  76. <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>
  77. </button>
  78. </nav>
  79. </form>
  80. <div class="md-search__output">
  81. <div class="md-search__scrollwrap" data-md-scrollfix>
  82. <div class="md-search-result" data-md-component="search-result">
  83. <div class="md-search-result__meta">
  84. Initializing search
  85. </div>
  86. <ol class="md-search-result__list"></ol>
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="md-header__source">
  93. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  94. <div class="md-source__icon md-icon">
  95. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  96. </div>
  97. <div class="md-source__repository">
  98. External Secrets Operator
  99. </div>
  100. </a>
  101. </div>
  102. </nav>
  103. </header>
  104. <div class="md-container" data-md-component="container">
  105. <main class="md-main" data-md-component="main">
  106. <div class="md-main__inner md-grid">
  107. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  108. <div class="md-sidebar__scrollwrap">
  109. <div class="md-sidebar__inner">
  110. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  111. <label class="md-nav__title" for="__drawer">
  112. <a href=".." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  113. <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>
  114. </a>
  115. External Secrets Operator
  116. </label>
  117. <div class="md-nav__source">
  118. <a href="https://github.com/external-secrets/external-secrets/" title="Go to repository" class="md-source" data-md-component="source">
  119. <div class="md-source__icon md-icon">
  120. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
  121. </div>
  122. <div class="md-source__repository">
  123. External Secrets Operator
  124. </div>
  125. </a>
  126. </div>
  127. <ul class="md-nav__list" data-md-scrollfix>
  128. <li class="md-nav__item">
  129. <a href=".." class="md-nav__link">
  130. Introduction
  131. </a>
  132. </li>
  133. <li class="md-nav__item">
  134. <a href="../api-overview/" class="md-nav__link">
  135. Overview
  136. </a>
  137. </li>
  138. <li class="md-nav__item md-nav__item--nested">
  139. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
  140. <label class="md-nav__link" for="__nav_3">
  141. API Types
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <nav class="md-nav" aria-label="API Types" data-md-level="1">
  145. <label class="md-nav__title" for="__nav_3">
  146. <span class="md-nav__icon md-icon"></span>
  147. API Types
  148. </label>
  149. <ul class="md-nav__list" data-md-scrollfix>
  150. <li class="md-nav__item">
  151. <a href="../api-externalsecret/" class="md-nav__link">
  152. ExternalSecret
  153. </a>
  154. </li>
  155. <li class="md-nav__item">
  156. <a href="../api-secretstore/" class="md-nav__link">
  157. SecretStore
  158. </a>
  159. </li>
  160. <li class="md-nav__item">
  161. <a href="../api-clustersecretstore/" class="md-nav__link">
  162. ClusterSecretStore
  163. </a>
  164. </li>
  165. <li class="md-nav__item">
  166. <a href="../api-clusterexternalsecret/" class="md-nav__link">
  167. ClusterExternalSecret
  168. </a>
  169. </li>
  170. </ul>
  171. </nav>
  172. </li>
  173. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  174. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
  175. <label class="md-nav__link" for="__nav_4">
  176. Guides
  177. <span class="md-nav__icon md-icon"></span>
  178. </label>
  179. <nav class="md-nav" aria-label="Guides" data-md-level="1">
  180. <label class="md-nav__title" for="__nav_4">
  181. <span class="md-nav__icon md-icon"></span>
  182. Guides
  183. </label>
  184. <ul class="md-nav__list" data-md-scrollfix>
  185. <li class="md-nav__item">
  186. <a href="../guides-introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../guides-getting-started/" class="md-nav__link">
  192. Getting started
  193. </a>
  194. </li>
  195. <li class="md-nav__item md-nav__item--nested">
  196. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
  197. <label class="md-nav__link" for="__nav_4_3">
  198. Advanced Templating
  199. <span class="md-nav__icon md-icon"></span>
  200. </label>
  201. <nav class="md-nav" aria-label="Advanced Templating" data-md-level="2">
  202. <label class="md-nav__title" for="__nav_4_3">
  203. <span class="md-nav__icon md-icon"></span>
  204. Advanced Templating
  205. </label>
  206. <ul class="md-nav__list" data-md-scrollfix>
  207. <li class="md-nav__item">
  208. <a href="../guides-templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../guides-templating-v1/" class="md-nav__link">
  214. v1
  215. </a>
  216. </li>
  217. </ul>
  218. </nav>
  219. </li>
  220. <li class="md-nav__item">
  221. <a href="../guides-all-keys-one-secret/" class="md-nav__link">
  222. All keys, One secret
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="../guides-common-k8s-secret-types/" class="md-nav__link">
  227. Common K8S Secret Types
  228. </a>
  229. </li>
  230. <li class="md-nav__item">
  231. <a href="../guides-controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../guides-ownership-deletion-policy/" class="md-nav__link">
  237. Lifecycle: ownership & deletion
  238. </a>
  239. </li>
  240. <li class="md-nav__item md-nav__item--active">
  241. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  242. <label class="md-nav__link md-nav__link--active" for="__toc">
  243. Decoding Strategies
  244. <span class="md-nav__icon md-icon"></span>
  245. </label>
  246. <a href="./" class="md-nav__link md-nav__link--active">
  247. Decoding Strategies
  248. </a>
  249. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  250. <label class="md-nav__title" for="__toc">
  251. <span class="md-nav__icon md-icon"></span>
  252. Table of contents
  253. </label>
  254. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  255. <li class="md-nav__item">
  256. <a href="#none-default" class="md-nav__link">
  257. None (default)
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="#base64" class="md-nav__link">
  262. Base64
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="#base64url" class="md-nav__link">
  267. Base64URL
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="#auto" class="md-nav__link">
  272. Auto
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="#examples" class="md-nav__link">
  277. Examples
  278. </a>
  279. <nav class="md-nav" aria-label="Examples">
  280. <ul class="md-nav__list">
  281. <li class="md-nav__item">
  282. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  283. Setting Decoding strategy Auto in a DataFrom.Extract
  284. </a>
  285. </li>
  286. </ul>
  287. </nav>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="#limitations" class="md-nav__link">
  291. Limitations
  292. </a>
  293. </li>
  294. </ul>
  295. </nav>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="../guides-getallsecrets/" class="md-nav__link">
  299. Getting Multiple Secrets
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../guides-multi-tenancy/" class="md-nav__link">
  304. Multi Tenancy
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../guides-metrics/" class="md-nav__link">
  309. Metrics
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../guides-datafrom-rewrite/" class="md-nav__link">
  314. Rewriting Keys
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../guides-v1beta1/" class="md-nav__link">
  319. Upgrading to v1beta1
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../guides-using-latest-image/" class="md-nav__link">
  324. Using Latest Image
  325. </a>
  326. </li>
  327. </ul>
  328. </nav>
  329. </li>
  330. <li class="md-nav__item md-nav__item--nested">
  331. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  332. <label class="md-nav__link" for="__nav_5">
  333. Provider
  334. <span class="md-nav__icon md-icon"></span>
  335. </label>
  336. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  337. <label class="md-nav__title" for="__nav_5">
  338. <span class="md-nav__icon md-icon"></span>
  339. Provider
  340. </label>
  341. <ul class="md-nav__list" data-md-scrollfix>
  342. <li class="md-nav__item md-nav__item--nested">
  343. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  344. <label class="md-nav__link" for="__nav_5_1">
  345. AWS
  346. <span class="md-nav__icon md-icon"></span>
  347. </label>
  348. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  349. <label class="md-nav__title" for="__nav_5_1">
  350. <span class="md-nav__icon md-icon"></span>
  351. AWS
  352. </label>
  353. <ul class="md-nav__list" data-md-scrollfix>
  354. <li class="md-nav__item">
  355. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  356. Secrets Manager
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  361. Parameter Store
  362. </a>
  363. </li>
  364. </ul>
  365. </nav>
  366. </li>
  367. <li class="md-nav__item md-nav__item--nested">
  368. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  369. <label class="md-nav__link" for="__nav_5_2">
  370. Azure
  371. <span class="md-nav__icon md-icon"></span>
  372. </label>
  373. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  374. <label class="md-nav__title" for="__nav_5_2">
  375. <span class="md-nav__icon md-icon"></span>
  376. Azure
  377. </label>
  378. <ul class="md-nav__list" data-md-scrollfix>
  379. <li class="md-nav__item">
  380. <a href="../provider-azure-key-vault/" class="md-nav__link">
  381. Key Vault
  382. </a>
  383. </li>
  384. </ul>
  385. </nav>
  386. </li>
  387. <li class="md-nav__item md-nav__item--nested">
  388. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  389. <label class="md-nav__link" for="__nav_5_3">
  390. Google
  391. <span class="md-nav__icon md-icon"></span>
  392. </label>
  393. <nav class="md-nav" aria-label="Google" data-md-level="2">
  394. <label class="md-nav__title" for="__nav_5_3">
  395. <span class="md-nav__icon md-icon"></span>
  396. Google
  397. </label>
  398. <ul class="md-nav__list" data-md-scrollfix>
  399. <li class="md-nav__item">
  400. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  401. Secret Manager
  402. </a>
  403. </li>
  404. </ul>
  405. </nav>
  406. </li>
  407. <li class="md-nav__item md-nav__item--nested">
  408. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  409. <label class="md-nav__link" for="__nav_5_4">
  410. IBM
  411. <span class="md-nav__icon md-icon"></span>
  412. </label>
  413. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  414. <label class="md-nav__title" for="__nav_5_4">
  415. <span class="md-nav__icon md-icon"></span>
  416. IBM
  417. </label>
  418. <ul class="md-nav__list" data-md-scrollfix>
  419. <li class="md-nav__item">
  420. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  421. Secrets Manager
  422. </a>
  423. </li>
  424. </ul>
  425. </nav>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../provider-akeyless/" class="md-nav__link">
  429. Akeyless
  430. </a>
  431. </li>
  432. <li class="md-nav__item">
  433. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  434. HashiCorp Vault
  435. </a>
  436. </li>
  437. <li class="md-nav__item md-nav__item--nested">
  438. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  439. <label class="md-nav__link" for="__nav_5_7">
  440. Yandex
  441. <span class="md-nav__icon md-icon"></span>
  442. </label>
  443. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  444. <label class="md-nav__title" for="__nav_5_7">
  445. <span class="md-nav__icon md-icon"></span>
  446. Yandex
  447. </label>
  448. <ul class="md-nav__list" data-md-scrollfix>
  449. <li class="md-nav__item">
  450. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  451. Certificate Manager
  452. </a>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  456. Lockbox
  457. </a>
  458. </li>
  459. </ul>
  460. </nav>
  461. </li>
  462. <li class="md-nav__item md-nav__item--nested">
  463. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  464. <label class="md-nav__link" for="__nav_5_8">
  465. Gitlab
  466. <span class="md-nav__icon md-icon"></span>
  467. </label>
  468. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  469. <label class="md-nav__title" for="__nav_5_8">
  470. <span class="md-nav__icon md-icon"></span>
  471. Gitlab
  472. </label>
  473. <ul class="md-nav__list" data-md-scrollfix>
  474. <li class="md-nav__item">
  475. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  476. Gitlab Project Variables
  477. </a>
  478. </li>
  479. </ul>
  480. </nav>
  481. </li>
  482. <li class="md-nav__item md-nav__item--nested">
  483. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  484. <label class="md-nav__link" for="__nav_5_9">
  485. Oracle
  486. <span class="md-nav__icon md-icon"></span>
  487. </label>
  488. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  489. <label class="md-nav__title" for="__nav_5_9">
  490. <span class="md-nav__icon md-icon"></span>
  491. Oracle
  492. </label>
  493. <ul class="md-nav__list" data-md-scrollfix>
  494. <li class="md-nav__item">
  495. <a href="../provider-oracle-vault/" class="md-nav__link">
  496. Oracle Vault
  497. </a>
  498. </li>
  499. </ul>
  500. </nav>
  501. </li>
  502. <li class="md-nav__item md-nav__item--nested">
  503. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  504. <label class="md-nav__link" for="__nav_5_10">
  505. 1Password
  506. <span class="md-nav__icon md-icon"></span>
  507. </label>
  508. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  509. <label class="md-nav__title" for="__nav_5_10">
  510. <span class="md-nav__icon md-icon"></span>
  511. 1Password
  512. </label>
  513. <ul class="md-nav__list" data-md-scrollfix>
  514. <li class="md-nav__item">
  515. <a href="../provider-1password-automation/" class="md-nav__link">
  516. Secrets Automation
  517. </a>
  518. </li>
  519. </ul>
  520. </nav>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../provider-webhook/" class="md-nav__link">
  524. Webhook
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../provider-fake/" class="md-nav__link">
  529. Fake
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../provider-kubernetes/" class="md-nav__link">
  534. Kubernetes
  535. </a>
  536. </li>
  537. <li class="md-nav__item md-nav__item--nested">
  538. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  539. <label class="md-nav__link" for="__nav_5_14">
  540. senhasegura
  541. <span class="md-nav__icon md-icon"></span>
  542. </label>
  543. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  544. <label class="md-nav__title" for="__nav_5_14">
  545. <span class="md-nav__icon md-icon"></span>
  546. senhasegura
  547. </label>
  548. <ul class="md-nav__list" data-md-scrollfix>
  549. <li class="md-nav__item">
  550. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  551. DevOps Secrets Management (DSM)
  552. </a>
  553. </li>
  554. </ul>
  555. </nav>
  556. </li>
  557. </ul>
  558. </nav>
  559. </li>
  560. <li class="md-nav__item md-nav__item--nested">
  561. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  562. <label class="md-nav__link" for="__nav_6">
  563. Examples
  564. <span class="md-nav__icon md-icon"></span>
  565. </label>
  566. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  567. <label class="md-nav__title" for="__nav_6">
  568. <span class="md-nav__icon md-icon"></span>
  569. Examples
  570. </label>
  571. <ul class="md-nav__list" data-md-scrollfix>
  572. <li class="md-nav__item">
  573. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  574. FluxCD
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  579. Anchore Engine
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  584. Jenkins
  585. </a>
  586. </li>
  587. </ul>
  588. </nav>
  589. </li>
  590. <li class="md-nav__item md-nav__item--nested">
  591. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  592. <label class="md-nav__link" for="__nav_7">
  593. External Resources
  594. <span class="md-nav__icon md-icon"></span>
  595. </label>
  596. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  597. <label class="md-nav__title" for="__nav_7">
  598. <span class="md-nav__icon md-icon"></span>
  599. External Resources
  600. </label>
  601. <ul class="md-nav__list" data-md-scrollfix>
  602. <li class="md-nav__item">
  603. <a href="../eso-talks/" class="md-nav__link">
  604. Talks
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../eso-demos/" class="md-nav__link">
  609. Demos
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../eso-blogs/" class="md-nav__link">
  614. Blogs
  615. </a>
  616. </li>
  617. </ul>
  618. </nav>
  619. </li>
  620. <li class="md-nav__item md-nav__item--nested">
  621. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  622. <label class="md-nav__link" for="__nav_8">
  623. References
  624. <span class="md-nav__icon md-icon"></span>
  625. </label>
  626. <nav class="md-nav" aria-label="References" data-md-level="1">
  627. <label class="md-nav__title" for="__nav_8">
  628. <span class="md-nav__icon md-icon"></span>
  629. References
  630. </label>
  631. <ul class="md-nav__list" data-md-scrollfix>
  632. <li class="md-nav__item">
  633. <a href="../spec/" class="md-nav__link">
  634. API specification
  635. </a>
  636. </li>
  637. </ul>
  638. </nav>
  639. </li>
  640. <li class="md-nav__item md-nav__item--nested">
  641. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  642. <label class="md-nav__link" for="__nav_9">
  643. Contributing
  644. <span class="md-nav__icon md-icon"></span>
  645. </label>
  646. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  647. <label class="md-nav__title" for="__nav_9">
  648. <span class="md-nav__icon md-icon"></span>
  649. Contributing
  650. </label>
  651. <ul class="md-nav__list" data-md-scrollfix>
  652. <li class="md-nav__item">
  653. <a href="../contributing-devguide/" class="md-nav__link">
  654. Developer guide
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../contributing-process/" class="md-nav__link">
  659. Contributing Process
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../contributing-release/" class="md-nav__link">
  664. Release Process
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../contributing-coc/" class="md-nav__link">
  669. Code of Conduct
  670. </a>
  671. </li>
  672. </ul>
  673. </nav>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../roadmap/" class="md-nav__link">
  677. Roadmap
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../faq/" class="md-nav__link">
  682. FAQ
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../stability-support/" class="md-nav__link">
  687. Stability and Support
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../deprecation-policy/" class="md-nav__link">
  692. Deprecation Policy
  693. </a>
  694. </li>
  695. </ul>
  696. </nav>
  697. </div>
  698. </div>
  699. </div>
  700. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  701. <div class="md-sidebar__scrollwrap">
  702. <div class="md-sidebar__inner">
  703. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  704. <label class="md-nav__title" for="__toc">
  705. <span class="md-nav__icon md-icon"></span>
  706. Table of contents
  707. </label>
  708. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  709. <li class="md-nav__item">
  710. <a href="#none-default" class="md-nav__link">
  711. None (default)
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="#base64" class="md-nav__link">
  716. Base64
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="#base64url" class="md-nav__link">
  721. Base64URL
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="#auto" class="md-nav__link">
  726. Auto
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="#examples" class="md-nav__link">
  731. Examples
  732. </a>
  733. <nav class="md-nav" aria-label="Examples">
  734. <ul class="md-nav__list">
  735. <li class="md-nav__item">
  736. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  737. Setting Decoding strategy Auto in a DataFrom.Extract
  738. </a>
  739. </li>
  740. </ul>
  741. </nav>
  742. </li>
  743. <li class="md-nav__item">
  744. <a href="#limitations" class="md-nav__link">
  745. Limitations
  746. </a>
  747. </li>
  748. </ul>
  749. </nav>
  750. </div>
  751. </div>
  752. </div>
  753. <div class="md-content" data-md-component="content">
  754. <article class="md-content__inner md-typeset">
  755. <a href="https://github.com/external-secrets/external-secrets/edit/main/docs/guides-decoding-strategy.md" title="Edit this page" class="md-content__button md-icon">
  756. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
  757. </a>
  758. <h1 id="decoding-strategies">Decoding Strategies</h1>
  759. <p>The External Secrets Operator has the feature to allow multiple decoding strategies during an object generation.</p>
  760. <p>The <code>decodingStrategy</code> field allows the user to set the following Decoding Strategies based on their needs. <code>decodingStrategy</code> can be placed under <code>spec.data.remoteRef</code>, <code>spec.dataFrom.extract</code> or <code>spec.dataFrom.find</code>. It will configure the decoding strategy for that specific operation, leaving others with the default behavior if not set.</p>
  761. <h3 id="none-default">None (default)</h3>
  762. <p>ESO will not try to decode the secret value.</p>
  763. <h3 id="base64">Base64</h3>
  764. <p>ESO will try to decode the secret value using <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-4">base64</a> method. If the decoding fails, an error is produced.</p>
  765. <h3 id="base64url">Base64URL</h3>
  766. <p>ESO will try to decode the secret value using <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-5">base64url</a> method. If the decoding fails, an error is produced.</p>
  767. <h3 id="auto">Auto</h3>
  768. <p>ESO will try to decode using Base64/Base64URL strategies. If the decoding fails, ESO will apply decoding strategy None. No error is produced to the user.</p>
  769. <h2 id="examples">Examples</h2>
  770. <h3 id="setting-decoding-strategy-auto-in-a-datafromextract">Setting Decoding strategy Auto in a DataFrom.Extract</h3>
  771. <p>Given that we have the given secret information:
  772. <div class="highlight"><pre><span></span><code>{
  773. &quot;name&quot;: &quot;Gustavo&quot;,
  774. &quot;surname&quot;: &quot;Fring&quot;,
  775. &quot;address&quot;:&quot;aGFwcHkgc3RyZWV0&quot;,
  776. }
  777. </code></pre></div>
  778. if we apply the following dataFrom:
  779. <div class="highlight"><pre><span></span><code>spec:
  780. dataFrom:
  781. - extract:
  782. key: my-secret
  783. decodingStrategy: Auto
  784. </code></pre></div>
  785. It will render the following Kubernetes Secret:
  786. <div class="highlight"><pre><span></span><code>data:
  787. name: R3VzdGF2bw== #Gustavo
  788. surname: RnJpbmc= #Fring
  789. address: aGFwcHkgc3RyZWV0 #happy street
  790. </code></pre></div></p>
  791. <h2 id="limitations">Limitations</h2>
  792. <p>At this time, decoding Strategy Auto is only trying to check if the original input is valid to perform Base64 operations. This means that some non-encoded secret values might end up being decoded, producing gibberish. This is the case for numbered values like <code>123456</code> or some specially crafted string values such as <code>happy/street</code>. </p>
  793. <div class="admonition note">
  794. <p class="admonition-title">Note</p>
  795. <p>If you are using <code>decodeStrategy: Auto</code> and start to see ESO pulling completely wrong secret values into your kubernetes secret, consider changing it to <code>None</code> to investigate it.</p>
  796. </div>
  797. </article>
  798. </div>
  799. </div>
  800. </main>
  801. <footer class="md-footer">
  802. <nav class="md-footer__inner md-grid" aria-label="Footer">
  803. <a href="../guides-ownership-deletion-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lifecycle: ownership &amp; deletion" rel="prev">
  804. <div class="md-footer__button md-icon">
  805. <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>
  806. </div>
  807. <div class="md-footer__title">
  808. <div class="md-ellipsis">
  809. <span class="md-footer__direction">
  810. Previous
  811. </span>
  812. Lifecycle: ownership & deletion
  813. </div>
  814. </div>
  815. </a>
  816. <a href="../guides-getallsecrets/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Multiple Secrets" rel="next">
  817. <div class="md-footer__title">
  818. <div class="md-ellipsis">
  819. <span class="md-footer__direction">
  820. Next
  821. </span>
  822. Getting Multiple Secrets
  823. </div>
  824. </div>
  825. <div class="md-footer__button md-icon">
  826. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  827. </div>
  828. </a>
  829. </nav>
  830. <div class="md-footer-meta md-typeset">
  831. <div class="md-footer-meta__inner md-grid">
  832. <div class="md-copyright">
  833. <div class="md-copyright__highlight">
  834. &copy; 2022 The external-secrets Authors.<br/>
  835. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  836. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  837. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  838. </div>
  839. Made with
  840. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  841. Material for MkDocs
  842. </a>
  843. </div>
  844. </div>
  845. </div>
  846. </footer>
  847. </div>
  848. <div class="md-dialog" data-md-component="dialog">
  849. <div class="md-dialog__inner md-typeset"></div>
  850. </div>
  851. <script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../assets/javascripts/workers/search.092fa1f6.min.js", "version": {"provider": "mike"}}</script>
  852. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  853. </body>
  854. </html>