httpsig

package module

Go to main page

Versions in this module

v1

v1.2.0

Aug 23, 2025

Changes in this version

type SigningKey

+ Opts SigningKeyOpts

+ type SigningKeyOpts struct

+ ASN1ForECDSA bool

+ Signer crypto.Signer

v1.1.3

Jun 9, 2025

Changes in this version

+ func SetAddDebugInfo(ctx context.Context) context.Context

+ type VerifyDebugInfo struct

+ SignatureBase string

type VerifyResult

+ DebugInfo VerifyDebugInfo

v1.1.2

May 29, 2025

v1.1.1

May 7, 2025

v1.1.0

May 5, 2025

Changes in this version

type VerifyProfile

+ SignatureLabel string

type VerifyResult

+ KeySpecer KeySpecer

+ Label string

v1.0.3

Apr 22, 2025

v1.0.2

Apr 10, 2025

Changes in this version

+ type AcceptSignature struct

+ MetaKeyID string

+ MetaNonce string

+ MetaTag string

+ Profile SigningProfile

type Signer

+ func (s *Signer) Alg() (string, error)

+ func (s *Signer) Created() (int, error)

+ func (s *Signer) Expires() (int, error)

+ func (s *Signer) KeyID() (string, error)

+ func (s *Signer) Nonce() (string, error)

+ func (s *Signer) Tag() (string, error)

+ type SigningKey struct

+ Key crypto.PrivateKey

+ MetaKeyID string

+ MetaTag string

+ Secret []byte

type SigningProfile

+ ExpiresDuration time.Duration

v1.0.1

Apr 7, 2025

Changes in this version

type Signer

+ func NewSignerWithSecret(profile SigningProfile, secret []byte, mdp ...MetadataProvider) (*Signer, error)

+ type SigningProfile struct

+ Algorithm Algorithm

+ Digest Digest

+ Fields []SignedField

+ Label string

+ MetaExpiresDuration time.Duration

+ MetaKeyID string

+ MetaNonce NonceScheme

+ MetaTag string

+ Metadata []Metadata

+ func (so SigningProfile) Alg() (string, error)

+ func (so SigningProfile) Created() (int, error)

+ func (so SigningProfile) Expires() (int, error)

+ func (so SigningProfile) KeyID() (string, error)

+ func (so SigningProfile) Nonce() (string, error)

+ func (so SigningProfile) Tag() (string, error)

v1.0.0

Mar 31, 2025

Changes in this version

+ const Algo_ECDSA_P256_SHA256

+ const Algo_ECDSA_P384_SHA384

+ const Algo_ED25519

+ const Algo_HMAC_SHA256

+ const Algo_RSA_PSS_SHA512

+ const Algo_RSA_v1_5_sha256

+ const DefaultSignatureLabel

+ const DigestSHA256

+ const DigestSHA512

+ const MetaAlgorithm

+ const MetaCreated

+ const MetaExpires

+ const MetaKeyID

+ const MetaNonce

+ const MetaTag

+ const NonceRandom32

+ var DefaultRequiredFields = Fields("content-digest", "@method", "@target-uri")

+ var DefaultVerifyProfile = VerifyProfile

+ func NewHTTPClient(hc *http.Client, signer *Signer, verifier *Verifier) *http.Client

+ func NewHandler(h http.Handler, verifier *Verifier) http.Handler

+ func NewTransport(rt http.RoundTripper, signer *Signer, verifier *Verifier) http.RoundTripper

+ func Sign(req *http.Request, params SigningOptions, mdp ...MetadataProvider) error

+ type Algorithm string

+ type CreatedScheme int

+ type Digest string

+ type ErrCode string

+ const ErrInternal

+ const ErrInvalidAcceptSignature

+ const ErrInvalidComponent

+ const ErrInvalidMetadata

+ const ErrInvalidSignatureOptions

+ const ErrMissingAcceptSignature

+ const ErrNoSigInvalidHeader

+ const ErrNoSigInvalidSignature

+ const ErrNoSigMessageBody

+ const ErrNoSigMissingSignature

+ const ErrNoSigUnsupportedDigest

+ const ErrNoSigWrongDigest

+ const ErrSigInvalidSignature

+ const ErrSigKeyFetch

+ const ErrSigProfile

+ const ErrSigPublicKey

