config.yml.sample

@@ -319,3 +319,16 @@ metrics:
   username:
   # If set to a non-empty value the /metrics endpoint will require this as a password via basic auth in combination with the username below.
   password:
+
+# Webhook configuration
+webhooks:
+  - events : [ '*' ]
+    # URL for webhook
+    url: "http://127.0.0.1/test/test1/?q="
+    secret : "abc123"
+    timeout : 3
+  - events : [ 'task.', 'foobar.' ]
+    # URL for webhook
+    url: "http://127.0.0.1/test/test2/"
+    # no secret == no HMAC
+    # no timeout == default : 5s 

docs/content/doc/setup/config.md

@@ -1161,3 +1161,33 @@ Full path: `metrics.password`
 Environment path: `VIKUNJA_METRICS_PASSWORD`
 
 
+---
+
+## webhook
+
+Webhook configuration
+
+
+
+### enabled
+
+If set to true, HTTP POST is executed
+
+Default: `true`
+
+Full path: `webhook.enabled`
+
+Environment path: `VIKUNJA_WEBHOOK_ENABLED`
+
+
+### url
+
+URL for webhook
+
+Default: `http://127.0.0.1/test/`
+
+Full path: `webhook.url`
+
+Environment path: `VIKUNJA_WEBHOOK_URL`
+
+

pkg/config/config.go

@@ -160,8 +160,16 @@ const (
 	MetricsEnabled  Key = `metrics.enabled`
 	MetricsUsername Key = `metrics.username`
 	MetricsPassword Key = `metrics.password`
+
+	WebhooksConf Key = `webhooks`
 )
 
+// Unmarshal object directly from config
+func (k Key) GetUnmarshaled(rawVal interface{}) interface{} {
+	return viper.UnmarshalKey(string(k), &rawVal)
+}
+
+
 // GetString returns a string config value
 func (k Key) GetString() string {
 	return viper.GetString(string(k))
@@ -369,6 +377,8 @@ func InitDefaultConfig() {
 	KeyvalueType.setDefault("memory")
 	// Metrics
 	MetricsEnabled.setDefault(false)
+
+	WebhooksConf.setDefault([]int{})
 }
 
 // InitConfig initializes the config, sets defaults etc.

pkg/events/events.go

@@ -28,6 +28,8 @@ import (
 	"github.com/ThreeDotsLabs/watermill/message"
 	"github.com/ThreeDotsLabs/watermill/message/router/middleware"
 	"github.com/ThreeDotsLabs/watermill/pubsub/gochannel"
+
+	"code.vikunja.io/api/pkg/webhooks"
 )
 
 var pubsub *gochannel.GoChannel
@@ -72,7 +74,10 @@ func InitEvents() (err error) {
 		return nil
 	})
 
