1

/* $Id$ */

     2

     3

/** @file network_client.cpp Client part of the network protocol. */

     4

     5

#ifdef ENABLE_NETWORK

     6

     7

#include "../stdafx.h"

     8

#include "../debug.h"

     9

#include "../openttd.h"

    10

#include "network_data.h"

    11

#include "core/tcp.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_func.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

#include "../string_func.h"

    26

#include "../player_func.h"

    27

#include "../player_base.h"

    28

#include "../player_gui.h"

    29

#include "../rev.h"

    30

    31

#include "table/strings.h"

    32

    33

// This file handles all the client-commands

    34

    35

    36

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

    37

#define MY_CLIENT DEREF_CLIENT(0)

    38

    39

static uint32 last_ack_frame;

    40

    41

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

    42

static uint32 _password_game_seed;

    43

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

    44

static char _password_server_unique_id[NETWORK_UNIQUE_ID_LENGTH];

    45

    46

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

    47

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

    48

    49

/**

    50

 * Generates a hashed password for the company name.

    51

 * @param password the password to 'encrypt'.

    52

 * @return the hashed password.

    53

 */

    54

static const char *GenerateCompanyPasswordHash(const char *password)

    55

{

    56

	if (StrEmpty(password)) return password;

    57

    58

	char salted_password[NETWORK_UNIQUE_ID_LENGTH];

    59

    60

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

    61

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

    62

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

    63

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

    64

    65

	Md5 checksum;

    66

	uint8 digest[16];

    67

	static char hashed_password[NETWORK_UNIQUE_ID_LENGTH];

    68

    69

	/* Generate the MD5 hash */

    70

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

    71

	checksum.Finish(digest);

    72

    73

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

    74

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

    75

    76

	return hashed_password;

    77

}

    78

    79

/**

    80

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

    81

 */

    82

void HashCurrentCompanyPassword()

    83

{

    84

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

    85

    87

	ttd_strlcpy(_password_server_unique_id, _network_unique_id, sizeof(_password_server_unique_id));

    88

    89

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

    90

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

    91

}

    92

    93

    94

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

    95

// Sending functions

    96

//   DEF_CLIENT_SEND_COMMAND has no parameters

    97

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

    98

    99

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_COMPANY_INFO)

   100

{

   101

	//

   102

	// Packet: CLIENT_COMPANY_INFO

   103

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

   104

	// Data:

   105

	//    <none>

   106

	//

   107

	Packet *p;

   108

	_network_join_status = NETWORK_JOIN_STATUS_GETTING_COMPANY_INFO;

   109

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   110

   111

	p = NetworkSend_Init(PACKET_CLIENT_COMPANY_INFO);

   112

	MY_CLIENT->Send_Packet(p);

   113

}

   114

   115

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_JOIN)

   116

{

   117

	//

   118

	// Packet: CLIENT_JOIN

   119

	// Function: Try to join the server

   120

	// Data:

   121

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

   122

	//    String: Player Name (max NETWORK_NAME_LENGTH)

   123

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

   124

	//    uint8:  Language ID

   125

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

   126

	//

   127

   128

	Packet *p;

   129

	_network_join_status = NETWORK_JOIN_STATUS_AUTHORIZING;

   130

	InvalidateWindow(WC_NETWORK_STATUS_WINDOW, 0);

   131

   132

	p = NetworkSend_Init(PACKET_CLIENT_JOIN);

   133

	p->Send_string(_openttd_revision);

   134

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

   135

	p->Send_uint8 (_network_playas);      // PlayAs

   136

	p->Send_uint8 (NETLANG_ANY);          // Language

   137

	p->Send_string(_network_unique_id);

   138

	MY_CLIENT->Send_Packet(p);

   139

}

   140

   141

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_NEWGRFS_CHECKED)

   142

{

   143

	//

   144

	// Packet: CLIENT_NEWGRFS_CHECKED

   145

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

   146

	// Data:

   147

	//

   148

   149

	Packet *p = NetworkSend_Init(PACKET_CLIENT_NEWGRFS_CHECKED);

   150

	MY_CLIENT->Send_Packet(p);

   151

}

   152

   153

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

   154

{

   155

	//

   156

	// Packet: CLIENT_PASSWORD

   157

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

   158

	// Data:

   159

	//    uint8:  NetworkPasswordType

   160

	//    String: Password

   161

	//

   162

	Packet *p = NetworkSend_Init(PACKET_CLIENT_PASSWORD);

   163

	p->Send_uint8 (type);

   164

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

   165

	MY_CLIENT->Send_Packet(p);

   166

}

   167

   168

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_GETMAP)

   169

{

   170

	//

   171

	// Packet: CLIENT_GETMAP

   172

	// Function: Request the map from the server

   173

	// Data:

   174

	//    <none>

   175

	//

   176

   177

	Packet *p = NetworkSend_Init(PACKET_CLIENT_GETMAP);

   178

	MY_CLIENT->Send_Packet(p);

   179

}

   180

   181

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_MAP_OK)

   182

