flow

Documentation

Index

• Variables
• func VerifyRequest(r *http.Request, flowType Type, disableAPIFlowEnforcement bool, ...) error
• type Type

Variables

var ErrCookieHeaderNeedsBrowserFlow = herodot.ErrBadRequest.
	WithReasonf(`The HTTP Request Header included the "Cookie" key, indicating that this request was made by a Browser. The flow however was initiated as an API request. To prevent potential misuse and mitigate several attack vectors including CSRF, the request has been blocked. Please consult the documentation.`)

var ErrOriginHeaderNeedsBrowserFlow = herodot.ErrBadRequest.
	WithReasonf(`The HTTP Request Header included the "Origin" key, indicating that this request was made as part of an AJAX request in a Browser. The flow however was initiated as an API request. To prevent potential misuse and mitigate several attack vectors including CSRF, the request has been blocked. Please consult the documentation.`)

Functions

func VerifyRequest

func VerifyRequest(
	r *http.Request,
	flowType Type,
	disableAPIFlowEnforcement bool,
	generator func(r *http.Request) string,
	actual string,
) error

Types

type Type

type Type string

Type is the flow type.

The flow type can either be `api` or `browser`.

const (
	TypeAPI     Type = "api"
	TypeBrowser Type = "browser"
)