version: 1.10

package base32

import "encoding/base32"

Overview

Package base32 implements base32 encoding as specified by RFC 4648.

Index

Examples

Package files

base32.go

Constants

  1. const (
  2.     StdPadding rune = '=' // Standard padding character
  3.     NoPadding  rune = -1  // No padding
  4. )

Variables

  1. var HexEncoding = NewEncoding(encodeHex)

HexEncoding is the ``Extended Hex Alphabet’’ defined in RFC 4648. It is
typically used in DNS.

  1. var StdEncoding = NewEncoding(encodeStd)

StdEncoding is the standard base32 encoding, as defined in RFC 4648.

func NewDecoder

  1. func NewDecoder(enc *Encoding, r io.Reader) io.Reader

NewDecoder constructs a new base32 stream decoder.

func NewEncoder

  1. func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser

NewEncoder returns a new base32 stream encoder. Data written to the returned
writer will be encoded using enc and then written to w. Base32 encodings operate
in 5-byte blocks; when finished writing, the caller must Close the returned
encoder to flush any partially written blocks.


Example:

  1. input := []byte("foo\x00bar")
  2. encoder := base32.NewEncoder(base32.StdEncoding, os.Stdout)
  3. encoder.Write(input)
  4. // Must close the encoder when finished to flush any partial blocks.
  5. // If you comment out the following line, the last partial block "r"
  6. // won't be encoded.
  7. encoder.Close()
  8. // Output:
  9. // MZXW6ADCMFZA====

type CorruptInputError

  1. type CorruptInputError int64

func (CorruptInputError) Error

  1. func (e CorruptInputError) Error() string

type Encoding

  1. type Encoding struct {
  2.     // contains filtered or unexported fields
  3. }

An Encoding is a radix 32 encoding/decoding scheme, defined by a 32-character
alphabet. The most common is the “base32” encoding introduced for SASL GSSAPI
and standardized in RFC 4648. The alternate “base32hex” encoding is used in
DNSSEC.

func NewEncoding

  1. func NewEncoding(encoder string) *Encoding

NewEncoding returns a new Encoding defined by the given alphabet, which must be
a 32-byte string.

func (*Encoding) Decode

  1. func (enc *Encoding) Decode(dst, src []byte) (n int, err error)

Decode decodes src using the encoding enc. It writes at most
DecodedLen(len(src)) bytes to dst and returns the number of bytes written. If
src contains invalid base32 data, it will return the number of bytes
successfully written and CorruptInputError. New line characters (\r and \n) are
ignored.

func (*Encoding) DecodeString

  1. func (enc *Encoding) DecodeString(s string) ([]byte, error)

DecodeString returns the bytes represented by the base32 string s.


Example:

  1. str := "ONXW2ZJAMRQXIYJAO5UXI2BAAAQGC3TEEDX3XPY="
  2. data, err := base32.StdEncoding.DecodeString(str)
  3. if err != nil {
  4.     fmt.Println("error:", err)
  5.     return
  6. }
  7. fmt.Printf("%q\n", data)
  8. // Output:
  9. // "some data with \x00 and \ufeff"

func (*Encoding) DecodedLen

  1. func (enc *Encoding) DecodedLen(n int) int

DecodedLen returns the maximum length in bytes of the decoded data corresponding
to n bytes of base32-encoded data.

func (*Encoding) Encode

  1. func (enc *Encoding) Encode(dst, src []byte)

Encode encodes src using the encoding enc, writing EncodedLen(len(src)) bytes to
dst.

The encoding pads the output to a multiple of 8 bytes, so Encode is not
appropriate for use on individual blocks of a large data stream. Use
NewEncoder() instead.

func (*Encoding) EncodeToString

  1. func (enc *Encoding) EncodeToString(src []byte) string

EncodeToString returns the base32 encoding of src.


Example:

  1. data := []byte("any + old & data")
  2. str := base32.StdEncoding.EncodeToString(data)
  3. fmt.Println(str)
  4. // Output:
  5. // MFXHSIBLEBXWYZBAEYQGIYLUME======

func (*Encoding) EncodedLen

  1. func (enc *Encoding) EncodedLen(n int) int

EncodedLen returns the length in bytes of the base32 encoding of an input buffer
of length n.

func (Encoding) WithPadding

  1. func (enc Encoding) WithPadding(padding rune) *Encoding

WithPadding creates a new encoding identical to enc except with a specified
padding character, or NoPadding to disable padding. The padding character must
not be ‘\r’ or ‘\n’, must not be contained in the encoding’s alphabet and must
be a rune equal or below ‘\xff’.