index.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845
  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="../../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="../introduction/" class="md-nav__link">
  187. Introduction
  188. </a>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="../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="../templating/" class="md-nav__link">
  209. v2
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="../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="../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="../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="../controller-class/" class="md-nav__link">
  232. Controller Classes
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="../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="../getallsecrets/" class="md-nav__link">
  299. Getting Multiple Secrets
  300. </a>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="../multi-tenancy/" class="md-nav__link">
  304. Multi Tenancy
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../metrics/" class="md-nav__link">
  309. Metrics
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="../datafrom-rewrite/" class="md-nav__link">
  314. Rewriting Keys
  315. </a>
  316. </li>
  317. <li class="md-nav__item">
  318. <a href="../v1beta1/" class="md-nav__link">
  319. Upgrading to v1beta1
  320. </a>
  321. </li>
  322. <li class="md-nav__item">
  323. <a href="../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. <li class="md-nav__item">
  558. <a href="../../provider/doppler/" class="md-nav__link">
  559. Doppler
  560. </a>
  561. </li>
  562. </ul>
  563. </nav>
  564. </li>
  565. <li class="md-nav__item md-nav__item--nested">
  566. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
  567. <label class="md-nav__link" for="__nav_6">
  568. Examples
  569. <span class="md-nav__icon md-icon"></span>
  570. </label>
  571. <nav class="md-nav" aria-label="Examples" data-md-level="1">
  572. <label class="md-nav__title" for="__nav_6">
  573. <span class="md-nav__icon md-icon"></span>
  574. Examples
  575. </label>
  576. <ul class="md-nav__list" data-md-scrollfix>
  577. <li class="md-nav__item">
  578. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  579. FluxCD
  580. </a>
  581. </li>
  582. <li class="md-nav__item">
  583. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  584. Anchore Engine
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  589. Jenkins
  590. </a>
  591. </li>
  592. </ul>
  593. </nav>
  594. </li>
  595. <li class="md-nav__item md-nav__item--nested">
  596. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
  597. <label class="md-nav__link" for="__nav_7">
  598. External Resources
  599. <span class="md-nav__icon md-icon"></span>
  600. </label>
  601. <nav class="md-nav" aria-label="External Resources" data-md-level="1">
  602. <label class="md-nav__title" for="__nav_7">
  603. <span class="md-nav__icon md-icon"></span>
  604. External Resources
  605. </label>
  606. <ul class="md-nav__list" data-md-scrollfix>
  607. <li class="md-nav__item">
  608. <a href="../../eso-talks/" class="md-nav__link">
  609. Talks
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../eso-demos/" class="md-nav__link">
  614. Demos
  615. </a>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../../eso-blogs/" class="md-nav__link">
  619. Blogs
  620. </a>
  621. </li>
  622. </ul>
  623. </nav>
  624. </li>
  625. <li class="md-nav__item md-nav__item--nested">
  626. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
  627. <label class="md-nav__link" for="__nav_8">
  628. References
  629. <span class="md-nav__icon md-icon"></span>
  630. </label>
  631. <nav class="md-nav" aria-label="References" data-md-level="1">
  632. <label class="md-nav__title" for="__nav_8">
  633. <span class="md-nav__icon md-icon"></span>
  634. References
  635. </label>
  636. <ul class="md-nav__list" data-md-scrollfix>
  637. <li class="md-nav__item">
  638. <a href="../../spec/" class="md-nav__link">
  639. API specification
  640. </a>
  641. </li>
  642. </ul>
  643. </nav>
  644. </li>
  645. <li class="md-nav__item md-nav__item--nested">
  646. <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
  647. <label class="md-nav__link" for="__nav_9">
  648. Contributing
  649. <span class="md-nav__icon md-icon"></span>
  650. </label>
  651. <nav class="md-nav" aria-label="Contributing" data-md-level="1">
  652. <label class="md-nav__title" for="__nav_9">
  653. <span class="md-nav__icon md-icon"></span>
  654. Contributing
  655. </label>
  656. <ul class="md-nav__list" data-md-scrollfix>
  657. <li class="md-nav__item">
  658. <a href="../../contributing/devguide/" class="md-nav__link">
  659. Developer guide
  660. </a>
  661. </li>
  662. <li class="md-nav__item">
  663. <a href="../../contributing/process/" class="md-nav__link">
  664. Contributing Process
  665. </a>
  666. </li>
  667. <li class="md-nav__item">
  668. <a href="../../contributing/release/" class="md-nav__link">
  669. Release Process
  670. </a>
  671. </li>
  672. <li class="md-nav__item">
  673. <a href="../../contributing/coc/" class="md-nav__link">
  674. Code of Conduct
  675. </a>
  676. </li>
  677. <li class="md-nav__item">
  678. <a href="../../contributing/roadmap/" class="md-nav__link">
  679. Roadmap
  680. </a>
  681. </li>
  682. </ul>
  683. </nav>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../../faq/" class="md-nav__link">
  687. FAQ
  688. </a>
  689. </li>
  690. <li class="md-nav__item">
  691. <a href="../../stability-support/" class="md-nav__link">
  692. Stability and Support
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="../../deprecation-policy/" class="md-nav__link">
  697. Deprecation Policy
  698. </a>
  699. </li>
  700. </ul>
  701. </nav>
  702. </div>
  703. </div>
  704. </div>
  705. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  706. <div class="md-sidebar__scrollwrap">
  707. <div class="md-sidebar__inner">
  708. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  709. <label class="md-nav__title" for="__toc">
  710. <span class="md-nav__icon md-icon"></span>
  711. Table of contents
  712. </label>
  713. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  714. <li class="md-nav__item">
  715. <a href="#none-default" class="md-nav__link">
  716. None (default)
  717. </a>
  718. </li>
  719. <li class="md-nav__item">
  720. <a href="#base64" class="md-nav__link">
  721. Base64
  722. </a>
  723. </li>
  724. <li class="md-nav__item">
  725. <a href="#base64url" class="md-nav__link">
  726. Base64URL
  727. </a>
  728. </li>
  729. <li class="md-nav__item">
  730. <a href="#auto" class="md-nav__link">
  731. Auto
  732. </a>
  733. </li>
  734. <li class="md-nav__item">
  735. <a href="#examples" class="md-nav__link">
  736. Examples
  737. </a>
  738. <nav class="md-nav" aria-label="Examples">
  739. <ul class="md-nav__list">
  740. <li class="md-nav__item">
  741. <a href="#setting-decoding-strategy-auto-in-a-datafromextract" class="md-nav__link">
  742. Setting Decoding strategy Auto in a DataFrom.Extract
  743. </a>
  744. </li>
  745. </ul>
  746. </nav>
  747. </li>
  748. <li class="md-nav__item">
  749. <a href="#limitations" class="md-nav__link">
  750. Limitations
  751. </a>
  752. </li>
  753. </ul>
  754. </nav>
  755. </div>
  756. </div>
  757. </div>
  758. <div class="md-content" data-md-component="content">
  759. <article class="md-content__inner md-typeset">
  760. <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">
  761. <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>
  762. </a>
  763. <h1 id="decoding-strategies">Decoding Strategies</h1>
  764. <p>The External Secrets Operator has the feature to allow multiple decoding strategies during an object generation.</p>
  765. <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>
  766. <h3 id="none-default">None (default)</h3>
  767. <p>ESO will not try to decode the secret value.</p>
  768. <h3 id="base64">Base64</h3>
  769. <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>
  770. <h3 id="base64url">Base64URL</h3>
  771. <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>
  772. <h3 id="auto">Auto</h3>
  773. <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>
  774. <h2 id="examples">Examples</h2>
  775. <h3 id="setting-decoding-strategy-auto-in-a-datafromextract">Setting Decoding strategy Auto in a DataFrom.Extract</h3>
  776. <p>Given that we have the given secret information:
  777. <div class="highlight"><pre><span></span><code>{
  778. &quot;name&quot;: &quot;Gustavo&quot;,
  779. &quot;surname&quot;: &quot;Fring&quot;,
  780. &quot;address&quot;:&quot;aGFwcHkgc3RyZWV0&quot;,
  781. }
  782. </code></pre></div>
  783. if we apply the following dataFrom:
  784. <div class="highlight"><pre><span></span><code>spec:
  785. dataFrom:
  786. - extract:
  787. key: my-secret
  788. decodingStrategy: Auto
  789. </code></pre></div>
  790. It will render the following Kubernetes Secret:
  791. <div class="highlight"><pre><span></span><code>data:
  792. name: R3VzdGF2bw== #Gustavo
  793. surname: RnJpbmc= #Fring
  794. address: aGFwcHkgc3RyZWV0 #happy street
  795. </code></pre></div></p>
  796. <h2 id="limitations">Limitations</h2>
  797. <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>
  798. <div class="admonition note">
  799. <p class="admonition-title">Note</p>
  800. <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>
  801. </div>
  802. </article>
  803. </div>
  804. </div>
  805. </main>
  806. <footer class="md-footer">
  807. <nav class="md-footer__inner md-grid" aria-label="Footer">
  808. <a href="../ownership-deletion-policy/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lifecycle: ownership &amp; deletion" rel="prev">
  809. <div class="md-footer__button md-icon">
  810. <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>
  811. </div>
  812. <div class="md-footer__title">
  813. <div class="md-ellipsis">
  814. <span class="md-footer__direction">
  815. Previous
  816. </span>
  817. Lifecycle: ownership & deletion
  818. </div>
  819. </div>
  820. </a>
  821. <a href="../getallsecrets/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Multiple Secrets" rel="next">
  822. <div class="md-footer__title">
  823. <div class="md-ellipsis">
  824. <span class="md-footer__direction">
  825. Next
  826. </span>
  827. Getting Multiple Secrets
  828. </div>
  829. </div>
  830. <div class="md-footer__button md-icon">
  831. <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>
  832. </div>
  833. </a>
  834. </nav>
  835. <div class="md-footer-meta md-typeset">
  836. <div class="md-footer-meta__inner md-grid">
  837. <div class="md-copyright">
  838. <div class="md-copyright__highlight">
  839. &copy; 2022 The external-secrets Authors.<br/>
  840. &copy; 2022 The Linux Foundation. All rights reserved.<br/><br/>
  841. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  842. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  843. </div>
  844. Made with
  845. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  846. Material for MkDocs
  847. </a>
  848. </div>
  849. </div>
  850. </div>
  851. </footer>
  852. </div>
  853. <div class="md-dialog" data-md-component="dialog">
  854. <div class="md-dialog__inner md-typeset"></div>
  855. </div>
  856. <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>
  857. <script src="../../assets/javascripts/bundle.e3b2bf44.min.js"></script>
  858. </body>
  859. </html>