From 76bc2385ca6125ce9173905b1dc3e24a0ce4f958 Mon Sep 17 00:00:00 2001 From: Martin Michelsen Date: Fri, 22 Mar 2024 22:23:41 -0700 Subject: [PATCH] add PSOBB Hangame functions --- src/Client.cc | 2 +- src/Main.cc | 9 ++++ src/SaveFileFormats.cc | 107 +++++++++++++++++++++++++++++++++++++ src/SaveFileFormats.hh | 2 + system/config.example.json | 1 + tests/config.json | 1 + 6 files changed, 121 insertions(+), 1 deletion(-) diff --git a/src/Client.cc b/src/Client.cc index 34554f0e..bb57534f 100644 --- a/src/Client.cc +++ b/src/Client.cc @@ -266,7 +266,7 @@ void Client::set_license(shared_ptr l) { if (this->version() == Version::BB_V4) { // Make sure bb_username is filename-safe for (char ch : l->bb_username) { - if (!isalnum(ch) && (ch != '-') && (ch != '_')) { + if (!isalnum(ch) && (ch != '-') && (ch != '_') && (ch != '@')) { throw runtime_error("invalid characters in username"); } } diff --git a/src/Main.cc b/src/Main.cc index da5b48eb..0ff3803d 100644 --- a/src/Main.cc +++ b/src/Main.cc @@ -2285,6 +2285,15 @@ Action a_diff_dol_files( } }); +Action a_generate_hangame_creds( + "generate-hangame-creds", nullptr, +[](Arguments& args) { + const string& user_id = args.get(1); + const string& token = args.get(2); + const string& unused = args.get(3, false); + string hex = format_data_string(encode_psobb_hangame_credentials(user_id, token, unused)); + fprintf(stdout, "psobb.exe 1196310600 %s\n", hex.c_str()); + }); + Action a_format_ep3_battle_record( "format-ep3-battle-record", nullptr, +[](Arguments& args) { string data = read_input_data(args); diff --git a/src/SaveFileFormats.cc b/src/SaveFileFormats.cc index fab3398d..18d5ba38 100644 --- a/src/SaveFileFormats.cc +++ b/src/SaveFileFormats.cc @@ -1,5 +1,6 @@ #include "SaveFileFormats.hh" +#include #include #include @@ -633,3 +634,109 @@ const array PSOBBBaseSystemFile::DEFAULT_JOYSTICK_CONFIG = { 0x00, 0x00, 0x08, 0x00, 0x01, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00}; + +static uint16_t crc16(const void* data, size_t size) { + static const uint16_t table[0x100] = { + // clang-format off + /* 00 */ 0x0000, 0x1189, 0x2312, 0x329B, 0x4624, 0x57AD, 0x6536, 0x74BF, + /* 08 */ 0x8C48, 0x9DC1, 0xAF5A, 0xBED3, 0xCA6C, 0xDBE5, 0xE97E, 0xF8F7, + /* 10 */ 0x1081, 0x0108, 0x3393, 0x221A, 0x56A5, 0x472C, 0x75B7, 0x643E, + /* 18 */ 0x9CC9, 0x8D40, 0xBFDB, 0xAE52, 0xDAED, 0xCB64, 0xF9FF, 0xE876, + /* 20 */ 0x2102, 0x308B, 0x0210, 0x1399, 0x6726, 0x76AF, 0x4434, 0x55BD, + /* 28 */ 0xAD4A, 0xBCC3, 0x8E58, 0x9FD1, 0xEB6E, 0xFAE7, 0xC87C, 0xD9F5, + /* 30 */ 0x3183, 0x200A, 0x1291, 0x0318, 0x77A7, 0x662E, 0x54B5, 0x453C, + /* 38 */ 0xBDCB, 0xAC42, 0x9ED9, 0x8F50, 0xFBEF, 0xEA66, 0xD8FD, 0xC974, + /* 40 */ 0x4204, 0x538D, 0x6116, 0x709F, 0x0420, 0x15A9, 0x2732, 0x36BB, + /* 48 */ 0xCE4C, 0xDFC5, 0xED5E, 0xFCD7, 0x8868, 0x99E1, 0xAB7A, 0xBAF3, + /* 50 */ 0x5285, 0x430C, 0x7197, 0x601E, 0x14A1, 0x0528, 0x37B3, 0x263A, + /* 58 */ 0xDECD, 0xCF44, 0xFDDF, 0xEC56, 0x98E9, 0x8960, 0xBBFB, 0xAA72, + /* 60 */ 0x6306, 0x728F, 0x4014, 0x519D, 0x2522, 0x34AB, 0x0630, 0x17B9, + /* 68 */ 0xEF4E, 0xFEC7, 0xCC5C, 0xDDD5, 0xA96A, 0xB8E3, 0x8A78, 0x9BF1, + /* 70 */ 0x7387, 0x620E, 0x5095, 0x411C, 0x35A3, 0x242A, 0x16B1, 0x0738, + /* 78 */ 0xFFCF, 0xEE46, 0xDCDD, 0xCD54, 0xB9EB, 0xA862, 0x9AF9, 0x8B70, + /* 80 */ 0x8408, 0x9581, 0xA71A, 0xB693, 0xC22C, 0xD3A5, 0xE13E, 0xF0B7, + /* 88 */ 0x0840, 0x19C9, 0x2B52, 0x3ADB, 0x4E64, 0x5FED, 0x6D76, 0x7CFF, + /* 90 */ 0x9489, 0x8500, 0xB79B, 0xA612, 0xD2AD, 0xC324, 0xF1BF, 0xE036, + /* 98 */ 0x18C1, 0x0948, 0x3BD3, 0x2A5A, 0x5EE5, 0x4F6C, 0x7DF7, 0x6C7E, + /* A0 */ 0xA50A, 0xB483, 0x8618, 0x9791, 0xE32E, 0xF2A7, 0xC03C, 0xD1B5, + /* A8 */ 0x2942, 0x38CB, 0x0A50, 0x1BD9, 0x6F66, 0x7EEF, 0x4C74, 0x5DFD, + /* B0 */ 0xB58B, 0xA402, 0x9699, 0x8710, 0xF3AF, 0xE226, 0xD0BD, 0xC134, + /* B8 */ 0x39C3, 0x284A, 0x1AD1, 0x0B58, 0x7FE7, 0x6E6E, 0x5CF5, 0x4D7C, + /* C0 */ 0xC60C, 0xD785, 0xE51E, 0xF497, 0x8028, 0x91A1, 0xA33A, 0xB2B3, + /* C8 */ 0x4A44, 0x5BCD, 0x6956, 0x78DF, 0x0C60, 0x1DE9, 0x2F72, 0x3EFB, + /* D0 */ 0xD68D, 0xC704, 0xF59F, 0xE416, 0x90A9, 0x8120, 0xB3BB, 0xA232, + /* D8 */ 0x5AC5, 0x4B4C, 0x79D7, 0x685E, 0x1CE1, 0x0D68, 0x3FF3, 0x2E7A, + /* E0 */ 0xE70E, 0xF687, 0xC41C, 0xD595, 0xA12A, 0xB0A3, 0x8238, 0x93B1, + /* E8 */ 0x6B46, 0x7ACF, 0x4854, 0x59DD, 0x2D62, 0x3CEB, 0x0E70, 0x1FF9, + /* F0 */ 0xF78F, 0xE606, 0xD49D, 0xC514, 0xB1AB, 0xA022, 0x92B9, 0x8330, + /* F8 */ 0x7BC7, 0x6A4E, 0x58D5, 0x495C, 0x3DE3, 0x2C6A, 0x1EF1, 0x0F78, + // clang-format on + }; + + uint16_t ret = 0xFFFF; + StringReader r(data, size); + while (!r.eof()) { + ret = (ret >> 8) ^ table[r.get_u8() ^ (ret & 0xFF)]; + } + return ret ^ 0xFFFF; +} + +string encode_psobb_hangame_credentials(const string& user_id, const string& token, const string& unused) { + if (user_id.size() < 4) { + throw runtime_error("user_id must be at least 4 characters"); + } + if (user_id.size() > 12) { + throw runtime_error("user_id must be at most 12 characters"); + } + if (!ends_with(user_id, "@HG")) { + throw runtime_error("user_id must end with \"@HG\""); + } + if (token.empty()) { + throw runtime_error("token must not be empty"); + } + if (token.size() > 8) { + throw runtime_error("token must be at most 8 characters"); + } + for (char ch : token) { + if (!isdigit(ch)) { + throw runtime_error("token must contain only decimal digits"); + } + } + if (unused.size() > 0xFF) { + throw runtime_error("unused must be at most 255 characters"); + } + + // The encoded format is: + // parray mask_key; // xor this with all bytes starting with checksum + // le_uint16_t checksum; // crc16(&unused, EOF - &unused) + // uint8_t unused; + // uint8_t user_id_size; + // char user_id[user_id_size]; // Length must be in [4, 12] and must end with "@HG" + // uint8_t token_size; + // char token[token_size]; // Length must be in [1, 8] and must be all decimal digits + // uint8_t unused_size; + // char unused[unused_size]; // Ignored (possibly email address?) + // We'll fill in mask_key and checksum after all the other fields. + string data(7, '\0'); // mask_key, checksum, unused + data.push_back(user_id.size()); + data += user_id; + data.push_back(token.size()); + data += token; + data.push_back(unused.size()); + data += unused; + + uint16_t checksum = crc16(data.data() + 6, data.size() - 6); + uint32_t timestamp = time(nullptr); + data[0] = (timestamp & 0xFF); + data[1] = ((timestamp >> 8) & 0xFF); + data[2] = ((timestamp >> 16) & 0xFF); + data[3] = ((timestamp >> 24) & 0xFF); + data[4] = checksum & 0xFF; + data[5] = (checksum >> 8) & 0xFF; + + for (size_t z = 0; z < data.size() - 4; z++) { + data[z + 4] ^= data[z % 3]; + } + + return data; +} diff --git a/src/SaveFileFormats.hh b/src/SaveFileFormats.hh index 993a1464..6e9fcf8f 100644 --- a/src/SaveFileFormats.hh +++ b/src/SaveFileFormats.hh @@ -788,3 +788,5 @@ struct LegacySavedAccountDataBB { // .nsa file format /* F060 */ pstring team_name; /* F080 */ } __attribute__((packed)); + +std::string encode_psobb_hangame_credentials(const std::string& user_id, const std::string& token, const std::string& unused = ""); diff --git a/system/config.example.json b/system/config.example.json index 83f49d46..c02c945e 100644 --- a/system/config.example.json +++ b/system/config.example.json @@ -87,6 +87,7 @@ "pc": [9300, "pc", "login_server"], "pc-patch": [10000, "patch", "patch_server_pc"], "bb-patch": [11000, "patch", "patch_server_bb"], + "bb-patch-hg": [11200, "patch", "patch_server_bb"], "bb-init": [12000, "bb", "login_server"], // PSO Xbox tunnels its connections through the Xbox Live service (or, in diff --git a/tests/config.json b/tests/config.json index b1755710..39f40c4a 100644 --- a/tests/config.json +++ b/tests/config.json @@ -66,6 +66,7 @@ "xb": [9500, "xb", "login_server"], "pc-patch": [10000, "patch", "patch_server_pc"], "bb-patch": [11000, "patch", "patch_server_bb"], + "bb-patch-hg": [11200, "patch", "patch_server_bb"], "bb-patch2": [11100, "patch", "patch_server_bb"], "bb-patch3": [10500, "patch", "patch_server_bb"], "bb-init": [12000, "bb", "login_server"],