<titledata-react-helmet="true">Session Storage | OAuth2 Proxy</title><metadata-react-helmet="true"name="twitter:card"content="summary_large_image"><metadata-react-helmet="true"name="docusaurus_language"content="en"><metadata-react-helmet="true"name="docusaurus_version"content="7.1.x"><metadata-react-helmet="true"name="docusaurus_tag"content="docs-default-7.1.x"><metadata-react-helmet="true"property="og:title"content="Session Storage | OAuth2 Proxy"><metadata-react-helmet="true"name="description"content="Sessions allow a user's authentication to be tracked between multiple HTTP"><metadata-react-helmet="true"property="og:description"content="Sessions allow a user's authentication to be tracked between multiple HTTP"><metadata-react-helmet="true"property="og:url"content="https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/session_storage"><linkdata-react-helmet="true"rel="shortcut icon"href="/oauth2-proxy/img/logos/OAuth2_Proxy_icon.svg"><linkdata-react-helmet="true"rel="canonical"href="https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/session_storage"><linkrel="stylesheet"href="/oauth2-proxy/styles.b2862157.css">
requests to a service.</p><p>The OAuth2 Proxy uses a Cookie to track user sessions and will store the session
data in one of the available session storage backends.</p><p>At present the available backends are (as passed to <code>--session-store-type</code>):</p><ul><li><ahref="#cookie-storage">cookie</a> (default)</li><li><ahref="#redis-storage">redis</a></li></ul><h3><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2cZh"id="cookie-storage"></a>Cookie Storage<aaria-hidden="true"tabindex="-1"class="hash-link"href="#cookie-storage"title="Direct link to heading">#</a></h3><p>The Cookie storage backend is the default backend implementation and has
been used in the OAuth2 Proxy historically.</p><p>With the Cookie storage backend, all session information is stored in client
side cookies and transferred with each and every request.</p><p>The following should be known when using this implementation:</p><ul><li>Since all state is stored client side, this storage backend means that the OAuth2 Proxy is completely stateless</li><li>Cookies are signed server side to prevent modification client-side</li><li>It is mandatory to set a <code>cookie-secret</code> which will ensure data is encrypted within the cookie data.</li><li>Since multiple requests can be made concurrently to the OAuth2 Proxy, this session implementation
cannot lock sessions and while updating and refreshing sessions, there can be conflicts which force
users to re-authenticate</li></ul><h3><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2cZh"id="redis-storage"></a>Redis Storage<aaria-hidden="true"tabindex="-1"class="hash-link"href="#redis-storage"title="Direct link to heading">#</a></h3><p>The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information
to the user as the cookie value instead.</p><p>A ticket is composed as the following:</p><p><code>{CookieName}-{ticketID}.{secret}</code></p><p>Where:</p><ul><li>The <code>CookieName</code> is the OAuth2 cookie name (_oauth2_proxy by default)</li><li>The <code>ticketID</code> is a 128 bit random number, hex-encoded</li><li>The <code>secret</code> is a 128 bit random number, base64url encoded (no padding). The secret is unique for every session.</li><li>The pair of <code>{CookieName}-{ticketID}</code> comprises a ticket handle, and thus, the redis key
to which the session is stored. The encoded session is encrypted with the secret and stored
in redis via the <code>SETEX</code> command.</li></ul><p>Encrypting every session uniquely protects the refresh/access/id tokens stored in the session from
disclosure.</p><h4><aaria-hidden="true"tabindex="-1"class="anchor enhancedAnchor_2cZh"id="usage"></a>Usage<aaria-hidden="true"tabindex="-1"class="hash-link"href="#usage"title="Direct link to heading">#</a></h4><p>When using the redis store, specify <code>--session-store-type=redis</code> as well as the Redis connection URL, via
<code>--redis-connection-url=redis://host[:port][/db-number]</code>.</p><p>You may also configure the store for Redis Sentinel. In this case, you will want to use the
<code>--redis-use-sentinel=true</code> flag, as well as configure the flags <code>--redis-sentinel-master-name</code>
and <code>--redis-sentinel-connection-urls</code> appropriately.</p><p>Redis Cluster is available to be the backend store as well. To leverage it, you will need to set the
