3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
20 #ifndef NETWORKPROTOCOL_HEADER
21 #define NETWORKPROTOCOL_HEADER
22 #include "util/string.h"
25 changes by PROTOCOL_VERSION:
28 Base for writing changes here
33 Add TOCLIENT_CRAFTITEMDEF
35 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
36 Obsolete TOSERVER_GROUND_ACTION
38 Make players to be handled mostly as ActiveObjects
40 Only non-cached textures are sent
43 Obsolete TOCLIENT_TOOLDEF
44 Obsolete TOCLIENT_CRAFTITEMDEF
45 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
47 Digging based on item groups
50 ContentFeatures and NodeDefManager use a different serialization
51 format; better for future version cross-compatibility
53 Obsolete TOCLIENT_PLAYERITEM
56 Version raised to force 'fly' and 'fast' privileges into effect.
57 Node metadata change (came in later; somewhat incompatible)
59 TileDef in ContentFeatures
62 TOCLIENT_INVENTORY_FORMSPEC
65 TOSERVER_INVENTORY_FIELDS
67 TOCLIENT_DETACHED_INVENTORY
69 InventoryList field "Width" (deserialization fails with old versions)
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
77 Serialization format changes
79 TOCLIENT_SHOW_FORMSPEC
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
87 damageGroups added to ToolCapabilities
88 sound_place added to ItemDefinition
90 GENERIC_CMD_SET_PHYSICS_OVERRIDE
95 TOCLIENT_HUD_SET_FLAGS
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
108 Obsolete TOSERVER_RECEIVED_MEDIA
109 Server: Stop using TOSERVER_CLIENT_READY
111 ContentFeatures version 7
112 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
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
123 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
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
133 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
134 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
136 Add TileDef tileable_horizontal, tileable_vertical flags
138 backface_culling: backwards compatibility for playing with
139 newer client on pre-27 servers.
140 Add nodedef v3 - connected nodeboxes
144 Server doesn't accept TOSERVER_BREATH anymore
145 serialization of TileAnimation params changed
147 Removed client-sided chat perdiction
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)
155 Stop sending TOSERVER_CLIENT_READY
158 #define LATEST_PROTOCOL_VERSION 31
160 // Server's supported network protocol range
161 #define SERVER_PROTOCOL_VERSION_MIN 24
162 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
164 // Client's supported network protocol range
165 // The minimal version depends on whether
166 // send_pre_v25_init is enabled or not
167 #define CLIENT_PROTOCOL_VERSION_MIN 25
168 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
169 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
171 // Constant that differentiates the protocol from random data and other protocols
172 #define PROTOCOL_ID 0x4f457403
174 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
175 // base64-encoded SHA-1 (27+\0).
177 #define FORMSPEC_API_VERSION 1
178 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
180 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
184 TOCLIENT_HELLO = 0x02,
186 Sent after TOSERVER_INIT.
188 u8 deployed serialisation version
189 u16 deployed network compression mode
190 u16 deployed protocol version
191 u32 supported auth methods
192 std::string username that should be used for legacy hash (for proper casing)
194 TOCLIENT_AUTH_ACCEPT = 0x03,
196 Message from server to accept auth.
198 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
200 f1000 recommended send interval
201 u32 : supported auth methods for sudo mode
202 (where the user can change their password)
204 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
206 Sent to client to show it is in sudo mode now.
208 TOCLIENT_DENY_SUDO_MODE = 0x05,
210 Signals client that sudo mode auth failed.
212 TOCLIENT_INIT_LEGACY = 0x10,
214 Server's reply to TOSERVER_INIT.
215 Sent second after connected.
217 [0] u16 TOSERVER_INIT
218 [2] u8 deployed version
219 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
220 [12] u64 map seed (new as of 2011-02-27)
221 [20] f1000 recommended send interval (in seconds) (new as of 14)
223 NOTE: The position in here is deprecated; position is
224 explicitly sent afterwards
226 TOCLIENT_ACCESS_DENIED = 0x0A,
229 std::string custom reason (if needed, otherwise "")
232 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
233 TOCLIENT_ADDNODE = 0x21,
237 u8 keep_metadata // Added in protocol version 22
239 TOCLIENT_REMOVENODE = 0x22,
241 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
244 // Followed by an arbitary number of these:
245 // Number is determined from packet length.
247 [N+2] v3s32 position*100
248 [N+2+12] v3s32 speed*100
249 [N+2+12+12] s32 pitch*100
250 [N+2+12+12+4] s32 yaw*100
253 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
256 // Followed by an arbitary number of these:
257 // Number is determined from packet length.
262 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
264 TOCLIENT_SECTORMETA = 0x26, // Obsolete
268 [3...] v2s16 pos + sector metadata
271 TOCLIENT_INVENTORY = 0x27,
274 [2] serialized inventory
277 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
281 u16 number of player positions
294 TOCLIENT_TIME_OF_DAY = 0x29,
297 Added in a later version:
301 // (oops, there is some gap here)
303 TOCLIENT_CHAT_MESSAGE = 0x30,
309 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
311 u16 count of removed objects
312 for all removed objects {
315 u16 count of added objects
316 for all added objects {
319 u32 initialization data length
320 string initialization data
324 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
339 TOCLIENT_MOVE_PLAYER = 0x34,
341 v3f1000 player position
346 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
352 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
354 u16 count of player items
355 for all player items {
357 u16 length of serialized item
358 string serialized item
362 TOCLIENT_DEATHSCREEN = 0x37,
364 u8 bool set camera point target
365 v3f1000 camera point target (to point the death cause or whatever)
368 TOCLIENT_MEDIA = 0x38,
370 u16 total number of texture bunches
371 u16 index of this bunch
372 u32 number of files in this bunch
379 u16 length of remote media server url (if applicable)
383 TOCLIENT_TOOLDEF = 0x39,
385 u32 length of the next item
386 serialized ToolDefManager
389 TOCLIENT_NODEDEF = 0x3a,
391 u32 length of the next item
392 serialized NodeDefManager
395 TOCLIENT_CRAFTITEMDEF = 0x3b,
397 u32 length of the next item
398 serialized CraftiItemDefManager
401 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
408 u16 length of sha1_digest
413 TOCLIENT_ITEMDEF = 0x3d,
415 u32 length of next item
416 serialized ItemDefManager
419 TOCLIENT_PLAY_SOUND = 0x3f,
425 u8 type (0=local, 1=positional, 2=object)
426 s32[3] pos_nodes*10000
431 TOCLIENT_STOP_SOUND = 0x40,
436 TOCLIENT_PRIVILEGES = 0x41,
438 u16 number of privileges
444 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
450 TOCLIENT_DETACHED_INVENTORY = 0x43,
455 [2] serialized inventory
458 TOCLIENT_SHOW_FORMSPEC = 0x44,
467 TOCLIENT_MOVEMENT = 0x45,
469 f1000 movement_acceleration_default
470 f1000 movement_acceleration_air
471 f1000 movement_acceleration_fast
472 f1000 movement_speed_walk
473 f1000 movement_speed_crouch
474 f1000 movement_speed_fast
475 f1000 movement_speed_climb
476 f1000 movement_speed_jump
477 f1000 movement_liquid_fluidity
478 f1000 movement_liquid_fluidity_smooth
479 f1000 movement_liquid_sink
480 f1000 movement_gravity
483 TOCLIENT_SPAWN_PARTICLE = 0x46,
490 u8 bool collisiondetection
497 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
511 u8 bool collisiondetection
519 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
524 TOCLIENT_HUDADD = 0x49,
543 TOCLIENT_HUDRM = 0x4a,
548 TOCLIENT_HUDCHANGE = 0x4b,
558 TOCLIENT_HUD_SET_FLAGS = 0x4c,
564 TOCLIENT_HUD_SET_PARAM = 0x4d,
571 TOCLIENT_BREATH = 0x4e,
576 TOCLIENT_SET_SKY = 0x4f,
587 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
589 u8 do_override (boolean)
590 u16 day-night ratio 0...65535
593 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
602 TOCLIENT_EYE_OFFSET = 0x52,
608 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
613 TOCLIENT_SRP_BYTES_S_B = 0x60,
615 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
621 TOCLIENT_NUM_MSG_TYPES = 0x61,
626 TOSERVER_INIT = 0x02,
628 Sent first after connected.
630 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
631 u16 supported network compression modes
632 u16 minimum supported network protocol version
633 u16 maximum supported network protocol version
634 std::string player name
637 TOSERVER_INIT_LEGACY = 0x10,
639 Sent first after connected.
641 [0] u16 TOSERVER_INIT_LEGACY
642 [2] u8 SER_FMT_VER_HIGHEST_READ
643 [3] u8[20] player_name
644 [23] u8[28] password (new in some version)
645 [51] u16 minimum supported network protocol version (added sometime)
646 [53] u16 maximum supported network protocol version (added later than the previous one)
649 TOSERVER_INIT2 = 0x11,
651 Sent as an ACK for TOCLIENT_INIT.
652 After this, the server can send data.
654 [0] u16 TOSERVER_INIT2
657 TOSERVER_GETBLOCK=0x20, // Obsolete
658 TOSERVER_ADDNODE = 0x21, // Obsolete
659 TOSERVER_REMOVENODE = 0x22, // Obsolete
661 TOSERVER_PLAYERPOS = 0x23,
664 [2] v3s32 position*100
665 [2+12] v3s32 speed*100
666 [2+12+12] s32 pitch*100
667 [2+12+12+4] s32 yaw*100
668 [2+12+12+4+4] u32 keyPressed
669 [2+12+12+4+4+1] u8 fov*80
670 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
673 TOSERVER_GOTBLOCKS = 0x24,
682 TOSERVER_DELETEDBLOCKS = 0x25,
691 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
698 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
702 [2] u8 button (0=left, 1=right)
708 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
713 [3] v3s16 nodepos_undersurface
714 [9] v3s16 nodepos_abovesurface
717 0: start digging (from undersurface)
718 1: place block (to abovesurface)
719 2: stop digging (all parameters ignored)
723 TOSERVER_RELEASE = 0x29, // Obsolete
725 // (oops, there is some gap here)
727 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
735 TOSERVER_INVENTORY_ACTION = 0x31,
737 See InventoryAction in inventorymanager.h
740 TOSERVER_CHAT_MESSAGE = 0x32,
746 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
753 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
757 [2] u8 button (0=left, 1=right)
762 TOSERVER_DAMAGE = 0x35,
767 TOSERVER_PASSWORD_LEGACY = 0x36,
769 Sent to change password.
771 [0] u16 TOSERVER_PASSWORD
772 [2] u8[28] old password
773 [30] u8[28] new password
776 TOSERVER_PLAYERITEM = 0x37,
778 Sent to change selected item.
780 [0] u16 TOSERVER_PLAYERITEM
784 TOSERVER_RESPAWN = 0x38,
789 TOSERVER_INTERACT = 0x39,
794 [5] u32 length of the next item
795 [9] serialized PointedThing
797 0: start digging (from undersurface) or use
798 1: stop digging (all parameters ignored)
800 3: place block or item (to abovesurface)
803 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
806 TOSERVER_REMOVED_SOUNDS = 0x3a,
812 TOSERVER_NODEMETA_FIELDS = 0x3b,
816 u8[len] form name (reserved for future use)
825 TOSERVER_INVENTORY_FIELDS = 0x3c,
828 u8[len] form name (reserved for future use)
837 TOSERVER_REQUEST_MEDIA = 0x40,
839 u16 number of files requested
846 TOSERVER_RECEIVED_MEDIA = 0x41,
851 TOSERVER_BREATH = 0x42, // Obsolete
856 TOSERVER_CLIENT_READY = 0x43,
863 u8[len] full_version_string
866 TOSERVER_FIRST_SRP = 0x50,
868 Belonging to AUTH_MECHANISM_FIRST_SRP.
871 std::string srp verification key
872 u8 is_empty (=1 if password is empty, 0 otherwise)
875 TOSERVER_SRP_BYTES_A = 0x51,
877 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
878 depending on current_login_based_on.
881 u8 current_login_based_on : on which version of the password's
882 hash this login is based on (0 legacy hash,
883 or 1 directly the password)
886 TOSERVER_SRP_BYTES_M = 0x52,
888 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
893 TOSERVER_NUM_MSG_TYPES = 0x53,
899 AUTH_MECHANISM_NONE = 0,
901 // SRP based on the legacy hash
902 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
904 // SRP based on the srp verification key
905 AUTH_MECHANISM_SRP = 1 << 1,
907 // Establishes a srp verification key, for first login and password changing
908 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
911 enum AccessDeniedCode {
912 SERVER_ACCESSDENIED_WRONG_PASSWORD,
913 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
914 SERVER_ACCESSDENIED_SINGLEPLAYER,
915 SERVER_ACCESSDENIED_WRONG_VERSION,
916 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
917 SERVER_ACCESSDENIED_WRONG_NAME,
918 SERVER_ACCESSDENIED_TOO_MANY_USERS,
919 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
920 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
921 SERVER_ACCESSDENIED_SERVER_FAIL,
922 SERVER_ACCESSDENIED_CUSTOM_STRING,
923 SERVER_ACCESSDENIED_SHUTDOWN,
924 SERVER_ACCESSDENIED_CRASH,
925 SERVER_ACCESSDENIED_MAX,
928 enum NetProtoCompressionMode {
929 NETPROTO_COMPRESSION_NONE = 0,
932 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
934 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
935 "The server is running in simple singleplayer mode. You cannot connect.",
936 "Your client's version is not supported.\nPlease contact server administrator.",
937 "Player name contains disallowed characters.",
938 "Player name not allowed.",
940 "Empty passwords are disallowed. Set a password and try again.",
941 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
942 "Server authentication failed. This is likely a server error.",
944 "Server shutting down.",
945 "This server has experienced an internal error. You will now be disconnected."