# `base64` — Base16, Base32, Base64, Base85 데이터 인코딩

소스 코드: Lib/base64.py

This module provides functions for encoding binary data to printable ASCII characters and decoding such encodings back to binary data. This includes the encodings specified in RFC 4648 (Base64, Base32 and Base16), the Base85 encoding specified in PDF 2.0, and non-standard variants of Base85 used elsewhere.

이 모듈은 두 개의 인터페이스를 제공합니다. 최신 인터페이스는 바이트열류 객체를 ASCII `bytes`로 인코딩하고, 바이트열류 객체나 ASCII를 포함하는 문자열을 `bytes`로 디코딩하는 것을 지원합니다. RFC 4648에 정의된 두 가지(일반, 그리고 URL과 파일 시스템에서 안전한) base-64 알파벳이 모두 지원됩니다.

The legacy interface does not support decoding from strings, but it does provide functions for encoding and decoding to and from file objects. 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 `email` package instead.

버전 3.3에서 변경: ASCII 전용 유니코드 문자열은 이제 최신 인터페이스의 디코딩 함수가 받아들입니다.

버전 3.4에서 변경: 모든 바이트열류 객체는 이제 이 모듈의 모든 인코딩과 디코딩 함수가 받아들입니다. Ascii85/Base85 지원이 추가되었습니다.

## RFC 4648 Encodings

The RFC 4648 encodings are suitable for encoding binary data so that it can be safely sent by email, used as parts of URLs, or included as part of an HTTP POST request.

base64.b64encode(s, altchars=None, *, padded=True, wrapcol=0)

  Base64를 사용하여 바이트열류 객체 s를 인코딩하고 인코딩된 `bytes`를 반환합니다.

  선택적 altchars는 `+`와 `/` 문자의 대체 알파벳을 지정하는 길이 2의 바이트열류 객체여야 합니다. 이를 통해 응용 프로그램은 URL이나 파일 시스템에서 안전한 Base64 문자열을 생성할 수 있습니다. 기본값은 `None`이며, 표준 Base64 알파벳이 사용됩니다.

  If padded is true (default), pad the encoded data with the ‘=’ character to a size multiple of 4. If padded is false, do not add the pad characters.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not insert any newlines.

  버전 3.15에서 변경: Added the padded and wrapcol parameters.

base64.b64decode(s, altchars=None, validate=False, *, padded=True, canonical=False)
base64.b64decode(s, altchars=None, validate=True, *, ignorechars, padded=True, canonical=False)

  Base64로 인코딩된 바이트열류 객체나 ASCII 문자열 s를 디코딩하고 디코딩된 `bytes`를 반환합니다.

  선택적 altchars는 `+`와 `/` 문자 대신에 사용되는 대체 알파벳을 지정하는 길이 2의 바이트열류 객체나 ASCII 문자열이어야 합니다.

  If padded is true, the last group of 4 base 64 alphabet characters must be padded with the ‘=’ character. If padded is false, padding is neither required nor recognized: the ‘=’ character is not treated as padding but as a non-alphabet character, which means it is silently discarded when validate is false, or causes an `Error` when validate is true unless b’=’ is included in ignorechars.

  s가 잘못 채워지면(padded) `binascii.Error` 예외가 발생합니다.

  If ignorechars is specified, it should be a bytes-like object containing characters to ignore from the input when validate is true. If ignorechars contains the pad character `'='`, the pad characters presented before the end of the encoded data and the excess pad characters will be ignored. The default value of validate is `True` if ignorechars is specified, `False` otherwise.

  If validate is false, characters that are neither in the normal base-64 alphabet nor (if ignorechars is not specified) the alternative alphabet are discarded prior to the padding check, but the `+` and `/` characters keep their meaning if they are not in altchars (they will be discarded in future Python versions).

  If validate is true, these non-alphabet characters in the input result in a `binascii.Error`.

  If canonical is true, non-zero padding bits are rejected. See `binascii.a2b_base64()` for details.

  For more information about the strict base64 check, see `binascii.a2b_base64()`

  버전 3.15에서 변경: Added the canonical, ignorechars, and padded parameters.

  버전 3.15부터 폐지됨: Accepting the `+` and `/` characters with an alternative alphabet is now deprecated.

