src/network/networkprotocol.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "util/string.h"
  23
  24 /*
  25         changes by PROTOCOL_VERSION:
  26
  27         PROTOCOL_VERSION 3:
  28                 Base for writing changes here
  29         PROTOCOL_VERSION 4:
  30                 Add TOCLIENT_MEDIA
  31                 Add TOCLIENT_TOOLDEF
  32                 Add TOCLIENT_NODEDEF
  33                 Add TOCLIENT_CRAFTITEMDEF
  34                 Add TOSERVER_INTERACT
  35                 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
  36                 Obsolete TOSERVER_GROUND_ACTION
  37         PROTOCOL_VERSION 5:
  38                 Make players to be handled mostly as ActiveObjects
  39         PROTOCOL_VERSION 6:
  40                 Only non-cached textures are sent
  41         PROTOCOL_VERSION 7:
  42                 Add TOCLIENT_ITEMDEF
  43                 Obsolete TOCLIENT_TOOLDEF
  44                 Obsolete TOCLIENT_CRAFTITEMDEF
  45                 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
  46         PROTOCOL_VERSION 8:
  47                 Digging based on item groups
  48                 Many things
  49         PROTOCOL_VERSION 9:
  50                 ContentFeatures and NodeDefManager use a different serialization
  51                     format; better for future version cross-compatibility
  52                 Many things
  53                 Obsolete TOCLIENT_PLAYERITEM
  54         PROTOCOL_VERSION 10:
  55                 TOCLIENT_PRIVILEGES
  56                 Version raised to force 'fly' and 'fast' privileges into effect.
  57                 Node metadata change (came in later; somewhat incompatible)
  58         PROTOCOL_VERSION 11:
  59                 TileDef in ContentFeatures
  60                 Nodebox drawtype
  61                 (some dev snapshot)
  62                 TOCLIENT_INVENTORY_FORMSPEC
  63                 (0.4.0, 0.4.1)
  64         PROTOCOL_VERSION 12:
  65                 TOSERVER_INVENTORY_FIELDS
  66                 16-bit node ids
  67                 TOCLIENT_DETACHED_INVENTORY
  68         PROTOCOL_VERSION 13:
  69                 InventoryList field "Width" (deserialization fails with old versions)
  70         PROTOCOL_VERSION 14:
  71                 Added transfer of player pressed keys to the server
  72                 Added new messages for mesh and bone animation, as well as attachments
  73                 GENERIC_CMD_SET_ANIMATION
  74                 GENERIC_CMD_SET_BONE_POSITION
  75                 GENERIC_CMD_SET_ATTACHMENT
  76         PROTOCOL_VERSION 15:
  77                 Serialization format changes
  78         PROTOCOL_VERSION 16:
  79                 TOCLIENT_SHOW_FORMSPEC
  80         PROTOCOL_VERSION 17:
  81                 Serialization format change: include backface_culling flag in TileDef
  82                 Added rightclickable field in nodedef
  83                 TOCLIENT_SPAWN_PARTICLE
  84                 TOCLIENT_ADD_PARTICLESPAWNER
  85                 TOCLIENT_DELETE_PARTICLESPAWNER
  86         PROTOCOL_VERSION 18:
  87                 damageGroups added to ToolCapabilities
  88                 sound_place added to ItemDefinition
  89         PROTOCOL_VERSION 19:
  90                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
  91         PROTOCOL_VERSION 20:
  92                 TOCLIENT_HUDADD
  93                 TOCLIENT_HUDRM
  94                 TOCLIENT_HUDCHANGE
  95                 TOCLIENT_HUD_SET_FLAGS
  96         PROTOCOL_VERSION 21:
  97                 TOCLIENT_BREATH
  98                 TOSERVER_BREATH
  99                 range added to ItemDefinition
 100                 drowning, leveled and liquid_range added to ContentFeatures
 101                 stepheight and collideWithObjects added to object properties
 102                 version, heat and humidity transfer in MapBock
 103                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 104                         added to object properties
 105         PROTOCOL_VERSION 22:
 106                 add swap_node
 107         PROTOCOL_VERSION 23:
 108                 Obsolete TOSERVER_RECEIVED_MEDIA
 109                 Server: Stop using TOSERVER_CLIENT_READY
 110         PROTOCOL_VERSION 24:
 111                 ContentFeatures version 7
 112                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 113         PROTOCOL_VERSION 25:
 114                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
 115                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
 116                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
 117                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
 118                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
 119                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
 120                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
 121                         for standard error, keeping customisation possible. This
 122                         permit translation
 123                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
 124                         reading u32
 125                 Add new opcode TOSERVER_INIT for client presentation to server
 126                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
 127                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
 128                         for the three supported auth mechanisms around srp
 129                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
 130                         for sudo mode handling (auth mech generic way of changing password).
 131                 Add TOCLIENT_HELLO for presenting server to client after client
 132                         presentation
 133                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
 134                 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
 135         PROTOCOL_VERSION 26:
 136                 Add TileDef tileable_horizontal, tileable_vertical flags
 137         PROTOCOL_VERSION 27:
 138                 backface_culling: backwards compatibility for playing with
 139                 newer client on pre-27 servers.
 140                 Add nodedef v3 - connected nodeboxes
 141         PROTOCOL_VERSION 28:
 142                 CPT2_MESHOPTIONS
 143         PROTOCOL_VERSION 29:
 144                 Server doesn't accept TOSERVER_BREATH anymore
 145                 serialization of TileAnimation params changed
 146                 TAT_SHEET_2D
 147                 Removed client-sided chat perdiction
 148         PROTOCOL VERSION 30:
 149                 New ContentFeatures serialization version
 150                 Add node and tile color and palette
 151                 Fix plantlike visual_scale being applied squared and add compatibility
 152                         with pre-30 clients by sending sqrt(visual_scale)
 153         PROTOCOL VERSION 31:
 154                 Add tile overlay
 155                 Stop sending TOSERVER_CLIENT_READY
 156         PROTOCOL VERSION 32:
 157                 Add fading sounds
 158         PROTOCOL VERSION 33:
 159                 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
 160                         instead of guessing based on the active object list.
 161         PROTOCOL VERSION 34:
 162                 Add sound pitch
 163         PROTOCOL VERSION 35:
 164                 Rename TOCLIENT_CHAT_MESSAGE to TOCLIENT_CHAT_MESSAGE_OLD (0x30)
 165                 Add TOCLIENT_CHAT_MESSAGE (0x2F)
 166                         This chat message is a signalisation message containing various
 167                         informations:
 168                         * timestamp
 169                         * sender
 170                         * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
 171                         * content
 172                 Add TOCLIENT_CSM_RESTRICTION_FLAGS to define which CSM features should be
 173                         limited
 174                 Add settable player collisionbox. Breaks compatibility with older
 175                         clients as a 1-node vertical offset has been removed from player's
 176                         position
 177                 Add settable player stepheight using existing object property.
 178                         Breaks compatibility with older clients.
 179         PROTOCOL VERSION 36:
 180                 Backwards compatibility drop
 181                 Add 'can_zoom' to player object properties
 182                 Add glow to object properties
 183                 Change TileDef serialization format.
 184                 Add world-aligned tiles.
 185                 Mod channels
 186                 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
 187                         'zoom_fov'.
 188                 Nodebox version 5
 189                 Add disconnected nodeboxes
 190                 Add TOCLIENT_FORMSPEC_PREPEND
 191         PROTOCOL VERSION 37:
 192                 Redo detached inventory sending
 193                 Add TOCLIENT_NODEMETA_CHANGED
 194                 New network float format
 195                 ContentFeatures version 13
 196 */
 197
 198 #define LATEST_PROTOCOL_VERSION 37
 199 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
 200
 201 // Server's supported network protocol range
 202 #define SERVER_PROTOCOL_VERSION_MIN 37
 203 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 204
 205 // Client's supported network protocol range
 206 // The minimal version depends on whether
 207 // send_pre_v25_init is enabled or not
 208 #define CLIENT_PROTOCOL_VERSION_MIN 37
 209 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 210
 211 // Constant that differentiates the protocol from random data and other protocols
 212 #define PROTOCOL_ID 0x4f457403
 213
 214 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 215                                // base64-encoded SHA-1 (27+\0).
 216
 217 #define FORMSPEC_API_VERSION 1
 218 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 219
 220 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 221
 222 typedef u16 session_t;
 223
 224 enum ToClientCommand
 225 {
 226         TOCLIENT_HELLO = 0x02,
 227         /*
 228                 Sent after TOSERVER_INIT.
 229
 230                 u8 deployed serialisation version
 231                 u16 deployed network compression mode
 232                 u16 deployed protocol version
 233                 u32 supported auth methods
 234                 std::string username that should be used for legacy hash (for proper casing)
 235         */
 236         TOCLIENT_AUTH_ACCEPT = 0x03,
 237         /*
 238                 Message from server to accept auth.
 239
 240                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 241                 u64 map seed
 242                 f1000 recommended send interval
 243                 u32 : supported auth methods for sudo mode
 244                       (where the user can change their password)
 245         */
 246         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 247         /*
 248                 Sent to client to show it is in sudo mode now.
 249         */
 250         TOCLIENT_DENY_SUDO_MODE = 0x05,
 251         /*
 252                 Signals client that sudo mode auth failed.
 253         */
 254         TOCLIENT_ACCESS_DENIED = 0x0A,
 255         /*
 256                 u8 reason
 257                 std::string custom reason (if needed, otherwise "")
 258                 u8 (bool) reconnect
 259         */
 260
 261         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 262
 263         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 264         TOCLIENT_ADDNODE = 0x21,
 265         /*
 266                 v3s16 position
 267                 serialized mapnode
 268                 u8 keep_metadata // Added in protocol version 22
 269         */
 270         TOCLIENT_REMOVENODE = 0x22,
 271
 272         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 273         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 274         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 275         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 276
 277         TOCLIENT_INVENTORY = 0x27,
 278         /*
 279                 [0] u16 command
 280                 [2] serialized inventory
 281         */
 282
 283         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 284
 285         TOCLIENT_TIME_OF_DAY = 0x29,
 286         /*
 287                 u16 time (0-23999)
 288                 Added in a later version:
 289                 f1000 time_speed
 290         */
 291
 292         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 293         /*
 294                 u32 CSMRestrictionFlags byteflag
 295          */
 296
 297         // (oops, there is some gap here)
 298
 299         TOCLIENT_CHAT_MESSAGE = 0x2F,
 300         /*
 301                 u8 version
 302                 u8 message_type
 303                 u16 sendername length
 304                 wstring sendername
 305                 u16 length
 306                 wstring message
 307         */
 308
 309         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 310
 311         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 312         /*
 313                 u16 count of removed objects
 314                 for all removed objects {
 315                         u16 id
 316                 }
 317                 u16 count of added objects
 318                 for all added objects {
 319                         u16 id
 320                         u8 type
 321                         u32 initialization data length
 322                         string initialization data
 323                 }
 324         */
 325
 326         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 327         /*
 328                 for all objects
 329                 {
 330                         u16 id
 331                         u16 message length
 332                         string message
 333                 }
 334         */
 335
 336         TOCLIENT_HP = 0x33,
 337         /*
 338                 u8 hp
 339         */
 340
 341         TOCLIENT_MOVE_PLAYER = 0x34,
 342         /*
 343                 v3f1000 player position
 344                 f1000 player pitch
 345                 f1000 player yaw
 346         */
 347
 348         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 349         /*
 350                 u16 reason_length
 351                 wstring reason
 352         */
 353
 354         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 355
 356         TOCLIENT_DEATHSCREEN = 0x37,
 357         /*
 358                 u8 bool set camera point target
 359                 v3f1000 camera point target (to point the death cause or whatever)
 360         */
 361
 362         TOCLIENT_MEDIA = 0x38,
 363         /*
 364                 u16 total number of texture bunches
 365                 u16 index of this bunch
 366                 u32 number of files in this bunch
 367                 for each file {
 368                         u16 length of name
 369                         string name
 370                         u32 length of data
 371                         data
 372                 }
 373                 u16 length of remote media server url (if applicable)
 374                 string url
 375         */
 376
 377         TOCLIENT_TOOLDEF = 0x39,
 378         /*
 379                 u32 length of the next item
 380                 serialized ToolDefManager
 381         */
 382
 383         TOCLIENT_NODEDEF = 0x3a,
 384         /*
 385                 u32 length of the next item
 386                 serialized NodeDefManager
 387         */
 388
 389         TOCLIENT_CRAFTITEMDEF = 0x3b,
 390         /*
 391                 u32 length of the next item
 392                 serialized CraftiItemDefManager
 393         */
 394
 395         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 396
 397         /*
 398                 u32 number of files
 399                 for each texture {
 400                         u16 length of name
 401                         string name
 402                         u16 length of sha1_digest
 403                         string sha1_digest
 404                 }
 405         */
 406
 407         TOCLIENT_ITEMDEF = 0x3d,
 408         /*
 409                 u32 length of next item
 410                 serialized ItemDefManager
 411         */
 412
 413         TOCLIENT_PLAY_SOUND = 0x3f,
 414         /*
 415                 s32 sound_id
 416                 u16 len
 417                 u8[len] sound name
 418                 s32 gain*1000
 419                 u8 type (0=local, 1=positional, 2=object)
 420                 s32[3] pos_nodes*10000
 421                 u16 object_id
 422                 u8 loop (bool)
 423         */
 424
 425         TOCLIENT_STOP_SOUND = 0x40,
 426         /*
 427                 s32 sound_id
 428         */
 429
 430         TOCLIENT_PRIVILEGES = 0x41,
 431         /*
 432                 u16 number of privileges
 433                 for each privilege
 434                         u16 len
 435                         u8[len] privilege
 436         */
 437
 438         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 439         /*
 440                 u32 len
 441                 u8[len] formspec
 442         */
 443
 444         TOCLIENT_DETACHED_INVENTORY = 0x43,
 445         /*
 446                 [0] u16 command
 447                 u16 len
 448                 u8[len] name
 449                 [2] serialized inventory
 450         */
 451
 452         TOCLIENT_SHOW_FORMSPEC = 0x44,
 453         /*
 454                 [0] u16 command
 455                 u32 len
 456                 u8[len] formspec
 457                 u16 len
 458                 u8[len] formname
 459         */
 460
 461         TOCLIENT_MOVEMENT = 0x45,
 462         /*
 463                 f1000 movement_acceleration_default
 464                 f1000 movement_acceleration_air
 465                 f1000 movement_acceleration_fast
 466                 f1000 movement_speed_walk
 467                 f1000 movement_speed_crouch
 468                 f1000 movement_speed_fast
 469                 f1000 movement_speed_climb
 470                 f1000 movement_speed_jump
 471                 f1000 movement_liquid_fluidity
 472                 f1000 movement_liquid_fluidity_smooth
 473                 f1000 movement_liquid_sink
 474                 f1000 movement_gravity
 475         */
 476
 477         TOCLIENT_SPAWN_PARTICLE = 0x46,
 478         /*
 479                 v3f1000 pos
 480                 v3f1000 velocity
 481                 v3f1000 acceleration
 482                 f1000 expirationtime
 483                 f1000 size
 484                 u8 bool collisiondetection
 485                 u32 len
 486                 u8[len] texture
 487                 u8 bool vertical
 488                 u8 collision_removal
 489                 TileAnimation animation
 490                 u8 glow
 491                 u8 object_collision
 492         */
 493
 494         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 495         /*
 496                 u16 amount
 497                 f1000 spawntime
 498                 v3f1000 minpos
 499                 v3f1000 maxpos
 500                 v3f1000 minvel
 501                 v3f1000 maxvel
 502                 v3f1000 minacc
 503                 v3f1000 maxacc
 504                 f1000 minexptime
 505                 f1000 maxexptime
 506                 f1000 minsize
 507                 f1000 maxsize
 508                 u8 bool collisiondetection
 509                 u32 len
 510                 u8[len] texture
 511                 u8 bool vertical
 512                 u8 collision_removal
 513                 u32 id
 514                 TileAnimation animation
 515                 u8 glow
 516                 u8 object_collision
 517         */
 518
 519         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 520
 521         TOCLIENT_HUDADD = 0x49,
 522         /*
 523                 u32 id
 524                 u8 type
 525                 v2f1000 pos
 526                 u32 len
 527                 u8[len] name
 528                 v2f1000 scale
 529                 u32 len2
 530                 u8[len2] text
 531                 u32 number
 532                 u32 item
 533                 u32 dir
 534                 v2f1000 align
 535                 v2f1000 offset
 536                 v3f1000 world_pos
 537                 v2s32 size
 538         */
 539
 540         TOCLIENT_HUDRM = 0x4a,
 541         /*
 542                 u32 id
 543         */
 544
 545         TOCLIENT_HUDCHANGE = 0x4b,
 546         /*
 547                 u32 id
 548                 u8 stat
 549                 [v2f1000 data |
 550                  u32 len
 551                  u8[len] data |
 552                  u32 data]
 553         */
 554
 555         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 556         /*
 557                 u32 flags
 558                 u32 mask
 559         */
 560
 561         TOCLIENT_HUD_SET_PARAM = 0x4d,
 562         /*
 563                 u16 param
 564                 u16 len
 565                 u8[len] value
 566         */
 567
 568         TOCLIENT_BREATH = 0x4e,
 569         /*
 570                 u16 breath
 571         */
 572
 573         TOCLIENT_SET_SKY = 0x4f,
 574         /*
 575                 u8[4] color (ARGB)
 576                 u8 len
 577                 u8[len] type
 578                 u16 count
 579                 foreach count:
 580                         u8 len
 581                         u8[len] param
 582                 u8 clouds (boolean)
 583         */
 584
 585         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 586         /*
 587                 u8 do_override (boolean)
 588                 u16 day-night ratio 0...65535
 589         */
 590
 591         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 592         /*
 593                 v2s32 stand/idle
 594                 v2s32 walk
 595                 v2s32 dig
 596                 v2s32 walk+dig
 597                 f1000 frame_speed
 598         */
 599
 600         TOCLIENT_EYE_OFFSET = 0x52,
 601         /*
 602                 v3f1000 first
 603                 v3f1000 third
 604         */
 605
 606         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 607         /*
 608                 u32 id
 609         */
 610
 611         TOCLIENT_CLOUD_PARAMS = 0x54,
 612         /*
 613                 f1000 density
 614                 u8[4] color_diffuse (ARGB)
 615                 u8[4] color_ambient (ARGB)
 616                 f1000 height
 617                 f1000 thickness
 618                 v2f1000 speed
 619         */
 620
 621         TOCLIENT_FADE_SOUND = 0x55,
 622         /*
 623                 s32 sound_id
 624                 float step
 625                 float gain
 626         */
 627         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 628         /*
 629                 u8 type
 630                 u16 number of players
 631                 for each player
 632                         u16 len
 633                         u8[len] player name
 634         */
 635
 636         TOCLIENT_MODCHANNEL_MSG = 0x57,
 637         /*
 638                 u16 channel name length
 639                 std::string channel name
 640                 u16 channel name sender
 641                 std::string channel name
 642                 u16 message length
 643                 std::string message
 644         */
 645
 646         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 647         /*
 648                 u8 signal id
 649                 u16 channel name length
 650                 std::string channel name
 651         */
 652
 653         TOCLIENT_NODEMETA_CHANGED = 0x59,
 654         /*
 655                 serialized and compressed node metadata
 656         */
 657
 658         TOCLIENT_SRP_BYTES_S_B = 0x60,
 659         /*
 660                 Belonging to AUTH_MECHANISM_SRP.
 661
 662                 std::string bytes_s
 663                 std::string bytes_B
 664         */
 665
 666         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 667         /*
 668                 u16 len
 669                 u8[len] formspec
 670         */
 671
 672         TOCLIENT_NUM_MSG_TYPES = 0x62,
 673 };
 674
 675 enum ToServerCommand
 676 {
 677         TOSERVER_INIT = 0x02,
 678         /*
 679                 Sent first after connected.
 680
 681                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 682                 u16 supported network compression modes
 683                 u16 minimum supported network protocol version
 684                 u16 maximum supported network protocol version
 685                 std::string player name
 686         */
 687
 688         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 689
 690         TOSERVER_INIT2 = 0x11,
 691         /*
 692                 Sent as an ACK for TOCLIENT_INIT.
 693                 After this, the server can send data.
 694
 695                 [0] u16 TOSERVER_INIT2
 696         */
 697
 698         TOSERVER_MODCHANNEL_JOIN = 0x17,
 699         /*
 700                 u16 channel name length
 701                 std::string channel name
 702          */
 703
 704         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 705         /*
 706                 u16 channel name length
 707                 std::string channel name
 708          */
 709
 710         TOSERVER_MODCHANNEL_MSG = 0x19,
 711         /*
 712                 u16 channel name length
 713                 std::string channel name
 714                 u16 message length
 715                 std::string message
 716          */
 717
 718         TOSERVER_GETBLOCK = 0x20, // Obsolete
 719         TOSERVER_ADDNODE = 0x21, // Obsolete
 720         TOSERVER_REMOVENODE = 0x22, // Obsolete
 721
 722         TOSERVER_PLAYERPOS = 0x23,
 723         /*
 724                 [0] u16 command
 725                 [2] v3s32 position*100
 726                 [2+12] v3s32 speed*100
 727                 [2+12+12] s32 pitch*100
 728                 [2+12+12+4] s32 yaw*100
 729                 [2+12+12+4+4] u32 keyPressed
 730                 [2+12+12+4+4+1] u8 fov*80
 731                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 732         */
 733
 734         TOSERVER_GOTBLOCKS = 0x24,
 735         /*
 736                 [0] u16 command
 737                 [2] u8 count
 738                 [3] v3s16 pos_0
 739                 [3+6] v3s16 pos_1
 740                 ...
 741         */
 742
 743         TOSERVER_DELETEDBLOCKS = 0x25,
 744         /*
 745                 [0] u16 command
 746                 [2] u8 count
 747                 [3] v3s16 pos_0
 748                 [3+6] v3s16 pos_1
 749                 ...
 750         */
 751
 752         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 753         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 754         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 755         TOSERVER_RELEASE = 0x29, // Obsolete
 756         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 757
 758         TOSERVER_INVENTORY_ACTION = 0x31,
 759         /*
 760                 See InventoryAction in inventorymanager.h
 761         */
 762
 763         TOSERVER_CHAT_MESSAGE = 0x32,
 764         /*
 765                 u16 length
 766                 wstring message
 767         */
 768
 769         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 770         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 771
 772         TOSERVER_DAMAGE = 0x35,
 773         /*
 774                 u8 amount
 775         */
 776
 777         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 778
 779         TOSERVER_PLAYERITEM = 0x37,
 780         /*
 781                 Sent to change selected item.
 782
 783                 [0] u16 TOSERVER_PLAYERITEM
 784                 [2] u16 item
 785         */
 786
 787         TOSERVER_RESPAWN = 0x38,
 788         /*
 789                 u16 TOSERVER_RESPAWN
 790         */
 791
 792         TOSERVER_INTERACT = 0x39,
 793         /*
 794                 [0] u16 command
 795                 [2] u8 action
 796                 [3] u16 item
 797                 [5] u32 length of the next item
 798                 [9] serialized PointedThing
 799                 actions:
 800                 0: start digging (from undersurface) or use
 801                 1: stop digging (all parameters ignored)
 802                 2: digging completed
 803                 3: place block or item (to abovesurface)
 804                 4: use item
 805         */
 806
 807         TOSERVER_REMOVED_SOUNDS = 0x3a,
 808         /*
 809                 u16 len
 810                 s32[len] sound_id
 811         */
 812
 813         TOSERVER_NODEMETA_FIELDS = 0x3b,
 814         /*
 815                 v3s16 p
 816                 u16 len
 817                 u8[len] form name (reserved for future use)
 818                 u16 number of fields
 819                 for each field:
 820                         u16 len
 821                         u8[len] field name
 822                         u32 len
 823                         u8[len] field value
 824         */
 825
 826         TOSERVER_INVENTORY_FIELDS = 0x3c,
 827         /*
 828                 u16 len
 829                 u8[len] form name (reserved for future use)
 830                 u16 number of fields
 831                 for each field:
 832                         u16 len
 833                         u8[len] field name
 834                         u32 len
 835                         u8[len] field value
 836         */
 837
 838         TOSERVER_REQUEST_MEDIA = 0x40,
 839         /*
 840                 u16 number of files requested
 841                 for each file {
 842                         u16 length of name
 843                         string name
 844                 }
 845         */
 846
 847         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 848         TOSERVER_BREATH = 0x42, // Obsolete
 849
 850         TOSERVER_CLIENT_READY = 0x43,
 851         /*
 852                 u8 major
 853                 u8 minor
 854                 u8 patch
 855                 u8 reserved
 856                 u16 len
 857                 u8[len] full_version_string
 858         */
 859
 860         TOSERVER_FIRST_SRP = 0x50,
 861         /*
 862                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 863
 864                 std::string srp salt
 865                 std::string srp verification key
 866                 u8 is_empty (=1 if password is empty, 0 otherwise)
 867         */
 868
 869         TOSERVER_SRP_BYTES_A = 0x51,
 870         /*
 871                 Belonging to AUTH_MECHANISM_SRP,
 872                         depending on current_login_based_on.
 873
 874                 std::string bytes_A
 875                 u8 current_login_based_on : on which version of the password's
 876                                             hash this login is based on (0 legacy hash,
 877                                             or 1 directly the password)
 878         */
 879
 880         TOSERVER_SRP_BYTES_M = 0x52,
 881         /*
 882                 Belonging to AUTH_MECHANISM_SRP.
 883
 884                 std::string bytes_M
 885         */
 886
 887         TOSERVER_NUM_MSG_TYPES = 0x53,
 888 };
 889
 890 enum AuthMechanism
 891 {
 892         // reserved
 893         AUTH_MECHANISM_NONE = 0,
 894
 895         // SRP based on the legacy hash
 896         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 897
 898         // SRP based on the srp verification key
 899         AUTH_MECHANISM_SRP = 1 << 1,
 900
 901         // Establishes a srp verification key, for first login and password changing
 902         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 903 };
 904
 905 enum AccessDeniedCode {
 906         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 907         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 908         SERVER_ACCESSDENIED_SINGLEPLAYER,
 909         SERVER_ACCESSDENIED_WRONG_VERSION,
 910         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 911         SERVER_ACCESSDENIED_WRONG_NAME,
 912         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 913         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 914         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 915         SERVER_ACCESSDENIED_SERVER_FAIL,
 916         SERVER_ACCESSDENIED_CUSTOM_STRING,
 917         SERVER_ACCESSDENIED_SHUTDOWN,
 918         SERVER_ACCESSDENIED_CRASH,
 919         SERVER_ACCESSDENIED_MAX,
 920 };
 921
 922 enum NetProtoCompressionMode {
 923         NETPROTO_COMPRESSION_NONE = 0,
 924 };
 925
 926 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 927         "Invalid password",
 928         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 929         "The server is running in simple singleplayer mode.  You cannot connect.",
 930         "Your client's version is not supported.\nPlease contact server administrator.",
 931         "Player name contains disallowed characters.",
 932         "Player name not allowed.",
 933         "Too many users.",
 934         "Empty passwords are disallowed.  Set a password and try again.",
 935         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 936         "Server authentication failed.  This is likely a server error.",
 937         "",
 938         "Server shutting down.",
 939         "This server has experienced an internal error. You will now be disconnected."
 940 };
 941
 942 enum PlayerListModifer: u8
 943 {
 944         PLAYER_LIST_INIT,
 945         PLAYER_LIST_ADD,
 946         PLAYER_LIST_REMOVE,
 947 };
 948
 949 enum CSMRestrictionFlags : u64 {
 950         CSM_RF_NONE = 0x00000000,
 951         // Until server-sent CSM and verifying of builtin are complete,
 952         // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
 953         // When those are complete, this should return to only being a restriction on the
 954         // loading of client mods.
 955         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
 956         CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
 957         CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
 958         CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
 959         CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
 960         CSM_RF_READ_PLAYERINFO = 0x00000020, // Disable player info lookups
 961         CSM_RF_ALL = 0xFFFFFFFF,
 962 };