webhooks/github/github.go

package github

import (
	"crypto/hmac"
	"crypto/sha1"
	"encoding/hex"
	"encoding/json"
	"io/ioutil"
	"net/http"

	"gopkg.in/go-playground/webhooks.v1"
)

// Webhook instance contains all methods needed to process events
type Webhook struct {
	provider   webhooks.Provider
	secret     string
	eventFuncs map[Event]webhooks.ProcessPayloadFunc
}

// Config defines the configuration to create a new GitHub Webhook instance
type Config struct {
	Secret string
}

// Event defines a GitHub hook event type
type Event string

// GitHub hook types
const (
	CommitCommentEvent            Event = "commit_comment"
	CreateEvent                   Event = "create"
	DeleteEvent                   Event = "delete"
	DeploymentEvent               Event = "deployment"
	DeploymentStatusEvent         Event = "deployment_status"
	ForkEvent                     Event = "fork"
	GollumEvent                   Event = "gollum"
	IssueCommentEvent             Event = "issue_comment"
	IssuesEvent                   Event = "issues"
	MemberEvent                   Event = "member"
	MembershipEvent               Event = "membership"
	PageBuildEvent                Event = "page_build"
	PublicEvent                   Event = "public"
	PullRequestReviewCommentEvent Event = "pull_request_review_comment"
	PullRequestEvent              Event = "pull_request"
	PushEvent                     Event = "push"
	RepositoryEvent               Event = "repository"
	ReleaseEvent                  Event = "release"
	StatusEvent                   Event = "status"
	TeamAddEvent                  Event = "team_add"
	WatchEvent                    Event = "watch"
)

// EventSubtype defines a GitHub Hook Event subtype
type EventSubtype string

// GitHub hook event subtypes
const (
	NoSubtype     EventSubtype = ""
	BranchSubtype EventSubtype = "branch"
	TagSubtype    EventSubtype = "tag"
	PullSubtype   EventSubtype = "pull"
	IssueSubtype  EventSubtype = "issues"
)

// New creates and returns a WebHook instance denoted by the Provider type
func New(config *Config) *Webhook {
	return &Webhook{
		provider:   webhooks.GitHub,
		secret:     config.Secret,
		eventFuncs: map[Event]webhooks.ProcessPayloadFunc{},
	}
}

// Provider returns the current hooks provider ID
func (hook Webhook) Provider() webhooks.Provider {
	return hook.provider
}

// RegisterEvents registers the function to call when the specified event(s) are encountered
func (hook Webhook) RegisterEvents(fn webhooks.ProcessPayloadFunc, events ...Event) {

	for _, event := range events {
		hook.eventFuncs[event] = fn
	}
}

