home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _0e936df7346a31dc9de790495ed79351 < prev    next >
Text File  |  2000-03-23  |  5KB  |  140 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Digest::SHA1 - Perl interface to the SHA-1 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::SHA1 - Perl interface to the SHA-1 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="#see also">SEE ALSO</A></LI>
  28.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  29.     <LI><A HREF="#authors">AUTHORS</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Digest::SHA1 - Perl interface to the SHA-1 Algorithm</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.  # Functional style
  49.  use Digest::SHA1  qw(sha1 sha1_hex sha1_base64);</PRE>
  50. <PRE>
  51.  $digest = sha1($data);
  52.  $digest = sha1_hex($data);
  53.  $digest = sha1_base64($data);</PRE>
  54. <PRE>
  55.  # OO style
  56.  use Digest::SHA1;</PRE>
  57. <PRE>
  58.  $ctx = Digest::SHA1->new;</PRE>
  59. <PRE>
  60.  $ctx->add($data);
  61.  $ctx->addfile(*FILE);</PRE>
  62. <PRE>
  63.  $digest = $ctx->digest;
  64.  $digest = $ctx->hexdigest;
  65.  $digest = $ctx->b64digest;</PRE>
  66. <P>
  67. <HR>
  68. <H1><A NAME="description">DESCRIPTION</A></H1>
  69. <P>The <CODE>Digest::SHA1</CODE> module allows you to use the NIST SHA-1 message
  70. digest algorithm from within Perl programs.  The algorithm takes as
  71. input a message of arbitrary length and produces as output a 160-bit
  72. ``fingerprint'' or ``message digest'' of the input.</P>
  73. <P>The <CODE>Digest::SHA1</CODE> module provide a procedural interface for simple
  74. use, as well as an object oriented interface that can handle messages
  75. of arbitrary length and which can read files directly.</P>
  76. <P>A binary digest will be 20 bytes long.  A hex digest will be 40
  77. characters long.  A base64 digest will be 27 characters long.</P>
  78. <P>
  79. <HR>
  80. <H1><A NAME="functions">FUNCTIONS</A></H1>
  81. <P>The following functions can be exported from the <CODE>Digest::SHA1</CODE>
  82. module.  No functions are exported by default.</P>
  83. <DL>
  84. <DT><STRONG><A NAME="item_sha1"><CODE>sha1($data,...)</CODE></A></STRONG><BR>
  85. <DD>
  86. This function will concatenate all arguments, calculate the SHA-1
  87. digest of this ``message'', and return it in binary form.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_sha1_hex"><CODE>sha1_hex($data,...)</CODE></A></STRONG><BR>
  90. <DD>
  91. Same as sha1(), but will return the digest in hexadecimal form.
  92. <P></P>
  93. <DT><STRONG><A NAME="item_sha1_base64"><CODE>sha1_base64($data,...)</CODE></A></STRONG><BR>
  94. <DD>
  95. Same as sha1(), but will return the digest as a base64 encoded string.
  96. <P></P></DL>
  97. <P>
  98. <HR>
  99. <H1><A NAME="methods">METHODS</A></H1>
  100. <P>The <CODE>Digest::SHA1</CODE> module provide the standard <CODE>Digest</CODE> OO-interface.
  101. The constructor looks like this:</P>
  102. <DL>
  103. <DT><STRONG><A NAME="item_new">$sha1 = Digest-><CODE>new('SHA-1')</CODE></A></STRONG><BR>
  104. <DD>
  105. <DT><STRONG>$sha1 = Digest::SHA1->new</STRONG><BR>
  106. <DD>
  107. The constructor returns a new <CODE>Digest::SHA1</CODE> object which encapsulate
  108. the state of the SHA-1 message-digest algorithm.  You can add data to
  109. the object and finally ask for the digest using the methods described
  110. in <A HREF="../../../site/lib/Digest.html">the Digest manpage</A>.
  111. <P></P></DL>
  112. <P>
  113. <HR>
  114. <H1><A NAME="see also">SEE ALSO</A></H1>
  115. <P><A HREF="../../../site/lib/Digest.html">the Digest manpage</A>, <A HREF="../../../site/lib/Digest/HMAC_SHA1.html">the Digest::HMAC_SHA1 manpage</A>, <A HREF="../../../site/lib/Digest/MD5.html">the Digest::MD5 manpage</A></P>
  116. <P><A HREF="http://www.itl.nist.gov/fipspubs/fip180-1.htm">http://www.itl.nist.gov/fipspubs/fip180-1.htm</A></P>
  117. <P>
  118. <HR>
  119. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  120. <P>This library is free software; you can redistribute it and/or
  121. modify it under the same terms as Perl itself.</P>
  122. <PRE>
  123.  Copyright 1999 Gisle Aas.
  124.  Copyright 1997 Uwe Hollerbach.</PRE>
  125. <P>
  126. <HR>
  127. <H1><A NAME="authors">AUTHORS</A></H1>
  128. <P>Peter C. Gutmann,
  129. Uwe Hollerbach <<A HREF="mailto:uh@alumni.caltech.edu">uh@alumni.caltech.edu</A>>,
  130. Gisle Aas <<A HREF="mailto:gisle@aas.no">gisle@aas.no</A>></P>
  131. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  132. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  133. <STRONG><P CLASS=block> Digest::SHA1 - Perl interface to the SHA-1 Algorithm</P></STRONG>
  134. </TD></TR>
  135. </TABLE>
  136.  
  137. </BODY>
  138.  
  139. </HTML>
  140.