[BREAKING] Add tests for username auth, fix form key names

Also, testing infrastructure

socketserver/server/backend.go

@@ -142,9 +142,9 @@ func SendRemoteCommand(remoteCommand, data string, auth AuthInfo) (responseStr s
 	destURL := fmt.Sprintf("%s/cmd/%s", backendURL, remoteCommand)
 	var authKey string
 	if auth.UsernameValidated {
-		authKey = "usernameClaimed"
+		authKey = "usernameVerified"
 	} else {
-		authKey = "username"
+		authKey = "usernameClaimed"
 	}
 
 	formData := url.Values{

socketserver/server/backend_test.go

@@ -2,7 +2,9 @@ package server
 
 import (
 	"crypto/rand"
+	"fmt"
 	"golang.org/x/crypto/nacl/box"
+	"net/http"
 	"net/url"
 	"testing"
 )
@@ -44,3 +46,111 @@ func TestSealRequest(t *testing.T) {
 		t.Errorf("Failed to round-trip, got back %v", unsealedValues)
 	}
 }
+
+const MethodIsPost = "POST"
+
+type ExpectedBackendRequest struct {
+	ResponseCode int
+	Path         string
+	// Method       string // always POST
+	PostForm *url.Values
+	Response string
+}
+
+func (er *ExpectedBackendRequest) String() string {
+	if MethodIsPost == "" {
+		return er.Path
+	}
+	return fmt.Sprint("%s %s: %s", MethodIsPost, er.Path, er.PostForm.Encode())
+}
+
+type BackendRequestChecker struct {
+	ExpectedRequests []ExpectedBackendRequest
+
+	currentRequest int
+	tb             testing.TB
+}
+
+func NewBackendRequestChecker(tb testing.TB, urls ...ExpectedBackendRequest) *BackendRequestChecker {
+	return &BackendRequestChecker{ExpectedRequests: urls, tb: tb, currentRequest: 0}
+}
+
+func (backend *BackendRequestChecker) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if r.Method != MethodIsPost {
+		backend.tb.Errorf("Bad backend request: was not a POST. %v", r)
+		return
+	}
+
+	r.ParseForm()
+
+	unsealedForm, err := UnsealRequest(r.PostForm)
+	if err != nil {
+		backend.tb.Errorf("Failed to unseal backend request: %v", err)
+	}
+
+	if backend.currentRequest >= len(backend.ExpectedRequests) {
+		backend.tb.Errorf("Unexpected backend request: %s %s: %s", r.Method, r.URL, unsealedForm)
+		return
+	}
+
+	cur := backend.ExpectedRequests[backend.currentRequest]
+	backend.currentRequest++
+
+	defer func() {
+		w.WriteHeader(cur.ResponseCode)
+		if cur.Response != "" {
+			w.Write([]byte(cur.Response))
+		}
+	}()
+
+	if cur.Path != "" {
+		if r.URL.Path != cur.Path {
+			backend.tb.Errorf("Bad backend request. Expected %v, got %s %s", cur, r.Method, r.URL)
+			return
+		}
+	}
+
+	if cur.PostForm != nil {
+		anyErr := compareForms(backend.tb, "Different form contents", *cur.PostForm, unsealedForm)
+		if anyErr {
+			backend.tb.Errorf("...in %s %s: %s", r.Method, r.URL, unsealedForm.Encode())
+		}
+	}
+}
+
+func (backend *BackendRequestChecker) Close() error {
+	if backend.currentRequest < len(backend.ExpectedRequests) {
+		backend.tb.Errorf("Not all requests sent, got %d out of %d", backend.currentRequest, len(backend.ExpectedRequests))
+	}
+	return nil
+}
+
+func compareForms(tb testing.TB, ctx string, expectedForm, gotForm url.Values) (anyErrors bool) {
+	for k, expVal := range expectedForm {
+		gotVal, ok := gotForm[k]
+		if !ok {
+			tb.Errorf("%s: Form[%s]: Expected %v, (got nothing)", ctx, k, expVal)
+			anyErrors = true
+			continue
+		}
+		if len(expVal) != len(gotVal) {
+			tb.Errorf("%s: Form[%s]: Expected %d%v, Got %d%v", ctx, k, len(expVal), expVal, len(gotVal), gotVal)
+			anyErrors = true
+			continue
+		}
+		for i, el := range expVal {
+			if gotVal[i] != el {
+				tb.Errorf("%s: Form[%s][%d]: Expected %s, Got %s", ctx, k, i, el, gotVal[i])
+				anyErrors = true
+			}
+		}
+	}
+	for k, gotVal := range gotForm {
+		_, ok := expectedForm[k]
+		if !ok {
+			tb.Errorf("%s: Form[%s]: (expected nothing), Got %v", ctx, k, gotVal)
+			anyErrors = true
+		}
+	}
+	return anyErrors
+}

