home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _5ee3320eb88906f269fb863cec10fd76 < prev    next >
Text File  |  2000-03-23  |  9KB  |  254 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Digest::MD5 - Perl interface to the MD5 Algorithm</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Digest::MD5 - Perl interface to the MD5 Algorithm</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#functions">FUNCTIONS</A></LI>
  26.     <LI><A HREF="#methods">METHODS</A></LI>
  27.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30.     <LI><A HREF="#authors">AUTHORS</A></LI>
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>Digest::MD5 - Perl interface to the MD5 Algorithm</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Linux</LI>
  43. <LI>Solaris</LI>
  44. <LI>Windows</LI>
  45. </UL>
  46. <HR>
  47. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  48. <PRE>
  49.  # Functional style
  50.  use Digest::MD5  qw(md5 md5_hex md5_base64);</PRE>
  51. <PRE>
  52.  $digest = md5($data);
  53.  $digest = md5_hex($data);
  54.  $digest = md5_base64($data);</PRE>
  55. <PRE>
  56.  # OO style
  57.  use Digest::MD5;</PRE>
  58. <PRE>
  59.  $ctx = Digest::MD5->new;</PRE>
  60. <PRE>
  61.  $ctx->add($data);
  62.  $ctx->addfile(*FILE);</PRE>
  63. <PRE>
  64.  $digest = $ctx->digest;
  65.  $digest = $ctx->hexdigest;
  66.  $digest = $ctx->b64digest;</PRE>
  67. <P>
  68. <HR>
  69. <H1><A NAME="description">DESCRIPTION</A></H1>
  70. <P>The <CODE>Digest::MD5</CODE> module allows you to use the RSA Data Security
  71. Inc. MD5 Message Digest algorithm from within Perl programs.  The
  72. algorithm takes as input a message of arbitrary length and produces as
  73. output a 128-bit ``fingerprint'' or ``message digest'' of the input.</P>
  74. <P>The <CODE>Digest::MD5</CODE> module provide a procedural interface for simple
  75. use, as well as an object oriented interface that can handle messages
  76. of arbitrary length and which can read files directly.</P>
  77. <P>A binary digest will be 16 bytes long.  A hex digest will be 32
  78. characters long.  A base64 digest will be 22 characters long.</P>
  79. <P>
  80. <HR>
  81. <H1><A NAME="functions">FUNCTIONS</A></H1>
  82. <P>The following functions can be exported from the <CODE>Digest::MD5</CODE>
  83. module.  No functions are exported by default.</P>
  84. <DL>
  85. <DT><STRONG><A NAME="item_md5"><CODE>md5($data,...)</CODE></A></STRONG><BR>
  86. <DD>
  87. This function will concatenate all arguments, calculate the MD5 digest
  88. of this ``message'', and return it in binary form.
  89. <P></P>
  90. <DT><STRONG><A NAME="item_md5_hex"><CODE>md5_hex($data,...)</CODE></A></STRONG><BR>
  91. <DD>
  92. Same as md5(), but will return the digest in hexadecimal form.
  93. <P></P>
  94. <DT><STRONG><A NAME="item_md5_base64"><CODE>md5_base64($data,...)</CODE></A></STRONG><BR>
  95. <DD>
  96. Same as md5(), but will return the digest as a base64 encoded string.
  97. <P></P></DL>
  98. <P>
  99. <HR>
  100. <H1><A NAME="methods">METHODS</A></H1>
  101. <P>The following methods are available:</P>
  102. <DL>
  103. <DT><STRONG><A NAME="item_new">$md5 = Digest::MD5->new</A></STRONG><BR>
  104. <DD>
  105. The constructor returns a new <CODE>Digest::MD5</CODE> object which encapsulate
  106. the state of the MD5 message-digest algorithm.  You can add data to
  107. the object and finally ask for the digest.
  108. <P>If called as a instance method (i.e. $md5->new) it will just reset the
  109. state the object to the state of a newly created object.  No new
  110. object is created in this case.</P>
  111. <P></P>
  112. <DT><STRONG><A NAME="item_reset">$md5->reset</A></STRONG><BR>
  113. <DD>
  114. This is just an alias for $md5->new.
  115. <P></P>
  116. <DT><STRONG><A NAME="item_add">$md5-><CODE>add($data,...)</CODE></A></STRONG><BR>
  117. <DD>
  118. The $data provided as argument are appended to the message we
  119. calculate the digest for.  The return value is the $md5 object itself.
  120. <P></P>
  121. <DT><STRONG><A NAME="item_addfile">$md5-><CODE>addfile($io_handle)</CODE></A></STRONG><BR>
  122. <DD>
  123. The $io_handle is read until EOF and the content is appended to the
  124. message we calculate the digest for.  The return value is the $md5
  125. object itself.
  126. <P></P>
  127. <DT><STRONG><A NAME="item_digest">$md5->digest</A></STRONG><BR>
  128. <DD>
  129. Return the binary digest for the message.
  130. <P>Note that the <A HREF="#item_digest"><CODE>digest</CODE></A> operation is effectively a destructive,
  131. read-once operation. Once it has been performed, the <CODE>Digest::MD5</CODE>
  132. object is automatically <A HREF="#item_reset"><CODE>reset</CODE></A> and can be used to calculate another
  133. digest value.</P>
  134. <P></P>
  135. <DT><STRONG><A NAME="item_hexdigest">$md5->hexdigest</A></STRONG><BR>
  136. <DD>
  137. Same as $md5->digest, but will return the digest in hexadecimal form.
  138. <P></P>
  139. <DT><STRONG><A NAME="item_b64digest">$md5->b64digest</A></STRONG><BR>
  140. <DD>
  141. Same as $md5->digest, but will return the digest as a base64 encoded
  142. string.
  143. <P></P></DL>
  144. <P>
  145. <HR>
  146. <H1><A NAME="examples">EXAMPLES</A></H1>
  147. <P>The simplest way to use this library is to import the <A HREF="#item_md5_hex"><CODE>md5_hex()</CODE></A>
  148. function (or one of its cousins):</P>
  149. <PRE>
  150.     use Digest::MD5 qw(md5_hex);
  151.     print "Digest is ", md5_hex("foobarbaz"), "\n";</PRE>
  152. <P>The above example would print out the message</P>
  153. <PRE>
  154.     Digest is 6df23dc03f9b54cc38a0fc1483df6e21</PRE>
  155. <P>provided that the implementation is working correctly.  The same
  156. checksum can also be calculated in OO style:</P>
  157. <PRE>
  158.     use Digest::MD5;
  159. </PRE>
  160. <PRE>
  161.  
  162.     $md5 = Digest::MD5->new;
  163.     $md5->add('foo', 'bar');
  164.     $md5->add('baz');
  165.     $digest = $md5->hexdigest;</PRE>
  166. <PRE>
  167.  
  168.     print "Digest is $digest\n";</PRE>
  169. <P>With OO style you can break the message arbitrary.  This means that we
  170. are no longer limited to have space for the whole message in memory, i.e.
  171. we can handle messages of any size.</P>
  172. <P>This is useful when calculating checksum for files:</P>
  173. <PRE>
  174.     use Digest::MD5;</PRE>
  175. <PRE>
  176.     my $file = shift || "/etc/passwd";
  177.     open(FILE, $file) or die "Can't open '$file': $!";
  178.     binmode(FILE);</PRE>
  179. <PRE>
  180.     $md5 = Digest::MD5->new;
  181.     while (<FILE>) {
  182.         $md5->add($_);
  183.     }
  184.     close(FILE);
  185.     print $md5->b64digest, " $file\n";</PRE>
  186. <P>Or we can use the builtin addfile method for more efficient reading of
  187. the file:</P>
  188. <PRE>
  189.     use Digest::MD5;</PRE>
  190. <PRE>
  191.     my $file = shift || "/etc/passwd";
  192.     open(FILE, $file) or die "Can't open '$file': $!";
  193.     binmode(FILE);</PRE>
  194. <PRE>
  195.     print Digest::MD5->new->addfile(*FILE)->hexdigest, " $file\n";</PRE>
  196. <P>
  197. <HR>
  198. <H1><A NAME="see also">SEE ALSO</A></H1>
  199. <P><A HREF="../../../site/lib/Digest.html">the Digest manpage</A>,
  200. <A HREF="../../../site/lib/Digest/MD2.html">the Digest::MD2 manpage</A>,
  201. <A HREF="../../../site/lib/Digest/SHA1.html">the Digest::SHA1 manpage</A>,
  202. <A HREF="../../../site/lib/Digest/HMAC.html">the Digest::HMAC manpage</A></P>
  203. <P><EM>md5sum(1)</EM></P>
  204. <P>RFC 1321</P>
  205. <P>
  206. <HR>
  207. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  208. <P>This library is free software; you can redistribute it and/or
  209. modify it under the same terms as Perl itself.</P>
  210. <PRE>
  211.  Copyright 1998-1999 Gisle Aas.
  212.  Copyright 1995-1996 Neil Winton.
  213.  Copyright 1991-1992 RSA Data Security, Inc.</PRE>
  214. <P>The MD5 algorithm is defined in RFC 1321. The basic C code
  215. implementing the algorithm is derived from that in the RFC and is
  216. covered by the following copyright:</P>
  217. <DL>
  218. <DT><DD>
  219. Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
  220. rights reserved.
  221. <P>License to copy and use this software is granted provided that it
  222. is identified as the ``RSA Data Security, Inc. MD5 Message-Digest
  223. Algorithm'' in all material mentioning or referencing this software
  224. or this function.</P>
  225. <P>License is also granted to make and use derivative works provided
  226. that such works are identified as ``derived from the RSA Data
  227. Security, Inc. MD5 Message-Digest Algorithm'' in all material
  228. mentioning or referencing the derived work.</P>
  229. <P>RSA Data Security, Inc. makes no representations concerning either
  230. the merchantability of this software or the suitability of this
  231. software for any particular purpose. It is provided ``as is''
  232. without express or implied warranty of any kind.</P>
  233. <P>These notices must be retained in any copies of any part of this
  234. documentation and/or software.</P>
  235. <P></P></DL>
  236. <P>This copyright does not prohibit distribution of any version of Perl
  237. containing this extension under the terms of the GNU or Artistic
  238. licenses.</P>
  239. <P>
  240. <HR>
  241. <H1><A NAME="authors">AUTHORS</A></H1>
  242. <P>The original MD5 interface was written by Neil Winton
  243. (<CODE>N.Winton@axion.bt.co.uk</CODE>).</P>
  244. <P>This release was made by Gisle Aas <<A HREF="mailto:gisle@aas.no">gisle@aas.no</A>></P>
  245. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  246. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  247. <STRONG><P CLASS=block> Digest::MD5 - Perl interface to the MD5 Algorithm</P></STRONG>
  248. </TD></TR>
  249. </TABLE>
  250.  
  251. </BODY>
  252.  
  253. </HTML>
  254.