home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _aecc1b5acab8b2b7e94d82b5501933ca < prev    next >
Text File  |  2000-03-23  |  6KB  |  147 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>MIME::Base64 - Encoding and decoding of base64 strings</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> MIME::Base64 - Encoding and decoding of base64 strings</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="#diagnostics">DIAGNOSTICS</A></LI>
  26.     <LI><A HREF="#examples">EXAMPLES</A></LI>
  27.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>MIME::Base64 - Encoding and decoding of base64 strings</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.  use MIME::Base64;</PRE>
  47. <PRE>
  48.  $encoded = encode_base64('Aladdin:open sesame');
  49.  $decoded = decode_base64($encoded);</PRE>
  50. <P>
  51. <HR>
  52. <H1><A NAME="description">DESCRIPTION</A></H1>
  53. <P>This module provides functions to encode and decode strings into the
  54. Base64 encoding specified in RFC 2045 - <EM>MIME (Multipurpose Internet
  55. Mail Extensions)</EM>. The Base64 encoding is designed to represent
  56. arbitrary sequences of octets in a form that need not be humanly
  57. readable. A 65-character subset ([A-Za-z0-9+/=]) of US-ASCII is used,
  58. enabling 6 bits to be represented per printable character.</P>
  59. <P>The following functions are provided:</P>
  60. <DL>
  61. <DT><STRONG><A NAME="item_encode_base64">encode_base64($str, [$eol])</A></STRONG><BR>
  62. <DD>
  63. Encode data by calling the <A HREF="#item_encode_base64"><CODE>encode_base64()</CODE></A> function.  The first
  64. argument is the string to encode.  The second argument is the line
  65. ending sequence to use (it is optional and defaults to <CODE>"\n"</CODE>).  The
  66. returned encoded string is broken into lines of no more than 76
  67. characters each and it will end with $eol unless it is empty.  Pass an
  68. empty string as second argument if you do not want the encoded string
  69. broken into lines.
  70. <P></P>
  71. <DT><STRONG><A NAME="item_decode_base64"><CODE>decode_base64($str)</CODE></A></STRONG><BR>
  72. <DD>
  73. Decode a base64 string by calling the <A HREF="#item_decode_base64"><CODE>decode_base64()</CODE></A> function.  This
  74. function takes a single argument which is the string to decode and
  75. returns the decoded data.
  76. <P>Any character not part of the 65-character base64 subset set is
  77. silently ignored.  Characters occuring after a '=' padding character
  78. are never decoded.</P>
  79. <P>If the length of the string to decode (after ignoring
  80. non-base64 chars) is not a multiple of 4 or padding occurs too ealy,
  81. then a warning is generated if perl is running under <CODE>-w</CODE>.</P>
  82. <P></P></DL>
  83. <P>If you prefer not to import these routines into your namespace you can
  84. call them as:</P>
  85. <PRE>
  86.     use MIME::Base64 ();
  87.     $encoded = MIME::Base64::encode($decoded);
  88.     $decoded = MIME::Base64::decode($encoded);</PRE>
  89. <P>
  90. <HR>
  91. <H1><A NAME="diagnostics">DIAGNOSTICS</A></H1>
  92. <P>The following warnings might be generated if perl is invoked with the
  93. <CODE>-w</CODE> switch:</P>
  94. <DL>
  95. <DT><STRONG><A NAME="item_Premature_end_of_base64_data">Premature end of base64 data</A></STRONG><BR>
  96. <DD>
  97. The number of characters to decode is not a multiple of 4.  Legal
  98. base64 data should be padded with one or two ``='' characters to make
  99. its length a multiple of 4.  The decoded result will anyway be as if
  100. the padding was there.
  101. <P></P>
  102. <DT><STRONG><A NAME="item_Premature_padding_of_base64_data">Premature padding of base64 data</A></STRONG><BR>
  103. <DD>
  104. The '=' padding character occurs as the first or second character
  105. in a base64 quartet.
  106. <P></P></DL>
  107. <P>
  108. <HR>
  109. <H1><A NAME="examples">EXAMPLES</A></H1>
  110. <P>If you want to encode a large file, you should encode it in chunks
  111. that are a multiple of 57 bytes.  This ensures that the base64 lines
  112. line up and that you do not end up with padding in the middle. 57
  113. bytes of data fills one complete base64 line (76 == 57*4/3):</P>
  114. <PRE>
  115.    use MIME::Base64 qw(encode_base64);</PRE>
  116. <PRE>
  117.    open(FILE, "/var/log/wtmp") or die "$!";
  118.    while (read(FILE, $buf, 60*57)) {
  119.        print encode_base64($buf);
  120.    }</PRE>
  121. <P>or if you know you have enough memory</P>
  122. <PRE>
  123.    use MIME::Base64 qw(encode_base64);
  124.    local($/) = undef;  # slurp
  125.    print encode_base64(<STDIN>);</PRE>
  126. <P>
  127. <HR>
  128. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  129. <P>Copyright 1995-1999 Gisle Aas.</P>
  130. <P>This library is free software; you can redistribute it and/or
  131. modify it under the same terms as Perl itself.</P>
  132. <P>Distantly based on LWP::Base64 written by Martijn Koster
  133. <<A HREF="mailto:m.koster@nexor.co.uk">m.koster@nexor.co.uk</A>> and Joerg Reichelt <<A HREF="mailto:j.reichelt@nexor.co.uk">j.reichelt@nexor.co.uk</A>> and
  134. code posted to comp.lang.perl <<A HREF="mailto:3pd2lp$6gf@wsinti07.win.tue.nl">3pd2lp$6gf@wsinti07.win.tue.nl</A>> by Hans
  135. Mulder <<A HREF="mailto:hansm@wsinti07.win.tue.nl">hansm@wsinti07.win.tue.nl</A>></P>
  136. <P>The XS implementation use code from metamail.  Copyright 1991 Bell
  137. Communications Research, Inc. (Bellcore)</P>
  138. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  139. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  140. <STRONG><P CLASS=block> MIME::Base64 - Encoding and decoding of base64 strings</P></STRONG>
  141. </TD></TR>
  142. </TABLE>
  143.  
  144. </BODY>
  145.  
  146. </HTML>
  147.