base64.rst 10.5 KB
Newer Older
1 2
:mod:`base64` --- Base16, Base32, Base64, Base85 Data Encodings
===============================================================
3 4

.. module:: base64
5 6
   :synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings;
              Base85 and Ascii85
7

8
**Source code:** :source:`Lib/base64.py`
9 10 11 12 13

.. index::
   pair: base64; encoding
   single: MIME; base64 encoding

14 15
--------------

16 17 18
This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data.
It provides encoding and decoding functions for the encodings specified in
19
:rfc:`3548`, which defines the Base16, Base32, and Base64 algorithms,
20 21 22
and for the de-facto standard Ascii85 and Base85 encodings.

The :rfc:`3548` encodings are suitable for encoding binary data so that it can
23 24 25 26
safely sent by email, used as parts of URLs, or included as part of an HTTP
POST request.  The encoding algorithm is not the same as the
:program:`uuencode` program.

27 28 29
There are two interfaces provided by this module.  The modern interface
supports encoding :term:`bytes-like objects <bytes-like object>` to ASCII
:class:`bytes`, and decoding :term:`bytes-like objects <bytes-like object>` or
30 31
strings containing ASCII to :class:`bytes`.  Both base-64 alphabets
defined in :rfc:`3548` (normal, and URL- and filesystem-safe) are supported.
32 33 34 35 36 37 38 39

The legacy interface does not support decoding from strings, but it does
provide functions for encoding and decoding to and from :term:`file objects
<file object>`.  It only supports the Base64 standard alphabet, and it adds
newlines every 76 characters as per :rfc:`2045`.  Note that if you are looking
for :rfc:`2045` support you probably want to be looking at the :mod:`email`
package instead.

40 41 42 43

.. versionchanged:: 3.3
   ASCII-only Unicode strings are now accepted by the decoding functions of
   the modern interface.
44

45
.. versionchanged:: 3.4
46
   Any :term:`bytes-like objects <bytes-like object>` are now accepted by all
47
   encoding and decoding functions in this module.  Ascii85/Base85 support added.
48

49
The modern interface provides:
50

51
.. function:: b64encode(s, altchars=None)
52

53 54
   Encode the :term:`bytes-like object` *s* using Base64 and return the encoded
   :class:`bytes`.
55

56
   Optional *altchars* must be a :term:`bytes-like object` of at least
57 58 59 60 61 62
   length 2 (additional characters are ignored) which specifies an alternative
   alphabet for the ``+`` and ``/`` characters.  This allows an application to e.g.
   generate URL or filesystem safe Base64 strings.  The default is ``None``, for
   which the standard Base64 alphabet is used.


63
.. function:: b64decode(s, altchars=None, validate=False)
64

65 66
   Decode the Base64 encoded :term:`bytes-like object` or ASCII string
   *s* and return the decoded :class:`bytes`.
67

68
   Optional *altchars* must be a :term:`bytes-like object` or ASCII string of
69 70
   at least length 2 (additional characters are ignored) which specifies the
   alternative alphabet used instead of the ``+`` and ``/`` characters.
71

72
   A :exc:`binascii.Error` exception is raised
73
   if *s* is incorrectly padded.
74

75 76
   If *validate* is ``False`` (the default), characters that are neither
   in the normal base-64 alphabet nor the alternative alphabet are
77
   discarded prior to the padding check.  If *validate* is ``True``,
78
   these non-alphabet characters in the input result in a
79
   :exc:`binascii.Error`.
80 81 82 83


.. function:: standard_b64encode(s)

84 85
   Encode :term:`bytes-like object` *s* using the standard Base64 alphabet
   and return the encoded :class:`bytes`.
86 87 88 89


.. function:: standard_b64decode(s)

90 91
   Decode :term:`bytes-like object` or ASCII string *s* using the standard
   Base64 alphabet and return the decoded :class:`bytes`.
92 93 94 95


.. function:: urlsafe_b64encode(s)

96 97
   Encode :term:`bytes-like object` *s* using the
   URL- and filesystem-safe alphabet, which