base64.standard_b64encode(s)

  표준 Base64 알파벳을 사용하여 바이트열류 객체 s를 인코딩하고 인코딩된 `bytes`를 반환합니다.

base64.standard_b64decode(s)

  표준 Base64 알파벳을 사용하여 바이트열류 객체나 ASCII 문자열 s를 디코딩하고 디코딩된 `bytes`를 반환합니다.

base64.urlsafe_b64encode(s, *, padded=True)

  Encode bytes-like object s using the URL- and filesystem-safe alphabet, which substitutes `-` instead of `+` and `_` instead of `/` in the standard Base64 alphabet, and return the encoded `bytes`. The result can still contain `=` if padded is true (default).

  버전 3.15에서 변경: Added the padded parameter.

base64.urlsafe_b64decode(s, *, padded=False)

  표준 Base64 알파벳에서 `+` 대신 `-`를, `/` 대신 `_`를 사용하도록 대체한 URL과 파일 시스템에서 안전한 알파벳을 사용하여 바이트열류 객체나 ASCII 문자열 s를 디코딩하고, 디코딩된 `bytes`를 반환합니다.

  버전 3.15에서 변경: Added the padded parameter. Padding of input is no longer required by default.

  버전 3.15부터 폐지됨: Accepting the `+` and `/` characters is now deprecated.

base64.b32encode(s, *, padded=True, wrapcol=0)

  Base32를 사용하여 바이트열류 객체 s를 인코딩하고 인코딩된 `bytes`를 반환합니다.

  If padded is true (default), pad the encoded data with the ‘=’ character to a size multiple of 8. If padded is false, do not add the pad characters.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not add any newlines.

  버전 3.15에서 변경: Added the padded and wrapcol parameters.

base64.b32decode(s, casefold=False, map01=None, *, padded=True, ignorechars=b'', canonical=False)

  Base32로 인코딩된 바이트열류 객체나 ASCII 문자열 s를 디코딩하고 디코딩된 `bytes`를 반환합니다.

  선택적 casefold는 소문자 알파벳을 입력으로 사용할 수 있는지를 지정하는 플래그입니다. 보안을 위해, 기본값은 `False`입니다.

  RFC 4648은 숫자 0(영)을 글자 O(오)로 선택적으로 매핑하고, 숫자 1(일)을 글자 I(아이)나 글자 L(엘)로 선택적으로 매핑할 수 있게 합니다. 선택적 인자 map01이 `None`이 아니면, 숫자 1이 매핑되어야 하는 글자를 지정합니다 (map01이 `None`이 아닐 때, 숫자 0은 항상 글자 O로 매핑됩니다). 보안상의 이유로 기본값은 `None`이고, 0과 1은 입력에 허용되지 않습니다.

  If padded is true, the last group of 8 base 32 alphabet characters must be padded with the ‘=’ character. If padded is false, padding is neither required nor recognized: the ‘=’ character is not treated as padding but as a non-alphabet character, which means it raises an `Error` unless b’=’ is included in ignorechars.

  ignorechars should be a bytes-like object containing characters to ignore from the input.

  If canonical is true, non-zero padding bits are rejected. See `binascii.a2b_base32()` for details.

  s가 잘못 채워졌거나(padded) 입력에 알파벳이 아닌 문자가 있으면 `binascii.Error`가 발생합니다.

  버전 3.15에서 변경: Added the canonical, ignorechars, and padded parameters.

base64.b32hexencode(s, *, padded=True, wrapcol=0)

  Similar to `b32encode()` but uses the Extended Hex Alphabet, as defined in RFC 4648.

  Added in version 3.10.

  버전 3.15에서 변경: Added the padded and wrapcol parameters.

base64.b32hexdecode(s, casefold=False, *, padded=True, ignorechars=b'', canonical=False)

  Similar to `b32decode()` but uses the Extended Hex Alphabet, as defined in RFC 4648.

  This version does not allow the digit 0 (zero) to the letter O (oh) and digit 1 (one) to either the letter I (eye) or letter L (el) mappings, all these characters are included in the Extended Hex Alphabet and are not interchangeable.

  Added in version 3.10.

  버전 3.15에서 변경: Added the canonical, ignorechars, and padded parameters.

