crypt

README

crypt

Package crypt contains utilities to read and write encrypted text and protos.

Install

import (
	"libs.altipla.consulting/crypt"
)

Contributing

You can make pull requests or create issues in GitHub. Any code you send should be formatted using make gofmt.

Running tests

Run the tests:

make test

License

MIT License

Documentation

Overview

Package crypt contains utilities to read and write encrypted text and protos.

Index

• Variables
• type SignOption
  • func WithTTL(ttl time.Duration) SignOption
• type Signer
  • func NewSigner(signature, secret string) *Signer
  • func (s *Signer) ReadMessage(token string, msg proto.Message, opts ...SignOption) error
  • func (s *Signer) SignMessage(msg proto.Message, opts ...SignOption) (string, error)
  • func (s *Signer) String() string

Variables

var (
	ErrEmptyToken   = errors.New("empty token")
	ErrExpiredToken = errors.New("expired token")
)

Types

type SignOption

type SignOption func(c *configurator)

func WithTTL

func WithTTL(ttl time.Duration) SignOption

type Signer

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

func NewSigner

func NewSigner(signature, secret string) *Signer

NewSigner creates a new signer with the following params:

• signature: 32 random characters.
• secret: 16, 24, or 32 random characters to select AES-128, AES-192, or AES-256.

func (*Signer) ReadMessage

func (s *Signer) ReadMessage(token string, msg proto.Message, opts ...SignOption) error

func (*Signer) SignMessage

func (s *Signer) SignMessage(msg proto.Message, opts ...SignOption) (string, error)

func (*Signer) String

func (s *Signer) String() string