98 99
   substitutes ``-`` instead of ``+`` and ``_`` instead of ``/`` in the
   standard Base64 alphabet, and return the encoded :class:`bytes`.  The result
Benjamin Peterson's avatar
Benjamin Peterson committed
100
   can still contain ``=``.
101 102 103 104


.. function:: urlsafe_b64decode(s)

105 106
   Decode :term:`bytes-like object` or ASCII string *s*
   using the URL- and filesystem-safe
107 108 109
   alphabet, which substitutes ``-`` instead of ``+`` and ``_`` instead of
   ``/`` in the standard Base64 alphabet, and return the decoded
   :class:`bytes`.
110 111 112 113


.. function:: b32encode(s)

114 115
   Encode the :term:`bytes-like object` *s* using Base32 and return the
   encoded :class:`bytes`.
116 117


118
.. function:: b32decode(s, casefold=False, map01=None)
119

120 121
   Decode the Base32 encoded :term:`bytes-like object` or ASCII string *s* and
   return the decoded :class:`bytes`.
122

123
   Optional *casefold* is a flag specifying
124 125
   whether a lowercase alphabet is acceptable as input.  For security purposes,
   the default is ``False``.
126 127 128 129 130 131 132 133

   :rfc:`3548` allows for optional mapping of the digit 0 (zero) to the letter O
   (oh), and for optional mapping of the digit 1 (one) to either the letter I (eye)
   or letter L (el).  The optional argument *map01* when not ``None``, specifies
   which letter the digit 1 should be mapped to (when *map01* is not ``None``, the
   digit 0 is always mapped to the letter O).  For security purposes the default is
   ``None``, so that 0 and 1 are not allowed in the input.

134
   A :exc:`binascii.Error` is raised if *s* is
135
   incorrectly padded or if there are non-alphabet characters present in the
136
   input.
137 138 139 140


.. function:: b16encode(s)

141 142
   Encode the :term:`bytes-like object` *s* using Base16 and return the
   encoded :class:`bytes`.
143 144


145
.. function:: b16decode(s, casefold=False)
146

147 148
   Decode the Base16 encoded :term:`bytes-like object` or ASCII string *s* and
   return the decoded :class:`bytes`.
149

150
   Optional *casefold* is a flag specifying whether a
151 152 153
   lowercase alphabet is acceptable as input.  For security purposes, the default
   is ``False``.

154
   A :exc:`binascii.Error` is raised if *s* is
155
   incorrectly padded or if there are non-alphabet characters present in the
156
   input.
157 158


159
.. function:: a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)
160

161
   Encode the :term:`bytes-like object` *b* using Ascii85 and return the
162
   encoded :class:`bytes`.
163 164 165 166 167

   *foldspaces* is an optional flag that uses the special short sequence 'y'
   instead of 4 consecutive spaces (ASCII 0x20) as supported by 'btoa'. This
   feature is not supported by the "standard" Ascii85 encoding.

168
   *wrapcol* controls whether the output should have newline (``b'\n'``)
169 170 171
   characters added to it. If this is non-zero, each output line will be
   at most this many characters long.

172
   *pad* controls whether the input is padded to a multiple of 4
173 174 175 176 177 178 179 180
   before encoding. Note that the ``btoa`` implementation always pads.

   *adobe* controls whether the encoded byte sequence is framed with ``<~``
   and ``~>``, which is used by the Adobe implementation.

   .. versionadded:: 3.4


181
.. function:: a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \\t\\n\\r\\v')
182

183
   Decode the Ascii85 encoded :term:`bytes-like object` or ASCII string *b* and
184
   return the decoded :class:`bytes`.
185 186 187 188 189 190 191 192

   *foldspaces* is a flag that specifies whether the 'y' short sequence
   should be accepted as shorthand for 4 consecutive spaces (ASCII 0x20).
   This feature is not supported by the "standard" Ascii85 encoding.

   *adobe* controls whether the input sequence is in Adobe Ascii85 format
   (i.e. is framed with <~ and ~>).

