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.
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
159 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
160 instead of guessing based on the active object list.
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
170 * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
172 Add TOCLIENT_CSM_RESTRICTION_FLAGS to define which CSM features should be
174 Add settable player collisionbox. Breaks compatibility with older
175 clients as a 1-node vertical offset has been removed from player's
177 Add settable player stepheight using existing object property.
178 Breaks compatibility with older clients.
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.
186 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
189 Add disconnected nodeboxes
190 Add TOCLIENT_FORMSPEC_PREPEND
193 #define LATEST_PROTOCOL_VERSION 36
195 // Server's supported network protocol range
196 #define SERVER_PROTOCOL_VERSION_MIN 36
197 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
199 // Client's supported network protocol range
200 // The minimal version depends on whether
201 // send_pre_v25_init is enabled or not
202 #define CLIENT_PROTOCOL_VERSION_MIN 36
203 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
205 // Constant that differentiates the protocol from random data and other protocols
206 #define PROTOCOL_ID 0x4f457403
208 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
209 // base64-encoded SHA-1 (27+\0).
211 #define FORMSPEC_API_VERSION 1
212 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
214 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
216 typedef u16 session_t;
220 TOCLIENT_HELLO = 0x02,
222 Sent after TOSERVER_INIT.
224 u8 deployed serialisation version
225 u16 deployed network compression mode
226 u16 deployed protocol version
227 u32 supported auth methods
228 std::string username that should be used for legacy hash (for proper casing)
230 TOCLIENT_AUTH_ACCEPT = 0x03,
232 Message from server to accept auth.
234 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
236 f1000 recommended send interval
237 u32 : supported auth methods for sudo mode
238 (where the user can change their password)
240 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
242 Sent to client to show it is in sudo mode now.
244 TOCLIENT_DENY_SUDO_MODE = 0x05,
246 Signals client that sudo mode auth failed.
248 TOCLIENT_ACCESS_DENIED = 0x0A,
251 std::string custom reason (if needed, otherwise "")
255 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
257 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
258 TOCLIENT_ADDNODE = 0x21,
262 u8 keep_metadata // Added in protocol version 22
264 TOCLIENT_REMOVENODE = 0x22,
266 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
267 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
268 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
269 TOCLIENT_SECTORMETA = 0x26, // Obsolete
271 TOCLIENT_INVENTORY = 0x27,
274 [2] serialized inventory
277 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
279 TOCLIENT_TIME_OF_DAY = 0x29,
282 Added in a later version:
286 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
288 u32 CSMRestrictionFlags byteflag
291 // (oops, there is some gap here)
293 TOCLIENT_CHAT_MESSAGE = 0x2F,
297 u16 sendername length
303 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
305 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
307 u16 count of removed objects
308 for all removed objects {
311 u16 count of added objects
312 for all added objects {
315 u32 initialization data length
316 string initialization data
320 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
335 TOCLIENT_MOVE_PLAYER = 0x34,
337 v3f1000 player position
342 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
348 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
350 TOCLIENT_DEATHSCREEN = 0x37,
352 u8 bool set camera point target
353 v3f1000 camera point target (to point the death cause or whatever)
356 TOCLIENT_MEDIA = 0x38,
358 u16 total number of texture bunches
359 u16 index of this bunch
360 u32 number of files in this bunch
367 u16 length of remote media server url (if applicable)
371 TOCLIENT_TOOLDEF = 0x39,
373 u32 length of the next item
374 serialized ToolDefManager
377 TOCLIENT_NODEDEF = 0x3a,
379 u32 length of the next item
380 serialized NodeDefManager
383 TOCLIENT_CRAFTITEMDEF = 0x3b,
385 u32 length of the next item
386 serialized CraftiItemDefManager
389 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
396 u16 length of sha1_digest
401 TOCLIENT_ITEMDEF = 0x3d,
403 u32 length of next item
404 serialized ItemDefManager
407 TOCLIENT_PLAY_SOUND = 0x3f,
413 u8 type (0=local, 1=positional, 2=object)
414 s32[3] pos_nodes*10000
419 TOCLIENT_STOP_SOUND = 0x40,
424 TOCLIENT_PRIVILEGES = 0x41,
426 u16 number of privileges
432 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
438 TOCLIENT_DETACHED_INVENTORY = 0x43,
443 [2] serialized inventory
446 TOCLIENT_SHOW_FORMSPEC = 0x44,
455 TOCLIENT_MOVEMENT = 0x45,
457 f1000 movement_acceleration_default
458 f1000 movement_acceleration_air
459 f1000 movement_acceleration_fast
460 f1000 movement_speed_walk
461 f1000 movement_speed_crouch
462 f1000 movement_speed_fast
463 f1000 movement_speed_climb
464 f1000 movement_speed_jump
465 f1000 movement_liquid_fluidity
466 f1000 movement_liquid_fluidity_smooth
467 f1000 movement_liquid_sink
468 f1000 movement_gravity
471 TOCLIENT_SPAWN_PARTICLE = 0x46,
478 u8 bool collisiondetection
485 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
499 u8 bool collisiondetection
507 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
509 TOCLIENT_HUDADD = 0x49,
528 TOCLIENT_HUDRM = 0x4a,
533 TOCLIENT_HUDCHANGE = 0x4b,
543 TOCLIENT_HUD_SET_FLAGS = 0x4c,
549 TOCLIENT_HUD_SET_PARAM = 0x4d,
556 TOCLIENT_BREATH = 0x4e,
561 TOCLIENT_SET_SKY = 0x4f,
573 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
575 u8 do_override (boolean)
576 u16 day-night ratio 0...65535
579 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
588 TOCLIENT_EYE_OFFSET = 0x52,
594 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
599 TOCLIENT_CLOUD_PARAMS = 0x54,
602 u8[4] color_diffuse (ARGB)
603 u8[4] color_ambient (ARGB)
609 TOCLIENT_FADE_SOUND = 0x55,
615 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
618 u16 number of players
624 TOCLIENT_MODCHANNEL_MSG = 0x57,
626 u16 channel name length
627 std::string channel name
628 u16 channel name sender
629 std::string channel name
633 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
636 u16 channel name length
637 std::string channel name
640 TOCLIENT_SRP_BYTES_S_B = 0x60,
642 Belonging to AUTH_MECHANISM_SRP.
648 TOCLIENT_FORMSPEC_PREPEND = 0x61,
654 TOCLIENT_NUM_MSG_TYPES = 0x62,
659 TOSERVER_INIT = 0x02,
661 Sent first after connected.
663 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
664 u16 supported network compression modes
665 u16 minimum supported network protocol version
666 u16 maximum supported network protocol version
667 std::string player name
670 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
672 TOSERVER_INIT2 = 0x11,
674 Sent as an ACK for TOCLIENT_INIT.
675 After this, the server can send data.
677 [0] u16 TOSERVER_INIT2
680 TOSERVER_MODCHANNEL_JOIN = 0x17,
682 u16 channel name length
683 std::string channel name
686 TOSERVER_MODCHANNEL_LEAVE = 0x18,
688 u16 channel name length
689 std::string channel name
692 TOSERVER_MODCHANNEL_MSG = 0x19,
694 u16 channel name length
695 std::string channel name
700 TOSERVER_GETBLOCK = 0x20, // Obsolete
701 TOSERVER_ADDNODE = 0x21, // Obsolete
702 TOSERVER_REMOVENODE = 0x22, // Obsolete
704 TOSERVER_PLAYERPOS = 0x23,
707 [2] v3s32 position*100
708 [2+12] v3s32 speed*100
709 [2+12+12] s32 pitch*100
710 [2+12+12+4] s32 yaw*100
711 [2+12+12+4+4] u32 keyPressed
712 [2+12+12+4+4+1] u8 fov*80
713 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
716 TOSERVER_GOTBLOCKS = 0x24,
725 TOSERVER_DELETEDBLOCKS = 0x25,
734 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
735 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
736 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
737 TOSERVER_RELEASE = 0x29, // Obsolete
738 TOSERVER_SIGNTEXT = 0x30, // Obsolete
740 TOSERVER_INVENTORY_ACTION = 0x31,
742 See InventoryAction in inventorymanager.h
745 TOSERVER_CHAT_MESSAGE = 0x32,
751 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
752 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
754 TOSERVER_DAMAGE = 0x35,
759 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
761 TOSERVER_PLAYERITEM = 0x37,
763 Sent to change selected item.
765 [0] u16 TOSERVER_PLAYERITEM
769 TOSERVER_RESPAWN = 0x38,
774 TOSERVER_INTERACT = 0x39,
779 [5] u32 length of the next item
780 [9] serialized PointedThing
782 0: start digging (from undersurface) or use
783 1: stop digging (all parameters ignored)
785 3: place block or item (to abovesurface)
789 TOSERVER_REMOVED_SOUNDS = 0x3a,
795 TOSERVER_NODEMETA_FIELDS = 0x3b,
799 u8[len] form name (reserved for future use)
808 TOSERVER_INVENTORY_FIELDS = 0x3c,
811 u8[len] form name (reserved for future use)
820 TOSERVER_REQUEST_MEDIA = 0x40,
822 u16 number of files requested
829 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
830 TOSERVER_BREATH = 0x42, // Obsolete
832 TOSERVER_CLIENT_READY = 0x43,
839 u8[len] full_version_string
842 TOSERVER_FIRST_SRP = 0x50,
844 Belonging to AUTH_MECHANISM_FIRST_SRP.
847 std::string srp verification key
848 u8 is_empty (=1 if password is empty, 0 otherwise)
851 TOSERVER_SRP_BYTES_A = 0x51,
853 Belonging to AUTH_MECHANISM_SRP,
854 depending on current_login_based_on.
857 u8 current_login_based_on : on which version of the password's
858 hash this login is based on (0 legacy hash,
859 or 1 directly the password)
862 TOSERVER_SRP_BYTES_M = 0x52,
864 Belonging to AUTH_MECHANISM_SRP.
869 TOSERVER_NUM_MSG_TYPES = 0x53,
875 AUTH_MECHANISM_NONE = 0,
877 // SRP based on the legacy hash
878 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
880 // SRP based on the srp verification key
881 AUTH_MECHANISM_SRP = 1 << 1,
883 // Establishes a srp verification key, for first login and password changing
884 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
887 enum AccessDeniedCode {
888 SERVER_ACCESSDENIED_WRONG_PASSWORD,
889 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
890 SERVER_ACCESSDENIED_SINGLEPLAYER,
891 SERVER_ACCESSDENIED_WRONG_VERSION,
892 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
893 SERVER_ACCESSDENIED_WRONG_NAME,
894 SERVER_ACCESSDENIED_TOO_MANY_USERS,
895 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
896 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
897 SERVER_ACCESSDENIED_SERVER_FAIL,
898 SERVER_ACCESSDENIED_CUSTOM_STRING,
899 SERVER_ACCESSDENIED_SHUTDOWN,
900 SERVER_ACCESSDENIED_CRASH,
901 SERVER_ACCESSDENIED_MAX,
904 enum NetProtoCompressionMode {
905 NETPROTO_COMPRESSION_NONE = 0,
908 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
910 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
911 "The server is running in simple singleplayer mode. You cannot connect.",
912 "Your client's version is not supported.\nPlease contact server administrator.",
913 "Player name contains disallowed characters.",
914 "Player name not allowed.",
916 "Empty passwords are disallowed. Set a password and try again.",
917 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
918 "Server authentication failed. This is likely a server error.",
920 "Server shutting down.",
921 "This server has experienced an internal error. You will now be disconnected."
924 enum PlayerListModifer: u8
931 enum CSMRestrictionFlags : u64 {
932 CSM_RF_NONE = 0x00000000,
933 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Disable mods provided by clients
934 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
935 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
936 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
937 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
938 CSM_RF_ALL = 0xFFFFFFFF,