+ const ErrSigSecretKey

+ const ErrSigUnsupportedAlgorithm

+ const ErrSigVerification

+ const ErrUnsupported

+ type ExpiresScheme int

+ type InvalidSignature struct

+ Error SignatureError

+ HasMetadata bool

+ Label string

+ Raw string

+ type KeyError struct

+ Message string

+ Reason KeyErrorReason

+ type KeyErrorReason string

+ type KeyFetcher interface

+ Fetch func(ctx context.Context, rh http.Header, md MetadataProvider) (KeySpecer, error)

+ FetchByKeyID func(ctx context.Context, rh http.Header, keyID string) (KeySpecer, error)

+ type KeySpec struct

+ Algo Algorithm

+ KeyID string

+ PubKey crypto.PublicKey

+ Secret []byte

+ func (ks KeySpec) KeySpec() (KeySpec, error)

+ type KeySpecer interface

+ KeySpec func() (KeySpec, error)

+ type Metadata string

+ type MetadataProvider interface

+ Alg func() (string, error)

+ Created func() (int, error)

+ Expires func() (int, error)

+ KeyID func() (string, error)

+ Nonce func() (string, error)

+ Tag func() (string, error)

+ type NonceScheme int

+ type SignatureError struct

+ Cause error

+ Code ErrCode

+ Message string

+ func (se *SignatureError) Error() string

+ func (se *SignatureError) GoString() string

+ func (se *SignatureError) Unwrap() error

+ type SignedField struct

+ Name string

+ Parameters map[string]any

+ func Fields(fields ...string) []SignedField

+ type Signer struct

+ func NewSigner(params SigningOptions, mdp ...MetadataProvider) (*Signer, error)

+ func (s *Signer) Sign(req *http.Request) error

+ func (s *Signer) SignResponse(resp *http.Response) error

+ type SigningOptions struct

+ Algorithm Algorithm

+ Digest Digest

+ Fields []SignedField

+ Label string

+ MetaExpiresDuration time.Duration

+ MetaKeyID string

+ MetaNonce NonceScheme

+ MetaTag string

+ Metadata []Metadata

+ PrivateKey crypto.PrivateKey

+ Secret []byte

+ func ParseAcceptSignature(acceptHeader string) (SigningOptions, error)

+ func (so SigningOptions) Alg() (string, error)

+ func (so SigningOptions) Created() (int, error)

+ func (so SigningOptions) Expires() (int, error)

+ func (so SigningOptions) KeyID() (string, error)

+ func (so SigningOptions) Nonce() (string, error)

+ func (so SigningOptions) Tag() (string, error)

+ type VerifiedSignature struct

+ KeySpec KeySpecer

+ Label string

+ type Verifier struct

+ func NewVerifier(kf KeyFetcher, profile VerifyProfile) (*Verifier, error)

+ func (ver *Verifier) Verify(req *http.Request) (VerifyResult, error)

+ func (ver *Verifier) VerifyResponse(resp *http.Response) (VerifyResult, error)

+ type VerifyHandler struct

+ func (vh VerifyHandler) ServeHTTP(rw http.ResponseWriter, inReq *http.Request)

+ type VerifyProfile struct

+ AllowedAlgorithms []Algorithm

+ CreatedValidDuration time.Duration

+ DateFieldSkew time.Duration

+ DisableExpirationEnforcement bool

+ DisableMultipleSignatures bool

+ DisableTimeEnforcement bool

+ DisallowedMetadata []Metadata

+ ExpiredSkew time.Duration

+ RequiredFields []SignedField

+ RequiredMetadata []Metadata

+ type VerifyResult struct

+ InvalidSignatures map[string]InvalidSignature

+ Signatures map[string]VerifiedSignature

+ func GetVerifyResult(ctx context.Context) (v VerifyResult, found bool)

+ func Verify(req *http.Request, kf KeyFetcher, profile VerifyProfile) (VerifyResult, error)

+ func VerifyResponse(resp *http.Response, kf KeyFetcher, profile VerifyProfile) (VerifyResult, error)

+ func (vr *VerifyResult) InvalidSignature() InvalidSignature

+ func (vr *VerifyResult) NumSignatures() int

+ func (vr *VerifyResult) Signature() VerifiedSignature

+ func (vr *VerifyResult) Verified() bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL