1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../string.h"

     8

#include "../openttd.h"

     9

#include "network_data.h"

    10

#include "core/tcp.h"

    11

#include "../date.h"

    12

#include "table/strings.h"

    13

#include "../functions.h"

    14

#include "network_client.h"

    15

#include "network_gamelist.h"

    16

#include "network_gui.h"

    17

#include "../saveload.h"

    19

#include "../console.h"

    20

#include "../variables.h"

    21

#include "../ai/ai.h"

    22

#include "../helpers.hpp"

    23

#include "../fileio.h"

    24

#include "../md5.h"

    25

#include "../strings_func.h"

    26

    27

// This file handles all the client-commands

    28

    29

    30

// So we don't make too much typos ;)

    31

#define MY_CLIENT DEREF_CLIENT(0)

    32

    33

static uint32 last_ack_frame;

    34

    35

/** One bit of 'entropy' used to generate a salt for the company passwords. */

    36

static uint32 _password_game_seed;

    37

/** The other bit of 'entropy' used to generate a salt for the company passwords. */

    38

static char _password_server_unique_id[NETWORK_UNIQUE_ID_LENGTH];

    39

    40

/** Make sure the unique ID length is the same as a md5 hash. */

    41

assert_compile(NETWORK_UNIQUE_ID_LENGTH == 16 * 2 + 1);

    42

    43

/**

    44

 * Generates a hashed password for the company name.

    45

 * @param password the password to 'encrypt'.

    46

 * @return the hashed password.

    47

 */

    48

static const char *GenerateCompanyPasswordHash(const char *password)

    49

{

    50

	if (StrEmpty(password)) return password;

    51

    52

	char salted_password[NETWORK_UNIQUE_ID_LENGTH];

    53

    54

	memset(salted_password, 0, sizeof(salted_password));

    55

	snprintf(salted_password, sizeof(salted_password), "%s", password);

    56

	/* Add the game seed and the server's unique ID as the salt. */

    57

	for (uint i = 0; i < NETWORK_UNIQUE_ID_LENGTH; i++) salted_password[i] ^= _password_server_unique_id[i] ^ (_password_game_seed >> i);

    58

    59

	md5_state_t state;

    60

	md5_byte_t digest[16];

    61

	static char hashed_password[NETWORK_UNIQUE_ID_LENGTH];

    62

    63

	/* Generate the MD5 hash */

    64

	md5_init(&state);

    65

	md5_append(&state, (const md5_byte_t*)salted_password, sizeof(salted_password));

    66

	md5_finish(&state, digest);

    67

    68

	for (int di = 0; di < 16; di++) sprintf(hashed_password + di * 2, "%02x", digest[di]);

    69

    70

	return hashed_password;

    71

}

    72

    73

/**

    74

 * Hash the current company password; used when the server 'player' sets his/her password.

    75

 */

    76

void HashCurrentCompanyPassword()

    77

{

    78

	if (StrEmpty(_network_player_info[_local_player].password)) return;

    79

    80

	_password_game_seed = _patches.generation_seed;

    81

	snprintf(_password_server_unique_id, sizeof(_password_server_unique_id), _network_unique_id);

    82

    83

	const char *new_pw = GenerateCompanyPasswordHash(_network_player_info[_local_player].password);

    84

	snprintf(_network_player_info[_local_player].password, sizeof(_network_player_info[_local_player].password), new_pw);

    85

}

    86

    87

    88

// **********

    89

// Sending functions

    90

//   DEF_CLIENT_SEND_COMMAND has no parameters

    91

// **********

    92

    93

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    94

{

    95

	//

    96

	// Packet: CLIENT_COMPANY_INFO

    97

	// Function: Request company-info (in detail)

    98

	// Data:

    99

	//    <none>

   100

	//

   101

	Packet *p;

   102

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

   103

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   104

   105

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

   106

	MY_CLIENT->Send_Packet(p);

   107

}

   108

   109

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

   110

