Rewrite and TypeScript migration

.gitignore

@@ -58,7 +58,6 @@ typings/
 .env
 
 # custom
-nex-keys.txt
-*.pcapng
-t.js
-builds
+dist
+*.pcap
+*.pcapng

README.md

@@ -1,55 +1,30 @@
 # NEX Viewer
-### Utility for parsing and (eventually) viewing NEX connections from PCAP(NG) network dumps
+### Utility for viewing PRUDP connections and NEX/Rendez-Vous sessions.
 
-## TODO:
-### This tool is still VERY early in development, so nearly nothing is finished
-- [x] PRUDP v0 packet parsing
-- [x] PRUDP v1 packet parsing
-- [ ] Fragmented payloads
-- [ ] SMM DataStore method 50 (0x32) (`DataStoreSMM::GetCustomRankingByDataId`) is completely busted
-- [ ] NEX Protocols (there is mixed support, some protocols are partially implemented)
-- [ ] CLI Display
+## Settings / Accounts
+> [!WARNING]
+> Older versions of NEX Viewer precomputed the Kerberos keys for each password. These precomputed keys are NOT usable in newer versions of NEX Viewer. Password files must now always contain the raw game server password for each PID
 
+In order to decrypt PRUDP packet payloads for the games secure server(s) your game server account credentials must be known by NEX Viewer. To add an account to the settings open one of the following JSON files:
 
-## Installation
-```
-npm i https://github.com/PretendoNetwork/nex-viewer
-```
-
-## Example usage
-```js
-const NEXParser = require('../..');
-const parser = new NEXParser();
-
-parser.on('packet', packet => {
-	// DO SOMETHING
-	console.log(packet);
-});
-
-parser.parse(__dirname + '/smm.pcapng');
-```
-
-## NEX keys
-PRUDP packet payloads get encrypted using a key which is encrypted using a key which is derived from your NEX account PID and password. In order to read packets, `nex-viewer` requires a `nex-keys.txt` file to be placed in any of these locations:
-
-- `src` folder of this repo
-- Root folder of this repo
-- `%AppData%/Wireshark/nex-keys.txt` (Windows)
-- `~/.config/wireshark/nex-keys.txt` (Linux/MacOS)
+- `%AppData%/NEXViewer/settings.json` (Windows)
+- `~/.config/nex-viewer/settings.json` (Linux/MacOS)
 
-`nex-viewer` will check the local repo first then look elsewhere for the file depending on your operating system. `nex-keys.txt` must be in the following format:
+From here add an account entry to the `accounts` array. An account entry takes the following form:
 
+```ts
+{
+	platform: string; // The platform the account is for (W ii U, 3DS, PC, etc.). Unused currently
+	username: string; // Account username. For NEX accounts this is your account PID as a string
+	pid: number; // Account unique PID
+	password: string; // Account password. Must not be hashed. Used to generate the below hashes, and those for non-NEX game servers
+	password_hash_old: string; // Pre-computed Kerberos key using the old key derivation method
+	password_hash_new: string; // Pre-computed Kerberos key using the new key derivation method
+}
 ```
-NEX_PID:NEX_PASSWORD
-NEX_PID:NEX_PASSWORD
-NEX_PID:NEX_PASSWORD
-NEX_PID:NEX_PASSWORD
-```
-
-With each NEX account details on a new line. Each time `nex-viewer` runs it will derive the correct crypto key from each PID:PASSWORD and write it back to `nex-keys.txt`. This way your NEX password does not stay in plain-text on disk
 
-## WARNING!
-DO NOT SHARE YOUR NEX PID AND PASSWORD WITH ANYBODY UNLESS YOU ABSOLUTELY KNOW WHAT YOU ARE DOING OR YOU DO NOT CARE ABOUT THE ACCOUNT. THIS PID/PASSWORD COMBINATION IS WHAT THE CONSOLE USES TO VERIFY YOU WHEN PLAYING ONLINE, NOT YOUR NNID USERNAME/PASSWORD. SHARING THESE DETAILS CAN ALLOW ANYONE TO LOGIN TO ANY GAME UNDER YOUR ACCOUNT
+> [!CAUTION]
+DO NOT SHARE YOUR NEX PID AND PASSWORD WITH ANYBODY UNLESS YOU ABSOLUTELY KNOW WHAT YOU ARE DOING OR YOU DO NOT CARE ABOUT THE ACCOUNT. THIS PID/PASSWORD COMBINATION IS WHAT THE CONSOLE USES TO AUTHENTICATE YOU WHEN PLAYING ONLINE, NOT YOUR NNID USERNAME/PASSWORD. SHARING THESE DETAILS CAN ALLOW ANYONE TO LOGIN TO ANY GAME UNDER YOUR ACCOUNT.
 
 ## Obtaining NEX account details
 NEX accounts are _**not**_ the same thing as NNIDs. How you obtain your NEX account details depends on your system. See below for details