// ParsePayload parses and verifies the payload and fires off the mapped function, if it exists.
func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {

	event := r.Header.Get("X-GitHub-Event")
	if len(event) == 0 {
		http.Error(w, "400 Bad Request - Missing X-GitHub-Event Header", http.StatusBadRequest)
		return
	}

	gitHubEvent := Event(event)

	fn, ok := hook.eventFuncs[gitHubEvent]
	// if no event registered
	if !ok {
		return
	}

	payload, err := ioutil.ReadAll(r.Body)
	if err != nil || len(payload) == 0 {
		http.Error(w, "Error reading Body", http.StatusInternalServerError)
		return
	}

	// If we have a Secret set, we should check the MAC
	if len(hook.secret) > 0 {

		signature := r.Header.Get("X-Hub-Signature")

		if len(signature) == 0 {
			http.Error(w, "403 Forbidden - Missing X-Hub-Signature required for HMAC verification", http.StatusForbidden)
			return
		}

		mac := hmac.New(sha1.New, []byte(hook.secret))
		mac.Write(payload)

		expectedMAC := hex.EncodeToString(mac.Sum(nil))

		if !hmac.Equal([]byte(signature[5:]), []byte(expectedMAC)) {
			http.Error(w, "403 Forbidden - HMAC verification failed", http.StatusForbidden)
			return
		}
	}

	// Make headers available to ProcessPayloadFunc as a webhooks type
	hd := webhooks.Header(r.Header)

	switch gitHubEvent {
	case CommitCommentEvent:
		var cc CommitCommentPayload
		json.Unmarshal([]byte(payload), &cc)
		hook.runProcessPayloadFunc(fn, cc, hd)
	case CreateEvent:
		var c CreatePayload
		json.Unmarshal([]byte(payload), &c)
		hook.runProcessPayloadFunc(fn, c, hd)
	case DeleteEvent:
		var d DeletePayload
		json.Unmarshal([]byte(payload), &d)
		hook.runProcessPayloadFunc(fn, d, hd)
	case DeploymentEvent:
		var d DeploymentPayload
		json.Unmarshal([]byte(payload), &d)
		hook.runProcessPayloadFunc(fn, d, hd)
	case DeploymentStatusEvent:
		var d DeploymentStatusPayload
		json.Unmarshal([]byte(payload), &d)
		hook.runProcessPayloadFunc(fn, d, hd)
	case ForkEvent:
		var f ForkPayload
		json.Unmarshal([]byte(payload), &f)
		hook.runProcessPayloadFunc(fn, f, hd)
	case GollumEvent:
		var g GollumPayload
		json.Unmarshal([]byte(payload), &g)
		hook.runProcessPayloadFunc(fn, g, hd)
	case IssueCommentEvent:
		var i IssueCommentPayload
		json.Unmarshal([]byte(payload), &i)
		hook.runProcessPayloadFunc(fn, i, hd)
	case IssuesEvent:
		var i IssuesPayload
		json.Unmarshal([]byte(payload), &i)
		hook.runProcessPayloadFunc(fn, i, hd)
	case MemberEvent:
		var m MemberPayload
		json.Unmarshal([]byte(payload), &m)
		hook.runProcessPayloadFunc(fn, m, hd)
	case MembershipEvent:
		var m MembershipPayload
		json.Unmarshal([]byte(payload), &m)
		hook.runProcessPayloadFunc(fn, m, hd)
	case PageBuildEvent:
		var p PageBuildPayload
		json.Unmarshal([]byte(payload), &p)
		hook.runProcessPayloadFunc(fn, p, hd)
	case PublicEvent:
		var p PublicPayload
		json.Unmarshal([]byte(payload), &p)
		hook.runProcessPayloadFunc(fn, p, hd)
	case PullRequestReviewCommentEvent:
		var p PullRequestReviewCommentPayload
		json.Unmarshal([]byte(payload), &p)
		hook.runProcessPayloadFunc(fn, p, hd)
	case PullRequestEvent:
		var p PullRequestPayload
		json.Unmarshal([]byte(payload), &p)
		hook.runProcessPayloadFunc(fn, p, hd)
	case PushEvent:
		var p PushPayload
		json.Unmarshal([]byte(payload), &p)
		hook.runProcessPayloadFunc(fn, p, hd)
	case RepositoryEvent:
		var r RepositoryPayload
		json.Unmarshal([]byte(payload), &r)
		hook.runProcessPayloadFunc(fn, r, hd)
	case ReleaseEvent:
		var r ReleasePayload
		json.Unmarshal([]byte(payload), &r)
		hook.runProcessPayloadFunc(fn, r, hd)
	case StatusEvent:
		var s StatusPayload
		json.Unmarshal([]byte(payload), &s)
		hook.runProcessPayloadFunc(fn, s, hd)
	case TeamAddEvent:
		var t TeamAddPayload
		json.Unmarshal([]byte(payload), &t)
		hook.runProcessPayloadFunc(fn, t, hd)
	case WatchEvent:
		var w WatchPayload
		json.Unmarshal([]byte(payload), &w)
		hook.runProcessPayloadFunc(fn, w, hd)
	}
}

func (hook Webhook) runProcessPayloadFunc(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
	go func(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
		fn(results, header)
	}(fn, results, header)
}