envelope

Jul 22, 2024

Changes in this version

+ func OpenPayload(msg *api.SecureEnvelope, opts ...Option) (payload *api.Payload, reject *api.Error, err error)

+ func SealPayload(payload *api.Payload, opts ...Option) (_ *api.SecureEnvelope, reject *api.Error, err error)

type Envelope

+ func (e *Envelope) FindPayload() *api.Payload

+ func (e *Envelope) FindPublicKeySignature() string

+ func (e *Envelope) Parent() *Envelope

May 25, 2024

Changes in this version

+ var ErrCannotVerify = errors.New("cannot verify hmac: no cryptographic handler available")

+ var ErrInvalidErrorCode = errors.New("invalid rejection: unknown trisa error code")

+ var ErrMissingErrorCode = errors.New("invalid rejection: missing error code")

+ var ErrMissingErrorMessage = errors.New("invalid rejection: missing error message")

+ var ErrNoError = errors.New("invalid rejection: missing expected rejection error")

type Envelope

+ func WrapError(reject *api.Error, opts ...Option) (env *Envelope, err error)

+ func (e *Envelope) TransferState() api.TransferState

+ func (e *Envelope) ValidateError() error

+ func (e *Envelope) ValidateHMAC() (valid bool, err error)

type Option

+ func WithTransferState(state api.TransferState) Option

Apr 24, 2024

Changes in this version

+ var ErrInvalidEnvelopeId = errors.New("invalid envelope: envelope id is not a uuid")

+ var ErrInvalidTimestamp = errors.New("invalid envelope: could not parse ordering timestamp in RFC3339 format")

+ func Timestamp(msg *api.SecureEnvelope) (time.Time, error)

type Envelope

+ func (e *Envelope) IsError() bool

+ func (e *Envelope) UUID() (uuid.UUID, error)

Nov 14, 2022

Changes in this version

+ var ErrInvalidOrderingTimestamp = errors.New("could not parse ordering timestamp on secure envelope as RFC3339 timestamp")

+ var ErrNoOrderingTimesamp = errors.New("missing ordering timestamp on secure envelope")

May 26, 2022

Changes in this version

+ func Check(msg *api.SecureEnvelope) (_ *api.Error, iserr bool)

type State

+ func Status(msg *api.SecureEnvelope) State

Apr 18, 2022

Changes in this version

+ var ErrCannotEncrypt = errors.New("cannot encrypt envelope: no cryptographic handler available")

+ var ErrCannotSeal = errors.New("cannot seal envelope: no public key cryptographic handler available")

+ var ErrCannotUnseal = errors.New("cannot unseal envelope: no private key cryptographic handler available")

+ var ErrInvalidReceivedatPayload = errors.New("invalid payload: could not parse received at timestamp in RFC3339 format")

+ var ErrInvalidSentAtPayload = errors.New("invalid payload: could not parse sent at timestamp in RFC3339 format")

+ var ErrNoEncryptionInfo = errors.New("invalid envelope: missing encryption key or algorithm")

+ var ErrNoEnvelopeId = errors.New("invalid envelope: no envelope id")

+ var ErrNoHMACInfo = errors.New("invalid envelope: missing hmac signature, secret, or algorithm")

+ var ErrNoIdentityPayload = errors.New("invalid payload: payload does not contain identity data")

+ var ErrNoMessage = errors.New("invalid envelope: no wrapped message")

+ var ErrNoMessageData = errors.New("invalid envelope: must contain either error or payload")

+ var ErrNoPayload = errors.New("invalid payload: payload has not been decrypted")

+ var ErrNoSentAtPayload = errors.New("invalid payload: sent at timestamp is missing")

+ var ErrNoTimestamp = errors.New("invalid envelope: no ordering timestamp")

+ var ErrNoTransactionPayload = errors.New("invalid payload: payload does not contain transaction data")

+ func Open(msg *api.SecureEnvelope, opts ...Option) (payload *api.Payload, reject *api.Error, err error)

+ func Reject(reject *api.Error, opts ...Option) (_ *api.SecureEnvelope, err error)

+ func Seal(payload *api.Payload, opts ...Option) (_ *api.SecureEnvelope, reject *api.Error, err error)

+ func Validate(msg *api.SecureEnvelope) (err error)

+ type Envelope struct

+ func New(payload *api.Payload, opts ...Option) (env *Envelope, err error)

+ func Wrap(msg *api.SecureEnvelope, opts ...Option) (env *Envelope, err error)

+ func (e *Envelope) Crypto() crypto.Crypto

+ func (e *Envelope) Decrypt(opts ...Option) (env *Envelope, reject *api.Error, err error)

+ func (e *Envelope) Encrypt(opts ...Option) (env *Envelope, reject *api.Error, err error)

+ func (e *Envelope) Error() *api.Error

+ func (e *Envelope) ID() string

+ func (e *Envelope) Payload() (_ *api.Payload, err error)

+ func (e *Envelope) Proto() *api.SecureEnvelope

+ func (e *Envelope) Reject(reject *api.Error, opts ...Option) (env *Envelope, err error)

+ func (e *Envelope) Seal(opts ...Option) (env *Envelope, reject *api.Error, err error)

+ func (e *Envelope) Sealer() crypto.Cipher

+ func (e *Envelope) State() State

+ func (e *Envelope) Timestamp() (ts time.Time, err error)

+ func (e *Envelope) Unseal(opts ...Option) (env *Envelope, reject *api.Error, err error)

+ func (e *Envelope) Update(payload *api.Payload, opts ...Option) (env *Envelope, err error)

+ func (e *Envelope) ValidateMessage() error

+ func (e *Envelope) ValidatePayload() error

+ type Option func(e *Envelope) error

+ func FromEnvelope(env *Envelope) Option

+ func WithAESGCM(encryptionKey []byte, hmacSecret []byte) Option

+ func WithCrypto(crypto crypto.Crypto) Option

+ func WithEnvelopeID(id string) Option

+ func WithRSAPrivateKey(key *rsa.PrivateKey) Option

+ func WithRSAPublicKey(key *rsa.PublicKey) Option

+ func WithSeal(seal crypto.Cipher) Option

+ func WithSealingKey(key interface{}) Option

+ func WithTimestamp(ts time.Time) Option

+ func WithUnsealingKey(key interface{}) Option

+ type State uint16

+ const Clear

+ const ClearError

+ const Corrupted

+ const Error

+ const Sealed

+ const SealedError

+ const Unknown

+ const Unsealed

+ const UnsealedError

+ func (s State) String() string