index.html 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810
  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-v1beta1/" class="md-nav__link">
  314. Upgrading to v1beta1
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../guides-using-latest-image/" class="md-nav__link">
  319. Using Latest Image
  320. </a>
  321. </li>
  322. </ul>
  323. </nav>
  324. </li>
  325. <li class="md-nav__item md-nav__item--nested">
  326. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
  327. <label class="md-nav__link" for="__nav_5">
  328. Provider
  329. <span class="md-nav__icon md-icon"></span>
  330. </label>
  331. <nav class="md-nav" aria-label="Provider" data-md-level="1">
  332. <label class="md-nav__title" for="__nav_5">
  333. <span class="md-nav__icon md-icon"></span>
  334. Provider
  335. </label>
  336. <ul class="md-nav__list" data-md-scrollfix>
  337. <li class="md-nav__item md-nav__item--nested">
  338. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
  339. <label class="md-nav__link" for="__nav_5_1">
  340. AWS
  341. <span class="md-nav__icon md-icon"></span>
  342. </label>
  343. <nav class="md-nav" aria-label="AWS" data-md-level="2">
  344. <label class="md-nav__title" for="__nav_5_1">
  345. <span class="md-nav__icon md-icon"></span>
  346. AWS
  347. </label>
  348. <ul class="md-nav__list" data-md-scrollfix>
  349. <li class="md-nav__item">
  350. <a href="../provider-aws-secrets-manager/" class="md-nav__link">
  351. Secrets Manager
  352. </a>
  353. </li>
  354. <li class="md-nav__item">
  355. <a href="../provider-aws-parameter-store/" class="md-nav__link">
  356. Parameter Store
  357. </a>
  358. </li>
  359. </ul>
  360. </nav>
  361. </li>
  362. <li class="md-nav__item md-nav__item--nested">
  363. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
  364. <label class="md-nav__link" for="__nav_5_2">
  365. Azure
  366. <span class="md-nav__icon md-icon"></span>
  367. </label>
  368. <nav class="md-nav" aria-label="Azure" data-md-level="2">
  369. <label class="md-nav__title" for="__nav_5_2">
  370. <span class="md-nav__icon md-icon"></span>
  371. Azure
  372. </label>
  373. <ul class="md-nav__list" data-md-scrollfix>
  374. <li class="md-nav__item">
  375. <a href="../provider-azure-key-vault/" class="md-nav__link">
  376. Key Vault
  377. </a>
  378. </li>
  379. </ul>
  380. </nav>
  381. </li>
  382. <li class="md-nav__item md-nav__item--nested">
  383. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_3" type="checkbox" id="__nav_5_3" >
  384. <label class="md-nav__link" for="__nav_5_3">
  385. Google
  386. <span class="md-nav__icon md-icon"></span>
  387. </label>
  388. <nav class="md-nav" aria-label="Google" data-md-level="2">
  389. <label class="md-nav__title" for="__nav_5_3">
  390. <span class="md-nav__icon md-icon"></span>
  391. Google
  392. </label>
  393. <ul class="md-nav__list" data-md-scrollfix>
  394. <li class="md-nav__item">
  395. <a href="../provider-google-secrets-manager/" class="md-nav__link">
  396. Secret Manager
  397. </a>
  398. </li>
  399. </ul>
  400. </nav>
  401. </li>
  402. <li class="md-nav__item md-nav__item--nested">
  403. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_4" type="checkbox" id="__nav_5_4" >
  404. <label class="md-nav__link" for="__nav_5_4">
  405. IBM
  406. <span class="md-nav__icon md-icon"></span>
  407. </label>
  408. <nav class="md-nav" aria-label="IBM" data-md-level="2">
  409. <label class="md-nav__title" for="__nav_5_4">
  410. <span class="md-nav__icon md-icon"></span>
  411. IBM
  412. </label>
  413. <ul class="md-nav__list" data-md-scrollfix>
  414. <li class="md-nav__item">
  415. <a href="../provider-ibm-secrets-manager/" class="md-nav__link">
  416. Secrets Manager
  417. </a>
  418. </li>
  419. </ul>
  420. </nav>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../provider-akeyless/" class="md-nav__link">
  424. Akeyless
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../provider-hashicorp-vault/" class="md-nav__link">
  429. HashiCorp Vault
  430. </a>
  431. </li>
  432. <li class="md-nav__item md-nav__item--nested">
  433. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_7" type="checkbox" id="__nav_5_7" >
  434. <label class="md-nav__link" for="__nav_5_7">
  435. Yandex
  436. <span class="md-nav__icon md-icon"></span>
  437. </label>
  438. <nav class="md-nav" aria-label="Yandex" data-md-level="2">
  439. <label class="md-nav__title" for="__nav_5_7">
  440. <span class="md-nav__icon md-icon"></span>
  441. Yandex
  442. </label>
  443. <ul class="md-nav__list" data-md-scrollfix>
  444. <li class="md-nav__item">
  445. <a href="../provider-yandex-certificate-manager/" class="md-nav__link">
  446. Certificate Manager
  447. </a>
  448. </li>
  449. <li class="md-nav__item">
  450. <a href="../provider-yandex-lockbox/" class="md-nav__link">
  451. Lockbox
  452. </a>
  453. </li>
  454. </ul>
  455. </nav>
  456. </li>
  457. <li class="md-nav__item md-nav__item--nested">
  458. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_8" type="checkbox" id="__nav_5_8" >
  459. <label class="md-nav__link" for="__nav_5_8">
  460. Gitlab
  461. <span class="md-nav__icon md-icon"></span>
  462. </label>
  463. <nav class="md-nav" aria-label="Gitlab" data-md-level="2">
  464. <label class="md-nav__title" for="__nav_5_8">
  465. <span class="md-nav__icon md-icon"></span>
  466. Gitlab
  467. </label>
  468. <ul class="md-nav__list" data-md-scrollfix>
  469. <li class="md-nav__item">
  470. <a href="../provider-gitlab-project-variables/" class="md-nav__link">
  471. Gitlab Project Variables
  472. </a>
  473. </li>
  474. </ul>
  475. </nav>
  476. </li>
  477. <li class="md-nav__item md-nav__item--nested">
  478. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_9" type="checkbox" id="__nav_5_9" >
  479. <label class="md-nav__link" for="__nav_5_9">
  480. Oracle
  481. <span class="md-nav__icon md-icon"></span>
  482. </label>
  483. <nav class="md-nav" aria-label="Oracle" data-md-level="2">
  484. <label class="md-nav__title" for="__nav_5_9">
  485. <span class="md-nav__icon md-icon"></span>
  486. Oracle
  487. </label>
  488. <ul class="md-nav__list" data-md-scrollfix>
  489. <li class="md-nav__item">
  490. <a href="../provider-oracle-vault/" class="md-nav__link">
  491. Oracle Vault
  492. </a>
  493. </li>
  494. </ul>
  495. </nav>
  496. </li>
  497. <li class="md-nav__item md-nav__item--nested">
  498. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_10" type="checkbox" id="__nav_5_10" >
  499. <label class="md-nav__link" for="__nav_5_10">
  500. 1Password
  501. <span class="md-nav__icon md-icon"></span>
  502. </label>
  503. <nav class="md-nav" aria-label="1Password" data-md-level="2">
  504. <label class="md-nav__title" for="__nav_5_10">
  505. <span class="md-nav__icon md-icon"></span>
  506. 1Password
  507. </label>
  508. <ul class="md-nav__list" data-md-scrollfix>
  509. <li class="md-nav__item">
  510. <a href="../provider-1password-automation/" class="md-nav__link">
  511. Secrets Automation
  512. </a>
  513. </li>
  514. </ul>
  515. </nav>
  516. </li>
  517. <li class="md-nav__item">
  518. <a href="../provider-webhook/" class="md-nav__link">
  519. Webhook
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="../provider-fake/" class="md-nav__link">
  524. Fake
  525. </a>
  526. </li>
  527. <li class="md-nav__item">
  528. <a href="../provider-kubernetes/" class="md-nav__link">
  529. Kubernetes
  530. </a>
  531. </li>
  532. <li class="md-nav__item md-nav__item--nested">
  533. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_14" type="checkbox" id="__nav_5_14" >
  534. <label class="md-nav__link" for="__nav_5_14">
  535. senhasegura
  536. <span class="md-nav__icon md-icon"></span>
  537. </label>
  538. <nav class="md-nav" aria-label="senhasegura" data-md-level="2">
  539. <label class="md-nav__title" for="__nav_5_14">
  540. <span class="md-nav__icon md-icon"></span>
  541. senhasegura
  542. </label>
  543. <ul class="md-nav__list" data-md-scrollfix>
  544. <li class="md-nav__item">
  545. <a href="../provider-senhasegura-dsm/" class="md-nav__link">
  546. DevOps Secrets Management (DSM)
  547. </a>
  548. </li>
  549. </ul>
  550. </nav>
  551. </li>
  552. </ul>
  553. </nav>
  554. </li>
  555. <li class="md-nav__item md-nav__item--nested">
  556. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  557. <label class="md-nav__link" for="__nav_6">
  558. Examples
  559. <span class="md-nav__icon md-icon"></span>
  560. </label>
  561. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  562. <label class="md-nav__title" for="__nav_6">
  563. <span class="md-nav__icon md-icon"></span>
  564. Examples
  565. </label>
  566. <ul class="md-nav__list" data-md-scrollfix>
  567. <li class="md-nav__item">
  568. <a href="../examples-gitops-using-fluxcd/" class="md-nav__link">
  569. FluxCD
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../examples-anchore-engine-credentials/" class="md-nav__link">
  574. Anchore Engine
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../examples-jenkins-kubernetes-credentials/" class="md-nav__link">
  579. Jenkins
  580. </a>
  581. </li>
  582. </ul>
  583. </nav>
  584. </li>
  585. <li class="md-nav__item md-nav__item--nested">
  586. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  587. <label class="md-nav__link" for="__nav_7">
  588. External Resources
  589. <span class="md-nav__icon md-icon"></span>
  590. </label>
  591. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  592. <label class="md-nav__title" for="__nav_7">
  593. <span class="md-nav__icon md-icon"></span>
  594. External Resources
  595. </label>
  596. <ul class="md-nav__list" data-md-scrollfix>
  597. <li class="md-nav__item">
  598. <a href="../eso-talks/" class="md-nav__link">
  599. Talks
  600. </a>
  601. </li>
  602. <li class="md-nav__item">
  603. <a href="../eso-demos/" class="md-nav__link">
  604. Demos
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../eso-blogs/" class="md-nav__link">
  609. Blogs
  610. </a>
  611. </li>
  612. </ul>
  613. </nav>
  614. </li>
  615. <li class="md-nav__item md-nav__item--nested">
  616. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  617. <label class="md-nav__link" for="__nav_8">
  618. References
  619. <span class="md-nav__icon md-icon"></span>
  620. </label>
  621. <nav class="md-nav" aria-label="References" data-md-level="1">
  622. <label class="md-nav__title" for="__nav_8">
  623. <span class="md-nav__icon md-icon"></span>
  624. References
  625. </label>
  626. <ul class="md-nav__list" data-md-scrollfix>
  627. <li class="md-nav__item">
  628. <a href="../spec/" class="md-nav__link">
  629. API specification
  630. </a>
  631. </li>
  632. </ul>
  633. </nav>
  634. </li>
  635. <li class="md-nav__item md-nav__item--nested">
  636. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  637. <label class="md-nav__link" for="__nav_9">
  638. Contributing
  639. <span class="md-nav__icon md-icon"></span>
  640. </label>
  641. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  642. <label class="md-nav__title" for="__nav_9">
  643. <span class="md-nav__icon md-icon"></span>
  644. Contributing
  645. </label>
  646. <ul class="md-nav__list" data-md-scrollfix>
  647. <li class="md-nav__item">
  648. <a href="../contributing-devguide/" class="md-nav__link">
  649. Developer guide
  650. </a>
  651. </li>
  652. <li class="md-nav__item">
  653. <a href="../contributing-process/" class="md-nav__link">
  654. Contributing Process
  655. </a>
  656. </li>
  657. <li class="md-nav__item">
  658. <a href="../contributing-release/" class="md-nav__link">
  659. Release Process
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../contributing-coc/" class="md-nav__link">
  664. Code of Conduct
  665. </a>
  666. </li>
  667. </ul>
  668. </nav>
  669. </li>
  670. <li class="md-nav__item">
  671. <a href="../roadmap/" class="md-nav__link">
  672. Roadmap
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="../faq/" class="md-nav__link">
  677. FAQ
  678. </a>
  679. </li>
  680. <li class="md-nav__item">
  681. <a href="../stability-support/" class="md-nav__link">
  682. Stability and Support
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../deprecation-policy/" class="md-nav__link">
  687. Deprecation Policy
  688. </a>
  689. </li>
  690. </ul>
  691. </nav>
  692. </div>
  693. </div>
  694. </div>
  695. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  696. <div class="md-sidebar__scrollwrap">
  697. <div class="md-sidebar__inner">
  698. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  699. <label class="md-nav__title" for="__toc">
  700. <span class="md-nav__icon md-icon"></span>
  701. Table of contents
  702. </label>
  703. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  704. <li class="md-nav__item">
  705. <a href="#none-default" class="md-nav__link">
  706. None (default)
  707. </a>
  708. </li>
  709. <li class="md-nav__item">
  710. <a href="#base64" class="md-nav__link">
  711. Base64
  712. </a>
  713. </li>
  714. <li class="md-nav__item">
  715. <a href="#base64url" class="md-nav__link">
  716. Base64URL
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="#auto" class="md-nav__link">
  721. Auto
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="#examples" class="md-nav__link">
  726. Examples
  727. </a>
  728. <nav class="md-nav" aria-label="Examples">
  729. <ul class="md-nav__list">
  730. <li class="md-nav__item">
  731. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  732. Setting Decoding strategy Auto in a DataFrom.Extract
  733. </a>
  734. </li>
  735. </ul>
  736. </nav>
  737. </li>
  738. <li class="md-nav__item">
  739. <a href="#limitations" class="md-nav__link">
  740. Limitations
  741. </a>
  742. </li>
  743. </ul>
  744. </nav>
  745. </div>
  746. </div>
  747. </div>
  748. <div class="md-content" data-md-component="content">
  749. <article class="md-content__inner md-typeset">
  750. <a href="https://github.com/external-secrets/external-secrets/edit/master/docs/guides-decoding-strategy.md" title="Edit this page" class="md-content__button md-icon">
  751. <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>
  752. </a>
  753. <h1 id="decoding-strategies">Decoding Strategies</h1>
  754. <p>The External Secrets Operator has the feature to allow multiple decoding strategies during an object generation.</p>
  755. <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>
  756. <h3 id="none-default">None (default)</h3>
  757. <p>ESO will not try to decode the secret value.</p>
  758. <h3 id="base64">Base64</h3>
  759. <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>
  760. <h3 id="base64url">Base64URL</h3>
  761. <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>
  762. <h3 id="auto">Auto</h3>
  763. <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>
  764. <h2 id="examples">Examples</h2>
  765. <h3 id="setting-decoding-strategy-auto-in-a-datafromextract">Setting Decoding strategy Auto in a DataFrom.Extract</h3>
  766. <p>Given that we have the given secret information:
  767. <div class="highlight"><pre><span></span><code>{
  768. &quot;name&quot;: &quot;Gustavo&quot;,
  769. &quot;surname&quot;: &quot;Fring&quot;,
  770. &quot;address&quot;:&quot;aGFwcHkgc3RyZWV0&quot;,
  771. }
  772. </code></pre></div>
  773. if we apply the following dataFrom:
  774. <div class="highlight"><pre><span></span><code>spec:
  775. dataFrom:
  776. - extract:
  777. key: my-secret
  778. decodingStrategy: Auto
  779. </code></pre></div>
  780. It will render the following Kubernetes Secret:
  781. <div class="highlight"><pre><span></span><code>data:
  782. name: R3VzdGF2bw== #Gustavo
  783. surname: RnJpbmc= #Fring
  784. address: aGFwcHkgc3RyZWV0 #happy street
  785. </code></pre></div></p>
  786. <h2 id="limitations">Limitations</h2>
  787. <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>
  788. <div class="admonition note">
  789. <p class="admonition-title">Note</p>
  790. <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>
  791. </div>
  792. </article>
  793. </div>
  794. </div>
  795. </main>
  796. <footer class="md-footer">
  797. <nav class="md-footer__inner md-grid" aria-label="Footer">
  798. <a href="../guides-ownership-deletion-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lifecycle: ownership &amp; deletion" rel="prev">
  799. <div class="md-footer__button md-icon">
  800. <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>
  801. </div>
  802. <div class="md-footer__title">
  803. <div class="md-ellipsis">
  804. <span class="md-footer__direction">
  805. Previous
  806. </span>
  807. Lifecycle: ownership & deletion
  808. </div>
  809. </div>
  810. </a>
  811. <a href="../guides-getallsecrets/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Multiple Secrets" rel="next">
  812. <div class="md-footer__title">
  813. <div class="md-ellipsis">
  814. <span class="md-footer__direction">
  815. Next
  816. </span>
  817. Getting Multiple Secrets
  818. </div>
  819. </div>
  820. <div class="md-footer__button md-icon">
  821. <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>
  822. </div>
  823. </a>
  824. </nav>
  825. <div class="md-footer-meta md-typeset">
  826. <div class="md-footer-meta__inner md-grid">
  827. <div class="md-copyright">
  828. Made with
  829. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  830. Material for MkDocs
  831. </a>
  832. </div>
  833. </div>
  834. </div>
  835. </footer>
  836. </div>
  837. <div class="md-dialog" data-md-component="dialog">
  838. <div class="md-dialog__inner md-typeset"></div>
  839. </div>
  840. <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>
  841. <script src="../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  842. </body>
  843. </html>