hmac

package

v0.0.0-...-b96c0aa Latest Latest Go to latest Published: Apr 7, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	NotValidError   = Error("signature not valid")
	ExpiredError    = Error("signature expired")
	BadRequestError = Error("bad request")
)

Error constants retured by various functions.

View Source

var DebugOut = log.New(io.Discard, "[DEBUG] ", 0)

DebugOut is an optional logger to receive debugging messages

func NewVerifier(srv imageserver.Server, key, salt string, expiration time.Duration) imageserver.Server

NewVerifier returns an initialized Verifier. If expiration is 0, expirations are not enforced.

type Error string

Error is an error type

func (e Error) Error() string

Error returns the stringified version of Error

type Parser struct{}

Parser is a imageserver/http.Parser implementation for imageserver/image/expiration.Processor.

func (prs *Parser) Parse(req *http.Request, params imageserver.Params) error

Parse implements imageserver/http.Parser.

func (prs *Parser) Resolve(p string) (httpParam string)

Resolve implements imageserver/http.Parser.

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

Signer is an http.Handler that signs the request URL + query parameters and redirects to the signed URL.

func NewSigner(key, salt string, expires time.Duration) *Signer

NewSigner returns an initialized HMACSigner. If expires is 0, then expiration is not computed.

func (s *Signer) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP handles the request

type Verifier struct {
	Next imageserver.Server
	// contains filtered or unexported fields
}

Verifier is an imageserver.Server that verifies the signature and possibly the timestamp of a request URL

func (srv *Verifier) Get(params imageserver.Params) (*imageserver.Image, error)

Get does the HMAC verification, and possibly expiration calculation, of the request