{

   183

	//

   184

	// Packet: CLIENT_MAP_OK

   185

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

   186

	// Data:

   187

	//    <none>

   188

	//

   189

   190

	Packet *p = NetworkSend_Init(PACKET_CLIENT_MAP_OK);

   191

	MY_CLIENT->Send_Packet(p);

   192

}

   193

   194

DEF_CLIENT_SEND_COMMAND(PACKET_CLIENT_ACK)

   195

{

   196

	//

   197

	// Packet: CLIENT_ACK

   198

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

   199

	// Data:

   200

	//    uint32: current FrameCounter of the client

   201

	//

   202

   203

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ACK);

   204

   205

	p->Send_uint32(_frame_counter);

   206

	MY_CLIENT->Send_Packet(p);

   207

}

   208

   209

// Send a command packet to the server

   210

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_COMMAND)(CommandPacket *cp)

   211

{

   212

	//

   213

	// Packet: CLIENT_COMMAND

   214

	// Function: Send a DoCommand to the Server

   215

	// Data:

   216

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

   217

	//    uint32: CommandID (see command.h)

   218

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

   219

	//    uint32: P2

   220

	//    uint32: Tile

   221

	//    string: text

   222

	//    uint8:  CallBackID (see callback_table.c)

   223

	//

   224

   225

	Packet *p = NetworkSend_Init(PACKET_CLIENT_COMMAND);

   226

   227

	p->Send_uint8 (cp->player);

   228

	p->Send_uint32(cp->cmd);

   229

	p->Send_uint32(cp->p1);

   230

	p->Send_uint32(cp->p2);

   231

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

   232

	p->Send_string(cp->text);

   233

	p->Send_uint8 (cp->callback);

   234

   235

	MY_CLIENT->Send_Packet(p);

   236

}

   237

   238

// Send a chat-packet over the network

   239

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

   240

{

   241

	//

   242

	// Packet: CLIENT_CHAT

   243

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

   244

	// Data:

   245

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

   246

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

   247

	//    uint16: Destination Player

   248

	//    String: Message (max MAX_TEXT_MSG_LEN)

   249

	//

   250

   251

	Packet *p = NetworkSend_Init(PACKET_CLIENT_CHAT);

   252

   253

	p->Send_uint8 (action);

   254

	p->Send_uint8 (type);

   255

	p->Send_uint16(dest);

   256

	p->Send_string(msg);

   257

	MY_CLIENT->Send_Packet(p);

   258

}

   259

   260

// Send an error-packet over the network

   261

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_ERROR)(NetworkErrorCode errorno)

   262

{

   263

	//

   264

	// Packet: CLIENT_ERROR

   265

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

   266

	// Data:

   267

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

   268

	//

   269

	Packet *p = NetworkSend_Init(PACKET_CLIENT_ERROR);

   270

   271

	p->Send_uint8(errorno);

   272

	MY_CLIENT->Send_Packet(p);

   273

}

   274

   275

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_PASSWORD)(const char *password)

   276

{

   277

	//

   278

	// Packet: PACKET_CLIENT_SET_PASSWORD

   279

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

   280

	// Data:

   281

	//    String: Password

   282

	//

   283

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_PASSWORD);

   284

   285

	p->Send_string(GenerateCompanyPasswordHash(password));

   286

	MY_CLIENT->Send_Packet(p);

   287

}

   288

   289

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_SET_NAME)(const char *name)

   290

{

   291

	//

   292

	// Packet: PACKET_CLIENT_SET_NAME

   293

	// Function: Gives the player a new name

   294

	// Data:

   295

	//    String: Name

   296

	//

   297

	Packet *p = NetworkSend_Init(PACKET_CLIENT_SET_NAME);

   298

   299

	p->Send_string(name);

   300

	MY_CLIENT->Send_Packet(p);

   301

}

   302

   303

// Send an quit-packet over the network

   304

DEF_CLIENT_SEND_COMMAND_PARAM(PACKET_CLIENT_QUIT)(const char *leavemsg)

   305

{

   306

	//

   307

	// Packet: CLIENT_QUIT

   308

	// Function: The client is quiting the game

   309

	// Data:

   310

	//    String: leave-message

   311

	//

   312

	Packet *p = NetworkSend_Init(PACKET_CLIENT_QUIT);

   313

   314

	p->Send_string(leavemsg);

   315

	MY_CLIENT->Send_Packet(p);

   316

}

   317

   318

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

   319

{

   320

	Packet *p = NetworkSend_Init(PACKET_CLIENT_RCON);

   321

	p->Send_string(pass);

   322

	p->Send_string(command);

   323

	MY_CLIENT->Send_Packet(p);

   324

}

   325

   326

   327

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

   328

// Receiving functions

   329

//   DEF_CLIENT_RECEIVE_COMMAND has parameter: Packet *p

   330

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

   331

   332

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

   333

extern StringID _switch_mode_errorstr;

   334

   335

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_FULL)

   336

