.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "HTML::FormHandler::Field::RequestToken 3pm"
.TH HTML::FormHandler::Field::RequestToken 3pm "2017-11-11" "perl v5.26.1" "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"
HTML::FormHandler::Field::RequestToken \- Hidden text field which contains
a unique time\-stamped token
.SH "VERSION"
.IX Header "VERSION"
version 0.40068
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    with \*(AqHTML::FormHandler::Field::Role::RequestToken\*(Aq;
\&    ...
\&    has_field \*(Aq_token\*(Aq => (
\&        type => \*(AqRequestToken\*(Aq,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This field is for preventing \s-1CSRF\s0 attacks.  It contains
an encrypted token containing an expiration time for the form.
No data needs to be persisted in the user's session or on the
server.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "expiration_time"
.IX Subsection "expiration_time"
Length of time (in seconds) that token will be accepted as valid from
the time it is initially generated. Defaults to \f(CW3600\fR.
.SS "token_prefix"
.IX Subsection "token_prefix"
An optional string to prepend to the token value before encrypting it.
If specified, any received tokens must begin with this value to be
accepted as valid.  Defaults to an empty string.
.PP
Passed on form process. \f(CW\*(C`$c\->sessionid . \*(Aq|\*(Aq\*(C'\fR
.SS "crypto_key"
.IX Subsection "crypto_key"
Key to use to encrypt/decrypt the token payload.
.SS "crypto_cipher_type"
.IX Subsection "crypto_cipher_type"
The \f(CW\*(C`Crypt::CBC\*(C'\fR cipher to use to encrypt/decrypt the token payload.
Defaults to \f(CW\*(C`Blowfish\*(C'\fR.
.SS "message"
.IX Subsection "message"
Error message if token is missing/invalid.
.SS "cipher"
.IX Subsection "cipher"
A \f(CW\*(C`Crypt::CBC\*(C'\fR object to handle encrypting/decrypting the token payload.
If not specified, \*(L"crypto_key\*(R" and \*(L"crypto_cipher_type\*(R" will be
used to construct one.
.SS "verify_token"
.IX Subsection "verify_token"
Validates whether the specified token is currently valid for this form.
.SS "get_token"
.IX Subsection "get_token"
Generates a new token and returns it.
.SH "AUTHOR"
.IX Header "AUTHOR"
FormHandler Contributors \- see HTML::FormHandler
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Gerda Shank.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.