signer

README

request-signer

Documentation

Index

• Variables
• type Ed25519KeyGenerator
  • func NewKeyGenerator(privateKeyPath, publicKeyPath string) (*Ed25519KeyGenerator, error)
  • func (r Ed25519KeyGenerator) Generate() error
• type KeyGenerator
• type RequestSigner
  • func NewSigner(keys fs.FS) (*RequestSigner, error)
  • func NewSignerWithNameAndOrder(keys fs.FS, privateKeyName string, order binary.ByteOrder) (*RequestSigner, error)
  • func (r RequestSigner) Sign(payload []byte, timestamp uint64) []byte
  • func (r RequestSigner) SignString(payload []byte, timestamp uint64) string
• type RequestVerifier
  • func NewVerifier(keys fs.FS) (*RequestVerifier, error)
  • func NewVerifierWithNameAndOrder(keys fs.FS, publicKeyName string, order binary.ByteOrder) (*RequestVerifier, error)
  • func (r RequestVerifier) Verify(timestamp uint64, payload []byte, signature []byte) error
  • func (r RequestVerifier) VerifyStringSignature(timestamp uint64, payload []byte, signature string) error
• type Signer
• type Verifier

Variables

var (
	ErrInvalidSignature       = errors.New("signature is invalid")
	ErrKeysAlreadyExist       = errors.New("public and private keys already exist")
	ErrInvalidBase64Signature = errors.New("signature is not base64url encoded")
)

Types

type Ed25519KeyGenerator

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

func NewKeyGenerator

func NewKeyGenerator(privateKeyPath, publicKeyPath string) (*Ed25519KeyGenerator, error)

func (Ed25519KeyGenerator) Generate

func (r Ed25519KeyGenerator) Generate() error

type KeyGenerator

type KeyGenerator interface {
	Generate() error
}

type RequestSigner

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

func NewSigner

func NewSigner(keys fs.FS) (*RequestSigner, error)

func NewSignerWithNameAndOrder

func NewSignerWithNameAndOrder(keys fs.FS, privateKeyName string, order binary.ByteOrder) (*RequestSigner, error)

func (RequestSigner) Sign

func (r RequestSigner) Sign(payload []byte, timestamp uint64) []byte

func (RequestSigner) SignString

func (r RequestSigner) SignString(payload []byte, timestamp uint64) string

type RequestVerifier

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

func NewVerifier

func NewVerifier(keys fs.FS) (*RequestVerifier, error)

func NewVerifierWithNameAndOrder

func NewVerifierWithNameAndOrder(keys fs.FS, publicKeyName string, order binary.ByteOrder) (*RequestVerifier, error)

func (RequestVerifier) Verify

func (r RequestVerifier) Verify(timestamp uint64, payload []byte, signature []byte) error

func (RequestVerifier) VerifyStringSignature

func (r RequestVerifier) VerifyStringSignature(timestamp uint64, payload []byte, signature string) error

type Signer

type Signer interface {
	Sign([]byte, uint64) []byte
	SignString([]byte, uint64) string
}

type Verifier

type Verifier interface {
	Verify(uint64, []byte, []byte) error
	VerifyStringSignature(uint64, []byte, string) error
}