File: //usr/local/share/man/man3/Cookie::Baker.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Cookie::Baker 3pm"
.TH Cookie::Baker 3pm "2019-06-07" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Cookie::Baker \- Cookie string generator / parser
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Cookie::Baker;
\&
\& $headers\->push_header(\*(AqSet\-Cookie\*(Aq, bake_cookie($key,$val));
\&
\& my $cookies_hashref = crush_cookie($headers\->header(\*(AqCookie\*(Aq));
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Cookie::Baker provides simple cookie string generator and parser.
.SH "XS IMPLEMENTATION"
.IX Header "XS IMPLEMENTATION"
This module tries to use Cookie::Baker::XS's crush_cookie by default.
If this fails, it will use Cookie::Baker's pure Perl crush_cookie.
.PP
There is no \s-1XS\s0 implementation of bake_cookie yet.
.SH "FUNCTION"
.IX Header "FUNCTION"
.IP "bake_cookie" 4
.IX Item "bake_cookie"
.Vb 7
\& my $cookie = bake_cookie(\*(Aqfoo\*(Aq,\*(Aqval\*(Aq);
\& my $cookie = bake_cookie(\*(Aqfoo\*(Aq, {
\& value => \*(Aqval\*(Aq,
\& path => "test",
\& domain => \*(Aq.example.com\*(Aq,
\& expires => \*(Aq+24h\*(Aq
\& } );
.Ve
.Sp
Generates a cookie string for an \s-1HTTP\s0 response header.
The first argument is the cookie's name and the second argument is a plain string or hash reference that
can contain keys such as \f(CW\*(C`value\*(C'\fR, \f(CW\*(C`domain\*(C'\fR, \f(CW\*(C`expires\*(C'\fR, \f(CW\*(C`path\*(C'\fR, \f(CW\*(C`httponly\*(C'\fR, \f(CW\*(C`secure\*(C'\fR,
\&\f(CW\*(C`max\-age\*(C'\fR, \f(CW\*(C`samesite\*(C'\fR.
.RS 4
.IP "value" 4
.IX Item "value"
Cookie's value.
.IP "domain" 4
.IX Item "domain"
Cookie's domain.
.IP "expires" 4
.IX Item "expires"
Cookie's expires date time. Several formats are supported:
.Sp
.Vb 9
\& expires => time + 24 * 60 * 60 # epoch time
\& expires => \*(AqWed, 03\-Nov\-2010 20:54:16 GMT\*(Aq
\& expires => \*(Aq+30s\*(Aq # 30 seconds from now
\& expires => \*(Aq+10m\*(Aq # ten minutes from now
\& expires => \*(Aq+1h\*(Aq # one hour from now
\& expires => \*(Aq\-1d\*(Aq # yesterday (i.e. "ASAP!")
\& expires => \*(Aq+3M\*(Aq # in three months
\& expires => \*(Aq+10y\*(Aq # in ten years time (60*60*24*365*10 seconds)
\& expires => \*(Aqnow\*(Aq #immediately
.Ve
.IP "max-age" 4
.IX Item "max-age"
If defined, sets the max-age for the cookie.
.IP "path" 4
.IX Item "path"
Cookie's path.
.IP "httponly" 4
.IX Item "httponly"
If true, sets HttpOnly flag. false by default.
.IP "secure" 4
.IX Item "secure"
If true, sets secure flag. false by default.
.IP "samesite" 4
.IX Item "samesite"
If defined as 'lax' or 'strict' or 'none' (case-insensitive), sets the SameSite restriction for the cookie as described in the
draft proposal <https://tools.ietf.org/html/draft-west-first-party-cookies-07>, which is already implemented in
Chrome (v51), Safari (v12), Edge (v16), Opera (v38) and Firefox (v60).
.RE
.RS 4
.RE
.IP "crush_cookie" 4
.IX Item "crush_cookie"
Parses cookie string and returns a hashref.
.Sp
.Vb 2
\& my $cookies_hashref = crush_cookie($headers\->header(\*(AqCookie\*(Aq));
\& my $cookie_value = $cookies_hashref\->{cookie_name}
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1CPAN\s0 already has many cookie related modules. But there is no simple cookie string generator and parser module.
.PP
\&\s-1CGI\s0, CGI::Simple, Plack, Dancer::Cookie
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) Masahiro Nagano.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Masahiro Nagano <kazeburo@gmail.com>