libolmpickle

Documentation

Index

• Constants
• func Pickle(key, plaintext []byte) ([]byte, error)
• func PickleAsJSON(object any, pickleVersion byte, key []byte) ([]byte, error)
• func Unpickle(key, input []byte) ([]byte, error)
• func UnpickleAsJSON(object any, pickled, key []byte, pickleVersion byte) error
• type Decoder
  • func NewDecoder(buf []byte) *Decoder
  • func (d *Decoder) ReadBool() (bool, error)
  • func (d *Decoder) ReadBytes(length int) (data []byte, err error)
  • func (d *Decoder) ReadUInt32() (uint32, error)
  • func (d *Decoder) ReadUInt8() (uint8, error)
• type Encoder
  • func NewEncoder() *Encoder
  • func (p *Encoder) WriteBool(value bool)
  • func (p *Encoder) WriteEmptyBytes(count int)
  • func (p *Encoder) WriteUInt32(value uint32)
  • func (p *Encoder) WriteUInt8(value uint8)

Constants

const (
	PickleBoolLength   = 1
	PickleUInt8Length  = 1
	PickleUInt32Length = 4
)

Functions

func Pickle

func Pickle(key, plaintext []byte) ([]byte, error)

Pickle encrypts the input with the key and the cipher AESSHA256. The result is then encoded in base64.

func PickleAsJSON

func PickleAsJSON(object any, pickleVersion byte, key []byte) ([]byte, error)

PickleAsJSON returns an object as a base64 string encrypted using the supplied key. The unencrypted representation of the object is in JSON format.

func Unpickle

func Unpickle(key, input []byte) ([]byte, error)

Unpickle decodes the input from base64 and decrypts the decoded input with the key and the cipher AESSHA256.

func UnpickleAsJSON

func UnpickleAsJSON(object any, pickled, key []byte, pickleVersion byte) error

UnpickleAsJSON updates the object by a base64 encrypted string using the supplied key. The unencrypted representation has to be in JSON format.

Types

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

func NewDecoder

func NewDecoder(buf []byte) *Decoder

func (*Decoder) ReadBool

func (d *Decoder) ReadBool() (bool, error)

func (*Decoder) ReadBytes

func (d *Decoder) ReadBytes(length int) (data []byte, err error)

func (*Decoder) ReadUInt32

func (d *Decoder) ReadUInt32() (uint32, error)

func (*Decoder) ReadUInt8

func (d *Decoder) ReadUInt8() (uint8, error)

type Encoder

type Encoder struct {
	bytes.Buffer
}

func NewEncoder

func NewEncoder() *Encoder

func (*Encoder) WriteBool

func (p *Encoder) WriteBool(value bool)

func (*Encoder) WriteEmptyBytes

func (p *Encoder) WriteEmptyBytes(count int)

func (*Encoder) WriteUInt32

func (p *Encoder) WriteUInt32(value uint32)

func (*Encoder) WriteUInt8

func (p *Encoder) WriteUInt8(value uint8)