transport

Documentation

Index

• type Envelope
• type Packager

Types

type Envelope

type Envelope struct {
	Message []byte
	FromKey []byte
	// ToKeys stores keys for an outbound message packing
	ToKeys []string
	// ToKey holds the key that was used to decrypt an inbound message
	ToKey   []byte
	FromDID string
	ToDID   string
}

Envelope holds message data and metadata for inbound and outbound messaging.

type Packager

type Packager interface {
	// PackMessage Pack a message for one or more recipients.
	//
	// Args:
	//
	// envelope: The message to pack
	//
	// Returns:
	//
	// []byte: The packed message
	//
	// error: error
	PackMessage(envelope *Envelope) ([]byte, error)

	// UnpackMessage Unpack a message.
	//
	// Args:
	//
	// encMessage: The encrypted message
	//
	// Returns:
	//
	// envelope: unpack message
	//
	// error: error
	UnpackMessage(encMessage []byte) (*Envelope, error)
}

Packager manages the handling, building and parsing of DIDComm raw messages in JSON envelopes.

These envelopes are used as wire-level wrappers of messages sent in Aries agent-agent communication.