base64.b16encode(s, *, wrapcol=0)

  Base16을 사용하여 바이트열류 객체 s를 인코딩하고 인코딩된 `bytes`를 반환합니다.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not add any newlines.

  버전 3.15에서 변경: Added the wrapcol parameter.

base64.b16decode(s, casefold=False, *, ignorechars=b'')

  Base16으로 인코딩된 바이트열류 객체나 ASCII 문자열 s를 디코딩하고 디코딩된 `bytes`를 반환합니다.

  선택적 casefold는 소문자 알파벳을 입력으로 사용할 수 있는지를 지정하는 플래그입니다. 보안을 위해, 기본값은 `False`입니다.

  ignorechars should be a bytes-like object containing characters to ignore from the input.

  s가 잘못 채워졌거나(padded) 입력에 알파벳이 아닌 문자가 있으면 `binascii.Error`가 발생합니다.

  버전 3.15에서 변경: Added the ignorechars parameter.

## Base85 Encodings

Base85 encoding is a family of algorithms which represent four bytes using five ASCII characters. Originally implemented in the Unix `btoa(1)` utility, a version of it was later adopted by Adobe in the PostScript language and is standardized in PDF 2.0 (ISO 32000-2). This version, in both its `btoa` and PDF variants, is implemented by `a85encode()`.

A separate version, using a different output character set, was defined as an April Fool’s joke in RFC 1924 but is now used by Git and other software. This version is implemented by `b85encode()`.

Finally, a third version, using yet another output character set designed for safe inclusion in programming language strings, is defined by ZeroMQ and implemented here by `z85encode()`.

The functions present in this module differ in how they handle the following:

- Whether to include and expect enclosing `<~` and `~>` markers.

- Whether to fold the input into multiple lines.

- The set of ASCII characters used for encoding.

- Compact encodings of sequences of spaces and null bytes.

- The encoding of zero-padding bytes applied to the input.

Refer to the documentation of the individual functions for more information.

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

  Ascii85를 사용하여 바이트열류 객체 b를 인코딩하고 인코딩된 `bytes`를 반환합니다.

  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 encoding used in PDF.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not insert any newlines.

  pad controls whether zero-padding applied to the end of the input is fully retained in the output encoding, as done by `btoa`, producing an exact multiple of 5 bytes of output. This is not part of the standard encoding used in PDF, as it does not preserve the length of the data.

  adobe controls whether the encoded byte sequence is framed with `<~` and `~>`, as in a PostScript base-85 string literal. Note that while ASCII85Decode streams in PDF documents must be terminated with `~>`, they must not use a leading `<~`.

  Added in version 3.4.

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

  Ascii85로 인코딩된 바이트열류 객체나 ASCII 문자열 b를 디코딩하고 디코딩된 `bytes`를 반환합니다.

  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 used in PDF and PostScript.

  adobe controls whether the `<~` and `~>` markers are present. While the leading `<~` is not required, the input must end with `~>`, or a `ValueError` is raised.

  ignorechars should be a bytes-like object containing characters to ignore from the input. This should only contain whitespace characters, and by default contains all whitespace characters in ASCII.

  If canonical is true, non-canonical encodings are rejected. See `binascii.a2b_ascii85()` for details.

  Added in version 3.4.

  버전 3.15에서 변경: Added the canonical parameter. Single-character final groups are now always rejected as encoding violations.

base64.b85encode(b, pad=False, *, wrapcol=0)

  base85를 사용하여 바이트열류 객체 b를 인코딩하고 (예를 들어 git 스타일 바이너리 diff에서 사용되는 것처럼), 인코딩된 `bytes`를 반환합니다.

  The input is padded with `b'\0'` so its length is a multiple of 4 bytes before encoding. If pad is true, all the resulting characters are retained in the output, which will always be a multiple of 5 bytes, and thus the length of the data may not be preserved on decoding.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not add any newlines.

  Added in version 3.4.

  버전 3.15에서 변경: Added the wrapcol parameter.

