validator

Documentation

Index

• type HTTPSig
  • func NewHTTPSig() HTTPSig
  • func (validator HTTPSig) Validate(request *http.Request, document *streams.Document) Result
• type Result

Types

type HTTPSig

type HTTPSig struct{}

HTTPSig is a Validator that checks incoming HTTP requests using the HTTP signatures algorithm. https://docs.joinmastodon.org/spec/security/

func NewHTTPSig

func NewHTTPSig() HTTPSig

func (HTTPSig) Validate

func (validator HTTPSig) Validate(request *http.Request, document *streams.Document) Result

Validate uses the hannibal/sigs library to verify that the HTTP request is signed with a valid key.

type Result

type Result string

Result indicates the outcome of a validation attempt

const ResultError Result = "ERROR"

ResultError indicates that the current Validator encountered an error while attempting to validate the HTTP request

const ResultInvalid Result = "INVALID"

ResultInvalid indicates that the current Validator can say with certainty that the HTTP request is invalid

const ResultUnknown Result = "UNKNOWN"

ResultUnknown indicates that the current Validator cannot say that the HTTP request is valid or invalid

const ResultValid Result = "VALID"

ResultValid indicates that the current Validator has successfully validated the HTTP request