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
134 #define LATEST_PROTOCOL_VERSION 24
136 // Server's supported network protocol range
137 #define SERVER_PROTOCOL_VERSION_MIN 13
138 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
140 // Client's supported network protocol range
141 #define CLIENT_PROTOCOL_VERSION_MIN 13
142 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
144 // Constant that differentiates the protocol from random data and other protocols
145 #define PROTOCOL_ID 0x4f457403
147 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
148 // base64-encoded SHA-1 (27+\0).
150 #define FORMSPEC_API_VERSION 1
151 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
153 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
157 TOCLIENT_HELLO = 0x02,
159 Sent after TOSERVER_INIT.
162 u32 supported auth methods
163 std::string username that should be used for legacy hash (for proper casing)
165 TOCLIENT_AUTH_ACCEPT = 0x03,
167 Message from server to accept auth.
169 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
171 f1000 recommended send interval
172 u32 : supported auth methods for sudo mode
173 (where the user can change their password)
175 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
177 Sent to client to show it is in sudo mode now.
179 TOCLIENT_DENY_SUDO_MODE = 0x05,
181 Signals client that sudo mode auth failed.
183 TOCLIENT_INIT_LEGACY = 0x10,
185 Server's reply to TOSERVER_INIT.
186 Sent second after connected.
188 [0] u16 TOSERVER_INIT
189 [2] u8 deployed version
190 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
191 [12] u64 map seed (new as of 2011-02-27)
192 [20] f1000 recommended send interval (in seconds) (new as of 14)
194 NOTE: The position in here is deprecated; position is
195 explicitly sent afterwards
197 TOCLIENT_ACCESS_DENIED = 0x0A,
200 std::string custom reason (if reason == SERVER_ACCESSDENIED_CUSTOM_STRING)
202 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
203 TOCLIENT_ADDNODE = 0x21,
208 u8 keep_metadata // Added in protocol version 22
210 TOCLIENT_REMOVENODE = 0x22,
212 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
215 // Followed by an arbitary number of these:
216 // Number is determined from packet length.
218 [N+2] v3s32 position*100
219 [N+2+12] v3s32 speed*100
220 [N+2+12+12] s32 pitch*100
221 [N+2+12+12+4] s32 yaw*100
224 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
227 // Followed by an arbitary number of these:
228 // Number is determined from packet length.
233 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
235 TOCLIENT_SECTORMETA = 0x26, // Obsolete
239 [3...] v2s16 pos + sector metadata
242 TOCLIENT_INVENTORY = 0x27,
245 [2] serialized inventory
248 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
253 u16 number of player positions
266 TOCLIENT_TIME_OF_DAY = 0x29,
270 Added in a later version:
274 // (oops, there is some gap here)
276 TOCLIENT_CHAT_MESSAGE = 0x30,
283 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
286 u16 count of removed objects
287 for all removed objects {
290 u16 count of added objects
291 for all added objects {
294 u32 initialization data length
295 string initialization data
299 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
316 TOCLIENT_MOVE_PLAYER = 0x34,
319 v3f1000 player position
324 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
331 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
334 u16 count of player items
335 for all player items {
337 u16 length of serialized item
338 string serialized item
342 TOCLIENT_DEATHSCREEN = 0x37,
345 u8 bool set camera point target
346 v3f1000 camera point target (to point the death cause or whatever)
349 TOCLIENT_MEDIA = 0x38,
352 u16 total number of texture bunches
353 u16 index of this bunch
354 u32 number of files in this bunch
361 u16 length of remote media server url (if applicable)
365 TOCLIENT_TOOLDEF = 0x39,
368 u32 length of the next item
369 serialized ToolDefManager
372 TOCLIENT_NODEDEF = 0x3a,
375 u32 length of the next item
376 serialized NodeDefManager
379 TOCLIENT_CRAFTITEMDEF = 0x3b,
382 u32 length of the next item
383 serialized CraftiItemDefManager
386 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
394 u16 length of sha1_digest
399 TOCLIENT_ITEMDEF = 0x3d,
402 u32 length of next item
403 serialized ItemDefManager
406 TOCLIENT_PLAY_SOUND = 0x3f,
413 u8 type (0=local, 1=positional, 2=object)
414 s32[3] pos_nodes*10000
419 TOCLIENT_STOP_SOUND = 0x40,
425 TOCLIENT_PRIVILEGES = 0x41,
428 u16 number of privileges
434 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
441 TOCLIENT_DETACHED_INVENTORY = 0x43,
446 [2] serialized inventory
449 TOCLIENT_SHOW_FORMSPEC = 0x44,
458 TOCLIENT_MOVEMENT = 0x45,
461 f1000 movement_acceleration_default
462 f1000 movement_acceleration_air
463 f1000 movement_acceleration_fast
464 f1000 movement_speed_walk
465 f1000 movement_speed_crouch
466 f1000 movement_speed_fast
467 f1000 movement_speed_climb
468 f1000 movement_speed_jump
469 f1000 movement_liquid_fluidity
470 f1000 movement_liquid_fluidity_smooth
471 f1000 movement_liquid_sink
472 f1000 movement_gravity
475 TOCLIENT_SPAWN_PARTICLE = 0x46,
483 u8 bool collisiondetection
489 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
504 u8 bool collisiondetection
511 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
517 TOCLIENT_HUDADD = 0x49,
537 TOCLIENT_HUDRM = 0x4a,
543 TOCLIENT_HUDCHANGE = 0x4b,
554 TOCLIENT_HUD_SET_FLAGS = 0x4c,
561 TOCLIENT_HUD_SET_PARAM = 0x4d,
569 TOCLIENT_BREATH = 0x4e,
575 TOCLIENT_SET_SKY = 0x4f,
587 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
590 u8 do_override (boolean)
591 u16 day-night ratio 0...65535
594 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
604 TOCLIENT_EYE_OFFSET = 0x52,
611 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
617 TOCLIENT_SRP_BYTES_S_B = 0x60,
619 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
626 TOCLIENT_NUM_MSG_TYPES = 0x61,
631 TOSERVER_INIT = 0x02,
633 Sent first after connected.
635 [2] u8 SER_FMT_VER_HIGHEST_READ
636 [3] u8 compression_modes
637 [4] u16 minimum supported network protocol version
638 [6] u16 maximum supported network protocol version
639 [8] std::string player name
642 TOSERVER_INIT_LEGACY = 0x10,
644 Sent first after connected.
646 [0] u16 TOSERVER_INIT_LEGACY
647 [2] u8 SER_FMT_VER_HIGHEST_READ
648 [3] u8[20] player_name
649 [23] u8[28] password (new in some version)
650 [51] u16 minimum supported network protocol version (added sometime)
651 [53] u16 maximum supported network protocol version (added later than the previous one)
654 TOSERVER_INIT2 = 0x11,
656 Sent as an ACK for TOCLIENT_INIT.
657 After this, the server can send data.
659 [0] u16 TOSERVER_INIT2
662 TOSERVER_GETBLOCK=0x20, // Obsolete
663 TOSERVER_ADDNODE = 0x21, // Obsolete
664 TOSERVER_REMOVENODE = 0x22, // Obsolete
666 TOSERVER_PLAYERPOS = 0x23,
669 [2] v3s32 position*100
670 [2+12] v3s32 speed*100
671 [2+12+12] s32 pitch*100
672 [2+12+12+4] s32 yaw*100
673 [2+12+12+4+4] u32 keyPressed
676 TOSERVER_GOTBLOCKS = 0x24,
685 TOSERVER_DELETEDBLOCKS = 0x25,
694 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
701 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
705 [2] u8 button (0=left, 1=right)
711 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
716 [3] v3s16 nodepos_undersurface
717 [9] v3s16 nodepos_abovesurface
720 0: start digging (from undersurface)
721 1: place block (to abovesurface)
722 2: stop digging (all parameters ignored)
726 TOSERVER_RELEASE = 0x29, // Obsolete
728 // (oops, there is some gap here)
730 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
739 TOSERVER_INVENTORY_ACTION = 0x31,
741 See InventoryAction in inventorymanager.h
744 TOSERVER_CHAT_MESSAGE = 0x32,
751 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
759 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
763 [2] u8 button (0=left, 1=right)
768 TOSERVER_DAMAGE = 0x35,
774 TOSERVER_PASSWORD_LEGACY = 0x36,
776 Sent to change password.
778 [0] u16 TOSERVER_PASSWORD
779 [2] u8[28] old password
780 [30] u8[28] new password
783 TOSERVER_PLAYERITEM = 0x37,
785 Sent to change selected item.
787 [0] u16 TOSERVER_PLAYERITEM
791 TOSERVER_RESPAWN = 0x38,
796 TOSERVER_INTERACT = 0x39,
801 [5] u32 length of the next item
802 [9] serialized PointedThing
804 0: start digging (from undersurface) or use
805 1: stop digging (all parameters ignored)
807 3: place block or item (to abovesurface)
810 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
813 TOSERVER_REMOVED_SOUNDS = 0x3a,
820 TOSERVER_NODEMETA_FIELDS = 0x3b,
825 u8[len] form name (reserved for future use)
834 TOSERVER_INVENTORY_FIELDS = 0x3c,
838 u8[len] form name (reserved for future use)
847 TOSERVER_REQUEST_MEDIA = 0x40,
850 u16 number of files requested
857 TOSERVER_RECEIVED_MEDIA = 0x41,
862 TOSERVER_BREATH = 0x42,
868 TOSERVER_CLIENT_READY = 0x43,
875 u8[len] full_version_string
878 TOSERVER_FIRST_SRP = 0x50,
880 Belonging to AUTH_MECHANISM_FIRST_SRP.
883 std::string srp verification key
884 u8 is_empty (=1 if password is empty, 0 otherwise)
887 TOSERVER_SRP_BYTES_A = 0x51,
889 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
890 depending on current_login_based_on.
893 u8 current_login_based_on : on which version of the password's
894 hash this login is based on (0 legacy hash,
895 or 1 directly the password)
898 TOSERVER_SRP_BYTES_M = 0x52,
900 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
905 TOSERVER_NUM_MSG_TYPES = 0x53,
911 AUTH_MECHANISM_NONE = 0,
913 // SRP based on the legacy hash
914 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
916 // SRP based on the srp verification key
917 AUTH_MECHANISM_SRP = 1 << 1,
919 // Establishes a srp verification key, for first login and password changing
920 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
923 enum AccessDeniedCode {
924 SERVER_ACCESSDENIED_WRONG_PASSWORD,
925 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
926 SERVER_ACCESSDENIED_SINGLEPLAYER,
927 SERVER_ACCESSDENIED_WRONG_VERSION,
928 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
929 SERVER_ACCESSDENIED_WRONG_NAME,
930 SERVER_ACCESSDENIED_TOO_MANY_USERS,
931 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
932 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
933 SERVER_ACCESSDENIED_SERVER_FAIL,
934 SERVER_ACCESSDENIED_CUSTOM_STRING,
935 SERVER_ACCESSDENIED_MAX,
938 enum NetProtoCompressionMode {
939 NETPROTO_COMPRESSION_ZLIB = 0,
942 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
944 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
945 "The server is running in simple singleplayer mode. You cannot connect.",
946 "Your client's version is not supported.\nPlease contact server administrator.",
947 "Player name contains disallowed characters.",
948 "Player name not allowed.",
950 "Empty passwords are disallowed. Set a password and try again.",
951 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
952 "Server authention failed. This is likely a server error."