.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Digest::HMAC 3"
.TH Digest::HMAC 3 2023-07-25 "perl v5.38.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
Digest::HMAC \- Keyed\-Hashing for Message Authentication
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& # Functional style
\& use Digest::HMAC qw(hmac hmac_hex);
\& $digest = hmac($data, $key, \e&myhash);
\& print hmac_hex($data, $key, \e&myhash);
\&
\& # OO style
\& use Digest::HMAC;
\& $hmac = Digest::HMAC\->new($key, "Digest::MyHash");
\&
\& $hmac\->add($data);
\& $hmac\->addfile(*FILE);
\&
\& $digest = $hmac\->digest;
\& $digest = $hmac\->hexdigest;
\& $digest = $hmac\->b64digest;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
HMAC is used for message integrity checks between two parties that
share a secret key, and works in combination with some other Digest
algorithm, usually MD5 or SHA\-1.  The HMAC mechanism is described in
RFC 2104.
.PP
HMAC follow the common \f(CW\*(C`Digest::\*(C'\fR interface, but the constructor
takes the secret key and the name of some other simple \f(CW\*(C`Digest::\*(C'\fR
as argument.
.PP
The \fBhmac()\fR and \fBhmac_hex()\fR functions and the Digest::HMAC\->\fBnew()\fR constructor
takes an optional \f(CW$blocksize\fR argument as well.  The HMAC algorithm assumes the
digester to hash by iterating a basic compression function on blocks of data
and the \f(CW$blocksize\fR should match the byte-length of such blocks.
.PP
The default \f(CW$blocksize\fR is 64 which is suitable for the MD5 and SHA\-1 digest
functions.  For stronger algorithms the blocksize probably needs to be
increased.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Digest::HMAC_MD5, Digest::HMAC_SHA1
.PP
RFC 2104
.SH MAINTAINER
.IX Header "MAINTAINER"
Andrew Rodland <arodland@cpan.org>
.SH "ORIGINAL AUTHORS"
.IX Header "ORIGINAL AUTHORS"
Graham Barr <gbarr@ti.com>, Gisle Aas <gisle@aas.no>