webhooks

Author: urlquery

README.md

@@ -1,12 +1,16 @@
 # uqw - urlquery-worker (v0.2)
 
-A worker to submit and retrive reports from urlquery.net
+A worker for submitting URLs and retrive reports from http://urlquery.net
 
-Monitor files for input (URLs), and are submitted to urlquery.net for analysis.
+It monitors files for input (URLs) which are submitted to urlquery.net for analysis.
 
-Report data (screenshot, JSON) can be saved to a output directory further handling / analysis.
+Report data (screenshot, JSON) can be retrived and saved to a output directory for further handling / analysis.
 Supports retrival of report data via both webhooks and REST API.
 
+Get a APIKEY by creating a account at:
+https://urlquery.net/user/signup
+
+
 ## Usage example
 
 Simple config
@@ -18,6 +22,7 @@ webhooks:
   enabled: false
   listen: 0.0.0.0:8080
 
+  # Setup webhook listeners for report events
   reports:
     # Alerts from users YARA signatures
     alerted:
@@ -40,7 +45,7 @@ submit:
     enabled: true
 
     settings:
-      access: public
+      access: public # public, restricted, private
       tags: []
 
     # alternative to webhooks

config.go

@@ -16,6 +16,7 @@ type AppConfig struct {
 type WebhooksSettings struct {
 	Enabled bool   `yaml:"enabled"`
 	Listen  string `yaml:"listen"`
+
 	Reports struct {
 		Alerted   ReportOutput `yaml:"alerted"`
 		Submitted ReportOutput `yaml:"submitted"`

config.yaml

@@ -3,7 +3,8 @@ apikey:
 
 webhooks: 
   enabled: false
-  listen: 0.0.0.0:0
+  # IP this server should listen
+  listen: 0.0.0.0:0 
 
   reports:
     # Alerts from users YARA signatures

main.go

@@ -1,9 +1,11 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"log"
+	"net/http"
 	"os"
 	"os/signal"
 	"strings"
@@ -31,13 +33,28 @@ func init() {
 	}
 	urlquery.SetDefaultKey(cfg.APIKey)
 
+	if cfg.Webhooks.Enabled {
+		fmt.Println("Using Webhooks")
+
+		usr, _ := urlquery.GetUser()
+		if err == nil {
+			fmt.Println("  NB: Make sure the configured Webhook is correct (requests originate from urlquery.net)")
+			fmt.Println("  Webhook URL:", usr.Notify.Webhook.URL)
+
+			if usr.Notify.Webhook.Enabled == false {
+				fmt.Println("  WARNING - Webhooks is not enabled")
+			}
+		}
+	}
+
 }
 
 func main() {
+	var srv *http.Server
 
 	// Start webhook server
 	if cfg.Webhooks.Enabled {
-		StartWebhookServer()
+		srv = StartWebhookServer()
 	}
 
 	// Start submission workers
@@ -47,11 +64,44 @@ func main() {
 		}
 	}
 
-	// TODO: add shutdown
+	waitForQuitSignal()
+	err := shutdownHttpServer(srv, 60)
+	if err != nil {
+		fmt.Println("Shutdown timedout")
+		os.Exit(1)
+	}
+
+}
+
+// waitForQuitSignal waits for CRTL-C, forces exit if its pressed 2 more times
+func waitForQuitSignal() {
 	// listen for OS interrupt signals
 	quit := make(chan os.Signal, 1)
 	signal.Notify(quit, os.Interrupt)
 	<-quit
+
+	go func() {
+		for force_quit := 2; force_quit != 0; force_quit-- {
+			fmt.Printf("Hit Ctrl-C %d more times to force quit..\n", force_quit)
+			signal.Notify(quit, os.Interrupt)
+			<-quit
+		}
+		os.Exit(1)
+	}()
+}
+
+func shutdownHttpServer(srv *http.Server, timeout_seconds uint) error {
+	if srv == nil {
+		return nil
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(timeout_seconds)*time.Second)
+	defer cancel()
+	if err := srv.Shutdown(ctx); err != nil {
+		return err
+	}
+
+	return nil
 }
 
 func SubmitWorker(cfg SubmitterSettings) {

webhook.go

@@ -15,7 +15,7 @@ type webhookServer struct {
 	cfg    WebhooksSettings
 }
 
-func StartWebhookServer() {
+func StartWebhookServer() *http.Server {
 	srv := CreateWebhookServer(cfg.Webhooks)
 	http.Handle("/", srv.router)
 
@@ -31,6 +31,8 @@ func StartWebhookServer() {
 			log.Fatal(err)
 		}
 	}()
+
+	return web
 }
 
 func CreateWebhookServer(cfg WebhooksSettings) *webhookServer {