|
@@ -12,10 +12,33 @@ and manipulating cookie headers.
|
|
|
== Exports
|
|
|
|
|
|
* link:man:cow_cookie:parse_cookie(3)[cow_cookie:parse_cookie(3)] - Parse a cookie header
|
|
|
+* link:man:cow_cookie:parse_set_cookie(3)[cow_cookie:parse_set_cookie(3)] - Parse a set-cookie header
|
|
|
+* link:man:cow_cookie:cookie(3)[cow_cookie:cookie(3)] - Generate a cookie header
|
|
|
* link:man:cow_cookie:setcookie(3)[cow_cookie:setcookie(3)] - Generate a set-cookie header
|
|
|
|
|
|
== Types
|
|
|
|
|
|
+=== cookie_attrs()
|
|
|
+
|
|
|
+[source,erlang]
|
|
|
+----
|
|
|
+cookie_attrs() :: #{
|
|
|
+ expires => calendar:datetime(),
|
|
|
+ max_age => calendar:datetime(),
|
|
|
+ domain => binary(),
|
|
|
+ path => binary(),
|
|
|
+ secure => true,
|
|
|
+ http_only => true,
|
|
|
+ same_site => strict | lax
|
|
|
+}
|
|
|
+----
|
|
|
+
|
|
|
+Cookie attributes parsed from the set-cookie header.
|
|
|
+The attributes must be passed as-is to a cookie store
|
|
|
+engine for processing, along with the cookie name and value.
|
|
|
+More information about the attributes can be found in
|
|
|
+https://tools.ietf.org/html/rfc6265[RFC 6265].
|
|
|
+
|
|
|
=== cookie_opts()
|
|
|
|
|
|
[source,erlang]
|
|
@@ -72,6 +95,11 @@ Whether the cookie should be sent only on secure channels
|
|
|
integrity of the cookie, only its confidentiality during
|
|
|
transfer. By default there are no restrictions.
|
|
|
|
|
|
+== Changelog
|
|
|
+
|
|
|
+* *2.9*: The `cookie_attrs` type was added.
|
|
|
+* *1.0*: Module introduced.
|
|
|
+
|
|
|
== See also
|
|
|
|
|
|
link:man:cowlib(7)[cowlib(7)],
|