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
55 Version raised to force 'fly' and 'fast' privileges into effect.
56 Node metadata change (came in later; somewhat incompatible)
58 TileDef in ContentFeatures
61 TOCLIENT_INVENTORY_FORMSPEC
64 TOSERVER_INVENTORY_FIELDS
66 TOCLIENT_DETACHED_INVENTORY
68 InventoryList field "Width" (deserialization fails with old versions)
70 Added transfer of player pressed keys to the server
71 Added new messages for mesh and bone animation, as well as attachments
72 GENERIC_CMD_SET_ANIMATION
73 GENERIC_CMD_SET_BONE_POSITION
74 GENERIC_CMD_SET_ATTACHMENT
76 Serialization format changes
78 TOCLIENT_SHOW_FORMSPEC
80 Serialization format change: include backface_culling flag in TileDef
81 Added rightclickable field in nodedef
82 TOCLIENT_SPAWN_PARTICLE
83 TOCLIENT_ADD_PARTICLESPAWNER
84 TOCLIENT_DELETE_PARTICLESPAWNER
86 damageGroups added to ToolCapabilities
87 sound_place added to ItemDefinition
89 GENERIC_CMD_SET_PHYSICS_OVERRIDE
94 TOCLIENT_HUD_SET_FLAGS
98 range added to ItemDefinition
99 drowning, leveled and liquid_range added to ContentFeatures
100 stepheight and collideWithObjects added to object properties
101 version, heat and humidity transfer in MapBock
102 automatic_face_movement_dir and automatic_face_movement_dir_offset
103 added to object properties
107 TOSERVER_CLIENT_READY
109 ContentFeatures version 7
110 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
112 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
113 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
114 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
115 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
116 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
117 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
118 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
119 for standard error, keeping customisation possible. This
121 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
123 Add new opcode TOSERVER_INIT for client presentation to server
124 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
125 TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
126 for the three supported auth mechanisms around srp
127 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
128 for sudo mode handling (auth mech generic way of changing password).
129 Add TOCLIENT_HELLO for presenting server to client after client
131 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
132 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
134 Add TileDef tileable_horizontal, tileable_vertical flags
136 backface_culling: backwards compatibility for playing with
137 newer client on pre-27 servers.
140 #define LATEST_PROTOCOL_VERSION 27
142 // Server's supported network protocol range
143 #define SERVER_PROTOCOL_VERSION_MIN 13
144 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
146 // Client's supported network protocol range
147 #define CLIENT_PROTOCOL_VERSION_MIN 13
148 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
150 // Constant that differentiates the protocol from random data and other protocols
151 #define PROTOCOL_ID 0x4f457403
153 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
154 // base64-encoded SHA-1 (27+\0).
156 #define FORMSPEC_API_VERSION 1
157 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
159 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
163 TOCLIENT_HELLO = 0x02,
165 Sent after TOSERVER_INIT.
167 u8 deployed serialisation version
168 u16 deployed network compression mode
169 u16 deployed protocol version
170 u32 supported auth methods
171 std::string username that should be used for legacy hash (for proper casing)
173 TOCLIENT_AUTH_ACCEPT = 0x03,
175 Message from server to accept auth.
177 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
179 f1000 recommended send interval
180 u32 : supported auth methods for sudo mode
181 (where the user can change their password)
183 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
185 Sent to client to show it is in sudo mode now.
187 TOCLIENT_DENY_SUDO_MODE = 0x05,
189 Signals client that sudo mode auth failed.
191 TOCLIENT_INIT_LEGACY = 0x10,
193 Server's reply to TOSERVER_INIT.
194 Sent second after connected.
196 [0] u16 TOSERVER_INIT
197 [2] u8 deployed version
198 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
199 [12] u64 map seed (new as of 2011-02-27)
200 [20] f1000 recommended send interval (in seconds) (new as of 14)
202 NOTE: The position in here is deprecated; position is
203 explicitly sent afterwards
205 TOCLIENT_ACCESS_DENIED = 0x0A,
208 std::string custom reason (if needed, otherwise "")
211 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
212 TOCLIENT_ADDNODE = 0x21,
216 u8 keep_metadata // Added in protocol version 22
218 TOCLIENT_REMOVENODE = 0x22,
220 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
223 // Followed by an arbitary number of these:
224 // Number is determined from packet length.
226 [N+2] v3s32 position*100
227 [N+2+12] v3s32 speed*100
228 [N+2+12+12] s32 pitch*100
229 [N+2+12+12+4] s32 yaw*100
232 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
235 // Followed by an arbitary number of these:
236 // Number is determined from packet length.
241 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
243 TOCLIENT_SECTORMETA = 0x26, // Obsolete
247 [3...] v2s16 pos + sector metadata
250 TOCLIENT_INVENTORY = 0x27,
253 [2] serialized inventory
256 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
260 u16 number of player positions
273 TOCLIENT_TIME_OF_DAY = 0x29,
276 Added in a later version:
280 // (oops, there is some gap here)
282 TOCLIENT_CHAT_MESSAGE = 0x30,
288 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
290 u16 count of removed objects
291 for all removed objects {
294 u16 count of added objects
295 for all added objects {
298 u32 initialization data length
299 string initialization data
303 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
318 TOCLIENT_MOVE_PLAYER = 0x34,
320 v3f1000 player position
325 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
331 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
333 u16 count of player items
334 for all player items {
336 u16 length of serialized item
337 string serialized item
341 TOCLIENT_DEATHSCREEN = 0x37,
343 u8 bool set camera point target
344 v3f1000 camera point target (to point the death cause or whatever)
347 TOCLIENT_MEDIA = 0x38,
349 u16 total number of texture bunches
350 u16 index of this bunch
351 u32 number of files in this bunch
358 u16 length of remote media server url (if applicable)
362 TOCLIENT_TOOLDEF = 0x39,
364 u32 length of the next item
365 serialized ToolDefManager
368 TOCLIENT_NODEDEF = 0x3a,
370 u32 length of the next item
371 serialized NodeDefManager
374 TOCLIENT_CRAFTITEMDEF = 0x3b,
376 u32 length of the next item
377 serialized CraftiItemDefManager
380 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
387 u16 length of sha1_digest
392 TOCLIENT_ITEMDEF = 0x3d,
394 u32 length of next item
395 serialized ItemDefManager
398 TOCLIENT_PLAY_SOUND = 0x3f,
404 u8 type (0=local, 1=positional, 2=object)
405 s32[3] pos_nodes*10000
410 TOCLIENT_STOP_SOUND = 0x40,
415 TOCLIENT_PRIVILEGES = 0x41,
417 u16 number of privileges
423 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
429 TOCLIENT_DETACHED_INVENTORY = 0x43,
434 [2] serialized inventory
437 TOCLIENT_SHOW_FORMSPEC = 0x44,
446 TOCLIENT_MOVEMENT = 0x45,
448 f1000 movement_acceleration_default
449 f1000 movement_acceleration_air
450 f1000 movement_acceleration_fast
451 f1000 movement_speed_walk
452 f1000 movement_speed_crouch
453 f1000 movement_speed_fast
454 f1000 movement_speed_climb
455 f1000 movement_speed_jump
456 f1000 movement_liquid_fluidity
457 f1000 movement_liquid_fluidity_smooth
458 f1000 movement_liquid_sink
459 f1000 movement_gravity
462 TOCLIENT_SPAWN_PARTICLE = 0x46,
469 u8 bool collisiondetection
475 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
489 u8 bool collisiondetection
496 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
501 TOCLIENT_HUDADD = 0x49,
520 TOCLIENT_HUDRM = 0x4a,
525 TOCLIENT_HUDCHANGE = 0x4b,
535 TOCLIENT_HUD_SET_FLAGS = 0x4c,
541 TOCLIENT_HUD_SET_PARAM = 0x4d,
548 TOCLIENT_BREATH = 0x4e,
553 TOCLIENT_SET_SKY = 0x4f,
564 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
566 u8 do_override (boolean)
567 u16 day-night ratio 0...65535
570 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
579 TOCLIENT_EYE_OFFSET = 0x52,
585 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
590 TOCLIENT_SRP_BYTES_S_B = 0x60,
592 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
598 TOCLIENT_NUM_MSG_TYPES = 0x61,
603 TOSERVER_INIT = 0x02,
605 Sent first after connected.
607 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
608 u16 supported network compression modes
609 u16 minimum supported network protocol version
610 u16 maximum supported network protocol version
611 std::string player name
614 TOSERVER_INIT_LEGACY = 0x10,
616 Sent first after connected.
618 [0] u16 TOSERVER_INIT_LEGACY
619 [2] u8 SER_FMT_VER_HIGHEST_READ
620 [3] u8[20] player_name
621 [23] u8[28] password (new in some version)
622 [51] u16 minimum supported network protocol version (added sometime)
623 [53] u16 maximum supported network protocol version (added later than the previous one)
626 TOSERVER_INIT2 = 0x11,
628 Sent as an ACK for TOCLIENT_INIT.
629 After this, the server can send data.
631 [0] u16 TOSERVER_INIT2
634 TOSERVER_GETBLOCK=0x20, // Obsolete
635 TOSERVER_ADDNODE = 0x21, // Obsolete
636 TOSERVER_REMOVENODE = 0x22, // Obsolete
638 TOSERVER_PLAYERPOS = 0x23,
641 [2] v3s32 position*100
642 [2+12] v3s32 speed*100
643 [2+12+12] s32 pitch*100
644 [2+12+12+4] s32 yaw*100
645 [2+12+12+4+4] u32 keyPressed
648 TOSERVER_GOTBLOCKS = 0x24,
657 TOSERVER_DELETEDBLOCKS = 0x25,
666 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
673 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
677 [2] u8 button (0=left, 1=right)
683 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
688 [3] v3s16 nodepos_undersurface
689 [9] v3s16 nodepos_abovesurface
692 0: start digging (from undersurface)
693 1: place block (to abovesurface)
694 2: stop digging (all parameters ignored)
698 TOSERVER_RELEASE = 0x29, // Obsolete
700 // (oops, there is some gap here)
702 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
710 TOSERVER_INVENTORY_ACTION = 0x31,
712 See InventoryAction in inventorymanager.h
715 TOSERVER_CHAT_MESSAGE = 0x32,
721 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
728 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
732 [2] u8 button (0=left, 1=right)
737 TOSERVER_DAMAGE = 0x35,
742 TOSERVER_PASSWORD_LEGACY = 0x36,
744 Sent to change password.
746 [0] u16 TOSERVER_PASSWORD
747 [2] u8[28] old password
748 [30] u8[28] new password
751 TOSERVER_PLAYERITEM = 0x37,
753 Sent to change selected item.
755 [0] u16 TOSERVER_PLAYERITEM
759 TOSERVER_RESPAWN = 0x38,
764 TOSERVER_INTERACT = 0x39,
769 [5] u32 length of the next item
770 [9] serialized PointedThing
772 0: start digging (from undersurface) or use
773 1: stop digging (all parameters ignored)
775 3: place block or item (to abovesurface)
778 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
781 TOSERVER_REMOVED_SOUNDS = 0x3a,
787 TOSERVER_NODEMETA_FIELDS = 0x3b,
791 u8[len] form name (reserved for future use)
800 TOSERVER_INVENTORY_FIELDS = 0x3c,
803 u8[len] form name (reserved for future use)
812 TOSERVER_REQUEST_MEDIA = 0x40,
814 u16 number of files requested
821 TOSERVER_RECEIVED_MEDIA = 0x41,
826 TOSERVER_BREATH = 0x42,
831 TOSERVER_CLIENT_READY = 0x43,
838 u8[len] full_version_string
841 TOSERVER_FIRST_SRP = 0x50,
843 Belonging to AUTH_MECHANISM_FIRST_SRP.
846 std::string srp verification key
847 u8 is_empty (=1 if password is empty, 0 otherwise)
850 TOSERVER_SRP_BYTES_A = 0x51,
852 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
853 depending on current_login_based_on.
856 u8 current_login_based_on : on which version of the password's
857 hash this login is based on (0 legacy hash,
858 or 1 directly the password)
861 TOSERVER_SRP_BYTES_M = 0x52,
863 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
868 TOSERVER_NUM_MSG_TYPES = 0x53,
874 AUTH_MECHANISM_NONE = 0,
876 // SRP based on the legacy hash
877 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
879 // SRP based on the srp verification key
880 AUTH_MECHANISM_SRP = 1 << 1,
882 // Establishes a srp verification key, for first login and password changing
883 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
886 enum AccessDeniedCode {
887 SERVER_ACCESSDENIED_WRONG_PASSWORD,
888 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
889 SERVER_ACCESSDENIED_SINGLEPLAYER,
890 SERVER_ACCESSDENIED_WRONG_VERSION,
891 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
892 SERVER_ACCESSDENIED_WRONG_NAME,
893 SERVER_ACCESSDENIED_TOO_MANY_USERS,
894 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
895 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
896 SERVER_ACCESSDENIED_SERVER_FAIL,
897 SERVER_ACCESSDENIED_CUSTOM_STRING,
898 SERVER_ACCESSDENIED_SHUTDOWN,
899 SERVER_ACCESSDENIED_CRASH,
900 SERVER_ACCESSDENIED_MAX,
903 enum NetProtoCompressionMode {
904 NETPROTO_COMPRESSION_NONE = 0,
907 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
909 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
910 "The server is running in simple singleplayer mode. You cannot connect.",
911 "Your client's version is not supported.\nPlease contact server administrator.",
912 "Player name contains disallowed characters.",
913 "Player name not allowed.",
915 "Empty passwords are disallowed. Set a password and try again.",
916 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
917 "Server authentication failed. This is likely a server error.",
919 "Server shutting down.",
920 "This server has experienced an internal error. You will now be disconnected."