httpsig

Documentation

Overview

Package httpsig implements HTTP signatures.

Index

• func Sign(r *http.Request, key Key, now time.Time) error
• type Key
• type Signature
  • func Extract(r *http.Request, body []byte, domain string, now time.Time, ...) (*Signature, error)
  • func (s *Signature) Verify(key any) error

Functions

func Sign

func Sign(r *http.Request, key Key, now time.Time) error

Sign adds a signature to an outgoing HTTP request.

Types

type Key

type Key struct {
	ID         string
	PrivateKey any
}

Key is used to sign outgoing HTTP requests or verify incoming HTTP requests.

type Signature

type Signature struct {
	KeyID string
	// contains filtered or unexported fields
}

func Extract

func Extract(r *http.Request, body []byte, domain string, now time.Time, maxAge time.Duration) (*Signature, error)

Extract extracts signature attributes, validates them and returns a Signature. Caller should obtain the key and pass it to Signature.Verify.

func (*Signature) Verify

func (s *Signature) Verify(key any) error

Verify verifies a signature.