umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00
Code Issues Wiki Activity

Change the order of set_resp_cookie arguments

Browse source 
The Opts value is put last, to be more consistent with the
rest of the cowboy_req module.

Additionally a test handler was fixed which reduced the number
of errors in http_SUITE.
This commit is contained in:
Loïc Hoguin 2017-02-19 09:46:11 +01:00
parent 87a05a1219
commit 91ae70b06c
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
6 changed files with 34 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

27
doc/src/guide/cookies.asciidoc
View file

@ -33,24 +33,21 @@ update the expiration time and avoid losing a cookie.
=== Setting cookies
// @todo So I am not particularly happy about set_resp_cookie/4
// having Opts as a *third* argument, instead of the *last* like
// all other functions that come with an Opts argument. We will
// probably need to change this before 2.0.
By default cookies are defined for the duration of the session:
[source,erlang]
----
SessionID = generate_session_id(),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0).
----
They can also be set for a duration in seconds:
[source,erlang]
----
SessionID = generate_session_id(),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
#{max_age => 3600}, Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
#{max_age => 3600}).
----
To delete cookies, set `max_age` to 0:
@ -58,8 +55,8 @@ To delete cookies, set `max_age` to 0:
[source,erlang]
----
SessionID = generate_session_id(),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
#{max_age => 0}, Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
#{max_age => 0}).
----
To restrict cookies to a specific domain and path, the options
@ -67,8 +64,8 @@ of the same name can be used:
[source,erlang]
----
Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>,
#{domain => "my.example.org", path => "/account"}, Req0).
Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>, Req0,
#{domain => "my.example.org", path => "/account"}).
----
Cookies will be sent with requests to this domain and all
@ -81,8 +78,8 @@ available over HTTPS):
[source,erlang]
----
SessionID = generate_session_id(),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
#{secure => true}, Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
#{secure => true}).
----
To prevent client-side scripts from accessing a cookie:
@ -90,8 +87,8 @@ To prevent client-side scripts from accessing a cookie:
[source,erlang]
----
SessionID = generate_session_id(),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
#{http_only => true}, Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
#{http_only => true}).
----
Cookies may also be set client-side, for example using

36
doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
View file

@ -11,7 +11,7 @@ cowboy_req:set_resp_cookie - Set a cookie
set_resp_cookie(Name, Value, Req :: cowboy_req:req())
-> set_resp_cookie(Name, Value, [], Req)
set_resp_cookie(Name, Value, Opts, Req :: cowboy_req:req())
set_resp_cookie(Name, Value, Req :: cowboy_req:req(), Opts)
-> Req
Name :: binary() %% case sensitive
@ -33,14 +33,14 @@ Value::
Cookie value.
Opts::
Optional cookie options.
Req::
The Req object.
Opts::
Cookie options.
== Return value
A new Req object is returned.
@ -66,44 +66,38 @@ Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0).
.Set a cookie with an expiration time
[source,erlang]
----
Req = cowboy_req:set_resp_cookie(<<"lang">>, <<"fr-FR">>, [
{max_age, 3600}
], Req0).
Req = cowboy_req:set_resp_cookie(<<"lang">>, <<"fr-FR">>,
Req0, #{max_age => 3600}).
----
.Delete a cookie
[source,erlang]
----
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, <<>>, [
{max_age, 0}
], Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, <<>>,
Req0, #{max_age => 0}).
----
.Set a cookie for a specific domain and path
[source,erlang]
----
Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>, [
{domain, "my.example.org"},
{path, "/account"}
], Req0).
Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>,
Req0, #{domain => "my.example.org", path => "/account"}).
----
.Restrict a cookie to HTTPS
[source,erlang]
----
SessionID = base64:encode(crypto:strong_rand_bytes(32)),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, [
{secure, true}
], Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
Req0, #{secure => true}).
----
.Restrict a cookie to HTTP
[source,erlang]
----
SessionID = base64:encode(crypto:strong_rand_bytes(32)),
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, [
{http_only, true}
], Req0).
Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
Req0, #{http_only => true}).
----
== See also