193 194
   *ignorechars* should be a :term:`bytes-like object` or ASCII string
   containing characters to ignore
195 196 197 198 199 200
   from the input. This should only contain whitespace characters, and by
   default contains all whitespace characters in ASCII.

   .. versionadded:: 3.4


201
.. function:: b85encode(b, pad=False)
202

203
   Encode the :term:`bytes-like object` *b* using base85 (as used in e.g.
204
   git-style binary diffs) and return the encoded :class:`bytes`.
205

206 207
   If *pad* is true, the input is padded with ``b'\0'`` so its length is a
   multiple of 4 bytes before encoding.
208 209 210 211 212 213

   .. versionadded:: 3.4


.. function:: b85decode(b)

214 215
   Decode the base85-encoded :term:`bytes-like object` or ASCII string *b* and
   return the decoded :class:`bytes`.  Padding is implicitly removed, if
216 217 218 219 220 221 222 223 224 225 226 227 228
   necessary.

   .. versionadded:: 3.4


.. note::
   Both Base85 and Ascii85 have an expansion factor of 5 to 4 (5 Base85 or
   Ascii85 characters can encode 4 binary bytes), while the better-known
   Base64 has an expansion factor of 6 to 4.  They are therefore more
   efficient when space expensive.  They differ by details such as the
   character map used for encoding.


229
The legacy interface:
230 231 232

.. function:: decode(input, output)

233
   Decode the contents of the binary *input* file and write the resulting binary
234
   data to the *output* file. *input* and *output* must be :term:`file objects
235 236
   <file object>`. *input* will be read until ``input.readline()`` returns an
   empty bytes object.
237 238


239
.. function:: decodebytes(s)
240

241 242
   Decode the :term:`bytes-like object` *s*, which must contain one or more
   lines of base64 encoded data, and return the decoded :class:`bytes`.
243

244 245
   .. versionadded:: 3.1

246 247 248 249 250 251
.. function:: decodestring(s)

   Deprecated alias of :func:`decodebytes`.

   .. deprecated:: 3.1

252 253 254

.. function:: encode(input, output)

255
   Encode the contents of the binary *input* file and write the resulting base64
256 257
   encoded data to the *output* file. *input* and *output* must be :term:`file
   objects <file object>`. *input* will be read until ``input.read()`` returns
258 259 260
   an empty bytes object. :func:`encode` inserts a newline character (``b'\n'``)
   after every 76 bytes of the output, as well as ensuring that the output
   always ends with a newline, as per :rfc:`2045` (MIME).
261

262

263
.. function:: encodebytes(s)
264

265 266 267 268 269
   Encode the :term:`bytes-like object` *s*, which can contain arbitrary binary
   data, and return :class:`bytes` containing the base64-encoded data, with newlines
   (``b'\n'``) inserted after every 76 bytes of output, and ensuring that
   there is a trailing newline, as per :rfc:`2045` (MIME).

270 271 272 273 274 275 276
   .. versionadded:: 3.1

.. function:: encodestring(s)

   Deprecated alias of :func:`encodebytes`.

   .. deprecated:: 3.1
277 278


Christian Heimes's avatar
Christian Heimes committed
279
An example usage of the module:
280 281

   >>> import base64
Georg Brandl's avatar
Georg Brandl committed
282
   >>> encoded = base64.b64encode(b'data to be encoded')
283
   >>> encoded
284
   b'ZGF0YSB0byBiZSBlbmNvZGVk'
285 286
   >>> data = base64.b64decode(encoded)
   >>> data
Georg Brandl's avatar
Georg Brandl committed
287
   b'data to be encoded'
288 289 290 291 292 293 294 295 296 297 298


.. seealso::

   Module :mod:`binascii`
      Support module containing ASCII-to-binary and binary-to-ASCII conversions.

   :rfc:`1521` - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies
      Section 5.2, "Base64 Content-Transfer-Encoding," provides the definition of the
      base64 encoding.