webhook

package module

v0.0.3 Latest Latest Go to latest Published: Nov 12, 2019 License: MIT Imports: 8 Imported by: 1

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

Repository

github.com/arxdsilva/webhook

Links

Open Source Insights

README ¶

webhook

Golang parser for webhooks. Not a server, though it could be integrated with one.

Installation

$ go get gopkg.in/arxdsilva/webhook.v0

Usage

Given an incoming *http.Request representing a webhook signed with a secret, use webhook to validate and parse its content:

secret := []byte("don't tell!")
hook, err := webhook.Parse(secret, req)

Plays nicely with the google/go-github client!

evt := github.PullRequestEvent{}
if err := json.Unmarshal(hook.Payload, &evt); err != nil {
  fmt.Println("Invalid JSON?", err)
}

Documentation ¶

Overview ¶

Package githubhook implements handling and verification of github webhooks

Index ¶

Variables
func SignBody(secret, body []byte) []byte
type Hook
- func New(req *http.Request) (hook *Hook, err error)
- func Parse(secret []byte, req *http.Request) (hook *Hook, err error)
- func (h *Hook) Extract(dst interface{}) error
- func (h *Hook) SignedBy(secret []byte) bool

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoSignature      = errors.New("No signature!")
	ErrUnknownMethod    = errors.New("Unknown method!")
	ErrInvalidSignature = errors.New("Invalid signature")
)

Functions ¶

func SignBody ¶ added in v0.0.3

func SignBody(secret, body []byte) []byte

Types ¶

type Hook ¶

type Hook struct {

	// Id specifies the Id of a github webhook request.
	//
	// Id is extracted from the inbound request's `X-Github-Delivery` header.
	Id string

	// Event specifies the event name of a github webhook request.
	//
	// Event is extracted from the inbound request's `X-GitHub-Event` header.
	// See: https://developer.github.com/webhooks/#events
	Event string

	// Signature specifies the signature of a github webhook request.
	//
	// Signature is extracted from the inbound request's `X-Hub-Signature` header.
	Signature string

	// Payload contains the raw contents of the webhook request.
	//
	// Payload is extracted from the JSON-formatted body of the inbound request.
	Payload []byte
}

Hook is an inbound github webhook

func New ¶

func New(req *http.Request) (hook *Hook, err error)

New reads a Hook from an incoming HTTP Request.

func Parse ¶

func Parse(secret []byte, req *http.Request) (hook *Hook, err error)

Parse reads and verifies the hook in an inbound request.

func (*Hook) Extract ¶

func (h *Hook) Extract(dst interface{}) error

Extract unmarshals Payload into a destination interface.

func (*Hook) SignedBy ¶

func (h *Hook) SignedBy(secret []byte) bool

SignedBy checks that the provided secret matches the hook Signature

Implements validation described in github's documentation: https://developer.github.com/webhooks/securing/

Source Files ¶

View all Source files

webhook.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL