message

Documentation

Overview

Package message used as a storage and loading of encrypted messages.

The package allows initializing verification of the correctness of the message by the hash length and proof of work.

Index

• Constants
• Variables
• type IMessage
  • func LoadMessage(psett ISettings, pMsg interface{}) (IMessage, error)
• type ISettings
  • func NewSettings(pSett *SSettings) ISettings
• type SMessage
  • func (p *SMessage) GetEncKey() []byte
  • func (p *SMessage) GetHash() []byte
  • func (p *SMessage) GetPayload() []byte
  • func (p *SMessage) GetPubKey() []byte
  • func (p *SMessage) GetSalt() []byte
  • func (p *SMessage) GetSign() []byte
  • func (p *SMessage) IsValid(psett ISettings) bool
  • func (p *SMessage) ToBytes() []byte
  • func (p *SMessage) ToString() string
• type SSettings

Constants

const (
	CSeparator = "@"
)

Variables

var (
	ErrUnknownType        = errors.New("unknown type of message")
	ErrSeparatorNotFound  = errors.New("separator is not found")
	ErrDeserializeMessage = errors.New("deserialize message")
	ErrDecodePayload      = errors.New("decode hex payload")
	ErrInvalidMessage     = errors.New("invalid message")
)

Types

type IMessage

type IMessage interface {
	types.IConverter

	IsValid(ISettings) bool
	GetPubKey() []byte  // Public key of the sender.
	GetEncKey() []byte  // One-time key of encryption data.
	GetSalt() []byte    // Random bytes for hide data of the hash.
	GetHash() []byte    // Hash of the (sender + receiver + payload).
	GetSign() []byte    // Sign of the hash.
	GetPayload() []byte // Main data in the ecnrypted bytes format.
}

func LoadMessage

func LoadMessage(psett ISettings, pMsg interface{}) (IMessage, error)

Message can be created only with client module.

type ISettings

type ISettings interface {
	GetKeySizeBits() uint64
	GetMessageSizeBytes() uint64
}

func NewSettings

func NewSettings(pSett *SSettings) ISettings

type SMessage

type SMessage struct {
	FPubKey  string `json:"pubk"`
	FEncKey  string `json:"enck"`
	FSalt    string `json:"salt"`
	FHash    string `json:"hash"`
	FSign    string `json:"sign"`
	FPayload []byte `json:"-"`
}

Basic structure of transport package.

func (*SMessage) GetEncKey

func (p *SMessage) GetEncKey() []byte

func (*SMessage) GetHash

func (p *SMessage) GetHash() []byte

func (*SMessage) GetPayload

func (p *SMessage) GetPayload() []byte

func (*SMessage) GetPubKey

func (p *SMessage) GetPubKey() []byte

func (*SMessage) GetSalt

func (p *SMessage) GetSalt() []byte

func (*SMessage) GetSign

func (p *SMessage) GetSign() []byte

func (*SMessage) IsValid

func (p *SMessage) IsValid(psett ISettings) bool

func (*SMessage) ToBytes

func (p *SMessage) ToBytes() []byte

func (*SMessage) ToString

func (p *SMessage) ToString() string

type SSettings

type SSettings sSettings