msg

Documentation

Index

• Constants
• type Envelope
  • func UnmarshalAndVerifyEnvelopeFromCBOR(data []byte) (*Envelope, error)
  • func UnmarshalEnvelopeFromCBOR(data []byte) (*Envelope, error)
  • func (e *Envelope) IsValid() bool
  • func (e *Envelope) Open(privateKey []byte) (*Message, error)
  • func (e *Envelope) Verify() error
• type Headers
  • func (h *Headers) CreatedTime() time.Time
  • func (h *Headers) ExpiresTime() time.Time
  • func (h *Headers) Recipient() (*did.DID, error)
  • func (h *Headers) SemVersion() (semver.Version, error)
  • func (h *Headers) Sender() (*did.DID, error)
• type Message
  • func New(from string, to string, content []byte, contentType string, ...) (*Message, error)
  • func NewBroadcast(from string, to string, content []byte, contentType string, ...) (*Message, error)
  • func UnmarshalAndVerifyMessageFromCBOR(b []byte) (*Message, error)
  • func UnmarshalMessageFromCBOR(b []byte) (*Message, error)
  • func (m *Message) Broadcast(ctx context.Context, t *pubsub.Topic) error
  • func (m *Message) Headers() *Headers
  • func (m *Message) Send(ctx context.Context, t *pubsub.Topic) error
  • func (m *Message) Sign(privKey *ed25519.PrivateKey) error
  • func (m *Message) Verify() error

Constants

const (

	// Messages which are older than a day should be ignored
	MESSAGE_TTL = ma.MESSAGE_DEFAULT_TTL
)

Types

type Envelope

type Envelope struct {
	EphemeralKey     []byte
	EncryptedContent []byte
	EncryptedHeaders []byte
}

Bask the encrypted message and the encrypted symmetric key in a CBOR envelope.

func UnmarshalAndVerifyEnvelopeFromCBOR

func UnmarshalAndVerifyEnvelopeFromCBOR(data []byte) (*Envelope, error)

func UnmarshalEnvelopeFromCBOR

func UnmarshalEnvelopeFromCBOR(data []byte) (*Envelope, error)

Takes the envelope as a byte array and returns a pointer to an Envelope struct Basically this is what you do with a receieved message envelope, eg. in an Open() function.

func (*Envelope) IsValid

func (e *Envelope) IsValid() bool

func (*Envelope) Open

func (e *Envelope) Open(privateKey []byte) (*Message, error)

func (*Envelope) Verify

func (e *Envelope) Verify() error

type Headers

type Headers struct {
	// Version of the message format
	Version string
	// Unique identifier of the message
	ID string `cbor:"id"`
	// MIME type of the message
	MimeType string `cbor:"mimeType"`
	// Creation time of the message in seconds since Unix epoch
	Created int64 `cbor:"keyasint64"`
	// Expiration time of the message in seconds since Unix epoch
	Expires int64 `cbor:"keyasint64"`
	// Sender of the message
	From string `cbor:"from"`
	// Recipient of the message
	To string `cbor:"to"`
	// MIME type of the message body
	ContentType string `cbor:"contentType"`
	// Hexadecimal string representation of the SHA-256 hash of the message body
	Signature []byte `cbor:"signature"`
}

This struct mimicks the Headers format, but it's *not* Headers. It should enable using Headers later, if that's a good idea. NB! Content is *not* a part of the headers

func (*Headers) CreatedTime

func (h *Headers) CreatedTime() time.Time

func (*Headers) ExpiresTime

func (h *Headers) ExpiresTime() time.Time

func (*Headers) Recipient

func (h *Headers) Recipient() (*did.DID, error)

func (*Headers) SemVersion

func (h *Headers) SemVersion() (semver.Version, error)

func (*Headers) Sender

func (h *Headers) Sender() (*did.DID, error)

type Message

type Message struct {
	// Version of the message format
	Version string `cbor:"version"`
	// Unique identifier of the message
	ID string `cbor:"id"`
	// MIME type of the message
	MimeType string `cbor:"mimeType"`
	// Sender of the message
	From string `cbor:"from"`
	// Recipient of the message
	To string `cbor:"to"`
	// MIME type of the message body
	ContentType string `cbor:"contentType"`
	// Hexadecimal string representation of the SHA-256 hash of the message body
	Content []byte `cbor:"content"`
	// Signature of the message headers. NB! This includes the ContentHash field,
	// which can be used to verify the integrity of the message body.
	Signature []byte `cbor:"signature"`
}

This struct mimicks the Message format, but it's *not* Message. It should enable using Message later, if that's a good idea.

func New

func New(
	from string,
	to string,
	content []byte,
	contentType string,
	priv_key *ed25519.PrivateKey) (*Message, error)

New creates a new Message instance

func NewBroadcast

func NewBroadcast(
	from string,
	to string,
	content []byte,
	contentType string,
	priv_key *ed25519.PrivateKey) (*Message, error)

func UnmarshalAndVerifyMessageFromCBOR

func UnmarshalAndVerifyMessageFromCBOR(b []byte) (*Message, error)

func UnmarshalMessageFromCBOR

func UnmarshalMessageFromCBOR(b []byte) (*Message, error)

UnmarshalMessageFromCBOR unmarshals a Message from a CBOR byte slice and verifies the signature

func (*Message) Broadcast

func (m *Message) Broadcast(ctx context.Context, t *pubsub.Topic) error

Send message to a pubsub topic

func (*Message) Headers

func (m *Message) Headers() *Headers

Returns the all the imprimatur headers

func (*Message) Send

func (m *Message) Send(ctx context.Context, t *pubsub.Topic) error

EncloseAndSend message to a pubsub topic EncloseAndSend differs from Send in that it encrypts the message and encloses it in an envelope before sending it.

func (*Message) Sign

func (m *Message) Sign(privKey *ed25519.PrivateKey) error

func (*Message) Verify

func (m *Message) Verify() error

Verify verifies the Message's signature Returns nil if the signature is valid