README
¶
Hookshot 
Hookshot is a Go http router that de-multiplexes and authorizes GitHub Webhooks.
Usage
r := hookshot.NewRouter()
r.Handle("deployment_status", DeploymentStatusHandler)
r.Handle("deployment", DeploymentHandler)
To automatically verify the X-Hub-Signature:
r.Handle("deployment", hookshot.Authorize(DeploymentHandler, "secret"))
Documentation
¶
Overview ¶
Package hookshot is a router that de-multiplexes and authorizes github webhooks.
Example ¶
package main
import (
"net/http"
"github.com/ejholmes/hookshot"
)
func HandlePing(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(200)
w.Write([]byte(`Pong`))
}
func main() {
r := hookshot.NewRouter()
r.HandleFunc("ping", HandlePing)
http.ListenAndServe(":8080", r)
}
Index ¶
Examples ¶
Constants ¶
const ( // HeaderEvent is the name of the header that contains the type of event. HeaderEvent = "X-GitHub-Event" // HeaderSignature is the name of the header that contains the signature. HeaderSignature = "X-Hub-Signature" )
Variables ¶
var ( // DefaultNotFoundHandler is the default NotFoundHandler for a Router instance. DefaultNotFoundHandler = http.HandlerFunc(http.NotFound) // instance, which responds with a 403 status and a plain text body. DefaultUnauthorizedHandler = http.HandlerFunc(unauthorized) )
Functions ¶
func IsAuthorized ¶
IsAuthorized checks that the calculated signature for the request matches the provided signature in the request headers. Returns the calculated signature, and a boolean value indicating whether or not the calculated signature matches the X-Hub-Signature value.
Example ¶
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if _, ok := IsAuthorized(r, "secret"); !ok {
http.Error(w, "The provided signature in the "+HeaderSignature+" header does not match.", 403)
return
}
w.Write([]byte(`Ok`))
})
res := httptest.NewRecorder()
req, _ := http.NewRequest("POST", "", bytes.NewBufferString(`{"data":"foo"}`))
req.Header.Set("X-Hub-Signature", "sha1=b3dc4e9a2d727ee1e60bb6828c2dcef88b5ec970")
h.ServeHTTP(res, req)
fmt.Print(res.Body)
Output: Ok
func Signature ¶
Signature calculates the SHA1 HMAC signature of body, signed by the secret.
When github-services makes a POST request, it includes a SHA1 HMAC signature of the request body, signed with the secret provided in the webhook configuration. See http://goo.gl/Oe4WwR.
Types ¶
type Router ¶
type Router struct {
// NotFoundHandler is called when a handler is not found for a given GitHub event.
// The nil value for NotFoundHandler
NotFoundHandler http.Handler
// contains filtered or unexported fields
}
Router demultiplexes github hooks.
func (*Router) HandleFunc ¶
HandleFunc maps a github event to an http.HandlerFunc.
type SecretHandler ¶
type SecretHandler struct {
// The secret to use to verify the request.
Secret string
// SetHeader controls what happens when the X-Hub-Signature header value does
// not match the calculated signature. Setting this value to true will set
// the X-Calculated-Signature header in the response.
//
// It's recommended that you only enable this for debugging purposes.
SetHeader bool
// Handler is the http.Handler that will be called if the request is
// authorized.
Handler http.Handler
// is not authorized.
Unauthorized http.Handler
}
SecretHandler is an http.Handler that will verify the authenticity of the request.
func Authorize ¶
func Authorize(h http.Handler, secret string) *SecretHandler
Authorize wraps an http.Handler to verify the authenticity of the request using the provided secret.
func (*SecretHandler) ServeHTTP ¶
func (h *SecretHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
ServeHTTP implements the http.Handler interface.
Source Files
Directories