httpsign

Oct 31, 2025

Changes in this version

type Signer

+ func NewJWSSignerV3(alg jwav3.SignatureAlgorithm, key interface{}, config *SignConfig, ...) (*Signer, error)

type Verifier

+ func NewJWSVerifierV3(alg jwav3.SignatureAlgorithm, key interface{}, config *VerifyConfig, ...) (*Verifier, error)

Oct 15, 2025

Changes in this version

+ type Message struct

+ func NewMessage(config *MessageConfig) (*Message, error)

+ func (m *Message) Verify(signatureName string, verifier Verifier) (*MessageDetails, error)

+ type MessageConfig struct

+ func NewMessageConfig() *MessageConfig

+ func (b *MessageConfig) WithAssociatedRequest(method string, u *url.URL, headers http.Header, authority, scheme string) *MessageConfig

+ func (b *MessageConfig) WithAuthority(authority string) *MessageConfig

+ func (b *MessageConfig) WithBody(body *io.ReadCloser) *MessageConfig

+ func (b *MessageConfig) WithHeaders(headers http.Header) *MessageConfig

+ func (b *MessageConfig) WithMethod(method string) *MessageConfig

+ func (b *MessageConfig) WithRequest(req *http.Request) *MessageConfig

+ func (b *MessageConfig) WithResponse(res *http.Response, req *http.Request) *MessageConfig

+ func (b *MessageConfig) WithScheme(scheme string) *MessageConfig

+ func (b *MessageConfig) WithStatusCode(statusCode int) *MessageConfig

+ func (b *MessageConfig) WithTrailers(trailers http.Header) *MessageConfig

+ func (b *MessageConfig) WithURL(u *url.URL) *MessageConfig

type MessageDetails

+ Created *time.Time

+ Expires *time.Time

+ Nonce *string

+ Tag *string

Dec 22, 2024

Changes in this version

type Fields

+ func (fs *Fields) AddHeaderOptional(hdr string) *Fields

Jun 11, 2024

Changes in this version

type SignConfig

+ func (c *SignConfig) SetKeyID(keyID string) *SignConfig

type VerifyConfig

+ func (v *VerifyConfig) SetKeyID(keyID string) *VerifyConfig

May 27, 2023

Changes in this version

+ func QueryEscapeForSignature(s string) string

+ func RequestSignatureNames(req *http.Request, withTrailers bool) ([]string, error)

+ func ResponseSignatureNames(res *http.Response, withTrailers bool) ([]string, error)

+ type EscapeError string

+ func (e EscapeError) Error() string

+ type InvalidHostError string

+ func (e InvalidHostError) Error() string

Nov 27, 2022

Changes in this version

type SignConfig

+ func (c *SignConfig) SetTag(tag string) *SignConfig

type VerifyConfig

+ func (v *VerifyConfig) SetAllowedTags(allowedTags []string) *VerifyConfig

Sep 22, 2022

Changes in this version

type SignConfig

+ func (c *SignConfig) SetContext(ctx string) *SignConfig

type Signer

+ func NewP384Signer(keyID string, key ecdsa.PrivateKey, config *SignConfig, fields Fields) (*Signer, error)

type Verifier

+ func NewP384Verifier(keyID string, key ecdsa.PublicKey, config *VerifyConfig, fields Fields) (*Verifier, error)

type VerifyConfig

+ func (v *VerifyConfig) SetAllowedContexts(allowedCtx []string) *VerifyConfig

May 27, 2022

Changes in this version

type Fields

+ func (fs *Fields) AddDictHeaderExt(hdr, key string, optional, associatedRequest bool) *Fields

+ func (fs *Fields) AddHeaderExt(hdr string, optional, associatedRequest bool) *Fields

+ func (fs *Fields) AddQueryParamExt(qp string, optional, associatedRequest bool) *Fields

+ func (fs *Fields) AddStructuredFieldExt(hdr string, optional, associatedRequest bool) *Fields

Mar 22, 2022

Changes in this version

+ func GenerateContentDigestHeader(body *io.ReadCloser, schemes []string) (string, error)

+ func ValidateContentDigestHeader(received []string, body *io.ReadCloser, accepted []string) error

type ClientConfig

+ func (c *ClientConfig) SetDigestSchemesRecv(s []string) *ClientConfig

+ func (c *ClientConfig) SetDigestSchemesSend(s []string) *ClientConfig

type HandlerConfig

+ func (h *HandlerConfig) SetDigestSchemesRecv(s []string) *HandlerConfig

+ func (h *HandlerConfig) SetDigestSchemesSend(s []string) *HandlerConfig

Mar 18, 2022

Changes in this version

+ const DigestSha256

+ const DigestSha512

+ func GenerateContentDigest(body *io.ReadCloser, scheme string) (string, error)

+ type ClientConfig struct

+ func NewClientConfig() *ClientConfig

+ func (c *ClientConfig) SetComputeDigest(b bool) *ClientConfig

+ func (c *ClientConfig) SetDigestScheme(s string) *ClientConfig

+ func (c *ClientConfig) SetFetchVerifier(...) *ClientConfig

+ func (c *ClientConfig) SetSignatureName(s string) *ClientConfig

+ func (c *ClientConfig) SetSigner(s *Signer) *ClientConfig

+ func (c *ClientConfig) SetVerifier(v *Verifier) *ClientConfig

type HandlerConfig

+ func (h *HandlerConfig) SetComputeDigest(b bool) *HandlerConfig

+ func (h *HandlerConfig) SetDigestScheme(s string) *HandlerConfig

+ func (h *HandlerConfig) SetLogger(l *log.Logger) *HandlerConfig

+ type MessageDetails struct

+ Alg string

+ Fields Fields

+ KeyID string

Mar 3, 2022

Changes in this version

type Fields

+ func (fs *Fields) AddOptionalDictHeader(hdr, key string) *Fields

+ func (fs *Fields) AddOptionalHeader(hdr string) *Fields

+ func (fs *Fields) AddOptionalQueryParam(qp string) *Fields

+ func (fs *Fields) AddOptionalStructuredField(hdr string) *Fields

Feb 15, 2022

Changes in this version

type VerifyConfig

+ func (v *VerifyConfig) SetVerifyDateWithin(d time.Duration) *VerifyConfig

Feb 9, 2022

Changes in this version

type Client

+ func (c *Client) PostForm(url string, data url.Values) (resp *http.Response, err error)

Feb 7, 2022

Changes in this version

type VerifyConfig

+ func (v *VerifyConfig) SetVerifyKeyID(verify bool) *VerifyConfig

Feb 2, 2022

Changes in this version

type Fields

+ func Headers(hs ...string) Fields

+ func (fs *Fields) AddHeaders(hs ...string) *Fields

+ func (fs *Fields) AddStructuredField(hdr string) *Fields

type Signer

+ func NewEd25519Signer(keyID string, key *ed25519.PrivateKey, config *SignConfig, fields Fields) (*Signer, error)

+ func NewEd25519SignerFromSeed(keyID string, seed *[]byte, config *SignConfig, fields Fields) (*Signer, error)

type Verifier

+ func NewEd25519Verifier(keyID string, key *ed25519.PublicKey, config *VerifyConfig, fields Fields) (*Verifier, error)

Jan 30, 2022

Changes in this version

type Signer

+ func NewJWSSigner(alg jwa.SignatureAlgorithm, keyID string, key interface{}, config *SignConfig, ...) (*Signer, error)

type Verifier

+ func NewJWSVerifier(alg jwa.SignatureAlgorithm, key interface{}, keyID string, ...) (*Verifier, error)

Jan 29, 2022

Changes in this version

+ func GetRequestSignature(req *http.Request, signatureName string) (string, error)

type Client

+ FetchVerifier func(res *http.Response, req *http.Request) (sigName string, verifier *Verifier)

+ SignatuerName string

+ Signer *Signer

+ Verifier *Verifier

type VerifyConfig

+ func (v *VerifyConfig) SetRequestResponse(name, signature string) *VerifyConfig

Jan 26, 2022

Changes in this version

+ func RequestDetails(signatureName string, req *http.Request) (keyID, alg string, err error)

+ func ResponseDetails(signatureName string, res *http.Response) (keyID, alg string, err error)

+ type Client struct

+ func NewClient(sigName string, signer *Signer, verifier *Verifier, ...) *Client

+ func NewDefaultClient(sigName string, signer *Signer, verifier *Verifier, ...) *Client

+ func (c *Client) Do(req *http.Request) (*http.Response, error)

+ func (c *Client) Get(url string) (res *http.Response, err error)

