initial commit

vatsimauth/vatsimauth.go

@@ -0,0 +1,72 @@
+package vatsimauth
+
+import (
+	"crypto/md5"
+	"crypto/rand"
+	"encoding/hex"
+)
+
+var Keys = map[uint16]string{
+	35044: "fe28334fb753cf0e3d19942197b9ce3e",
+	55538: "ImuL1WbbhVuD8d3MuKpWn2rrLZRa9iVP",
+	47546: "727d1efd5cb9f8d2c28372469d922bb4",
+}
+
+type VatsimAuth struct {
+	clientID uint16
+	init     string
+	state    string
+}
+
+func NewVatsimAuth(clientID uint16, privateKey string) *VatsimAuth {
+	return &VatsimAuth{
+		clientID: clientID,
+		init:     "",
+		state:    privateKey,
+	}
+}
+
+// SetInitialChallenge stores the initial challenge for this authentication state. This should be called once before running GenerateResponse
+func (v *VatsimAuth) SetInitialChallenge(initialChallenge string) {
+	v.init = v.GenerateResponse(initialChallenge)
+	v.state = v.init
+}
+
+// GenerateResponse returns the response for the provided challenge.
+func (v *VatsimAuth) GenerateResponse(challenge string) string {
+	c1, c2 := challenge[0:(len(challenge)/2)], challenge[(len(challenge)/2):]
+
+	if (v.clientID & 1) == 1 {
+		c1, c2 = c2, c1
+	}
+
+	s1, s2, s3 := v.state[0:12], v.state[12:22], v.state[22:32]
+
+	h := ""
+	switch v.clientID % 3 {
+	case 0:
+		h = s1 + c1 + s2 + c2 + s3
+	case 1:
+		h = s2 + c1 + s3 + c2 + s1
+	}
+
+	hash := md5.Sum([]byte(h))
+	return hex.EncodeToString(hash[:])
+}
+
+// UpdateState updates this authentication state with a response hash. This is conventionally called with the return value of GenerateResponse
+func (v *VatsimAuth) UpdateState(hash string) {
+	newStateHash := md5.Sum([]byte(v.init + hash))
+	v.state = hex.EncodeToString(newStateHash[:])
+}
+
+// GenerateChallenge returns a cryptographically secure random challenge string
+func GenerateChallenge() (string, error) {
+	challenge := make([]byte, 4)
+	_, err := rand.Read(challenge)
+	if err != nil {
+		return "", err
+	}
+
+	return hex.EncodeToString(challenge), nil
+}

vatsimauth/vatsimauth_test.go

@@ -0,0 +1,36 @@
+package vatsimauth
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestVatsimAuth(t *testing.T) {
+
+	// vPilot clientID and key
+	v := NewVatsimAuth(35044, "fe28334fb753cf0e3d19942197b9ce3e")
+	assert.NotNil(t, v)
+
+	// Initial challenge
+	// $DISERVER:CLIENT:VATSIM FSD V3.43:30984979d8caed23
+	v.SetInitialChallenge("30984979d8caed23")
+
+	// First challenge from server
+	// $ZCSERVER:N12345:de6acb8e
+	res := v.GenerateResponse("de6acb8e")
+
+	// Expected response:
+	// $ZRN12345:SERVER:f8ee97157f66455ed6108fccef6ccf5f
+	assert.Equal(t, "f8ee97157f66455ed6108fccef6ccf5f", res)
+	v.UpdateState(res)
+
+	// Second challenge from server
+	// $ZCSERVER:N12345:65b479573b0e
+	res = v.GenerateResponse("65b479573b0e")
+
+	// Expected response
+	// $ZRN12345:SERVER:8953f545c4e0ffd20943ad89b8ddd087
+	assert.Equal(t, "8953f545c4e0ffd20943ad89b8ddd087", res)
+	v.UpdateState(res)
+
+}