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 "table/strings.h"

    12

#include "network_client.h"

    13

#include "network_gamelist.h"

    14

#include "network_gui.h"

    15

#include "../saveload.h"

    16

#include "../command_func.h"

    17

#include "../console.h"

    18

#include "../variables.h"

    19

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

    20

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

    21

#include "../fileio.h"

    22

#include "../md5.h"

    23

#include "../strings_func.h"

    24

#include "../window_func.h"

    25

    26

// This file handles all the client-commands

    27

    28

    29

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

    30

#define MY_CLIENT DEREF_CLIENT(0)

    31

    32

static uint32 last_ack_frame;

    33

    34

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

    35

static uint32 _password_game_seed;

    36

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

    37

static char _password_server_unique_id[NETWORK_UNIQUE_ID_LENGTH];

    38

    39

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

    40

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

    41

    42

/**

    43

 * Generates a hashed password for the company name.

    44

 * @param password the password to 'encrypt'.

    45

 * @return the hashed password.

    46

 */

    47

static const char *GenerateCompanyPasswordHash(const char *password)

    48

{

    49

	if (StrEmpty(password)) return password;

    50

    51

	char salted_password[NETWORK_UNIQUE_ID_LENGTH];

    52

    53

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

    54

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

    55

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

    56

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

    57

    58

	Md5 checksum;

    59

	uint8 digest[16];

    60

	static char hashed_password[NETWORK_UNIQUE_ID_LENGTH];

    61

    62

	/* Generate the MD5 hash */

    63

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

    64

	checksum.Finish(digest);

    65

    66

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

    67

    68

	return hashed_password;

    69

}

    70

    71

/**

    72

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

    73

 */

    74

void HashCurrentCompanyPassword()

    75

{

    76

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

    77

    78

	_password_game_seed = _patches.generation_seed;

    79

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

    80

    81

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

    82

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

    83

}

    84

    85

    86

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

    87

// Sending functions

    88

//   DEF_CLIENT_SEND_COMMAND has no parameters

    89

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

    90

    91

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

    92

{

    93

	//

    94

	// Packet: CLIENT_COMPANY_INFO

    95

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

    96

	// Data:

    97

	//    <none>

    98

	//

    99

	Packet *p;

   100

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

   101

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   102

   103

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

   104

	MY_CLIENT->Send_Packet(p);

   105

}

   106

   107

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

   108

{

   109

	//

   110

	// Packet: CLIENT_JOIN

   111

	// Function: Try to join the server

   112

	// Data:

   113

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

   114

	//    String: Player Name (max NETWORK_NAME_LENGTH)

   115

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

   116

	//    uint8:  Language ID

   117

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

   118

	//

   119

   120

	extern const char _openttd_revision[];

   121

	Packet *p;

   122

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

   123

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   124

   125

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

   126

	p->Send_string(_openttd_revision);

   127

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

   128

	p->Send_uint8 (_network_playas);      // PlayAs

   129

	p->Send_uint8 (NETLANG_ANY);          // Language

   130

	p->Send_string(_network_unique_id);

   131

	MY_CLIENT->Send_Packet(p);

   132

}

   133

   134

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

   135

{

   136

	//

   137

	// Packet: CLIENT_NEWGRFS_CHECKED

   138

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

   139

	// Data:

   140

	//

   141

   142

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

   143

	MY_CLIENT->Send_Packet(p);

   144

}

   145

   146

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

   147

{

   148

	//

   149

	// Packet: CLIENT_PASSWORD

   150

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

   151

	// Data:

   152

	//    uint8:  NetworkPasswordType

   153

	//    String: Password

   154

	//

   155

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   156

	p->Send_uint8 (type);

   157

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

   158

	MY_CLIENT->Send_Packet(p);

   159

}

   160

   161

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   162

{

   163

	//

   164

	// Packet: CLIENT_GETMAP

   165

	// Function: Request the map from the server

   166

	// Data:

   167

	//    <none>

   168

	//

   169

   170

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   171

	MY_CLIENT->Send_Packet(p);

   172

}

   173

   174

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   175

{

   176

	//

   177

	// Packet: CLIENT_MAP_OK

   178

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

   179

	// Data:

   180

	//    <none>

   181

	//

   182

   183

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   184

	MY_CLIENT->Send_Packet(p);

   185

}

   186

   187

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   188

{

   189

	//

   190

	// Packet: CLIENT_ACK

   191

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

   192

	// Data:

   193

	//    uint32: current FrameCounter of the client

   194

	//

   195

   196

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   197

   198

	p->Send_uint32(_frame_counter);

   199

	MY_CLIENT->Send_Packet(p);

   200

}

   201

   202

// Send a command packet to the server

   203

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   204

{

   205

	//

   206

	// Packet: CLIENT_COMMAND

   207

	// Function: Send a DoCommand to the Server

   208

	// Data:

   209

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

   210

	//    uint32: CommandID (see command.h)

   211

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

   212

	//    uint32: P2

   213

	//    uint32: Tile

   214

	//    string: text

   215

	//    uint8:  CallBackID (see callback_table.c)

   216

	//

   217

   218

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   219

   220

	p->Send_uint8 (cp->player);

   221

	p->Send_uint32(cp->cmd);

   222

	p->Send_uint32(cp->p1);

   223

	p->Send_uint32(cp->p2);

   224

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

   225

	p->Send_string(cp->text);

   226

	p->Send_uint8 (cp->callback);

   227

   228

	MY_CLIENT->Send_Packet(p);

   229

}

   230

   231

// Send a chat-packet over the network

   232

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

   233

