Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions handlers/workflow.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
package handlers

import (
"crypto/subtle"
"encoding/json"

"github.com/stakwork/sphinx-tribes/db"
"github.com/stakwork/sphinx-tribes/utils"

"io"
"net/http"
"os"
"strings"
)

type workflowHandler struct {
Expand All @@ -19,12 +22,41 @@ type CreateWorkflowRequestRequest struct {
ResponseData db.PropertyMap `json:"response_data"`
}

const workflowResponseTokenHeader = "x-api-token"

func NewWorkFlowHandler(database db.Database) *workflowHandler {
return &workflowHandler{
db: database,
}
}

func validateStakworkResponseToken(r *http.Request) (int, string) {
expectedToken := strings.TrimSpace(os.Getenv("SWWF_RESKEY"))
if expectedToken == "" {
return http.StatusInternalServerError, "Server not configured"
}

token := strings.TrimSpace(r.Header.Get(workflowResponseTokenHeader))
if token == "" {
token = strings.TrimSpace(r.Header.Get("x-swwf-reskey"))
}
if token == "" {
authHeader := strings.TrimSpace(r.Header.Get("Authorization"))
if strings.HasPrefix(strings.ToLower(authHeader), "bearer ") {
token = strings.TrimSpace(authHeader[len("bearer "):])
}
}
if token == "" {
return http.StatusUnauthorized, "Missing token"
}

if subtle.ConstantTimeCompare([]byte(token), []byte(expectedToken)) != 1 {
return http.StatusUnauthorized, "Invalid token"
}

return http.StatusOK, ""
}

// HandleWorkflowRequest godoc
//
// @Summary Handle Workflow Request
Expand Down Expand Up @@ -86,6 +118,11 @@ func (wh *workflowHandler) HandleWorkflowRequest(w http.ResponseWriter, r *http.
// @Success 200 {object} map[string]string
// @Router /workflows/response [post]
func (wh *workflowHandler) HandleWorkflowResponse(w http.ResponseWriter, r *http.Request) {
if status, msg := validateStakworkResponseToken(r); status != http.StatusOK {
http.Error(w, msg, status)
return
}

body, err := io.ReadAll(r.Body)
if err != nil {
http.Error(w, "Error reading response body", http.StatusBadRequest)
Expand Down
83 changes: 82 additions & 1 deletion handlers/workflow_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ import (
"github.com/stretchr/testify/assert"
)

const testWorkflowResponseToken = "test-swwf-token"

func authorizeWorkflowResponse(req *http.Request) {
req.Header.Set("x-api-token", testWorkflowResponseToken)
}

func TestHandleWorkflowRequest(t *testing.T) {

teardownSuite := SetupSuite(t)
Expand Down Expand Up @@ -78,6 +84,7 @@ func TestHandleWorkflowResponse(t *testing.T) {

teardownSuite := SetupSuite(t)
defer teardownSuite(t)
t.Setenv("SWWF_RESKEY", testWorkflowResponseToken)

wh := NewWorkFlowHandler(db.TestDB)
t.Run("should process workflow response successfully", func(t *testing.T) {
Expand Down Expand Up @@ -120,6 +127,7 @@ func TestHandleWorkflowResponse(t *testing.T) {

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand Down Expand Up @@ -180,6 +188,7 @@ func TestHandleWorkflowResponse(t *testing.T) {

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand All @@ -201,6 +210,7 @@ func TestHandleWorkflowResponse(t *testing.T) {
payload, _ := json.Marshal(response)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand All @@ -212,6 +222,7 @@ func TestHandleWorkflowResponse(t *testing.T) {
invalidJSON := []byte(`{"request_id": "123", status: invalid}`)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(invalidJSON))
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand All @@ -228,6 +239,7 @@ func TestHandleWorkflowResponse(t *testing.T) {
payload, _ := json.Marshal(response)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand Down Expand Up @@ -259,6 +271,7 @@ func TestHandleWorkflowResponse(t *testing.T) {
payload, _ := json.Marshal(response)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand Down Expand Up @@ -301,6 +314,7 @@ func TestHandleWorkflowResponse(t *testing.T) {
payload, _ := json.Marshal(response)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
authorizeWorkflowResponse(req)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)
Expand All @@ -313,4 +327,71 @@ func TestHandleWorkflowResponse(t *testing.T) {
assert.Equal(t, db.StatusPending, updatedReq.Status)
assert.Equal(t, response.ResponseData, updatedReq.ResponseData)
})
}
}

func TestHandleWorkflowResponseTokenValidation(t *testing.T) {
wh := NewWorkFlowHandler(db.TestDB)
payload := []byte(`{"request_id":"test-request","response_data":{}}`)

t.Run("returns 401 when token is missing", func(t *testing.T) {
t.Setenv("SWWF_RESKEY", testWorkflowResponseToken)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)

assert.Equal(t, http.StatusUnauthorized, w.Code)
assert.Contains(t, w.Body.String(), "Missing token")
})

t.Run("returns 500 when server token is not configured", func(t *testing.T) {
t.Setenv("SWWF_RESKEY", "")

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("x-api-token", testWorkflowResponseToken)
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)

assert.Equal(t, http.StatusInternalServerError, w.Code)
assert.Contains(t, w.Body.String(), "Server not configured")
})

t.Run("returns 401 when token is invalid", func(t *testing.T) {
t.Setenv("SWWF_RESKEY", testWorkflowResponseToken)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("x-api-token", "wrong-token")
w := httptest.NewRecorder()

wh.HandleWorkflowResponse(w, req)

assert.Equal(t, http.StatusUnauthorized, w.Code)
assert.Contains(t, w.Body.String(), "Invalid token")
})

t.Run("accepts bearer token", func(t *testing.T) {
t.Setenv("SWWF_RESKEY", testWorkflowResponseToken)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer "+testWorkflowResponseToken)

status, msg := validateStakworkResponseToken(req)

assert.Equal(t, http.StatusOK, status)
assert.Empty(t, msg)
})

t.Run("accepts swwf token header", func(t *testing.T) {
t.Setenv("SWWF_RESKEY", testWorkflowResponseToken)

req := httptest.NewRequest(http.MethodPost, "/workflows/response", bytes.NewBuffer(payload))
req.Header.Set("x-swwf-reskey", testWorkflowResponseToken)

status, msg := validateStakworkResponseToken(req)

assert.Equal(t, http.StatusOK, status)
assert.Empty(t, msg)
})
}
58 changes: 57 additions & 1 deletion mocks/Database.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.