+	whMiddleware := webhooks.GenerateMiddleware()
+
 	router.AddMiddleware(
+		whMiddleware, //webhooks.WebhookMiddleware, 
 		poison,
 		middleware.Retry{
 			MaxRetries:          5,
@@ -86,6 +91,10 @@ func InitEvents() (err error) {
 		middleware.Recoverer,
 	)
 
+	router.AddMiddleware(
+
+	)
+
 	for topic, funcs := range listeners {
 		for _, handler := range funcs {
 			router.AddNoPublisherHandler(topic+"."+handler.Name(), topic, pubsub, handler.Handle)

pkg/webhooks/middleware.go

@@ -0,0 +1,49 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public Licensee as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package webhooks
+
+import (
+	"code.vikunja.io/api/pkg/log"
+
+	"github.com/ThreeDotsLabs/watermill/message"
+)
+
+func GenerateMiddleware() message.HandlerMiddleware {
+	runtimeConfig := ProcessConfig()
+	return func(hf message.HandlerFunc) message.HandlerFunc {
+		return func(msg *message.Message) ([]*message.Message, error) {
+			topic := message.SubscribeTopicFromCtx(msg.Context())
+			handleOutgoingWebhook(runtimeConfig, topic, msg)
+			newMsg, err := hf(msg)
+			if err != nil {
+				return nil, err
+			}
+			return newMsg, nil
+		}
+	}
+}
+
+func handleOutgoingWebhook(cfg []WebhookRuntimeConfig, topic string, msg *message.Message) {
+	log.Debugf("Webhook handler for '%s'", topic)
+	for i, entry := range cfg {
+		log.Debugf("Checking webhook config [%d]", i)
+		if entry.FilterFunc(topic) {
+			log.Debugf("Executing webhook [%d]", i)
+			entry.ExecuteFunc(topic, msg)
+		}
+	}
+}

pkg/webhooks/runtime.go

@@ -0,0 +1,143 @@
+// Vikunja is a to-do list application to facilitate your life.
+// Copyright 2018-2021 Vikunja and contributors. All rights reserved.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public Licensee as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public Licensee for more details.
+//
+// You should have received a copy of the GNU Affero General Public Licensee
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package webhooks
+
+import (
+	"bytes"
+	"fmt"
+	"net/http"
+	"strings"
+	"time"
+
+	"crypto/hmac"
+	"crypto/sha256"
+	"encoding/hex"
+
+	"code.vikunja.io/api/pkg/config"
+	"code.vikunja.io/api/pkg/log"
+
+	"github.com/ThreeDotsLabs/watermill/message"
+)
+
+const (
+	defaultTimeout = 5 * time.Second
+	ctHeader       = "Content-Type"
+	ctValue        = "application/json"
+	hmacHeader     = "X-Signature"
+)
+
+type FilteringFunction func(string) bool
+type WebhookCallFunction func(string, *message.Message) error
+
+// Single configuration entry
+type SingleConfEntry struct {
+	Events  []string `json:"events"`
+	URL     string   `json:"url"`
+	Secret  string   `json:"secret"`
+	Timeout int      `json:"timeout"`
+}
+
+type WebhookRuntimeConfig struct {
+	FilterFunc  FilteringFunction
+	ExecuteFunc WebhookCallFunction
+}
+
+func getWebhookFilterFunc(cfg SingleConfEntry) FilteringFunction {
+	return func(topic string) (is_interesting bool) {
+		for _, filter := range cfg.Events {
+			log.Debugf("Match pattern:'%s' topic:'%s'", filter, topic)
+			if filter == "*" {
+				log.Debugf(" '*' == Always match ")
+				return true
+			}
+			if strings.HasPrefix(topic, filter) {
+				log.Debugf("Positive match [%s] -> [%s]", filter, topic)
+				return true
+			}
+		}
+		log.Debugf("No match for [%s]", topic)
+		return false
+	}
+}
+
+func getWebhookCallFunc(cfg SingleConfEntry) WebhookCallFunction {
+	return func(topic string, msg *message.Message) error {
+		endpointURL := cfg.URL
+		hmacKey := cfg.Secret
+		timeout := defaultTimeout
+		if cfg.Timeout > 0 {
+			timeout = time.Second * time.Duration(cfg.Timeout)
+		}
+
+		log.Debugf("Webhook Call : %s (key=%s)", endpointURL, hmacKey)
+		webhookURL := fmt.Sprintf("%s%s", endpointURL, topic)
+
+		rawData := msg.Payload
+
+		req, err := http.NewRequest(http.MethodPost, webhookURL, bytes.NewBuffer(rawData))
+
+		if err != nil {
+			return err
+		}
+
+		client := &http.Client{
+			Timeout: timeout,
+		}
+
+		req.Header.Set(ctHeader, ctValue)
+
+		if len(hmacKey) > 1 {
+			signature := GenerateHMAC(rawData, hmacKey)
+			req.Header.Set(hmacHeader, signature)
+		}
+
+		resp, err = client.Do(req)
+		defer resp.Body.Close()
+		if err != nil {
+			log.Debugf("Webhook failed : %s , +%v", webhookURL, err)
+			return err
+		}
+
+		log.Debugf("Webhook success : %s ", webhookURL)
+		return nil
+	}
+}
+
+func GenerateHMAC(data []byte, key string) string {
+	h := hmac.New(sha256.New, []byte(key))
+	h.Write(data)
+	return hex.EncodeToString(h.Sum(nil))
+}
+
+// Process config and prepare mapping
+func ProcessConfig() []WebhookRuntimeConfig {
+
+	var items []SingleConfEntry
+
+	config.WebhooksConf.GetUnmarshaled(&items)
+
+	runtime := make([]WebhookRuntimeConfig, len(items))
+
+	log.Debugf("Webhook config items : %+v\n", items)
+
+	for i, item := range items {
+		runtime[i].FilterFunc = getWebhookFilterFunc(item)
+		runtime[i].ExecuteFunc = getWebhookCallFunc(item)
+	}
+
+	return runtime
+}