.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "OAuth::Lite2::Signer 3pm"
.TH OAuth::Lite2::Signer 3pm "2023-02-05" "perl v5.36.0" "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"
OAuth::Lite2::Signer \- OAuth 2.0 signature (DEPRECATED)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    my $signed_params = OAuth::Lite2::Signer\->sign(
\&        secret    => q{my_token_secret},
\&        algorithm => q{hmac\-sha256},
\&        method    => q{GET},
\&        url       => q{http://example.org/protected/resource},
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1DEPRECATED.\s0 This is for old version of OAuth 2.0 draft specification.
.PP
This is for client to generate signed request,
or for server to verify received request.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "sign( %params )"
.el .SS "sign( \f(CW%params\fP )"
.IX Subsection "sign( %params )"
Returns the hash reference that includes parameters for OAuth 2.0 signed request.
.PP
.Vb 6
\&    my $signed_params = OAuth::Lite2::Signer\->sign(
\&        secret    => q{my_token_secret},
\&        algorithm => q{hmac\-sha256},
\&        method    => q{GET},
\&        url       => q{http://example.org/protected/resource},
\&    );
.Ve
.IP "secret" 4
.IX Item "secret"
Access token secret.
.IP "algorithm" 4
.IX Item "algorithm"
The algorithm what you make signature with.
.IP "method" 4
.IX Item "method"
\&\s-1HTTP\s0 method of the request.
.IP "url" 4
.IX Item "url"
\&\s-1URL\s0 of the request.
.IP "debug_nonce" 4
.IX Item "debug_nonce"
Optional. If you omit this, nonce string is automatically generate random string.
.IP "debug_timestamp" 4
.IX Item "debug_timestamp"
Optional. If you omit this, current timestamp is set.
.ie n .SS "normalize_string( %params )"
.el .SS "normalize_string( \f(CW%params\fP )"
.IX Subsection "normalize_string( %params )"
Returns normalized string according to the specification.
.IP "host" 4
.IX Item "host"
host part of the url.
.IP "port" 4
.IX Item "port"
If you omit this, 80 is set by default.
.IP "nonce" 4
.IX Item "nonce"
Random string.
.IP "timestamp" 4
.IX Item "timestamp"
unix timestamp.
.IP "algorithm" 4
.IX Item "algorithm"
name of hmac hash algorithm.
.IP "method" 4
.IX Item "method"
\&\s-1HTTP\s0 method of the request.
.IP "url" 4
.IX Item "url"
\&\s-1URL\s0 of the request.
.ie n .SS "verify( %params )"
.el .SS "verify( \f(CW%params\fP )"
.IX Subsection "verify( %params )"
Verify a signed request.
.PP
.Vb 3
\&    unless ( OAuth::Lite2::Signer\->verify( %params ) ) {
\&        $app\->error("Invalid request");
\&    }
.Ve
.IP "signature" 4
.IX Item "signature"
\&'signature' parameter of the received request.
.IP "secret" 4
.IX Item "secret"
The access token secret.
.IP "algorithm" 4
.IX Item "algorithm"
\&'algorithm' parameter of the received request.
.IP "method" 4
.IX Item "method"
\&\s-1HTTP\s0 method of the received request.
.IP "url" 4
.IX Item "url"
\&\s-1URL\s0 of the received request.
.IP "nonce" 4
.IX Item "nonce"
\&'nonce' parameter of the received request.
.IP "timestamp" 4
.IX Item "timestamp"
\&'timestamp' parameter of the received request.
.SH "AUTHOR"
.IX Header "AUTHOR"
Lyo Kato, <lyo.kato@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2010 by Lyo Kato
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.