sig

Documentation

Overview

Package sig provides interfaces for signature.

Index

• Variables
• type Algorithm
• type Key
• type SigningKey
  • func NewErrorKey(err error) SigningKey
  • func NewInvalidKey(alg string, privateKey, publicKey any) SigningKey

Variables

var ErrHashUnavailable = errors.New("sig: hash is unavailable")

ErrSignatureMismatch is an error for unavailable hash.

var ErrSignUnavailable = errors.New("sig: sign method is unavailable")

ErrSignUnavailable means sign method is not unavailable.

var ErrSignatureMismatch = errors.New("sig: signature mismatch")

ErrSignatureMismatch is signature mismatch error.

Types

type Algorithm

type Algorithm interface {
	// NewSigningKey returns a new key for signing.
	NewSigningKey(key Key) SigningKey
}

Algorithm is an algorithm for signing.

type Key

type Key interface {
	PrivateKey() crypto.PrivateKey
	PublicKey() crypto.PublicKey
}

type SigningKey

type SigningKey interface {
	Sign(payload []byte) (signature []byte, err error)
	Verify(payload, signature []byte) error
}

SigningKey is a key for signing.

func NewErrorKey

func NewErrorKey(err error) SigningKey

NewInvalidKey returns a new key that returns an error for all Sign and Verify operations.

func NewInvalidKey

func NewInvalidKey(alg string, privateKey, publicKey any) SigningKey

NewInvalidKey returns a new key that returns an error for all Sign and Verify operations.