1

/* $Id$ */

     2

     3

#ifdef ENABLE_NETWORK

     4

     5

#include "../stdafx.h"

     6

#include "../debug.h"

     7

#include "../openttd.h"

     8

#include "network_data.h"

     9

#include "core/tcp.h"

    10

#include "network_client.h"

    11

#include "network_gamelist.h"

    12

#include "network_gui.h"

    13

#include "../saveload.h"

    14

#include "../command_func.h"

    15

#include "../console.h"

    16

#include "../variables.h"

    17

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

    18

#include "../core/alloc_func.hpp"

    19

#include "../fileio.h"

    20

#include "../md5.h"

    21

#include "../strings_func.h"

    22

#include "../window_func.h"

    23

#include "../string_func.h"

    24

#include "../player_func.h"

    25

#include "../player_base.h"

    26

#include "../player_gui.h"

    27

    28

#include "table/strings.h"

    29

    30

// This file handles all the client-commands

    31

    32

    33

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

    34

#define MY_CLIENT DEREF_CLIENT(0)

    35

    36

static uint32 last_ack_frame;

    37

    38

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

    39

static uint32 _password_game_seed;

    40

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

    41

static char _password_server_unique_id[NETWORK_UNIQUE_ID_LENGTH];

    42

    43

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

    44

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

    45

    46

/**

    47

 * Generates a hashed password for the company name.

    48

 * @param password the password to 'encrypt'.

    49

 * @return the hashed password.

    50

 */

    51

static const char *GenerateCompanyPasswordHash(const char *password)

    52

{

    53

	if (StrEmpty(password)) return password;

    54

    55

	char salted_password[NETWORK_UNIQUE_ID_LENGTH];

    56

    57

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

    58

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

    59

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

    60

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

    61

    62

	Md5 checksum;

    63

	uint8 digest[16];

    64

	static char hashed_password[NETWORK_UNIQUE_ID_LENGTH];

    65

    66

	/* Generate the MD5 hash */

    67

	checksum.Append((const uint8*)salted_password, sizeof(salted_password) - 1);

    68

	checksum.Finish(digest);

    69

    70

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

    71

	hashed_password[lengthof(hashed_password) - 1] = '\0';

    72

    73

	return hashed_password;

    74

}

    75

    76

/**

    77

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

    78

 */

    79

void HashCurrentCompanyPassword()

    80

{

    81

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

    82

    83

	_password_game_seed = _patches.generation_seed;

    84

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

    85

    86

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

    87

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

    88

}

    89

    90

    91

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

    92

// Sending functions

    93

//   DEF_CLIENT_SEND_COMMAND has no parameters

    94

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

    95

    96

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    97

{

    98

	//

    99

	// Packet: CLIENT_COMPANY_INFO

   100

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

   101

	// Data:

   102

	//    <none>

   103

	//

   104

	Packet *p;

   105

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

   106

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   107

   108

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

   109

	MY_CLIENT->Send_Packet(p);

   110

}

   111

   112

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

   113

{

   114

	//

   115

	// Packet: CLIENT_JOIN

   116

	// Function: Try to join the server

   117

	// Data:

   118

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

   119

	//    String: Player Name (max NETWORK_NAME_LENGTH)

   120

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

   121

	//    uint8:  Language ID

   122

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

   123

	//

   124

   125

	extern const char _openttd_revision[];

   126

	Packet *p;

   127

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

   128

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   129

   130

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

   131

	p->Send_string(_openttd_revision);

   132

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

   133

	p->Send_uint8 (_network_playas);      // PlayAs

   134

	p->Send_uint8 (NETLANG_ANY);          // Language

   135

	p->Send_string(_network_unique_id);

   136

	MY_CLIENT->Send_Packet(p);

   137

}

   138

   139

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

   140

{

   141

	//

   142

	// Packet: CLIENT_NEWGRFS_CHECKED

   143

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

   144

	// Data:

   145

	//

   146

   147

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

   148

	MY_CLIENT->Send_Packet(p);

   149

}

   150

   151

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

   152

