"base64" --- Base16, Base32, Base64, Base85 Data Encodings
**********************************************************

**Código fuente:** Lib/base64.py

======================================================================

Este módulo proporciona funciones para codificar datos binarios en
caracteres ASCII imprimibles y decodificar dichas codificaciones en
datos binarios. Proporciona funciones de codificación y decodificación
para las codificaciones especificadas en **RFC 4648**, que define los
algoritmos Base16, Base32 y Base64, y para las codificaciones estándar
de facto Ascii85 y Base85.

Las codificaciones **RFC 4648** son adecuadas para codificar datos
binarios para que puedan enviarse de forma segura por correo
electrónico, usarse como parte de las URL o incluirse como parte de
una solicitud HTTP POST. El algoritmo de codificación no es el mismo
que el del programa **uuencode**.

Hay dos interfaces proporcionadas por este módulo. La interfaz moderna
admite la codificación de *objetos similares a bytes* a ASCII "bytes"
y la decodificación de *objetos similares a bytes* o cadenas que
contienen ASCII a "bytes". Se admiten los dos alfabetos base 64
definidos en **RFC 4648** (normal y seguro para URL y sistema de
archivos).

La interfaz heredada no admite la decodificación desde cadenas de
caracteres, pero sí proporciona funciones para codificar y decodificar
desde y hacia *objetos de archivo*. Solo admite el alfabeto estándar
Base64 y agrega nuevas líneas cada 76 caracteres según **RFC 2045**.
Tenga en cuenta que si está buscando soporte de **RFC 2045**,
probablemente desee ver el paquete "email" en su lugar.

Distinto en la versión 3.3: Las cadenas de caracteres Unicode de solo
ASCII ahora son aceptadas por las funciones de decodificación de la
interfaz moderna.

Distinto en la versión 3.4: Cualquier *objeto similar a bytes* ahora
son aceptados por todas las funciones de codificación y decodificación
en este módulo. Ascii85/Base85 soporte agregado.

Las interfaces modernas proporcionan:

base64.b64encode(s, altchars=None)

   Codifica el *objeto similar a bytes* *s* utilizando Base64 y
   retorna los "bytes" codificados.

   Optional *altchars* must be a *bytes-like object* of length 2 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.

   May assert or raise a "ValueError" if the length of *altchars* is
   not 2.  Raises a "TypeError" if *altchars* is not a *bytes-like
   object*.

base64.b64decode(s, altchars=None, validate=False)

   Decodifica el *objeto similar a bytes* codificado en Base64 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   Optional *altchars* must be a *bytes-like object* or ASCII string
   of length 2 which specifies the alternative alphabet used instead
   of the "+" and "/" characters.

   Una excepción "binascii.Error" se lanza si *s* está incorrectamente
   rellenado (*padded*).

   Si *validate* es "False" (el valor predeterminado), los caracteres
   que no están en el alfabeto normal de base 64 ni en el alfabeto
   alternativo se descartan antes de la verificación del relleno. Si
   *validate* es "True", estos caracteres no alfabéticos en la entrada
   dan como resultado "binascii.Error".

   Para más información sobre la verificación estricta de base64,
   véase "binascii.a2b_base64()"

   May assert or raise a "ValueError" if the length of *altchars* is
   not 2.

base64.standard_b64encode(s)

   Codifica el *objeto similar a bytes* *s* usando el alfabeto
   estándar Base64 y retorna los "bytes" codificados.

base64.standard_b64decode(s)

   Decodifica un *bytes-like object* o cadena de caracteres ASCII *s*
   utilizando el alfabeto estándar Base64 y retorna los "bytes"
   decodificados.

base64.urlsafe_b64encode(s)

   Codifica el *objeto similar a bytes* *s* usando el alfabeto seguro
   para URL y sistemas de archivos, que sustituye a "-" en lugar de
   "+" y "_" en lugar de "/" en el alfabeto estándar de Base64, y
   retorna los "bytes" codificados. El resultado aún puede contener
   "=".

base64.urlsafe_b64decode(s)

   Decodifica *objeto similar a bytes* o cadena de caracteres ASCII
   *s* utilizando el alfabeto seguro para URL y sistema de archivos,
   que sustituye "-" en lugar de "+" y "_" en lugar de "/" en el
   alfabeto estándar de Base64, y retorna los "bytes" decodificados.

base64.b32encode(s)

   Codifica el *objeto similar a bytes* *s* utilizando Base32 y
   retorna los "bytes" codificados.

base64.b32decode(s, casefold=False, map01=None)

   Decodifica el *objeto similar a bytes* codificado en Base32 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   El opcional *casefold* es un flag que especifica si un alfabeto en
   minúscula es aceptable como entrada. Por motivos de seguridad, el
   valor predeterminado es "Falso".

   **RFC 4648** permite la asignación opcional del dígito 0 (cero) a
   la letra O (oh), y la asignación opcional del dígito 1 (uno) a la
   letra I (ojo) o la letra L (el) . El argumento opcional *map01*
   cuando no es "None", especifica la letra a la cual el dígito 1
   debería mapearse(cuando *map01* no es "None", el dígito 0 siempre
   se asigna a la letra O). Por motivos de seguridad, el valor
   predeterminado es "None", por lo que 0 y 1 no están permitidos en
   la entrada.

   Una "binascii.Error" se lanza si *s* está incorrectamente rellenado
   (*padded*) o si hay caracteres no alfabéticos presentes en la
   entrada.

base64.b32hexencode(s)

   Similar a "b32encode()" pero usa el Alfabeto Hexagonal Extendido,
   como se define en **RFC 4648**.

   Added in version 3.10.

