alg_hmac

Documentation

Overview

Package alg_hmac provides signer and verifier for HMAC digests using hmac-sha256

Index

• Constants
• func NewMultiHMACKeyDirectory(keys map[string]HMAC) verifier.KeyDirectory
• func NewSingleHMACKeyDirectory(hmac *HMAC) verifier.KeyDirectory
• type HMAC
  • func NewHMAC(key []byte) *HMAC
  • func NewHMACWithAttributes(key []byte, attrs any) *HMAC
  • func (h *HMAC) Attributes() any
  • func (h *HMAC) ContentDigest() contentdigest.Digester
  • func (h *HMAC) Sign(ctx context.Context, base string) ([]byte, error)
  • func (h *HMAC) Type() string
  • func (h *HMAC) Verify(ctx context.Context, base string, sig []byte) error

Constants

const HMAC_SHA256 = "hmac-sha256" // Algo is the HMAC algorithm name

Functions

func NewMultiHMACKeyDirectory

func NewMultiHMACKeyDirectory(keys map[string]HMAC) verifier.KeyDirectory

NewMultiHMACKeyDirectory creates a new in-memory MultiHMACKeyDirectory with the provided map of keyID to HMAC

GetKey() will validate the algorithm and return the HMAC if it is found

func NewSingleHMACKeyDirectory

func NewSingleHMACKeyDirectory(hmac *HMAC) verifier.KeyDirectory

NewSingleHMACKeyDirectory creates a new in-memory SingleHMACKeyDirectory with the provided key. All parameters are ignored in the GetKey() method, and it will never error.

Types

type HMAC

type HMAC struct {
	Key   []byte
	Attrs any
}

HMAC is a signer and verifier for HMAC digests. It uses crypto/hmac with sha256, and implements the httpsig.Attributer interface

func NewHMAC

func NewHMAC(key []byte) *HMAC

NewHMAC creates a new HMAC with the provided key

func NewHMACWithAttributes

func NewHMACWithAttributes(key []byte, attrs any) *HMAC

NewHMACWithAttributes creates a new HMAC with the provided key and attributes

func (*HMAC) Attributes

func (h *HMAC) Attributes() any

func (*HMAC) ContentDigest

func (h *HMAC) ContentDigest() contentdigest.Digester

func (*HMAC) Sign

func (h *HMAC) Sign(ctx context.Context, base string) ([]byte, error)

func (*HMAC) Type

func (h *HMAC) Type() string

func (*HMAC) Verify

func (h *HMAC) Verify(ctx context.Context, base string, sig []byte) error