+ func (c *Client) Head(url string) (res *http.Response, err error)

+ func (c *Client) Post(url, contentType string, body io.Reader) (res *http.Response, err error)

type SignConfig

+ func (c *SignConfig) SetExpires(expires int64) *SignConfig

+ func (c *SignConfig) SetNonce(nonce string) *SignConfig

type VerifyConfig

+ func (v *VerifyConfig) SetRejectExpired(rejectExpired bool) *VerifyConfig

Jan 23, 2022

Changes in this version

+ func RequestKeyID(signatureName string, req *http.Request) (string, error)

+ func ResponseKeyID(signatureName string, res *http.Response) (string, error)

+ func SignRequest(signatureName string, signer Signer, req *http.Request) (signatureInput, signature string, err error)

+ func SignResponse(signatureName string, signer Signer, res *http.Response) (signatureInput, signature string, err error)

+ func VerifyRequest(signatureName string, verifier Verifier, req *http.Request) (verified bool, err error)

+ func VerifyResponse(signatureName string, verifier Verifier, res *http.Response) (verified bool, err error)

+ func WrapHandler(h http.Handler, config *HandlerConfig) http.Handler

+ type Fields []field

+ func HeaderList(hs []string) Fields

+ func NewFields() *Fields

+ func (fs *Fields) AddDictHeader(hdr, key string) *Fields

+ func (fs *Fields) AddHeader(hdr string) *Fields

+ func (fs *Fields) AddQueryParam(qp string) *Fields

+ type HandlerConfig struct

+ func NewHandlerConfig() *HandlerConfig

+ func (h *HandlerConfig) SetFetchSigner(f func(res http.Response, r *http.Request) (sigName string, signer *Signer)) *HandlerConfig

+ func (h *HandlerConfig) SetFetchVerifier(f func(r *http.Request) (sigName string, verifier *Verifier)) *HandlerConfig

+ func (h *HandlerConfig) SetReqNotVerified(f func(w http.ResponseWriter, r *http.Request, err error)) *HandlerConfig

+ func (h *HandlerConfig) SetSignResponse(b bool) *HandlerConfig

+ func (h *HandlerConfig) SetVerifyRequest(b bool) *HandlerConfig

+ type SignConfig struct

+ func NewSignConfig() *SignConfig

+ func (c *SignConfig) SetRequestResponse(name, signature string) *SignConfig

+ func (c *SignConfig) SignAlg(b bool) *SignConfig

+ func (c *SignConfig) SignCreated(b bool) *SignConfig

+ type Signer struct

+ func NewHMACSHA256Signer(keyID string, key []byte, config *SignConfig, fields Fields) (*Signer, error)

+ func NewP256Signer(keyID string, key *ecdsa.PrivateKey, config *SignConfig, fields Fields) (*Signer, error)

+ func NewRSAPSSSigner(keyID string, key *rsa.PrivateKey, config *SignConfig, fields Fields) (*Signer, error)

+ func NewRSASigner(keyID string, key *rsa.PrivateKey, config *SignConfig, fields Fields) (*Signer, error)

+ type Verifier struct

+ func NewHMACSHA256Verifier(keyID string, key []byte, config *VerifyConfig, fields Fields) (*Verifier, error)

+ func NewP256Verifier(keyID string, key *ecdsa.PublicKey, config *VerifyConfig, fields Fields) (*Verifier, error)

+ func NewRSAPSSVerifier(keyID string, key *rsa.PublicKey, config *VerifyConfig, fields Fields) (*Verifier, error)

+ func NewRSAVerifier(keyID string, key *rsa.PublicKey, config *VerifyConfig, fields Fields) (*Verifier, error)

+ type VerifyConfig struct

+ func NewVerifyConfig() *VerifyConfig

+ func (v *VerifyConfig) SetAllowedAlgs(allowedAlgs []string) *VerifyConfig

+ func (v *VerifyConfig) SetNotNewerThan(notNewerThan time.Duration) *VerifyConfig

+ func (v *VerifyConfig) SetNotOlderThan(notOlderThan time.Duration) *VerifyConfig

+ func (v *VerifyConfig) SetVerifyAlg(verifyAlg bool) *VerifyConfig

+ func (v *VerifyConfig) SetVerifyCreated(verifyCreated bool) *VerifyConfig