httpsig

Documentation

Index

• func Sign(req *http.Request, bodyBytes []byte, signingKey *jwk.JWK, digestName string) (*http.Request, error)
• type Signer
  • func (s *Signer) ProofType() string
  • func (s *Signer) Sign(request *http.Request, requestBody []byte) (*http.Request, error)
• type Verifier
  • func NewVerifier(req *http.Request) *Verifier
  • func (v *Verifier) Verify(key *gnap.ClientKey) error

Functions

func Sign

func Sign(req *http.Request, bodyBytes []byte, signingKey *jwk.JWK, digestName string) (*http.Request, error)

Types

type Signer

type Signer struct {
	SigningKey *jwk.JWK
}

Signer signs GNAP http requests using http-signature.

func (*Signer) ProofType

func (s *Signer) ProofType() string

ProofType returns "httpsig", the GNAP proof type of the http-signature proof method.

func (*Signer) Sign

func (s *Signer) Sign(request *http.Request, requestBody []byte) (*http.Request, error)

Sign signs the given request using sha-256 for a content digest, and http-signature to sign headers.

type Verifier

type Verifier struct {
	// contains filtered or unexported fields
}

Verifier verifies that the client request is signed by the client key, using http-signature verification.

func NewVerifier

func NewVerifier(req *http.Request) *Verifier

NewVerifier initializes an http-signature Verifier on the given client request.

func (*Verifier) Verify

func (v *Verifier) Verify(key *gnap.ClientKey) error

Verify verifies that the Verifier's client request is signed by the client key, using http-signature verification.