casedhttp

README

casedhttp

casedhttp is a package used to add auditing capabilities to the net/http package.

By using casedhttp's provided casedhttp.ContextMiddleware around your http.HandlerFunc each audit event published using cased.PublishWithContext will include the following properties:

Key	Example	Sensitive Value
location	1.1.1.1	ip-address
request_url	/login	-
request_http_method	POST	-
request_user_agent	Mozilla/5.0	-
request_id	1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed	-

Usage

See example for an example implementation.

Documentation

Index

• Constants
• Variables
• func ContextMiddleware(next http.Handler) http.Handler
• func VerifyWebhookSignature(req *http.Request, params *VerifyWebhookSignatureParams) error
• func VerifyWebhookSignatureMiddleware(next http.Handler, params *VerifyWebhookSignatureParams) http.Handler
• type VerifyWebhookSignatureParams

Constants

const (
	WebhookTimestampHeader = "X-Cased-Timestamp"
	WebhookSignatureHeader = "X-Cased-Signature"
)

Variables

var (
	WebhookSecret                     = os.Getenv("CASED_WEBHOOK_SECRET")
	WebhookTimestampExpiredError      = errors.New("webhook timestamp expired")
	WebhookSignatureVerificationError = errors.New("webhook computed signature does not match signature sent with webhook")
)

Functions

func ContextMiddleware

func ContextMiddleware(next http.Handler) http.Handler

ContextMiddleware ...

func VerifyWebhookSignature

func VerifyWebhookSignature(req *http.Request, params *VerifyWebhookSignatureParams) error

func VerifyWebhookSignatureMiddleware

func VerifyWebhookSignatureMiddleware(next http.Handler, params *VerifyWebhookSignatureParams) http.Handler

Types

type VerifyWebhookSignatureParams

type VerifyWebhookSignatureParams struct {
	// Secret used to compute the HMAC signature. Optional if secret is provided
	// by the CASED_WEBHOOK_SECRET environment variable.
	Secret *string

	// TimestampExpires if provided will reject webhook requests that are
	// delivered after specified duration. Useful to prevent replay attacks. Each
	// webhook attempt delivered from Cased will provide a new timestamp.
	TimestampExpires time.Duration
}