{

   111

	//

   112

	// Packet: CLIENT_JOIN

   113

	// Function: Try to join the server

   114

	// Data:

   115

	//    String: OpenTTD Revision (norev000 if no revision)

   116

	//    String: Player Name (max NETWORK_NAME_LENGTH)

   117

	//    uint8:  Play as Player id (1..MAX_PLAYERS)

   118

	//    uint8:  Language ID

   119

	//    String: Unique id to find the player back in server-listing

   120

	//

   121

   122

	extern const char _openttd_revision[];

   123

	Packet *p;

   124

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

   125

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   126

   127

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

   128

	p->Send_string(_openttd_revision);

   129

	p->Send_string(_network_player_name); // Player name

   130

	p->Send_uint8 (_network_playas);      // PlayAs

   131

	p->Send_uint8 (NETLANG_ANY);          // Language

   132

	p->Send_string(_network_unique_id);

   133

	MY_CLIENT->Send_Packet(p);

   134

}

   135

   136

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

   137

{

   138

	//

   139

	// Packet: CLIENT_NEWGRFS_CHECKED

   140

	// Function: Tell the server that we have the required GRFs

   141

	// Data:

   142

	//

   143

   144

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

   145

	MY_CLIENT->Send_Packet(p);

   146

}

   147

   148

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_PASSWORD)(NetworkPasswordType type, const char *password)

   149

{

   150

	//

   151

	// Packet: CLIENT_PASSWORD

   152

	// Function: Send a password to the server to authorize

   153

	// Data:

   154

	//    uint8:  NetworkPasswordType

   155

	//    String: Password

   156

	//

   157

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   158

	p->Send_uint8 (type);

   159

	p->Send_string(type == NETWORK_GAME_PASSWORD ? password : GenerateCompanyPasswordHash(password));

   160

	MY_CLIENT->Send_Packet(p);

   161

}

   162

   163

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   164

{

   165

	//

   166

	// Packet: CLIENT_GETMAP

   167

	// Function: Request the map from the server

   168

	// Data:

   169

	//    <none>

   170

	//

   171

   172

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   173

	MY_CLIENT->Send_Packet(p);

   174

}

   175

   176

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   177

{

   178

	//

   179

	// Packet: CLIENT_MAP_OK

   180

	// Function: Tell the server that we are done receiving/loading the map

   181

	// Data:

   182

	//    <none>

   183

	//

   184

   185

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   186

	MY_CLIENT->Send_Packet(p);

   187

}

   188

   189

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   190

{

   191

	//

   192

	// Packet: CLIENT_ACK

   193

	// Function: Tell the server we are done with this frame

   194

	// Data:

   195

	//    uint32: current FrameCounter of the client

   196

	//

   197

   198

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   199

   200

	p->Send_uint32(_frame_counter);

   201

	MY_CLIENT->Send_Packet(p);

   202

}

   203

   204

// Send a command packet to the server

   205

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   206

{

   207

	//

   208

	// Packet: CLIENT_COMMAND

   209

	// Function: Send a DoCommand to the Server

   210

	// Data:

   211

	//    uint8:  PlayerID (0..MAX_PLAYERS-1)

   212

	//    uint32: CommandID (see command.h)

   213

	//    uint32: P1 (free variables used in DoCommand)

   214

	//    uint32: P2

   215

	//    uint32: Tile

   216

	//    string: text

   217

	//    uint8:  CallBackID (see callback_table.c)

   218

	//

   219

   220

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   221

   222

	p->Send_uint8 (cp->player);

   223

	p->Send_uint32(cp->cmd);

   224

	p->Send_uint32(cp->p1);

   225

	p->Send_uint32(cp->p2);

   226

	p->Send_uint32((uint32)cp->tile);

   227

	p->Send_string(cp->text);

   228

	p->Send_uint8 (cp->callback);

   229

   230

	MY_CLIENT->Send_Packet(p);

   231

}

   232

   233

// Send a chat-packet over the network

   234

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_CHAT)(NetworkAction action, DestType type, int dest, const char *msg)

   235

{

   236

	//

   237

	// Packet: CLIENT_CHAT

   238

	// Function: Send a chat-packet to the serve

   239

	// Data:

   240

	//    uint8:  ActionID (see network_data.h, NetworkAction)

   241

	//    uint8:  Destination Type (see network_data.h, DestType);

   242

	//    uint16: Destination Player

   243

	//    String: Message (max MAX_TEXT_MSG_LEN)

   244

	//

   245

   246

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   247

   248

	p->Send_uint8 (action);

   249

	p->Send_uint8 (type);

   250

	p->Send_uint16(dest);

   251

	p->Send_string(msg);

   252

	MY_CLIENT->Send_Packet(p);

   253

}

   254

   255