{

   153

	//

   154

	// Packet: CLIENT_PASSWORD

   155

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

   156

	// Data:

   157

	//    uint8:  NetworkPasswordType

   158

	//    String: Password

   159

	//

   160

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   161

	p->Send_uint8 (type);

   162

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

   163

	MY_CLIENT->Send_Packet(p);

   164

}

   165

   166

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   167

{

   168

	//

   169

	// Packet: CLIENT_GETMAP

   170

	// Function: Request the map from the server

   171

	// Data:

   172

	//    <none>

   173

	//

   174

   175

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   176

	MY_CLIENT->Send_Packet(p);

   177

}

   178

   179

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   180

{

   181

	//

   182

	// Packet: CLIENT_MAP_OK

   183

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

   184

	// Data:

   185

	//    <none>

   186

	//

   187

   188

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   189

	MY_CLIENT->Send_Packet(p);

   190

}

   191

   192

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   193

{

   194

	//

   195

	// Packet: CLIENT_ACK

   196

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

   197

	// Data:

   198

	//    uint32: current FrameCounter of the client

   199

	//

   200

   201

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   202

   203

	p->Send_uint32(_frame_counter);

   204

	MY_CLIENT->Send_Packet(p);

   205

}

   206

   207

// Send a command packet to the server

   208

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   209

{

   210

	//

   211

	// Packet: CLIENT_COMMAND

   212

	// Function: Send a DoCommand to the Server

   213

	// Data:

   214

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

   215

	//    uint32: CommandID (see command.h)

   216

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

   217

	//    uint32: P2

   218

	//    uint32: Tile

   219

	//    string: text

   220

	//    uint8:  CallBackID (see callback_table.c)

   221

	//

   222

   223

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   224

   225

	p->Send_uint8 (cp->player);

   226

	p->Send_uint32(cp->cmd);

   227

	p->Send_uint32(cp->p1);

   228

	p->Send_uint32(cp->p2);

   229

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

   230

	p->Send_string(cp->text);

   231

	p->Send_uint8 (cp->callback);

   232

   233

	MY_CLIENT->Send_Packet(p);

   234

}

   235

   236

// Send a chat-packet over the network

   237

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

   238

{

   239

	//

   240

	// Packet: CLIENT_CHAT

   241

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

   242

	// Data:

   243

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

   244

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

   245

	//    uint16: Destination Player

   246

	//    String: Message (max MAX_TEXT_MSG_LEN)

   247

	//

   248

   249

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   250

   251

	p->Send_uint8 (action);

   252

	p->Send_uint8 (type);

   253

	p->Send_uint16(dest);

   254

	p->Send_string(msg);

   255

	MY_CLIENT->Send_Packet(p);

   256

}

   257

   258

// Send an error-packet over the network

   259

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   260

{

   261

	//

   262

	// Packet: CLIENT_ERROR

   263

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

   264

	// Data:

   265

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

   266

	//

   267

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   268

   269

	p->Send_uint8(errorno);

   270

	MY_CLIENT->Send_Packet(p);

   271

}

   272

   273

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   274

{

   275

	//

   276

	// Packet: PACKET_CLIENT_SET_PASSWORD

   277

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

   278

	// Data:

   279

	//    String: Password

   280

	//

   281

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   282

   283

	p->Send_string(GenerateCompanyPasswordHash(password));

   284

	MY_CLIENT->Send_Packet(p);

   285

}

   286

   287

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   288

{

   289

	//

   290

	// Packet: PACKET_CLIENT_SET_NAME

   291

	// Function: Gives the player a new name

   292

	// Data:

   293

	//    String: Name

   294

	//

   295

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   296

   297

	p->Send_string(name);

   298

	MY_CLIENT->Send_Packet(p);

   299

}

   300

   301

// Send an quit-packet over the network

   302

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   303

