README
¶
ASN1 BER Encoding / Decoding Library for the GO programming language.
Required libraries: None
Working: Very basic encoding / decoding needed for LDAP protocol
Tests Implemented: A few
TODO: Fix all encoding / decoding to conform to ASN1 BER spec Implement Tests / Benchmarks
The Go gopher was designed by Renee French. (http://reneefrench.blogspot.com/) The design is licensed under the Creative Commons 3.0 Attributions license. Read this article for more details: http://blog.golang.org/gopher
Documentation
¶
Index ¶
- Constants
- Variables
- func DecodeString(data []byte) string
- func DescribePacket(p *Packet) string
- func ParseGeneralizedTime(v []byte) (time.Time, error)
- func ParseInt64(bytes []byte) (ret int64, err error)
- func ParseReal(v []byte) (val float64, err error)
- func PrintBytes(out io.Writer, buf []byte, indent string)
- func PrintPacket(p *Packet)
- func WritePacket(out io.Writer, p *Packet)
- type Class
- type Identifier
- type Packet
- func DecodePacket(data []byte) *Packet
- func DecodePacketErr(data []byte) (*Packet, error)
- func Encode(classType Class, tagType Type, tag Tag, value interface{}, description string) *Packet
- func NewBoolean(classType Class, tagType Type, tag Tag, value bool, description string) *Packet
- func NewGeneralizedTime(classType Class, tagType Type, tag Tag, value time.Time, description string) *Packet
- func NewInteger(classType Class, tagType Type, tag Tag, value interface{}, description string) *Packet
- func NewLDAPBoolean(classType Class, tagType Type, tag Tag, value bool, description string) *Packet
- func NewReal(classType Class, tagType Type, tag Tag, value interface{}, description string) *Packet
- func NewSequence(description string) *Packet
- func NewString(classType Class, tagType Type, tag Tag, value, description string) *Packet
- func ReadPacket(reader io.Reader) (*Packet, error)
- type Tag
- type Type
Constants ¶
const ( // LengthLongFormBitmask is the mask to apply to the length byte to see if a long-form byte sequence is used LengthLongFormBitmask = 0x80 // LengthValueBitmask is the mask to apply to the length byte to get the number of bytes in the long-form byte sequence LengthValueBitmask = 0x7f // LengthIndefinite is returned from readLength to indicate an indefinite length LengthIndefinite = -1 )
Variables ¶
var ClassMap = map[Class]string{ ClassUniversal: "Universal", ClassApplication: "Application", ClassContext: "Context", ClassPrivate: "Private", }
var Debug = false
var ErrInvalidTimeFormat = errors.New("invalid time format")
ErrInvalidTimeFormat is returned when the generalizedTime string was not correct.
var MaxPacketLengthBytes int64 = math.MaxInt32
MaxPacketLengthBytes specifies the maximum allowed packet size when calling ReadPacket or DecodePacket. Set to 0 for no limit.
var TypeMap = map[Type]string{ TypePrimitive: "Primitive", TypeConstructed: "Constructed", }
Functions ¶
func DecodeString ¶
func DescribePacket ¶ added in v1.5.5
Return a string describing packet content. This is not recursive, If the packet is a sequence, use `printPacket()`, or browse sequence yourself.
func ParseGeneralizedTime ¶ added in v1.5.0
ParseGeneralizedTime parses a string value and if it conforms to GeneralizedTime^0 format, will return a time.Time for that value.
func ParseInt64 ¶
func PrintPacket ¶
func PrintPacket(p *Packet)
func WritePacket ¶ added in v1.4.1
Types ¶
type Identifier ¶
type Packet ¶
type Packet struct {
Identifier
Value interface{}
ByteValue []byte
Data *bytes.Buffer
Children []*Packet
Description string
}
func DecodePacket ¶
DecodePacket decodes the given bytes into a single Packet If a decode error is encountered, nil is returned.
func DecodePacketErr ¶
DecodePacketErr decodes the given bytes into a single Packet If a decode error is encountered, nil is returned.
func NewBoolean ¶
func NewGeneralizedTime ¶ added in v1.5.0
func NewInteger ¶
func NewLDAPBoolean ¶ added in v1.4.1
NewLDAPBoolean returns a RFC 4511-compliant Boolean packet.
func NewSequence ¶
func ReadPacket ¶
ReadPacket reads a single Packet from the reader.
func (*Packet) AppendChild ¶
type Tag ¶
type Tag uint64
const ( TagEOC Tag = 0x00 TagBoolean Tag = 0x01 TagInteger Tag = 0x02 TagBitString Tag = 0x03 TagOctetString Tag = 0x04 TagNULL Tag = 0x05 TagObjectIdentifier Tag = 0x06 TagObjectDescriptor Tag = 0x07 TagExternal Tag = 0x08 TagRealFloat Tag = 0x09 TagEnumerated Tag = 0x0a TagEmbeddedPDV Tag = 0x0b TagUTF8String Tag = 0x0c TagRelativeOID Tag = 0x0d TagSequence Tag = 0x10 TagSet Tag = 0x11 TagNumericString Tag = 0x12 TagPrintableString Tag = 0x13 TagT61String Tag = 0x14 TagVideotexString Tag = 0x15 TagIA5String Tag = 0x16 TagUTCTime Tag = 0x17 TagGeneralizedTime Tag = 0x18 TagGraphicString Tag = 0x19 TagVisibleString Tag = 0x1a TagGeneralString Tag = 0x1b TagUniversalString Tag = 0x1c TagCharacterString Tag = 0x1d TagBMPString Tag = 0x1e TagBitmask Tag = 0x1f // xxx11111b // HighTag indicates the start of a high-tag byte sequence HighTag Tag = 0x1f // xxx11111b // HighTagContinueBitmask indicates the high-tag byte sequence should continue HighTagContinueBitmask Tag = 0x80 // 10000000b // HighTagValueBitmask obtains the tag value from a high-tag byte sequence byte HighTagValueBitmask Tag = 0x7f // 01111111b )
Source Files