socketserver/server/irc.go

@@ -4,13 +4,13 @@ import (
 	"bytes"
 	"crypto/rand"
 	"encoding/base64"
+	"errors"
 	"fmt"
 	irc "github.com/fluffle/goirc/client"
 	"log"
 	"strings"
 	"sync"
 	"time"
-	"errors"
 )
 
 type AuthCallback func(client *ClientInfo, successful bool)
@@ -106,13 +106,11 @@ func ircConnection() {
 		channel := line.Args[0]
 		msg := line.Args[1]
 		if channel != AuthChannel || !strings.HasPrefix(msg, AuthCommand) || !line.Public() {
-			fmt.Println(DEBUG, "discarded msg", line.Raw)
 			return
 		}
 
 		msgArray := strings.Split(msg, " ")
 		if len(msgArray) != 2 {
-			fmt.Println(DEBUG, "discarded msg - not 2 strings", line.Raw)
 			return
 		}
 
@@ -129,7 +127,7 @@ func ircConnection() {
 
 }
 
-func submitAuth(user, challenge string) error {
+func submitAuth(user, challenge string) {
 	var auth PendingAuthorization
 	var idx int = -1
 
@@ -147,12 +145,11 @@ func submitAuth(user, challenge string) error {
 	PendingAuthLock.Unlock()
 
 	if idx == -1 {
-		return errChallengeNotFound // perhaps it was for another socket server
+		return // perhaps it was for another socket server
 	}
 
 	// auth is valid, and removed from pending list
 
-	fmt.Println(DEBUG, "authorization success for user", auth.Client.TwitchUsername)
 	var usernameChanged bool
 	auth.Client.Mutex.Lock()
 	if auth.Client.TwitchUsername == user { // recheck condition
@@ -169,4 +166,4 @@ func submitAuth(user, challenge string) error {
 			auth.Callback(auth.Client, false)
 		}
 	}
-}
+}

socketserver/server/subscriptions_test.go

@@ -147,8 +147,8 @@ type TURLs struct {
 	SavePubMsg     string // cached_pub
 }
 
-func TGetUrls(testserver *httptest.Server) TURLs {
+func TGetUrls(socketserver *httptest.Server, backend *httptest.Server) TURLs {
-	addr := testserver.Listener.Addr().String()
+	addr := socketserver.Listener.Addr().String()
 	return TURLs{
 		Websocket:      fmt.Sprintf("ws://%s/", addr),
 		Origin:         fmt.Sprintf("http://%s", addr),
@@ -157,7 +157,13 @@ func TGetUrls(testserver *httptest.Server) TURLs {
 	}
 }
 
-func TSetup(testserver **httptest.Server, urls *TURLs) {
+const (
+	SetupWantSocketServer = 1 << iota
+	SetupWantBackendServer
+	SetupWantURLs
+)
+
+func TSetup(flags int, backendChecker *BackendRequestChecker) (socketserver *httptest.Server, backend *httptest.Server, urls TURLs) {
 	DumpBacklogData()
 
 	ioutil.WriteFile("index.html", []byte(`
@@ -174,28 +180,34 @@ func TSetup(testserver **httptest.Server, urls *TURLs) {
 	&mdash; CatBag by <a href="http://www.twitch.tv/wolsk">Wolsk</a>
 </div>
 </div>`), 0600)
+
 	conf := &ConfigFile{
 		ServerID:         20,
 		UseSSL:           false,
-		SocketOrigin:     "localhost:2002",
 		OurPublicKey:     []byte{176, 149, 72, 209, 35, 42, 110, 220, 22, 236, 212, 129, 213, 199, 1, 227, 185, 167, 150, 159, 117, 202, 164, 100, 9, 107, 45, 141, 122, 221, 155, 73},
 		OurPrivateKey:    []byte{247, 133, 147, 194, 70, 240, 211, 216, 223, 16, 241, 253, 120, 14, 198, 74, 237, 180, 89, 33, 146, 146, 140, 58, 88, 160, 2, 246, 112, 35, 239, 87},
 		BackendPublicKey: []byte{19, 163, 37, 157, 50, 139, 193, 85, 229, 47, 166, 21, 153, 231, 31, 133, 41, 158, 8, 53, 73, 0, 113, 91, 13, 181, 131, 248, 176, 18, 1, 107},
 	}
+
+	if flags&SetupWantBackendServer != 0 {
+		backend = httptest.NewServer(backendChecker)
+		conf.BackendURL = fmt.Sprintf("http://%s", backend.Listener.Addr().String())
+	}
+
 	Configuration = conf
 	setupBackend(conf)
 
-	if testserver != nil {
+	if flags&SetupWantSocketServer != 0 {
 		serveMux := http.NewServeMux()
 		SetupServerAndHandle(conf, serveMux)
 
-		tserv := httptest.NewUnstartedServer(serveMux)
+		socketserver = httptest.NewServer(serveMux)
-		*testserver = tserv
-		tserv.Start()
-		if urls != nil {
-			*urls = TGetUrls(tserv)
-		}
 	}
+
+	if flags&SetupWantURLs != 0 {
+		urls = TGetUrls(socketserver, backend)
+	}
+	return
 }
 
 func TestSubscriptionAndPublish(t *testing.T) {
@@ -220,9 +232,18 @@ func TestSubscriptionAndPublish(t *testing.T) {
 
 	var server *httptest.Server
 	var urls TURLs
-	TSetup(&server, &urls)
+
+	var backendExpected = NewBackendRequestChecker(t,
+		ExpectedBackendRequest{200, bPathAnnounceStartup, &url.Values{"startup": []string{"1"}}, ""},
+		ExpectedBackendRequest{200, bPathAddTopic, &url.Values{"channels": []string{TestChannelName1}, "added": []string{"t"}}, "ok"},
+		ExpectedBackendRequest{200, bPathAddTopic, &url.Values{"channels": []string{TestChannelName2}, "added": []string{"t"}}, "ok"},
+		ExpectedBackendRequest{200, bPathAddTopic, &url.Values{"channels": []string{TestChannelName3}, "added": []string{"t"}}, "ok"},
+	)
+	server, _, urls = TSetup(SetupWantSocketServer|SetupWantBackendServer|SetupWantURLs, backendExpected)
+
 	defer server.CloseClientConnections()
 	defer unsubscribeAllClients()
+	defer backendExpected.Close()
 
 	var conn *websocket.Conn
 	var resp *http.Response
@@ -277,6 +298,7 @@ func TestSubscriptionAndPublish(t *testing.T) {
 	}
 
 	doneWg.Add(1)
+	readyWg.Wait() // enforce ordering
 	readyWg.Add(1)
 	go func(conn *websocket.Conn) {
 		TSendMessage(t, conn, 1, HelloCommand, []interface{}{"ffz_0.0-test", uuid.NewV4().String()})
@@ -306,6 +328,7 @@ func TestSubscriptionAndPublish(t *testing.T) {
 	}
 
 	doneWg.Add(1)
+	readyWg.Wait() // enforce ordering
 	readyWg.Add(1)
 	go func(conn *websocket.Conn) {
 		TSendMessage(t, conn, 1, HelloCommand, []interface{}{"ffz_0.0-test", uuid.NewV4().String()})
@@ -402,6 +425,106 @@ func TestSubscriptionAndPublish(t *testing.T) {
 	server.Close()
 }
 
+func TestRestrictedCommands(t *testing.T) {
+	var doneWg sync.WaitGroup
+	var readyWg sync.WaitGroup
+
+	const TestCommandNeedsAuth = "needsauth"
+	const TestRequestData = "123456"
+	const TestRequestDataJSON = "\"" + TestRequestData + "\""
+	const TestReplyData = "success"
+	const TestUsername = "sirstendec"
+
+	var server *httptest.Server
+	var urls TURLs
+
+	var backendExpected = NewBackendRequestChecker(t,
+		ExpectedBackendRequest{200, bPathAnnounceStartup, &url.Values{"startup": []string{"1"}}, ""},
+		ExpectedBackendRequest{401, fmt.Sprintf("%s%s", bPathOtherCommand, TestCommandNeedsAuth), &url.Values{"usernameClaimed": []string{""}, "clientData": []string{TestRequestDataJSON}}, ""},
+		ExpectedBackendRequest{401, fmt.Sprintf("%s%s", bPathOtherCommand, TestCommandNeedsAuth), &url.Values{"usernameClaimed": []string{TestUsername}, "clientData": []string{TestRequestDataJSON}}, ""},
+		ExpectedBackendRequest{200, fmt.Sprintf("%s%s", bPathOtherCommand, TestCommandNeedsAuth), &url.Values{"usernameVerified": []string{TestUsername}, "clientData": []string{TestRequestDataJSON}}, fmt.Sprintf("\"%s\"", TestReplyData)},
+	)
+	server, _, urls = TSetup(SetupWantSocketServer|SetupWantBackendServer|SetupWantURLs, backendExpected)
+
+	defer server.CloseClientConnections()
+	defer unsubscribeAllClients()
+	defer backendExpected.Close()
+
+	var conn *websocket.Conn
+	var err error
+	var challengeChan = make(chan string)
+
+	var headers http.Header = make(http.Header)
+	headers.Set("Origin", TwitchDotTv)
+
+	// Client 1
+	conn, _, err = websocket.DefaultDialer.Dial(urls.Websocket, headers)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	doneWg.Add(1)
+	readyWg.Add(1)
+	go func(conn *websocket.Conn) {
+		defer doneWg.Done()
+		defer conn.Close()
+		TSendMessage(t, conn, 1, HelloCommand, []interface{}{"ffz_0.0-test", uuid.NewV4().String()})
+		TReceiveExpectedMessage(t, conn, 1, SuccessCommand, IgnoreReceivedArguments)
+		TSendMessage(t, conn, 2, ReadyCommand, 0)
+		TReceiveExpectedMessage(t, conn, 2, SuccessCommand, nil)
+
+		// Should get immediate refusal because no username set
+		TSendMessage(t, conn, 3, TestCommandNeedsAuth, TestRequestData)
+		TReceiveExpectedMessage(t, conn, 3, ErrorCommand, AuthorizationNeededError)
+
+		// Set a username
+		TSendMessage(t, conn, 4, SetUserCommand, TestUsername)
+		TReceiveExpectedMessage(t, conn, 4, SuccessCommand, nil)
+
+		// Should get authorization prompt
+		TSendMessage(t, conn, 5, TestCommandNeedsAuth, TestRequestData)
+		readyWg.Done()
+		msg, success := TReceiveExpectedMessage(t, conn, -1, AuthorizeCommand, IgnoreReceivedArguments)
+		if !success {
+			t.Error("recieve authorize command failed, cannot continue")
+			return
+		}
+		challenge, err := msg.ArgumentsAsString()
+		if err != nil {
+			t.Error(err)
+			return
+		}
+		challengeChan <- challenge // mocked: sending challenge to IRC server, IRC server sends challenge to socket server
+
+		TReceiveExpectedMessage(t, conn, 5, SuccessCommand, TestReplyData)
+	}(conn)
+
+	readyWg.Wait()
+
+	challenge := <-challengeChan
+	PendingAuthLock.Lock()
+	found := false
+	for _, v := range PendingAuths {
+		if conn.LocalAddr().String() == v.Client.RemoteAddr.String() {
+			found = true
+			if v.Challenge != challenge {
+				t.Error("Challenge in array was not what client got")
+			}
+			break
+		}
+	}
+	PendingAuthLock.Unlock()
+	if !found {
+		t.Fatal("Did not find authorization challenge in the pending auths array")
+	}
+
+	submitAuth(TestUsername, challenge)
+
+	doneWg.Wait()
+	server.Close()
+}
+
 func BenchmarkUserSubscriptionSinglePublish(b *testing.B) {
 	var doneWg sync.WaitGroup
 	var readyWg sync.WaitGroup
@@ -429,7 +552,7 @@ func BenchmarkUserSubscriptionSinglePublish(b *testing.B) {
 
 	var server *httptest.Server
 	var urls TURLs
-	TSetup(&server, &urls)
+	server, _, urls = TSetup(SetupWantSocketServer|SetupWantURLs, nil)
 	defer unsubscribeAllClients()
 
 	var headers http.Header = make(http.Header)