// Send an error-packet over the network

   256

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   257

{

   258

	//

   259

	// Packet: CLIENT_ERROR

   260

	// Function: The client made an error and is quiting the game

   261

	// Data:

   262

	//    uint8:  ErrorID (see network_data.h, NetworkErrorCode)

   263

	//

   264

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   265

   266

	p->Send_uint8(errorno);

   267

	MY_CLIENT->Send_Packet(p);

   268

}

   269

   270

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   271

{

   272

	//

   273

	// Packet: PACKET_CLIENT_SET_PASSWORD

   274

	// Function: Set the password for the clients current company

   275

	// Data:

   276

	//    String: Password

   277

	//

   278

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   279

   280

	p->Send_string(GenerateCompanyPasswordHash(password));

   281

	MY_CLIENT->Send_Packet(p);

   282

}

   283

   284

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   285

{

   286

	//

   287

	// Packet: PACKET_CLIENT_SET_NAME

   288

	// Function: Gives the player a new name

   289

	// Data:

   290

	//    String: Name

   291

	//

   292

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   293

   294

	p->Send_string(name);

   295

	MY_CLIENT->Send_Packet(p);

   296

}

   297

   298

// Send an quit-packet over the network

   299

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   300

{

   301

	//

   302

	// Packet: CLIENT_QUIT

   303

	// Function: The client is quiting the game

   304

	// Data:

   305

	//    String: leave-message

   306

	//

   307

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   308

   309

	p->Send_string(leavemsg);

   310

	MY_CLIENT->Send_Packet(p);

   311

}

   312

   313

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_RCON)(const char *pass, const char *command)

   314

{

   315

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   316

	p->Send_string(pass);

   317

	p->Send_string(command);

   318

	MY_CLIENT->Send_Packet(p);

   319

}

   320

   321

   322

// **********

   323

// Receiving functions

   324

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   325

// **********

   326

   327

extern bool SafeSaveOrLoad(const char *filename, int mode, int newgm, Subdirectory subdir);

   328

   329

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   330

{

   331

	// We try to join a server which is full

   332

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   333

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   334

   335

	return NETWORK_RECV_STATUS_SERVER_FULL;

   336

}

   337

   338

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   339

{

   340

	// We try to join a server where we are banned

   341

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   342

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   343

   344

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   345

}

   346

   347

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   348

{

   349

	byte company_info_version;

   350

	int i;

   351

   352

	company_info_version = p->Recv_uint8();

   353

   354

	if (!MY_CLIENT->has_quit && company_info_version == NETWORK_COMPANY_INFO_VERSION) {

   355

		byte total;

   356

		PlayerID current;

   357

   358

		total = p->Recv_uint8();

   359

   360

		// There is no data at all..

   361

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   362

   363

		current = (Owner)p->Recv_uint8();

   364

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   365

   366

		p->Recv_string(_network_player_info[current].company_name, sizeof(_network_player_info[current].company_name));

   367

		_network_player_info[current].inaugurated_year = p->Recv_uint32();

   368

		_network_player_info[current].company_value    = p->Recv_uint64();

   369

		_network_player_info[current].money            = p->Recv_uint64();

   370

		_network_player_info[current].income           = p->Recv_uint64();

   371

		_network_player_info[current].performance      = p->Recv_uint16();

   372

		_network_player_info[current].use_password     = p->Recv_bool();

   373

		for (i = 0; i < NETWORK_VEHICLE_TYPES; i++)

   374

			_network_player_info[current].num_vehicle[i] = p->Recv_uint16();

   375

		for (i = 0; i < NETWORK_STATION_TYPES; i++)

   376

			_network_player_info[current].num_station[i] = p->Recv_uint16();

   377

   378

		p->Recv_string(_network_player_info[current].players, sizeof(_network_player_info[current].players));

   379

   380

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   381

   382

		return NETWORK_RECV_STATUS_OKAY;

   383

	}

   384

   385

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   386

}

   387

   388

