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
135 #define LATEST_PROTOCOL_VERSION 25
137 // Server's supported network protocol range
138 #define SERVER_PROTOCOL_VERSION_MIN 13
139 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
141 // Client's supported network protocol range
142 #define CLIENT_PROTOCOL_VERSION_MIN 13
143 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
145 // Constant that differentiates the protocol from random data and other protocols
146 #define PROTOCOL_ID 0x4f457403
148 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
149 // base64-encoded SHA-1 (27+\0).
151 #define FORMSPEC_API_VERSION 1
152 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
154 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
158 TOCLIENT_HELLO = 0x02,
160 Sent after TOSERVER_INIT.
162 u8 deployed serialisation version
163 u16 deployed network compression mode
164 u16 deployed protocol version
165 u32 supported auth methods
166 std::string username that should be used for legacy hash (for proper casing)
168 TOCLIENT_AUTH_ACCEPT = 0x03,
170 Message from server to accept auth.
172 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
174 f1000 recommended send interval
175 u32 : supported auth methods for sudo mode
176 (where the user can change their password)
178 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
180 Sent to client to show it is in sudo mode now.
182 TOCLIENT_DENY_SUDO_MODE = 0x05,
184 Signals client that sudo mode auth failed.
186 TOCLIENT_INIT_LEGACY = 0x10,
188 Server's reply to TOSERVER_INIT.
189 Sent second after connected.
191 [0] u16 TOSERVER_INIT
192 [2] u8 deployed version
193 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
194 [12] u64 map seed (new as of 2011-02-27)
195 [20] f1000 recommended send interval (in seconds) (new as of 14)
197 NOTE: The position in here is deprecated; position is
198 explicitly sent afterwards
200 TOCLIENT_ACCESS_DENIED = 0x0A,
203 std::string custom reason (if reason == SERVER_ACCESSDENIED_CUSTOM_STRING)
205 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
206 TOCLIENT_ADDNODE = 0x21,
211 u8 keep_metadata // Added in protocol version 22
213 TOCLIENT_REMOVENODE = 0x22,
215 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
218 // Followed by an arbitary number of these:
219 // Number is determined from packet length.
221 [N+2] v3s32 position*100
222 [N+2+12] v3s32 speed*100
223 [N+2+12+12] s32 pitch*100
224 [N+2+12+12+4] s32 yaw*100
227 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
230 // Followed by an arbitary number of these:
231 // Number is determined from packet length.
236 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
238 TOCLIENT_SECTORMETA = 0x26, // Obsolete
242 [3...] v2s16 pos + sector metadata
245 TOCLIENT_INVENTORY = 0x27,
248 [2] serialized inventory
251 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
256 u16 number of player positions
269 TOCLIENT_TIME_OF_DAY = 0x29,
273 Added in a later version:
277 // (oops, there is some gap here)
279 TOCLIENT_CHAT_MESSAGE = 0x30,
286 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
289 u16 count of removed objects
290 for all removed objects {
293 u16 count of added objects
294 for all added objects {
297 u32 initialization data length
298 string initialization data
302 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
319 TOCLIENT_MOVE_PLAYER = 0x34,
322 v3f1000 player position
327 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
334 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
337 u16 count of player items
338 for all player items {
340 u16 length of serialized item
341 string serialized item
345 TOCLIENT_DEATHSCREEN = 0x37,
348 u8 bool set camera point target
349 v3f1000 camera point target (to point the death cause or whatever)
352 TOCLIENT_MEDIA = 0x38,
355 u16 total number of texture bunches
356 u16 index of this bunch
357 u32 number of files in this bunch
364 u16 length of remote media server url (if applicable)
368 TOCLIENT_TOOLDEF = 0x39,
371 u32 length of the next item
372 serialized ToolDefManager
375 TOCLIENT_NODEDEF = 0x3a,
378 u32 length of the next item
379 serialized NodeDefManager
382 TOCLIENT_CRAFTITEMDEF = 0x3b,
385 u32 length of the next item
386 serialized CraftiItemDefManager
389 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
397 u16 length of sha1_digest
402 TOCLIENT_ITEMDEF = 0x3d,
405 u32 length of next item
406 serialized ItemDefManager
409 TOCLIENT_PLAY_SOUND = 0x3f,
416 u8 type (0=local, 1=positional, 2=object)
417 s32[3] pos_nodes*10000
422 TOCLIENT_STOP_SOUND = 0x40,
428 TOCLIENT_PRIVILEGES = 0x41,
431 u16 number of privileges
437 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
444 TOCLIENT_DETACHED_INVENTORY = 0x43,
449 [2] serialized inventory
452 TOCLIENT_SHOW_FORMSPEC = 0x44,
461 TOCLIENT_MOVEMENT = 0x45,
464 f1000 movement_acceleration_default
465 f1000 movement_acceleration_air
466 f1000 movement_acceleration_fast
467 f1000 movement_speed_walk
468 f1000 movement_speed_crouch
469 f1000 movement_speed_fast
470 f1000 movement_speed_climb
471 f1000 movement_speed_jump
472 f1000 movement_liquid_fluidity
473 f1000 movement_liquid_fluidity_smooth
474 f1000 movement_liquid_sink
475 f1000 movement_gravity
478 TOCLIENT_SPAWN_PARTICLE = 0x46,
486 u8 bool collisiondetection
492 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
507 u8 bool collisiondetection
514 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
520 TOCLIENT_HUDADD = 0x49,
540 TOCLIENT_HUDRM = 0x4a,
546 TOCLIENT_HUDCHANGE = 0x4b,
557 TOCLIENT_HUD_SET_FLAGS = 0x4c,
564 TOCLIENT_HUD_SET_PARAM = 0x4d,
572 TOCLIENT_BREATH = 0x4e,
578 TOCLIENT_SET_SKY = 0x4f,
590 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
593 u8 do_override (boolean)
594 u16 day-night ratio 0...65535
597 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
607 TOCLIENT_EYE_OFFSET = 0x52,
614 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
620 TOCLIENT_SRP_BYTES_S_B = 0x60,
622 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
629 TOCLIENT_NUM_MSG_TYPES = 0x61,
634 TOSERVER_INIT = 0x02,
636 Sent first after connected.
638 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
639 u16 supported network compression modes
640 u16 minimum supported network protocol version
641 u16 maximum supported network protocol version
642 std::string player name
645 TOSERVER_INIT_LEGACY = 0x10,
647 Sent first after connected.
649 [0] u16 TOSERVER_INIT_LEGACY
650 [2] u8 SER_FMT_VER_HIGHEST_READ
651 [3] u8[20] player_name
652 [23] u8[28] password (new in some version)
653 [51] u16 minimum supported network protocol version (added sometime)
654 [53] u16 maximum supported network protocol version (added later than the previous one)
657 TOSERVER_INIT2 = 0x11,
659 Sent as an ACK for TOCLIENT_INIT.
660 After this, the server can send data.
662 [0] u16 TOSERVER_INIT2
665 TOSERVER_GETBLOCK=0x20, // Obsolete
666 TOSERVER_ADDNODE = 0x21, // Obsolete
667 TOSERVER_REMOVENODE = 0x22, // Obsolete
669 TOSERVER_PLAYERPOS = 0x23,
672 [2] v3s32 position*100
673 [2+12] v3s32 speed*100
674 [2+12+12] s32 pitch*100
675 [2+12+12+4] s32 yaw*100
676 [2+12+12+4+4] u32 keyPressed
679 TOSERVER_GOTBLOCKS = 0x24,
688 TOSERVER_DELETEDBLOCKS = 0x25,
697 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
704 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
708 [2] u8 button (0=left, 1=right)
714 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
719 [3] v3s16 nodepos_undersurface
720 [9] v3s16 nodepos_abovesurface
723 0: start digging (from undersurface)
724 1: place block (to abovesurface)
725 2: stop digging (all parameters ignored)
729 TOSERVER_RELEASE = 0x29, // Obsolete
731 // (oops, there is some gap here)
733 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
742 TOSERVER_INVENTORY_ACTION = 0x31,
744 See InventoryAction in inventorymanager.h
747 TOSERVER_CHAT_MESSAGE = 0x32,
754 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
762 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
766 [2] u8 button (0=left, 1=right)
771 TOSERVER_DAMAGE = 0x35,
777 TOSERVER_PASSWORD_LEGACY = 0x36,
779 Sent to change password.
781 [0] u16 TOSERVER_PASSWORD
782 [2] u8[28] old password
783 [30] u8[28] new password
786 TOSERVER_PLAYERITEM = 0x37,
788 Sent to change selected item.
790 [0] u16 TOSERVER_PLAYERITEM
794 TOSERVER_RESPAWN = 0x38,
799 TOSERVER_INTERACT = 0x39,
804 [5] u32 length of the next item
805 [9] serialized PointedThing
807 0: start digging (from undersurface) or use
808 1: stop digging (all parameters ignored)
810 3: place block or item (to abovesurface)
813 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
816 TOSERVER_REMOVED_SOUNDS = 0x3a,
823 TOSERVER_NODEMETA_FIELDS = 0x3b,
828 u8[len] form name (reserved for future use)
837 TOSERVER_INVENTORY_FIELDS = 0x3c,
841 u8[len] form name (reserved for future use)
850 TOSERVER_REQUEST_MEDIA = 0x40,
853 u16 number of files requested
860 TOSERVER_RECEIVED_MEDIA = 0x41,
865 TOSERVER_BREATH = 0x42,
871 TOSERVER_CLIENT_READY = 0x43,
878 u8[len] full_version_string
881 TOSERVER_FIRST_SRP = 0x50,
883 Belonging to AUTH_MECHANISM_FIRST_SRP.
886 std::string srp verification key
887 u8 is_empty (=1 if password is empty, 0 otherwise)
890 TOSERVER_SRP_BYTES_A = 0x51,
892 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
893 depending on current_login_based_on.
896 u8 current_login_based_on : on which version of the password's
897 hash this login is based on (0 legacy hash,
898 or 1 directly the password)
901 TOSERVER_SRP_BYTES_M = 0x52,
903 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
908 TOSERVER_NUM_MSG_TYPES = 0x53,
914 AUTH_MECHANISM_NONE = 0,
916 // SRP based on the legacy hash
917 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
919 // SRP based on the srp verification key
920 AUTH_MECHANISM_SRP = 1 << 1,
922 // Establishes a srp verification key, for first login and password changing
923 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
926 enum AccessDeniedCode {
927 SERVER_ACCESSDENIED_WRONG_PASSWORD,
928 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
929 SERVER_ACCESSDENIED_SINGLEPLAYER,
930 SERVER_ACCESSDENIED_WRONG_VERSION,
931 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
932 SERVER_ACCESSDENIED_WRONG_NAME,
933 SERVER_ACCESSDENIED_TOO_MANY_USERS,
934 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
935 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
936 SERVER_ACCESSDENIED_SERVER_FAIL,
937 SERVER_ACCESSDENIED_CUSTOM_STRING,
938 SERVER_ACCESSDENIED_MAX,
941 enum NetProtoCompressionMode {
942 NETPROTO_COMPRESSION_NONE = 0,
945 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
947 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
948 "The server is running in simple singleplayer mode. You cannot connect.",
949 "Your client's version is not supported.\nPlease contact server administrator.",
950 "Player name contains disallowed characters.",
951 "Player name not allowed.",
953 "Empty passwords are disallowed. Set a password and try again.",
954 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
955 "Server authention failed. This is likely a server error."