{

   304

	//

   305

	// Packet: CLIENT_QUIT

   306

	// Function: The client is quiting the game

   307

	// Data:

   308

	//    String: leave-message

   309

	//

   310

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   311

   312

	p->Send_string(leavemsg);

   313

	MY_CLIENT->Send_Packet(p);

   314

}

   315

   316

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

   317

{

   318

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   319

	p->Send_string(pass);

   320

	p->Send_string(command);

   321

	MY_CLIENT->Send_Packet(p);

   322

}

   323

   324

   325

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

   326

// Receiving functions

   327

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   328

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

   329

   330

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

   331

   332

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   333

{

   334

	// We try to join a server which is full

   335

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   336

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   337

   338

	return NETWORK_RECV_STATUS_SERVER_FULL;

   339

}

   340

   341

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   342

{

   343

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

   344

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   345

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   346

   347

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   348

}

   349

   350

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   351

{

   352

	byte company_info_version;

   353

	int i;

   354

   355

	company_info_version = p->Recv_uint8();

   356

   357

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

   358

		byte total;

   359

		PlayerID current;

   360

   361

		total = p->Recv_uint8();

   362

   363

		// There is no data at all..

   364

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   365

   366

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

   367

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   368

   369

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

   370

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

   371

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

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

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

   379

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

   380

   381

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

   382

   383

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   384

   385

		return NETWORK_RECV_STATUS_OKAY;

   386

	}

   387

   388

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   389

}

   390

   391

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

   392

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

   393

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

   394

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   395

{

   396

	NetworkClientInfo *ci;

   397

	uint16 index = p->Recv_uint16();

   398

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

   399

	char name[NETWORK_NAME_LENGTH];

   400

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];

   401

   402

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

   403

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

   404

   405

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   406

   407

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

   408

	if (index == _network_own_client_index) _network_playas = playas;

   409

   410

	ci = NetworkFindClientInfoFromIndex(index);

   411

	if (ci != NULL) {

   412

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

   413

			// Client name changed, display the change

   414

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

   415

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

   416

			// The player changed from client-player..

   417

			// Do not display that for now

   418

		}

   419

   420

		ci->client_playas = playas;

   421

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

   422

   423

		InvalidateWindow(WC_CLIENT_LIST, 0);

   424

   425

		return NETWORK_RECV_STATUS_OKAY;

   426

	}

   427

   428

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

   429

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   430

	if (ci != NULL) {

   431

		ci->client_index = index;

   432

		ci->client_playas = playas;

   433

   434

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

   435

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

   436

   437

		InvalidateWindow(WC_CLIENT_LIST, 0);

   438

   439

		return NETWORK_RECV_STATUS_OKAY;

   440

	}

   441

   442

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

   443

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   444

}

   445

   446

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   447

{

   448

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

   449

   450

	switch (error) {

   451

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

   452

		case NETWORK_ERROR_NOT_AUTHORIZED:

   453

		case NETWORK_ERROR_NOT_EXPECTED:

   454

		case NETWORK_ERROR_PLAYER_MISMATCH:

   455

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   456

			break;

   457

		case NETWORK_ERROR_FULL:

   458

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   459

			break;

   460

		case NETWORK_ERROR_WRONG_REVISION:

   461

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   462

			break;

   463

		case NETWORK_ERROR_WRONG_PASSWORD:

   464

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   465

			break;

   466

		case NETWORK_ERROR_KICKED:

   467

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   468

			break;

   469

		case NETWORK_ERROR_CHEATER:

   470

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   471

			break;

   472

		default:

   473

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   474

	}

   475

   476

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   477

   478

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   479

}

   480

   481

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   482

{

   483

	uint grf_count = p->Recv_uint8();

   484

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   485

   486

	/* Check all GRFs */

   487

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

   488

		GRFConfig c;

   489

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   490

   491

		/* Check whether we know this GRF */

   492

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

   493

		if (f == NULL) {

   494

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

   495

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

   496

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

   497

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

   498

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   499

		}

   500

	}

   501

   502

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   503

		/* Start receiving the map */

   504

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();