// This packet contains info about the client (playas and name)

   389

//  as client we save this in NetworkClientInfo, linked via 'index'

   390

//  which is always an unique number on a server.

   391

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   392

{

   393

	NetworkClientInfo *ci;

   394

	uint16 index = p->Recv_uint16();

   395

	PlayerID playas = (Owner)p->Recv_uint8();

   396

	char name[NETWORK_NAME_LENGTH];

   397

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];

   398

   399

	p->Recv_string(name, sizeof(name));

   400

	p->Recv_string(unique_id, sizeof(unique_id));

   401

   402

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   403

   404

	/* Do we receive a change of data? Most likely we changed playas */

   405

	if (index == _network_own_client_index) _network_playas = playas;

   406

   407

	ci = NetworkFindClientInfoFromIndex(index);

   408

	if (ci != NULL) {

   409

		if (playas == ci->client_playas && strcmp(name, ci->client_name) != 0) {

   410

			// Client name changed, display the change

   411

			NetworkTextMessage(NETWORK_ACTION_NAME_CHANGE, 1, false, ci->client_name, "%s", name);

   412

		} else if (playas != ci->client_playas) {

   413

			// The player changed from client-player..

   414

			// Do not display that for now

   415

		}

   416

   417

		ci->client_playas = playas;

   418

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   419

   420

		InvalidateWindow(WC_CLIENT_LIST, 0);

   421

   422

		return NETWORK_RECV_STATUS_OKAY;

   423

	}

   424

   425

	// We don't have this index yet, find an empty index, and put the data there

   426

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   427

	if (ci != NULL) {

   428

		ci->client_index = index;

   429

		ci->client_playas = playas;

   430

   431

		ttd_strlcpy(ci->client_name, name, sizeof(ci->client_name));

   432

		ttd_strlcpy(ci->unique_id, unique_id, sizeof(ci->unique_id));

   433

   434

		InvalidateWindow(WC_CLIENT_LIST, 0);

   435

   436

		return NETWORK_RECV_STATUS_OKAY;

   437

	}

   438

   439

	// Here the program should never ever come.....

   440

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   441

}

   442

   443

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   444

{

   445

	NetworkErrorCode error = (NetworkErrorCode)p->Recv_uint8();

   446

   447

	switch (error) {

   448

		/* We made an error in the protocol, and our connection is closed.... */

   449

		case NETWORK_ERROR_NOT_AUTHORIZED:

   450

		case NETWORK_ERROR_NOT_EXPECTED:

   451

		case NETWORK_ERROR_PLAYER_MISMATCH:

   452

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   453

			break;

   454

		case NETWORK_ERROR_FULL:

   455

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   456

			break;

   457

		case NETWORK_ERROR_WRONG_REVISION:

   458

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   459

			break;

   460

		case NETWORK_ERROR_WRONG_PASSWORD:

   461

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   462

			break;

   463

		case NETWORK_ERROR_KICKED:

   464

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   465

			break;

   466

		case NETWORK_ERROR_CHEATER:

   467

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   468

			break;

   469

		default:

   470

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   471

	}

   472

   473

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   474

   475

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   476

}

   477

   478

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   479

{

   480

	uint grf_count = p->Recv_uint8();

   481

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   482

   483

	/* Check all GRFs */

   484

	for (; grf_count > 0; grf_count--) {

   485

		GRFConfig c;

   486

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   487

   488

		/* Check whether we know this GRF */

   489

		const GRFConfig *f = FindGRFConfig(c.grfid, c.md5sum);

   490

		if (f == NULL) {

   491

			/* We do not know this GRF, bail out of initialization */

   492

			char buf[sizeof(c.md5sum) * 2 + 1];

   493

			md5sumToString(buf, lastof(buf), c.md5sum);

   494

			DEBUG(grf, 0, "NewGRF %08X not found; checksum %s", BSWAP32(c.grfid), buf);

   495

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   496

		}

   497

	}

   498

   499

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   500

		/* Start receiving the map */

   501

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();

   502

	} else {

   503

		/* NewGRF mismatch, bail out */

   504

		_switch_mode_errorstr = STR_NETWORK_ERR_NEWGRF_MISMATCH;

   505

	}