{

   234

	//

   235

	// Packet: CLIENT_CHAT

   236

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

   237

	// Data:

   238

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

   239

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

   240

	//    uint16: Destination Player

   241

	//    String: Message (max MAX_TEXT_MSG_LEN)

   242

	//

   243

   244

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   245

   246

	p->Send_uint8 (action);

   247

	p->Send_uint8 (type);

   248

	p->Send_uint16(dest);

   249

	p->Send_string(msg);

   250

	MY_CLIENT->Send_Packet(p);

   251

}

   252

   253

// Send an error-packet over the network

   254

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   255

{

   256

	//

   257

	// Packet: CLIENT_ERROR

   258

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

   259

	// Data:

   260

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

   261

	//

   262

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   263

   264

	p->Send_uint8(errorno);

   265

	MY_CLIENT->Send_Packet(p);

   266

}

   267

   268

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   269

{

   270

	//

   271

	// Packet: PACKET_CLIENT_SET_PASSWORD

   272

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

   273

	// Data:

   274

	//    String: Password

   275

	//

   276

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   277

   278

	p->Send_string(GenerateCompanyPasswordHash(password));

   279

	MY_CLIENT->Send_Packet(p);

   280

}

   281

   282

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   283

{

   284

	//

   285

	// Packet: PACKET_CLIENT_SET_NAME

   286

	// Function: Gives the player a new name

   287

	// Data:

   288

	//    String: Name

   289

	//

   290

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   291

   292

	p->Send_string(name);

   293

	MY_CLIENT->Send_Packet(p);

   294

}

   295

   296

// Send an quit-packet over the network

   297

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   298

{

   299

	//

   300

	// Packet: CLIENT_QUIT

   301

	// Function: The client is quiting the game

   302

	// Data:

   303

	//    String: leave-message

   304

	//

   305

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   306

   307

	p->Send_string(leavemsg);

   308

	MY_CLIENT->Send_Packet(p);

   309

}

   310

   311

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

   312

{

   313

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   314

	p->Send_string(pass);

   315

	p->Send_string(command);

   316

	MY_CLIENT->Send_Packet(p);

   317

}

   318

   319

   320

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

   321

// Receiving functions

   322

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   323

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

   324

   325

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

   326

   327

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   328

{

   329

	// We try to join a server which is full

   330

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   331

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   332

   333

	return NETWORK_RECV_STATUS_SERVER_FULL;

   334

}

   335

   336

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   337

{

   338

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

   339

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   340

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   341

   342

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   343

}

   344

   345

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   346

{

   347

	byte company_info_version;

   348

	int i;

   349

   350

	company_info_version = p->Recv_uint8();

   351

   352

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

   353

		byte total;

   354

		PlayerID current;

   355

   356

		total = p->Recv_uint8();

   357

   358

		// There is no data at all..

   359

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   360

   361

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

   362

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   363

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

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

   375

   376

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

   377

   378

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   379

   380

		return NETWORK_RECV_STATUS_OKAY;

   381

	}

   382

   383

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   384

}

   385

   386

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

   387

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

   388

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

   389

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   390

{

   391

	NetworkClientInfo *ci;

   392

	uint16 index = p->Recv_uint16();

   393

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

   394

	char name[NETWORK_NAME_LENGTH];

   395

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];

   396

   397

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

   398

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

   399

   400

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   401

   402

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

   403

	if (index == _network_own_client_index) _network_playas = playas;

   404

   405

	ci = NetworkFindClientInfoFromIndex(index);

   406

	if (ci != NULL) {

   407

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

   408

			// Client name changed, display the change

   409

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

   410

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

   411

			// The player changed from client-player..

   412

			// Do not display that for now

   413

		}

   414

   415

		ci->client_playas = playas;

   416

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

   417

   418

		InvalidateWindow(WC_CLIENT_LIST, 0);

   419

   420

		return NETWORK_RECV_STATUS_OKAY;

   421

	}

   422

   423

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

   424

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   425

	if (ci != NULL) {

   426

		ci->client_index = index;

   427

		ci->client_playas = playas;

   428

   429

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

   430

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

   431

   432

		InvalidateWindow(WC_CLIENT_LIST, 0);

   433

   434

		return NETWORK_RECV_STATUS_OKAY;

   435

	}

   436

   437

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

   438

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   439

}

   440

   441

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   442

{

   443

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

   444

   445

	switch (error) {

   446

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

   447

		case NETWORK_ERROR_NOT_AUTHORIZED:

   448

		case NETWORK_ERROR_NOT_EXPECTED:

   449

		case NETWORK_ERROR_PLAYER_MISMATCH:

   450

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   451

			break;

   452

		case NETWORK_ERROR_FULL:

   453

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   454

			break;

   455

		case NETWORK_ERROR_WRONG_REVISION:

   456

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   457

			break;

   458

		case NETWORK_ERROR_WRONG_PASSWORD:

   459

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   460

			break;

   461

		case NETWORK_ERROR_KICKED:

   462

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   463

			break;

   464

		case NETWORK_ERROR_CHEATER:

   465

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   466

			break;

   467

		default:

   468

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   469

	}

   470

   471

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   472

   473

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   474

}

   475

   476

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   477

{

   478

	uint grf_count = p->Recv_uint8();

   479

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   480

   481

	/* Check all GRFs */

   482

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

   483

		GRFConfig c;

   484

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   485

   486

		/* Check whether we know this GRF */

   487

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

   488

		if (f == NULL) {

   489

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

   490

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

   491

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

   492

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

   493

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   494

		}

   495

	}

   496

   497

	if (ret == NETWORK_RECV_STATUS_OKAY) {

   498

		/* Start receiving the map */

   499

		SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)();

   500

	} else {

   501

		/* NewGRF mismatch, bail out */

   502

		_switch_mode_errorstr = STR_NETWORK_ERR_NEWGRF_MISMATCH;

   503

	}

   504

	return ret;

   505