base32

Imports

Imports #

"io"
"slices"
"strconv"

Constants & Variables

HexEncoding var #

HexEncoding is the “Extended Hex Alphabet” defined in RFC 4648. It is typically used in DNS.

var HexEncoding = *ast.CallExpr

NoPadding const #

const NoPadding rune = *ast.UnaryExpr

StdEncoding var #

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

var StdEncoding = *ast.CallExpr

StdPadding const #

const StdPadding rune = '='

decodeMapInitialize const #

const decodeMapInitialize = *ast.BinaryExpr

invalidIndex const #

const invalidIndex = '\xff'

Type Aliases

CorruptInputError type #

type CorruptInputError int64

Structs

Encoding struct #

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.

type Encoding struct {
encode [32]byte
decodeMap [256]uint8
padChar rune
}

decoder struct #

type decoder struct {
err error
enc *Encoding
r io.Reader
end bool
buf [1024]byte
nbuf int
out []byte
outbuf [*ast.BinaryExpr]byte
}

encoder struct #

type encoder struct {
err error
enc *Encoding
w io.Writer
buf [5]byte
nbuf int
out [1024]byte
}

newlineFilteringReader struct #

type newlineFilteringReader struct {
wrapped io.Reader
}

Functions

AppendDecode method #

AppendDecode appends the base32 decoded src to dst and returns the extended buffer. If the input is malformed, it returns the partially decoded src and an error. New line characters (\r and \n) are ignored.

func (enc *Encoding) AppendDecode(dst []byte, src []byte) ([]byte, error)

AppendEncode method #

AppendEncode appends the base32 encoded src to dst and returns the extended buffer.

func (enc *Encoding) AppendEncode(dst []byte, src []byte) []byte

Close method #

Close flushes any pending output from the encoder. It is an error to call Write after calling Close.

func (e *encoder) Close() error

Decode method #

Decode decodes src using the encoding enc. It writes at most [Encoding.DecodedLen](len(src)) bytes to dst and returns the number of bytes written. The caller must ensure that dst is large enough to hold all the decoded data. If src contains invalid base32 data, it will return the number of bytes successfully written and [CorruptInputError]. Newline characters (\r and \n) are ignored.

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

DecodeString method #

DecodeString returns the bytes represented by the base32 string s. If the input is malformed, it returns the partially decoded data and [CorruptInputError]. New line characters (\r and \n) are ignored.

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

DecodedLen method #

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

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

Encode method #

Encode encodes src using the encoding enc, writing [Encoding.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 (enc *Encoding) Encode(dst []byte, src []byte)

EncodeToString method #

EncodeToString returns the base32 encoding of src.

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

EncodedLen method #

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

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

Error method #

func (e CorruptInputError) Error() string

NewDecoder function #

NewDecoder constructs a new base32 stream decoder.

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

NewEncoder function #

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.

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

NewEncoding function #

NewEncoding returns a new padded Encoding defined by the given alphabet, which must be a 32-byte string that contains unique byte values and does not contain the padding character or CR / LF ('\r', '\n'). The alphabet is treated as a sequence of byte values without any special treatment for multi-byte UTF-8. The resulting Encoding uses the default padding character ('='), which may be changed or disabled via [Encoding.WithPadding].

func NewEncoding(encoder string) *Encoding

Read method #

func (r *newlineFilteringReader) Read(p []byte) (int, error)

Read method #

func (d *decoder) Read(p []byte) (n int, err error)

WithPadding method #

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, must not be negative, and must be a rune equal or below '\xff'. Padding characters above '\x7f' are encoded as their exact byte value rather than using the UTF-8 representation of the codepoint.

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

Write method #

func (e *encoder) Write(p []byte) (n int, err error)

decode method #

decode is like Decode but returns an additional 'end' value, which indicates if end-of-message padding was encountered and thus any additional data is an error. This method assumes that src has been stripped of all supported whitespace ('\r' and '\n').

func (enc *Encoding) decode(dst []byte, src []byte) (n int, end bool, err error)

decodedLen function #

func decodedLen(n int, padChar rune) int

readEncodedData function #

func readEncodedData(r io.Reader, buf []byte, min int, expectsPadding bool) (n int, err error)

stripNewlines function #

stripNewlines removes newline characters and returns the number of non-newline characters copied to dst.

func stripNewlines(dst []byte, src []byte) int

Generated with Arrow