This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update MIME-Base64 to CPAN version 3.10
[perl5.git] / cpan / MIME-Base64 / Base64.pm
1 package MIME::Base64;
2
3 use strict;
4 use vars qw(@ISA @EXPORT @EXPORT_OK $VERSION);
5
6 require Exporter;
7 @ISA = qw(Exporter);
8 @EXPORT = qw(encode_base64 decode_base64);
9 @EXPORT_OK = qw(encoded_base64_length decoded_base64_length);
10
11 $VERSION = '3.10';
12
13 require XSLoader;
14 XSLoader::load('MIME::Base64', $VERSION);
15
16 *encode = \&encode_base64;
17 *decode = \&decode_base64;
18
19 1;
20
21 __END__
22
23 =head1 NAME
24
25 MIME::Base64 - Encoding and decoding of base64 strings
26
27 =head1 SYNOPSIS
28
29  use MIME::Base64;
30
31  $encoded = encode_base64('Aladdin:open sesame');
32  $decoded = decode_base64($encoded);
33
34 =head1 DESCRIPTION
35
36 This module provides functions to encode and decode strings into and from the
37 base64 encoding specified in RFC 2045 - I<MIME (Multipurpose Internet
38 Mail Extensions)>. The base64 encoding is designed to represent
39 arbitrary sequences of octets in a form that need not be humanly
40 readable. A 65-character subset ([A-Za-z0-9+/=]) of US-ASCII is used,
41 enabling 6 bits to be represented per printable character.
42
43 The following primary functions are provided:
44
45 =over 4
46
47 =item encode_base64($str)
48
49 =item encode_base64($str, $eol);
50
51 Encode data by calling the encode_base64() function.  The first
52 argument is the string to encode.  The second argument is the
53 line-ending sequence to use.  It is optional and defaults to "\n".  The
54 returned encoded string is broken into lines of no more than 76
55 characters each and it will end with $eol unless it is empty.  Pass an
56 empty string as second argument if you do not want the encoded string
57 to be broken into lines.
58
59 =item decode_base64($str)
60
61 Decode a base64 string by calling the decode_base64() function.  This
62 function takes a single argument which is the string to decode and
63 returns the decoded data.
64
65 Any character not part of the 65-character base64 subset is
66 silently ignored.  Characters occurring after a '=' padding character
67 are never decoded.
68
69 If the length of the string to decode, after ignoring
70 non-base64 chars, is not a multiple of 4 or if padding occurs too early,
71 then a warning is generated if perl is running under C<-w>.
72
73 =back
74
75 If you prefer not to import these routines into your namespace, you can
76 call them as:
77
78     use MIME::Base64 ();
79     $encoded = MIME::Base64::encode($decoded);
80     $decoded = MIME::Base64::decode($encoded);
81
82 Additional functions not exported by default:
83
84 =over 4
85
86 =item encoded_base64_length($str)
87
88 =item encoded_base64_length($str, $eol)
89
90 Returns the length that the encoded string would have without actually
91 encoding it.  This will return the same value as C<< length(encode_base64($str)) >>,
92 but should be more efficient.
93
94 =item decoded_base64_length($str)
95
96 Returns the length that the decoded string would have without actually
97 decoding it.  This will return the same value as C<< length(decode_base64($str)) >>,
98 but should be more efficient.
99
100 =back
101
102 =head1 DIAGNOSTICS
103
104 The following warnings can be generated if perl is invoked with the
105 C<-w> switch:
106
107 =over 4
108
109 =item Premature end of base64 data
110
111 The number of characters to decode is not a multiple of 4.  Legal
112 base64 data should be padded with one or two "=" characters to make
113 its length a multiple of 4.  The decoded result will be the same
114 whether the padding is present or not.
115
116 =item Premature padding of base64 data
117
118 The '=' padding character occurs as the first or second character
119 in a base64 quartet.
120
121 =back
122
123 The following exception can be raised:
124
125 =over 4
126
127 =item Wide character in subroutine entry
128
129 The string passed to encode_base64() contains characters with code
130 above 255.  The base64 encoding is only defined for single-byte
131 characters.  Use the Encode module to select the byte encoding you
132 want.
133
134 =back
135
136 =head1 EXAMPLES
137
138 If you want to encode a large file, you should encode it in chunks
139 that are a multiple of 57 bytes.  This ensures that the base64 lines
140 line up and that you do not end up with padding in the middle. 57
141 bytes of data fills one complete base64 line (76 == 57*4/3):
142
143    use MIME::Base64 qw(encode_base64);
144
145    open(FILE, "/var/log/wtmp") or die "$!";
146    while (read(FILE, $buf, 60*57)) {
147        print encode_base64($buf);
148    }
149
150 or if you know you have enough memory
151
152    use MIME::Base64 qw(encode_base64);
153    local($/) = undef;  # slurp
154    print encode_base64(<STDIN>);
155
156 The same approach as a command line:
157
158    perl -MMIME::Base64 -0777 -ne 'print encode_base64($_)' <file
159
160 Decoding does not need slurp mode if every line contains a multiple
161 of four base64 chars:
162
163    perl -MMIME::Base64 -ne 'print decode_base64($_)' <file
164
165 Perl v5.8 and better allow extended Unicode characters in strings.
166 Such strings cannot be encoded directly, as the base64
167 encoding is only defined for single-byte characters.  The solution is
168 to use the Encode module to select the byte encoding you want.  For
169 example:
170
171     use MIME::Base64 qw(encode_base64);
172     use Encode qw(encode);
173
174     $encoded = encode_base64(encode("UTF-8", "\x{FFFF}\n"));
175     print $encoded;
176
177 =head1 COPYRIGHT
178
179 Copyright 1995-1999, 2001-2004 Gisle Aas.
180
181 This library is free software; you can redistribute it and/or
182 modify it under the same terms as Perl itself.
183
184 Distantly based on LWP::Base64 written by Martijn Koster
185 <m.koster@nexor.co.uk> and Joerg Reichelt <j.reichelt@nexor.co.uk> and
186 code posted to comp.lang.perl <3pd2lp$6gf@wsinti07.win.tue.nl> by Hans
187 Mulder <hansm@wsinti07.win.tue.nl>
188
189 The XS implementation uses code from metamail.  Copyright 1991 Bell
190 Communications Research, Inc. (Bellcore)
191
192 =head1 SEE ALSO
193
194 L<MIME::QuotedPrint>
195
196 =cut