base64.b85decode(b, *, ignorechars=b'', canonical=False)

  Decode the base85-encoded bytes-like object or ASCII string b and return the decoded `bytes`.

  ignorechars should be a bytes-like object containing characters to ignore from the input.

  If canonical is true, non-canonical encodings are rejected. See `binascii.a2b_base85()` for details.

  Added in version 3.4.

  버전 3.15에서 변경: Added the canonical and ignorechars parameters. Single-character final groups are now always rejected as encoding violations.

base64.z85encode(s, pad=False, *, wrapcol=0)

  Encode the bytes-like object s using Z85 (as used in ZeroMQ) and return the encoded `bytes`.

  The input is padded with `b'\0'` so its length is a multiple of 4 bytes before encoding. If pad is true, all the resulting characters are retained in the output, which will always be a multiple of 5 bytes, as required by the ZeroMQ standard.

  If wrapcol is non-zero, insert a newline (`b'\n'`) character after at most every wrapcol characters. If wrapcol is zero (default), do not add any newlines.

  Added in version 3.13.

  버전 3.15에서 변경: The pad parameter was added.

  버전 3.15에서 변경: Added the wrapcol parameter.

base64.z85decode(s, *, ignorechars=b'', canonical=False)

  Decode the Z85-encoded bytes-like object or ASCII string s and return the decoded `bytes`.

  ignorechars should be a bytes-like object containing characters to ignore from the input.

  If canonical is true, non-canonical encodings are rejected. See `binascii.a2b_base85()` for details.

  Added in version 3.13.

  버전 3.15에서 변경: Added the canonical and ignorechars parameters. Single-character final groups are now always rejected as encoding violations.

## Legacy Interface

base64.decode(input, output)

  바이너리 input 파일의 내용을 디코딩하고 결과 바이너리 데이터를 output 파일에 씁니다. input과 output은 파일 객체여야 합니다. input은 `input.readline()`이 빈 바이트열 객체를 반환할 때까지 읽힙니다.

base64.decodebytes(s)

  하나 이상의 base64 인코딩된 데이터 줄을 포함해야 하는 바이트열류 객체 s를 디코딩하고 디코딩된 `bytes`를 반환합니다.

  Added in version 3.1.

base64.encode(input, output)

  바이너리 input 파일의 내용을 인코딩하고 base64로 인코딩된 결과 데이터를 output 파일에 씁니다. input과 output은 파일 객체여야 합니다. input은 `input.read()`이 빈 바이트열 객체를 반환할 때까지 읽힙니다. `encode()`는 RFC 2045(MIME)에 따라 출력의 76바이트마다 개행 문자(`b'\n'`)를 삽입할 뿐만 아니라, 항상 출력이 개행 문자로 끝나도록 합니다.

base64.encodebytes(s)

  임의의 바이너리 데이터를 포함할 수 있는 바이트열류 객체 s를 인코딩하고, RFC 2045 (MIME)에 따라 76바이트의 출력마다 개행(`b'\n'`)이 삽입되고, 후행 개행이 붙은 base64 인코딩된 데이터를 포함하는 `bytes`를 반환합니다.

  Added in version 3.1.

모듈 사용 예:

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

## Security Considerations

A new security considerations section was added to RFC 4648 (section 12); it’s recommended to review the security section for any code deployed to production.

더 보기

모듈 `binascii`

  ASCII에서 바이너리로, 바이너리에서 ASCII로의 변환이 포함된 지원 모듈.

RFC 1521 - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

  5.2 절, “Base64 Content-Transfer-Encoding” 은 base64 인코딩의 정의를 제공합니다.

ISO 32000-2 Portable document format - Part 2: PDF 2.0

  Section 7.4.3, “ASCII85Decode Filter,” provides the definition of the Ascii85 encoding used in PDF and PostScript, including the output character set and the details of data length preservation using zero-padding and partial output groups.

ZeroMQ RFC 32/Z85

  The “Formal Specification” section provides the character set used in Z85.