Clean-up

Linter and other misc cleaning

Author: lazarus

.gitignore

@@ -0,0 +1,34 @@
+### Project specific ###
+tests
+resources
+tools
+
+### Go ###
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+### Go Patch ###
+/vendor/
+/Godeps/
+
+### Goland ###
+*.iml
+*.ipr
+*.iws
+.idea/
+/build/
+/dist/
+/out/

.golangci.yml

@@ -0,0 +1,38 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # which dirs to skip: issues from them won't be reported;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but default dirs are skipped independently
+  # from this option's value (see skip-dirs-use-default).
+  # "/" will be replaced by current OS file path separator to properly work
+  # on Windows.
+  skip-dirs:
+    - tests
+
+# all available settings of specific linters
+linters-settings:
+
+  gocyclo:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 10
+
+linters:
+  disable-all: true
+  enable:
+    - deadcode
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck
+    - megacheck

README.md

@@ -4,7 +4,7 @@ My slow attempt at an 'RE' of the SoulWorker protocol.
 How to use:
 
 1. Download and open in GoLand or whatever IDE (or not) you use
-2. Setup the database with the provided .sql file
+2. Set up the database with the provided .sql file
 
 To launch the KRSW OnStove client (+skipping Stove Authenticator):
 ```
@@ -17,28 +17,31 @@ To bypass the OnStove authenticator without command line arguments, you can buil
 
 Changelog:
 
+* Oct 11, 2021
+  * Re-base
+
 * May 11, 2020
-    * Major refactor
-    * Small database implementation
-    * Somehow made it ask for 2fa and don't know how to skip, so done for today
+  * Major refactor
+  * Small database implementation
+  * Somehow made it ask for 2fa and don't know how to skip, so done for today
 
 * August 2, 2019
-	* No server sided updates, only client side discoveries.
+  * No server sided updates, only client side discoveries.
 
 * July 29, 2019
-	* Moved hardcoded keyTable to globals where it's defined
-	* Minimal file updates, just slight renaming on a few variables
-	* Changed cringe server name
-	* Added some tools/tests for `tb_*.res` table extraction/verification
-		* Includes `tb_*` string dump and the ASM dump for functions regarding them
-		* Includes the final go struct dump for all table structures
-		* You can find the original script that I modified in this [Gist](https://gist.github.com/x1nixmzeng/a4a5c419f1cd4bc72cba30d5e647bc4f)
+  * Moved hardcoded keyTable to globals where it's defined
+  * Minimal file updates, just slight renaming on a few variables
+  * Changed cringe server name
+  * Added some tools/tests for `tb_*.res` table extraction/verification
+    * Includes `tb_*` string dump and the ASM dump for functions regarding them
+    * Includes the final go struct dump for all table structures
+    * You can find the original script that I modified in this [Gist](https://gist.github.com/x1nixmzeng/a4a5c419f1cd4bc72cba30d5e647bc4f)
 
 * July 13, 2019
-	* Hardcoded keyTable instead of having it read from file
-	* Updated some packets from NA client to KR/BSW client
-	* Re-did some structs
-	* Added some string utils
+  * Hardcoded keyTable instead of having it read from file
+  * Updated some packets from NA client to KR/BSW client
+  * Re-did some structs
+  * Added some string utils
 
 * Dec 6, 2018
-	* Uploaded with initial edit from 11/12/2018
+  * Uploaded with initial edit from 11/12/2018

database/database.go

@@ -6,7 +6,8 @@ import (
 	"fmt"
 	"log"
 
-	. "../network/structures"
+	. "soulworker-server/network/structures"
+
 	_ "github.com/go-sql-driver/mysql"
 )
 
@@ -32,7 +33,7 @@ func Open() *sql.DB {
 	return DB
 }
 
-// CanConnect checks whether or not a database is accepting connections
+// CanConnect checks whether a database is accepting connections
 // It returns an error if not
 func CanConnect() error {
 	fmt.Print("[Database]\tChecking connection... ")
@@ -73,7 +74,7 @@ func VerifyLoginCredentials(username string, password string) uint32 {
 	return uint32(id)
 }
 
-// Updates a given accountId's sessionKey in the database
+// UpdateSessionKey Updates a given accountId's sessionKey in the database
 func UpdateSessionKey(accountId uint32, sessionKey uint64) {
 	stmt, err := DB.Prepare("UPDATE users SET session_key = ? WHERE id = ?")
 	if err != nil {
@@ -95,7 +96,7 @@ func UpdateSessionKey(accountId uint32, sessionKey uint64) {
 	log.Printf("ID = %d, affected = %d\n", lastId, rowCnt)
 }
 
-// Verifies that an accountId's sessionKey matches the one in the database
+// VerifySessionKey Verifies that an accountId's sessionKey matches the one in the database
 func VerifySessionKey(accountId uint32, sessionKey uint64) int {
 
 	var id int
@@ -110,7 +111,7 @@ func VerifySessionKey(accountId uint32, sessionKey uint64) int {
 	return id
 }
 
-// Inserts an entry for the character table into the database from the contents of the CharacterInfo struct
+// InsertCharacterToDb Inserts an entry for the character table into the database from the contents of the CharacterInfo struct
 func InsertCharacterToDb(charInfo *CharacterInfo) int64 {
 
 	stmt, err := DB.Prepare("INSERT INTO characters(accountId, `index`, name, class, appearance, level) VALUES(?, ?, ?, ?, ?, ?)")
@@ -136,7 +137,7 @@ func InsertCharacterToDb(charInfo *CharacterInfo) int64 {
 	return lastId
 }
 
-// Fetches the number of characters the given accountId has on the server.
+// FetchUserCharacterCount Fetches the number of characters the given accountId has on the server.
 func FetchUserCharacterCount(accountId uint32) int {
 	var count int
 
@@ -149,7 +150,7 @@ func FetchUserCharacterCount(accountId uint32) int {
 	return count
 }
 
-// Fetches the user character with the given characterId on the given accountId.
+// FetchUserCharacter Fetches the user character with the given characterId on the given accountId.
 func FetchUserCharacter(accountId uint32, characterId uint32) (CharacterInfo, error) {
 
 	char := CharacterInfo{}
@@ -163,7 +164,7 @@ func FetchUserCharacter(accountId uint32, characterId uint32) (CharacterInfo, er
 	return char, nil
 }
 
-// Fetches the user character with the given characterId.
+// FetchUserCharacterByCharacterId Fetches the user character with the given characterId.
 func FetchUserCharacterByCharacterId(characterId uint32) (CharacterInfo, error) {
 
 	char := CharacterInfo{}

global/global.go

@@ -8,17 +8,18 @@ import (
 // ServerMap - Array of Servers
 var (
 	KeyTable = []byte{
-		0x57, 0x19, 0xC6, 0x2D, 0x56, 0x68, 0x3A, 0xCC,
-		0x60, 0x3B, 0x0B, 0xB1, 0x90, 0x5C, 0x4A, 0xF8,
-
-		0x80, 0x28, 0xB1, 0x45, 0xB6, 0x85, 0xE7, 0x4C,
-		0x06, 0x2D, 0x55, 0x83, 0xAF, 0x44, 0x99, 0x95,
-
-		0xD9, 0x98, 0xBF, 0xAE, 0x53, 0x43, 0x63, 0xC8,
-		0x4A, 0x71, 0x80, 0x9D, 0x0B, 0xA1, 0x70, 0x8A,
-
-		0x0F, 0x54, 0x9C, 0x1B, 0x06, 0xC0, 0xEA, 0x3C,
-		0xC0, 0x88, 0x71, 0x48, 0xB3, 0xB9, 0x45, 0x78,
+		0xEE, 0x1B, 0xDE, 0xA6, 0x46, 0xE9, 0x2A, 0xDB, 0x97, 0x67, 0x9C, 0x02, 0x3C, 0xCE, 0x9A,
+		//0x57, 0x19, 0xC6, 0x2D, 0x56, 0x68, 0x3A, 0xCC,
+		//0x60, 0x3B, 0x0B, 0xB1, 0x90, 0x5C, 0x4A, 0xF8,
+		//
+		//0x80, 0x28, 0xB1, 0x45, 0xB6, 0x85, 0xE7, 0x4C,
+		//0x06, 0x2D, 0x55, 0x83, 0xAF, 0x44, 0x99, 0x95,
+		//
+		//0xD9, 0x98, 0xBF, 0xAE, 0x53, 0x43, 0x63, 0xC8,
+		//0x4A, 0x71, 0x80, 0x9D, 0x0B, 0xA1, 0x70, 0x8A,
+		//
+		//0x0F, 0x54, 0x9C, 0x1B, 0x06, 0xC0, 0xEA, 0x3C,
+		//0xC0, 0x88, 0x71, 0x48, 0xB3, 0xB9, 0x45, 0x78,
 	}
 	ServerMap     []Server
 	LoginPort     uint16 = 10000
@@ -49,4 +50,4 @@ func (server Server) GetName() string {
 // GetIP - Gets the IP of a Game Server
 func (server Server) GetIP() string {
 	return server.IP
-}
+}

go.mod

@@ -0,0 +1,9 @@
+module soulworker-server
+
+go 1.16
+
+require (
+	github.com/davecgh/go-spew v1.1.1
+	github.com/go-sql-driver/mysql v1.6.0
+	golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac
+)

go.sum

@@ -0,0 +1,6 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE=
+github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
+golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac h1:oN6lz7iLW/YC7un8pq+9bOLyXrprv2+DKfkJY+2LJJw=
+golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

main.go

@@ -1,50 +1,13 @@
 package main
 
 import (
-	"bytes"
+	"soulworker-server/database"
+	. "soulworker-server/global"
+	. "soulworker-server/network"
 	"time"
-
-	"encoding/hex"
-	"fmt"
-
-	"./database"
-	. "./global"
-	. "./network"
-	. "./network/packets"
 )
 
-// quickDecode quickly decodes a series of encoded bytes.
-// This simulates a receive call from the server.
-// It returns a byte Buffer containing the decoded byte contents.
-func quickDecode(arr []byte) *bytes.Buffer {
-	raw := Decrypt(arr)
-	if packetID, _, err := UnmarshalPacket(raw); err != nil {
-		fmt.Printf("err: %s\n", err)
-	} else {
-		fmt.Printf("ID=0x%04X, Size=%d, Total=%d\n", packetID, raw.Len(), raw.Len()+5)
-		fmt.Println(hex.Dump(raw.Bytes()))
-		return raw
-	}
-	return nil
-}
-
 func main() {
-	//packets := [][]byte{
-	//	{
-	//	},
-	//}
-	//
-	//for i := 0; i < len(packets); i++ {
-	//	quickDecode(packets[i][5:])
-	//
-	//	//charInfo := &structures.CharacterInfo{}
-	//	//charInfo.Read(buffer)
-	//
-	//	//fmt.Printf("%#+v\n", charInfo)
-	//
-	//	//spew.Dump(charInfo)
-	//}
-
 	// List of game servers
 	// Includes the server name and ip address
 	ServerMap = []Server{
@@ -59,8 +22,14 @@ func main() {
 // It starts the three component servers--login network, game network, and game world--each in a new thread
 // It then waits indefinitely until it is cancelled by the console
 func start() {
+	//defer profile.Start(profile.MemProfile).Stop()
+
 	Log("Starting...")
 
+	if len(KeyTable) < 1 {
+		panic("Key table has not been initialized.")
+	}
+
 	Log("Initializing database.")
 	database.Open()
 	if err := database.CanConnect(); err != nil {