diff options
| author | Loïc Hoguin <[email protected]> | 2024-01-29 15:40:26 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2024-01-29 15:40:26 +0100 |
| commit | 2368dc53d0c724f1899aeb2874ba1a763e11f0b8 (patch) | |
| tree | 37343cf8386eb4b02a096ac507b2208d84b07b43 /docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html | |
| parent | c4b13de35093b72a84c8782c0e8b0461d4aeaa13 (diff) | |
| download | ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.tar.gz ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.tar.bz2 ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.zip | |
Cowboy 2.11
Diffstat (limited to 'docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html')
| -rw-r--r-- | docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html | 199 |
1 files changed, 199 insertions, 0 deletions
diff --git a/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html b/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html new file mode 100644 index 00000000..2e7577bc --- /dev/null +++ b/docs/en/cowboy/2.11/manual/cowboy_req.filter_cookies/index.html @@ -0,0 +1,199 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:filter_cookies(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=7" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + </head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:filter_cookies(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:filter_cookies - Filter cookie headers</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">filter_cookies</font></b>(<font color="#009900">Names</font>, <font color="#009900">Req</font>) <font color="#990000">-></font> <font color="#009900">Req</font> + +<font color="#009900">Names</font> <font color="#990000">::</font> [<b><font color="#000080">atom</font></b>() | <b><font color="#000080">binary</font></b>()]</tt></pre> +</div></div> +<p>Filter cookie headers.</p> +<p>This function is meant to be used before attempting to parse or match cookies in order to remove cookies that are not relevant and are potentially malformed. Because Cowboy by default crashes on malformed cookies, this function allows processing requests that would otherwise result in a 400 error.</p> +<p>Malformed cookies are unfortunately fairly common due to the string-based interface provided by browsers and this function provides a middle ground between Cowboy's strict behavior and chaotic real world use cases.</p> +<p>Note that there may still be crashes even after filtering cookies because this function does not correct malformed values. Cookies that have malformed values should probably be unset in an error response or in a redirect.</p> +<p>This function can be called even if there are no cookies in the request.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Names</dt> +<dd><p>The cookies that should be kept.</p> +</dd> +<dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The Req object is returned with its cookie header value filtered.</p> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.7</strong>: Function introduced. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Filter then parse cookies</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">Req</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:filter_cookies</font></b>([<font color="#FF6600">session_id</font>, <font color="#FF6600">token</font>], <font color="#009900">Req0</font>), +<font color="#009900">Cookies</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_cookies</font></b>(<font color="#009900">Req</font>)<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.parse_cookies">cowboy_req:parse_cookies(3)</a>, <a href="../cowboy_req.match_cookies">cowboy_req:match_cookies(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.11 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.11/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.11/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + |