bertlv

README

ASN.1 BER-TLV Parsing and Builder

The project is a simple implementation of ASN.1 BER-TLV parsing and builder in Golang.

Test Coverage: 100%

References

• ASN.1
• ITU-T X.690
• ASN.1 Complete by Prof John Larmouth
• Quick ASN.1 Reference / ASN.1 Basic Encoding Rules

Documentation

Index

• Constants
• type Class
  • func (c Class) Constructed(value uint64) Tag
  • func (c Class) Primitive(value uint64) Tag
• type Form
  • func (f Form) Application(value uint64) Tag
  • func (f Form) ContextSpecific(value uint64) Tag
  • func (f Form) Private(value uint64) Tag
  • func (f Form) Universal(value uint64) Tag
• type Marshaler
• type Reflective
• type TLV
  • func MarshalValue(tag Tag, marshaler encoding.BinaryMarshaler) (tlv *TLV, err error)
  • func NewChildren(tag Tag, children ...*TLV) *TLV
  • func NewChildrenIter(tag Tag, children iter.Seq[*TLV]) *TLV
  • func NewValue(tag Tag, value []byte) *TLV
  • func (tlv *TLV) At(index int) *TLV
  • func (tlv *TLV) Bytes() []byte
  • func (tlv *TLV) Clone() *TLV
  • func (tlv *TLV) Find(tag Tag) (matches []*TLV)
  • func (tlv *TLV) First(tag Tag) *TLV
  • func (tlv *TLV) Len() int
  • func (tlv *TLV) MarshalBERTLV() (*TLV, error)
  • func (tlv *TLV) MarshalBinary() ([]byte, error)
  • func (tlv *TLV) MarshalText() ([]byte, error)
  • func (tlv *TLV) MarshalValue(marshaler encoding.BinaryMarshaler) (err error)
  • func (tlv *TLV) ReadFrom(r io.Reader) (n int64, err error)
  • func (tlv *TLV) Select(tags ...Tag) *TLV
  • func (tlv *TLV) String() string
  • func (tlv *TLV) UnmarshalBERTLV(cloned *TLV) error
  • func (tlv *TLV) UnmarshalBinary(data []byte) error
  • func (tlv *TLV) UnmarshalText(text []byte) error
  • func (tlv *TLV) UnmarshalValue(unmarshaler encoding.BinaryUnmarshaler) error
  • func (tlv *TLV) WriteTo(w io.Writer) (n int64, err error)
• type Tag
  • func NewTag(class Class, form Form, value uint64) Tag
  • func (t *Tag) Application() bool
  • func (t *Tag) Class() Class
  • func (t *Tag) Constructed() bool
  • func (t *Tag) ContextSpecific() bool
  • func (t *Tag) Equal(tag Tag) bool
  • func (t *Tag) Form() Form
  • func (t *Tag) If(class Class, form Form, value uint64) bool
  • func (t *Tag) Primitive() bool
  • func (t *Tag) Private() bool
  • func (t *Tag) ReadFrom(r io.Reader) (n int64, err error)
  • func (t *Tag) String() string
  • func (t *Tag) Universal() bool
  • func (t *Tag) Value() uint64
• type Unmarshaler

Constants

const (
	Universal       Class = 0b00
	Application     Class = 0b01
	ContextSpecific Class = 0b10
	Private         Class = 0b11
	Primitive       Form  = 0b0
	Constructed     Form  = 0b1
)

Types

type Class

type Class byte

func (Class) Constructed

func (c Class) Constructed(value uint64) Tag

func (Class) Primitive

func (c Class) Primitive(value uint64) Tag

type Form

type Form byte

func (Form) Application

func (f Form) Application(value uint64) Tag

func (Form) ContextSpecific

func (f Form) ContextSpecific(value uint64) Tag

func (Form) Private

func (f Form) Private(value uint64) Tag

func (Form) Universal

func (f Form) Universal(value uint64) Tag

type Marshaler

type Marshaler interface {
	MarshalBERTLV() (*TLV, error)
}

type Reflective

type Reflective interface {
	Tag() Tag
}

type TLV

type TLV struct {
	Tag      Tag
	Value    []byte
	Children []*TLV
}

func MarshalValue

func MarshalValue(tag Tag, marshaler encoding.BinaryMarshaler) (tlv *TLV, err error)

func NewChildren

func NewChildren(tag Tag, children ...*TLV) *TLV

func NewChildrenIter

func NewChildrenIter(tag Tag, children iter.Seq[*TLV]) *TLV

func NewValue

func NewValue(tag Tag, value []byte) *TLV

func (*TLV) At

func (tlv *TLV) At(index int) *TLV

func (*TLV) Bytes

func (tlv *TLV) Bytes() []byte

func (*TLV) Clone

func (tlv *TLV) Clone() *TLV

func (*TLV) Find

func (tlv *TLV) Find(tag Tag) (matches []*TLV)

func (*TLV) First

func (tlv *TLV) First(tag Tag) *TLV

func (*TLV) Len

func (tlv *TLV) Len() int

func (*TLV) MarshalBERTLV

func (tlv *TLV) MarshalBERTLV() (*TLV, error)

func (*TLV) MarshalBinary

func (tlv *TLV) MarshalBinary() ([]byte, error)

func (*TLV) MarshalText

func (tlv *TLV) MarshalText() ([]byte, error)

func (*TLV) MarshalValue

func (tlv *TLV) MarshalValue(marshaler encoding.BinaryMarshaler) (err error)

func (*TLV) ReadFrom

func (tlv *TLV) ReadFrom(r io.Reader) (n int64, err error)

func (*TLV) Select

func (tlv *TLV) Select(tags ...Tag) *TLV

func (*TLV) String

func (tlv *TLV) String() string

func (*TLV) UnmarshalBERTLV

func (tlv *TLV) UnmarshalBERTLV(cloned *TLV) error

func (*TLV) UnmarshalBinary

func (tlv *TLV) UnmarshalBinary(data []byte) error

func (*TLV) UnmarshalText

func (tlv *TLV) UnmarshalText(text []byte) error

func (*TLV) UnmarshalValue

func (tlv *TLV) UnmarshalValue(unmarshaler encoding.BinaryUnmarshaler) error

func (*TLV) WriteTo

func (tlv *TLV) WriteTo(w io.Writer) (n int64, err error)

type Tag

type Tag []byte

func NewTag

func NewTag(class Class, form Form, value uint64) Tag

func (*Tag) Application

func (t *Tag) Application() bool

func (*Tag) Class

func (t *Tag) Class() Class

func (*Tag) Constructed

func (t *Tag) Constructed() bool

func (*Tag) ContextSpecific

func (t *Tag) ContextSpecific() bool

func (*Tag) Equal

func (t *Tag) Equal(tag Tag) bool

func (*Tag) Form

func (t *Tag) Form() Form

func (*Tag) If

func (t *Tag) If(class Class, form Form, value uint64) bool

func (*Tag) Primitive

func (t *Tag) Primitive() bool

func (*Tag) Private

func (t *Tag) Private() bool

func (*Tag) ReadFrom

func (t *Tag) ReadFrom(r io.Reader) (n int64, err error)

func (*Tag) String

func (t *Tag) String() string

func (*Tag) Universal

func (t *Tag) Universal() bool

func (*Tag) Value

func (t *Tag) Value() uint64

type Unmarshaler

type Unmarshaler interface {
	UnmarshalBERTLV(*TLV) error
}