webhook

Documentation

Index

• Constants
• Variables
• func GenerateHMAC(payload []byte, secretKey string) string
• type GithubPushPayload
• type GitlabPushPayload
• type ParsedPayload
  • func Parse(r *http.Request, secretKey string) (ParsedPayload, error)

Constants

const (
	GithubSignatureHeader = "X-Hub-Signature-256"
	GiteaSignatureHeader  = "X-Gitea-Signature"
	GitlabTokenHeader     = "X-Gitlab-Token"
)

Variables

var (
	ErrInvalidHTTPMethod = errors.New("invalid http method")
	ErrParsingPayload    = errors.New("failed to parse payload")
)

var (
	ErrHMACVerificationFailed        = errors.New("HMAC verification failed")
	ErrGitlabTokenVerificationFailed = errors.New("gitlab token verification failed")
	ErrMissingSecurityHeader         = errors.New("missing signature or token header")
)

Functions

func GenerateHMAC

func GenerateHMAC(payload []byte, secretKey string) string

Types

type GithubPushPayload

type GithubPushPayload struct {
	Ref        string `json:"ref"`
	CommitSHA  string `json:"after"`
	Repository struct {
		Name     string `json:"name"`
		FullName string `json:"full_name"`
		CloneURL string `json:"clone_url"`
		Private  bool   `json:"private"`
	} `json:"repository"`
}

GithubPushPayload is a struct that represents the payload sent by GitHub or Gitea, as they have the same structure

type GitlabPushPayload

type GitlabPushPayload struct {
	Ref        string `json:"ref"`
	CommitSHA  string `json:"after"`
	Repository struct {
		Name              string `json:"name"`
		PathWithNamespace string `json:"path_with_namespace"`
		CloneURL          string `json:"http_url"`
		VisibilityLevel   int64  `json:"visibility_level"`
	} `json:"project"`
}

GitlabPushPayload is a struct that represents the payload sent by GitLab

type ParsedPayload

type ParsedPayload struct {
	Ref       string
	CommitSHA string
	Name      string
	FullName  string
	CloneURL  string
	Private   bool
}

ParsedPayload is a struct that contains the parsed payload data

func Parse

func Parse(r *http.Request, secretKey string) (ParsedPayload, error)

Parse parses the payload and returns the parsed payload data