Documentation
¶
Index ¶
- Constants
- func CheckPayloadSignature(payload []byte, secret string, signature string) (string, error)
- func ExtractParameterAsString(s string, params interface{}) (string, bool)
- func GetParameter(s string, params interface{}) (interface{}, bool)
- func ReplaceParameter(s string, params interface{}, value interface{}) bool
- type AndRule
- type Argument
- type ArgumentError
- type CommandStatusResponse
- type Hook
- func (h *Hook) ExtractCommandArguments(headers, query, payload *map[string]interface{}) ([]string, error)
- func (h *Hook) ExtractCommandArgumentsForEnv(headers, query, payload *map[string]interface{}) ([]string, error)
- func (h *Hook) ParseJSONParameters(headers, query, payload *map[string]interface{}) error
- type Hooks
- type MatchRule
- type NotRule
- type OrRule
- type ParseError
- type Rules
- type SignatureError
- type SourceError
Constants ¶
const ( SourceHeader string = "header" SourceQuery string = "url" SourcePayload string = "payload" SourceString string = "string" SourceEntirePayload string = "entire-payload" SourceEntireQuery string = "entire-query" SourceEntireHeaders string = "entire-headers" )
Constants used to specify the parameter source
const ( MatchValue string = "value" MatchRegex string = "regex" MatchHashSHA1 string = "payload-hash-sha1" )
Constants for the MatchRule type
const ( // EnvNamespace is the prefix used for passing arguments into the command // environment. EnvNamespace string = "HOOK_" )
Variables ¶
This section is empty.
Functions ¶
func CheckPayloadSignature ¶
CheckPayloadSignature calculates and verifies SHA1 signature of the given payload
func ExtractParameterAsString ¶
ExtractParameterAsString extracts value from interface{} as string based on the passed string
func GetParameter ¶
GetParameter extracts interface{} value based on the passed string
func ReplaceParameter ¶
ReplaceParameter replaces parameter value with the passed value in the passed map (please note you should pass pointer to the map, because we're modifying it) based on the passed string
Types ¶
type AndRule ¶
type AndRule []Rules
AndRule will evaluate to true if and only if all of the ChildRules evaluate to true
type Argument ¶
type Argument struct {
Source string `json:"source,omitempty"`
Name string `json:"name,omitempty"`
}
Argument type specifies the parameter key name and the source it should be extracted from
type ArgumentError ¶
type ArgumentError struct {
Argument Argument
}
ArgumentError describes an invalid argument passed to Hook.
func (*ArgumentError) Error ¶
func (e *ArgumentError) Error() string
type CommandStatusResponse ¶
type CommandStatusResponse struct {
ResponseMessage string `json:"message,omitempty"`
Output string `json:"output,omitempty"`
Error string `json:"error,omitempty"`
}
CommandStatusResponse type encapsulates the executed command exit code, message, stdout and stderr
type Hook ¶
type Hook struct {
ID string `json:"id,omitempty"`
ExecuteCommand string `json:"execute-command,omitempty"`
CommandWorkingDirectory string `json:"command-working-directory,omitempty"`
ResponseMessage string `json:"response-message,omitempty"`
CaptureCommandOutput bool `json:"include-command-output-in-response,omitempty"`
PassEnvironmentToCommand []Argument `json:"pass-environment-to-command,omitempty"`
PassArgumentsToCommand []Argument `json:"pass-arguments-to-command,omitempty"`
JSONStringParameters []Argument `json:"parse-parameters-as-json,omitempty"`
TriggerRule *Rules `json:"trigger-rule,omitempty"`
}
Hook type is a structure containing details for a single hook
func (*Hook) ExtractCommandArguments ¶
func (h *Hook) ExtractCommandArguments(headers, query, payload *map[string]interface{}) ([]string, error)
ExtractCommandArguments creates a list of arguments, based on the PassArgumentsToCommand property that is ready to be used with exec.Command()
func (*Hook) ExtractCommandArgumentsForEnv ¶
func (h *Hook) ExtractCommandArgumentsForEnv(headers, query, payload *map[string]interface{}) ([]string, error)
ExtractCommandArgumentsForEnv creates a list of arguments in key=value format, based on the PassEnvironmentToCommand property that is ready to be used with exec.Command().
func (*Hook) ParseJSONParameters ¶
ParseJSONParameters decodes specified arguments to JSON objects and replaces the string with the newly created object
type Hooks ¶
type Hooks []Hook
Hooks is an array of Hook objects
func (*Hooks) LoadFromFile ¶
LoadFromFile attempts to load hooks from specified JSON file
type MatchRule ¶
type MatchRule struct {
Type string `json:"type,omitempty"`
Regex string `json:"regex,omitempty"`
Secret string `json:"secret,omitempty"`
Value string `json:"value,omitempty"`
Parameter Argument `json:"parameter,omitempty"`
}
MatchRule will evaluate to true based on the type
type NotRule ¶
type NotRule Rules
NotRule will evaluate to true if any and only if the ChildRule evaluates to false
type OrRule ¶
type OrRule []Rules
OrRule will evaluate to true if any of the ChildRules evaluate to true
type ParseError ¶
type ParseError struct {
Err error
}
ParseError describes an error parsing user input.
func (*ParseError) Error ¶
func (e *ParseError) Error() string
type Rules ¶
type Rules struct {
And *AndRule `json:"and,omitempty"`
Or *OrRule `json:"or,omitempty"`
Not *NotRule `json:"not,omitempty"`
Match *MatchRule `json:"match,omitempty"`
}
Rules is a structure that contains one of the valid rule types
type SignatureError ¶
type SignatureError struct {
Signature string
}
SignatureError describes an invalid payload signature passed to Hook.
func (*SignatureError) Error ¶
func (e *SignatureError) Error() string
type SourceError ¶
type SourceError struct {
Argument Argument
}
SourceError describes an invalid source passed to Hook.
func (*SourceError) Error ¶
func (e *SourceError) Error() string
Source Files