.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Digest::MD5 3"
.TH Digest::MD5 3 "2002-11-24" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Digest::MD5 \- Perl interface to the MD5 Algorithm
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # Functional style
\& use Digest::MD5 qw(md5 md5_hex md5_base64);
.Ve
.PP
.Vb 3
\& $digest = md5($data);
\& $digest = md5_hex($data);
\& $digest = md5_base64($data);
.Ve
.PP
.Vb 2
\& # OO style
\& use Digest::MD5;
.Ve
.PP
.Vb 1
\& $ctx = Digest::MD5->new;
.Ve
.PP
.Vb 2
\& $ctx->add($data);
\& $ctx->addfile(*FILE);
.Ve
.PP
.Vb 3
\& $digest = $ctx->digest;
\& $digest = $ctx->hexdigest;
\& $digest = $ctx->b64digest;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Digest::MD5\*(C'\fR module allows you to use the \s-1RSA\s0 Data Security
Inc. \s-1MD5\s0 Message Digest algorithm from within Perl programs. The
algorithm takes as input a message of arbitrary length and produces as
output a 128\-bit \*(L"fingerprint\*(R" or \*(L"message digest\*(R" of the input.
.PP
The \f(CW\*(C`Digest::MD5\*(C'\fR module provide a procedural interface for simple
use, as well as an object oriented interface that can handle messages
of arbitrary length and which can read files directly.
.PP
A binary digest will be 16 bytes long. A hex digest will be 32
characters long. A base64 digest will be 22 characters long.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
The following functions can be exported from the \f(CW\*(C`Digest::MD5\*(C'\fR
module. No functions are exported by default.
.IP "md5($data,...)" 4
.IX Item "md5($data,...)"
This function will concatenate all arguments, calculate the \s-1MD5\s0 digest
of this \*(L"message\*(R", and return it in binary form.
.IP "md5_hex($data,...)" 4
.IX Item "md5_hex($data,...)"
Same as \fImd5()\fR, but will return the digest in hexadecimal form.
.IP "md5_base64($data,...)" 4
.IX Item "md5_base64($data,...)"
Same as \fImd5()\fR, but will return the digest as a base64 encoded string.
.Sp
The base64 encoded string returned is not padded to be a multiple of 4
bytes long. If you want interoperability with other base64 encoded
md5 digests you might want to append the string \*(L"==\*(R" to the result.
.SH "METHODS"
.IX Header "METHODS"
The following methods are available:
.IP "$md5 = Digest::MD5\->new" 4
.IX Item "$md5 = Digest::MD5->new"
The constructor returns a new \f(CW\*(C`Digest::MD5\*(C'\fR object which encapsulate
the state of the \s-1MD5\s0 message-digest algorithm. You can add data to
the object and finally ask for the digest.
.Sp
If called as an instance method (i.e. \f(CW$md5\fR\->new) it will just reset the
state the object to the state of a newly created object. No new
object is created in this case.
.IP "$md5\->reset" 4
.IX Item "$md5->reset"
This is just an alias for \f(CW$md5\fR\->new.
.IP "$md5\->add($data,...)" 4
.IX Item "$md5->add($data,...)"
The \f(CW$data\fR provided as argument are appended to the message we
calculate the digest for. The return value is the \f(CW$md5\fR object itself.
.IP "$md5\->addfile($io_handle)" 4
.IX Item "$md5->addfile($io_handle)"
The \f(CW$io_handle\fR is read until \s-1EOF\s0 and the content is appended to the
message we calculate the digest for. The return value is the \f(CW$md5\fR
object itself.
.Sp
In most cases you want to make sure that the \f(CW$io_handle\fR is set up to
be in \fIbinmode()\fR.
.IP "$md5\->digest" 4
.IX Item "$md5->digest"
Return the binary digest for the message.
.Sp
Note that the \f(CW\*(C`digest\*(C'\fR operation is effectively a destructive,
read-once operation. Once it has been performed, the \f(CW\*(C`Digest::MD5\*(C'\fR
object is automatically \f(CW\*(C`reset\*(C'\fR and can be used to calculate another
digest value.
.IP "$md5\->hexdigest" 4
.IX Item "$md5->hexdigest"
Same as \f(CW$md5\fR\->digest, but will return the digest in hexadecimal form.
.IP "$md5\->b64digest" 4
.IX Item "$md5->b64digest"
Same as \f(CW$md5\fR\->digest, but will return the digest as a base64 encoded
string.
.Sp
The base64 encoded string returned is not padded to be a multiple of 4
bytes long. If you want interoperability with other base64 encoded
md5 digests you might want to append the string \*(L"==\*(R" to the result.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The simplest way to use this library is to import the \fImd5_hex()\fR
function (or one of its cousins):
.PP
.Vb 2
\& use Digest::MD5 qw(md5_hex);
\& print "Digest is ", md5_hex("foobarbaz"), "\en";
.Ve
.PP
The above example would print out the message
.PP
.Vb 1
\& Digest is 6df23dc03f9b54cc38a0fc1483df6e21
.Ve
.PP
provided that the implementation is working correctly. The same
checksum can also be calculated in \s-1OO\s0 style:
.PP
.Vb 1
\& use Digest::MD5;
.Ve
.PP
.Vb 4
\& $md5 = Digest::MD5->new;
\& $md5->add('foo', 'bar');
\& $md5->add('baz');
\& $digest = $md5->hexdigest;
.Ve
.PP
.Vb 1
\& print "Digest is $digest\en";
.Ve
.PP
With \s-1OO\s0 style you can break the message arbitrary. This means that we
are no longer limited to have space for the whole message in memory, i.e.
we can handle messages of any size.
.PP
This is useful when calculating checksum for files:
.PP
.Vb 1
\& use Digest::MD5;
.Ve
.PP
.Vb 3
\& my $file = shift || "/etc/passwd";
\& open(FILE, $file) or die "Can't open '$file': $!";
\& binmode(FILE);
.Ve
.PP
.Vb 6
\& $md5 = Digest::MD5->new;
\& while (<FILE>) {
\& $md5->add($_);
\& }
\& close(FILE);
\& print $md5->b64digest, " $file\en";
.Ve
.PP
Or we can use the builtin addfile method for more efficient reading of
the file:
.PP
.Vb 1
\& use Digest::MD5;
.Ve
.PP
.Vb 3
\& my $file = shift || "/etc/passwd";
\& open(FILE, $file) or die "Can't open '$file': $!";
\& binmode(FILE);
.Ve
.PP
.Vb 1
\& print Digest::MD5->new->addfile(*FILE)->hexdigest, " $file\en";
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Digest,
Digest::MD2,
Digest::SHA1,
Digest::HMAC
.PP
\&\fImd5sum\fR\|(1)
.PP
\&\s-1RFC\s0 1321
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
.Vb 3
\& Copyright 1998-2002 Gisle Aas.
\& Copyright 1995-1996 Neil Winton.
\& Copyright 1991-1992 RSA Data Security, Inc.
.Ve
.PP
The \s-1MD5\s0 algorithm is defined in \s-1RFC\s0 1321. The basic C code
implementing the algorithm is derived from that in the \s-1RFC\s0 and is
covered by the following copyright:
.IP "\(bu" 4
Copyright (C) 1991\-2, \s-1RSA\s0 Data Security, Inc. Created 1991. All
rights reserved.
.Sp
License to copy and use this software is granted provided that it
is identified as the \*(L"\s-1RSA\s0 Data Security, Inc. \s-1MD5\s0 Message-Digest
Algorithm\*(R" in all material mentioning or referencing this software
or this function.
.Sp
License is also granted to make and use derivative works provided
that such works are identified as \*(L"derived from the \s-1RSA\s0 Data
Security, Inc. \s-1MD5\s0 Message-Digest Algorithm\*(R" in all material
mentioning or referencing the derived work.
.Sp
\&\s-1RSA\s0 Data Security, Inc. makes no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided \*(L"as is\*(R"
without express or implied warranty of any kind.
.Sp
These notices must be retained in any copies of any part of this
documentation and/or software.
.PP
This copyright does not prohibit distribution of any version of Perl
containing this extension under the terms of the \s-1GNU\s0 or Artistic
licenses.
.SH "AUTHORS"
.IX Header "AUTHORS"
The original \s-1MD5\s0 interface was written by Neil Winton
(\f(CW\*(C`N.Winton@axion.bt.co.uk\*(C'\fR).
.PP
This release was made by Gisle Aas <gisle@ActiveState.com>
|