{

   337

	// We try to join a server which is full

   338

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   339

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   340

   341

	return NETWORK_RECV_STATUS_SERVER_FULL;

   342

}

   343

   344

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_BANNED)

   345

{

   346

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

   347

	_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_BANNED;

   348

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   349

   350

	return NETWORK_RECV_STATUS_SERVER_BANNED;

   351

}

   352

   353

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_COMPANY_INFO)

   354

{

   355

	byte company_info_version;

   356

	int i;

   357

   358

	company_info_version = p->Recv_uint8();

   359

   360

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

   361

		byte total;

   362

		PlayerID current;

   363

   364

		total = p->Recv_uint8();

   365

   366

		// There is no data at all..

   367

		if (total == 0) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   368

   369

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

   370

		if (!IsValidPlayer(current)) return NETWORK_RECV_STATUS_CLOSE_QUERY;

   371

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

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

   379

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

   380

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

   381

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

   382

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

   383

   384

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

   385

   386

		InvalidateWindow(WC_NETWORK_WINDOW, 0);

   387

   388

		return NETWORK_RECV_STATUS_OKAY;

   389

	}

   390

   391

	return NETWORK_RECV_STATUS_CLOSE_QUERY;

   392

}

   393

   394

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

   395

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

   396

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

   397

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CLIENT_INFO)

   398

{

   399

	NetworkClientInfo *ci;

   400

	uint16 index = p->Recv_uint16();

   401

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

   402

	char name[NETWORK_NAME_LENGTH];

   403

	char unique_id[NETWORK_UNIQUE_ID_LENGTH];

   404

   405

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

   406

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

   407

   408

	if (MY_CLIENT->has_quit) return NETWORK_RECV_STATUS_CONN_LOST;

   409

   410

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

   411

	if (index == _network_own_client_index) _network_playas = playas;

   412

   413

	ci = NetworkFindClientInfoFromIndex(index);

   414

	if (ci != NULL) {

   415

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

   416

			// Client name changed, display the change

   417

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

   418

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

   419

			// The player changed from client-player..

   420

			// Do not display that for now

   421

		}

   422

   423

		ci->client_playas = playas;

   424

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

   425

   426

		InvalidateWindow(WC_CLIENT_LIST, 0);

   427

   428

		return NETWORK_RECV_STATUS_OKAY;

   429

	}

   430

   431

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

   432

	ci = NetworkFindClientInfoFromIndex(NETWORK_EMPTY_INDEX);

   433

	if (ci != NULL) {

   434

		ci->client_index = index;

   435

		ci->client_playas = playas;

   436

   437

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

   438

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

   439

   440

		InvalidateWindow(WC_CLIENT_LIST, 0);

   441

   442

		return NETWORK_RECV_STATUS_OKAY;

   443

	}

   444

   445

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

   446

	return NETWORK_RECV_STATUS_MALFORMED_PACKET;

   447

}

   448

   449

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_ERROR)

   450

{

   451

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

   452

   453

	switch (error) {

   454

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

   455

		case NETWORK_ERROR_NOT_AUTHORIZED:

   456

		case NETWORK_ERROR_NOT_EXPECTED:

   457

		case NETWORK_ERROR_PLAYER_MISMATCH:

   458

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_ERROR;

   459

			break;

   460

		case NETWORK_ERROR_FULL:

   461

			_switch_mode_errorstr = STR_NETWORK_ERR_SERVER_FULL;

   462

			break;

   463

		case NETWORK_ERROR_WRONG_REVISION:

   464

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_REVISION;

   465

			break;

   466

		case NETWORK_ERROR_WRONG_PASSWORD:

   467

			_switch_mode_errorstr = STR_NETWORK_ERR_WRONG_PASSWORD;

   468

			break;

   469

		case NETWORK_ERROR_KICKED:

   470

			_switch_mode_errorstr = STR_NETWORK_ERR_KICKED;

   471

			break;

   472

		case NETWORK_ERROR_CHEATER:

   473

			_switch_mode_errorstr = STR_NETWORK_ERR_CHEATER;

   474

			break;

   475

		default:

   476

			_switch_mode_errorstr = STR_NETWORK_ERR_LOSTCONNECTION;

   477

	}

   478

   479

	DeleteWindowById(WC_NETWORK_STATUS_WINDOW, 0);

   480

   481

	return NETWORK_RECV_STATUS_SERVER_ERROR;

   482

}

   483

   484

DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_CHECK_NEWGRFS)

   485

{

   486

	uint grf_count = p->Recv_uint8();

   487

	NetworkRecvStatus ret = NETWORK_RECV_STATUS_OKAY;

   488

   489

	/* Check all GRFs */

   490

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

   491

		GRFConfig c;

   492

		MY_CLIENT->Recv_GRFIdentifier(p, &c);

   493

   494

		/* Check whether we know this GRF */

   495

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

   496

		if (f == NULL) {

   497

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

   498

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

   499

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

   500

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

   501

			ret = NETWORK_RECV_STATUS_NEWGRF_MISMATCH;

   502

		}

   503

	}

   504