base64.b32hexdecode(s, casefold=False)

   Similar a "b32decode()" pero usa el Alfabeto Hexagonal Extendido,
   como se define en **RFC 4648**.

   Esta versión no permite el dígito 0 (cero) a la letra O (oh) y el
   dígito 1 (uno) a las asignaciones de la letra I (ojo) o la letra L
   (el), todos estos caracteres están incluidos en el Alfabeto
   Hexagonal Extendido y no son intercambiables.

   Added in version 3.10.

base64.b16encode(s)

   Codifica el *objeto similar a bytes* *s* utilizando Base16 y
   retorna los "bytes" codificados.

base64.b16decode(s, casefold=False)

   Decodifica el *objeto similar a bytes* codificado en Base16 o
   cadena de caracteres ASCII *s* y retorna los "bytes" decodificados.

   El opcional *casefold* es un flag que especifica si un alfabeto en
   minúscula es aceptable como entrada. Por motivos de seguridad, el
   valor predeterminado es "Falso".

   Una "binascii.Error" se lanza si *s* está incorrectamente rellenado
   (*padded*) o si hay caracteres no alfabéticos presentes en la
   entrada.

base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

   Codifica el *objeto similar a bytes* *b* utilizando Ascii85 y
   retorna los "bytes" codificados.

   *foldspaces* es un flag opcional que utiliza la secuencia corta
   especial 'y' en lugar de 4 espacios consecutivos (ASCII 0x20) como
   lo admite 'btoa'. Esta característica no es compatible con la
   codificación Ascii85 "estándar".

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

   *pad* controla si la entrada se rellena (*padded*) a un múltiplo de
   4 antes de la codificación. Tenga en cuenta que la implementación
   de "btoa" siempre es rellenada (*pads*).

   *adobe* controla si la secuencia de bytes codificada está enmarcada
   con "<~" y "~>", que es utilizada por la implementación de Adobe.

   Added in version 3.4.

base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

   Decodifica el *objeto similar a bytes* codificado en Ascii85 o
   cadena de caracteres ASCII *b* y retorna los "bytes" decodificados.

   *foldspaces* es un flag que especifica si la secuencia corta 'y'
   debe aceptarse como abreviatura durante 4 espacios consecutivos
   (ASCII 0x20). Esta característica no es compatible con la
   codificación Ascii85 "estándar".

   *adobe* controla si la secuencia de entrada está en formato Adobe
   Ascii85 (es decir, se enmarca con <~ y ~>).

   *ignorechars* debe ser un *objeto similar a byte* o cadena de
   caracteres ASCII que contiene caracteres para ignorar desde la
   entrada. Esto solo debe contener caracteres de espacio en blanco, y
   por defecto contiene todos los caracteres de espacio en blanco en
   ASCII.

   Added in version 3.4.

base64.b85encode(b, pad=False)

   Codifica el *objeto similar a bytes* *b* utilizando base85 (como se
   usa en por ejemplo, diferencias binarias de estilo git) y retorna
   los "bytes" codificados.

   Si *pad* es verdadero, la entrada se rellena con "b'\0'", por lo
   que su longitud es un múltiplo de 4 bytes antes de la codificación.

   Added in version 3.4.

base64.b85decode(b)

   Decodifica el *objeto similar a bytes* codificado en base85 o
   cadena de caracteres ASCII *b* y retorna los "bytes" decodificados.
   El relleno se elimina implícitamente, si es necesario.

   Added in version 3.4.

La interfaz antigua:

base64.decode(input, output)

   Decodifica el contenido del archivo binario *input* y escribe los
   datos binarios resultantes en el archivo *output*. *input* y
   *output* deben ser *objetos archivo*. *input* se leerá hasta que
   "input.readline()" retorne un objeto de bytes vacío.

base64.decodebytes(s)

   Decodifica el *objeto similar a bytes* *s*, que debe contener una o
   más líneas de datos codificados en base64, y retornará los "bytes"
   decodificados.

   Added in version 3.1.

base64.encode(input, output)

   Codifica el contenido del archivo binario *input* y escribe los
   datos codificados en base64 resultantes en el archivo *output*.
   *input* y *output* deben ser *objetos archivos*. *input* se leerá
   hasta que "input.read()" retorna un objeto de bytes vacío.
   "encode()" inserta un carácter de nueva línea ("b'\n'") después de
   cada 76 bytes de la salida, además de garantizar que la salida
   siempre termine con una nueva línea, según **RFC 2045** (MIME).

base64.encodebytes(s)

   Codifica el *objeto similar a bytes* *s*, que puede contener datos
   binarios arbitrarios, y retorna "bytes" que contienen los datos
   codificados en base64, con líneas nuevas ("b'\n'") insertado
   después de cada 76 bytes de salida, y asegurando que haya una nueva
   línea final, según **RFC 2045** (MIME).

   Added in version 3.1.

Un ejemplo de uso del módulo:

>>> import base64
>>> encoded = base64.b64encode(b'data to be encoded')
>>> encoded
b'ZGF0YSB0byBiZSBlbmNvZGVk'
>>> data = base64.b64decode(encoded)
>>> data
b'data to be encoded'


Consideraciones de Seguridad
============================

Se agregó una nueva sección de consideraciones de seguridad a **RFC
4648** (sección 12); se recomienda revisar la sección de seguridad
para cualquier código implementado en producción.

Ver también:

  Módulo "binascii"
     Módulo de soporte que contiene conversiones de ASCII a binario y
     binario a ASCII.

  **RFC 1521** - MIME (Extensiones multipropósito de correo de
  Internet) Parte uno: Mecanismos para especificar y describir el
  formato de los cuerpos de mensajes de Internet
     La Sección 5.2, "Codificación de transferencia de contenido
     Base64", proporciona la definición de la codificación base64.
