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
194 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
196 // Server's supported network protocol range
197 #define SERVER_PROTOCOL_VERSION_MIN 36
198 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
200 // Client's supported network protocol range
201 // The minimal version depends on whether
202 // send_pre_v25_init is enabled or not
203 #define CLIENT_PROTOCOL_VERSION_MIN 36
204 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
206 // Constant that differentiates the protocol from random data and other protocols
207 #define PROTOCOL_ID 0x4f457403
209 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
210 // base64-encoded SHA-1 (27+\0).
212 #define FORMSPEC_API_VERSION 1
213 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
215 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
217 typedef u16 session_t;
221 TOCLIENT_HELLO = 0x02,
223 Sent after TOSERVER_INIT.
225 u8 deployed serialisation version
226 u16 deployed network compression mode
227 u16 deployed protocol version
228 u32 supported auth methods
229 std::string username that should be used for legacy hash (for proper casing)
231 TOCLIENT_AUTH_ACCEPT = 0x03,
233 Message from server to accept auth.
235 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
237 f1000 recommended send interval
238 u32 : supported auth methods for sudo mode
239 (where the user can change their password)
241 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
243 Sent to client to show it is in sudo mode now.
245 TOCLIENT_DENY_SUDO_MODE = 0x05,
247 Signals client that sudo mode auth failed.
249 TOCLIENT_ACCESS_DENIED = 0x0A,
252 std::string custom reason (if needed, otherwise "")
256 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
258 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
259 TOCLIENT_ADDNODE = 0x21,
263 u8 keep_metadata // Added in protocol version 22
265 TOCLIENT_REMOVENODE = 0x22,
267 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
268 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
269 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
270 TOCLIENT_SECTORMETA = 0x26, // Obsolete
272 TOCLIENT_INVENTORY = 0x27,
275 [2] serialized inventory
278 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
280 TOCLIENT_TIME_OF_DAY = 0x29,
283 Added in a later version:
287 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
289 u32 CSMRestrictionFlags byteflag
292 // (oops, there is some gap here)
294 TOCLIENT_CHAT_MESSAGE = 0x2F,
298 u16 sendername length
304 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
306 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
308 u16 count of removed objects
309 for all removed objects {
312 u16 count of added objects
313 for all added objects {
316 u32 initialization data length
317 string initialization data
321 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
336 TOCLIENT_MOVE_PLAYER = 0x34,
338 v3f1000 player position
343 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
349 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
351 TOCLIENT_DEATHSCREEN = 0x37,
353 u8 bool set camera point target
354 v3f1000 camera point target (to point the death cause or whatever)
357 TOCLIENT_MEDIA = 0x38,
359 u16 total number of texture bunches
360 u16 index of this bunch
361 u32 number of files in this bunch
368 u16 length of remote media server url (if applicable)
372 TOCLIENT_TOOLDEF = 0x39,
374 u32 length of the next item
375 serialized ToolDefManager
378 TOCLIENT_NODEDEF = 0x3a,
380 u32 length of the next item
381 serialized NodeDefManager
384 TOCLIENT_CRAFTITEMDEF = 0x3b,
386 u32 length of the next item
387 serialized CraftiItemDefManager
390 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
397 u16 length of sha1_digest
402 TOCLIENT_ITEMDEF = 0x3d,
404 u32 length of next item
405 serialized ItemDefManager
408 TOCLIENT_PLAY_SOUND = 0x3f,
414 u8 type (0=local, 1=positional, 2=object)
415 s32[3] pos_nodes*10000
420 TOCLIENT_STOP_SOUND = 0x40,
425 TOCLIENT_PRIVILEGES = 0x41,
427 u16 number of privileges
433 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
439 TOCLIENT_DETACHED_INVENTORY = 0x43,
444 [2] serialized inventory
447 TOCLIENT_SHOW_FORMSPEC = 0x44,
456 TOCLIENT_MOVEMENT = 0x45,
458 f1000 movement_acceleration_default
459 f1000 movement_acceleration_air
460 f1000 movement_acceleration_fast
461 f1000 movement_speed_walk
462 f1000 movement_speed_crouch
463 f1000 movement_speed_fast
464 f1000 movement_speed_climb
465 f1000 movement_speed_jump
466 f1000 movement_liquid_fluidity
467 f1000 movement_liquid_fluidity_smooth
468 f1000 movement_liquid_sink
469 f1000 movement_gravity
472 TOCLIENT_SPAWN_PARTICLE = 0x46,
479 u8 bool collisiondetection
484 TileAnimation animation
489 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
503 u8 bool collisiondetection
509 TileAnimation animation
514 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
516 TOCLIENT_HUDADD = 0x49,
535 TOCLIENT_HUDRM = 0x4a,
540 TOCLIENT_HUDCHANGE = 0x4b,
550 TOCLIENT_HUD_SET_FLAGS = 0x4c,
556 TOCLIENT_HUD_SET_PARAM = 0x4d,
563 TOCLIENT_BREATH = 0x4e,
568 TOCLIENT_SET_SKY = 0x4f,
580 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
582 u8 do_override (boolean)
583 u16 day-night ratio 0...65535
586 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
595 TOCLIENT_EYE_OFFSET = 0x52,
601 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
606 TOCLIENT_CLOUD_PARAMS = 0x54,
609 u8[4] color_diffuse (ARGB)
610 u8[4] color_ambient (ARGB)
616 TOCLIENT_FADE_SOUND = 0x55,
622 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
625 u16 number of players
631 TOCLIENT_MODCHANNEL_MSG = 0x57,
633 u16 channel name length
634 std::string channel name
635 u16 channel name sender
636 std::string channel name
640 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
643 u16 channel name length
644 std::string channel name
647 TOCLIENT_SRP_BYTES_S_B = 0x60,
649 Belonging to AUTH_MECHANISM_SRP.
655 TOCLIENT_FORMSPEC_PREPEND = 0x61,
661 TOCLIENT_NUM_MSG_TYPES = 0x62,
666 TOSERVER_INIT = 0x02,
668 Sent first after connected.
670 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
671 u16 supported network compression modes
672 u16 minimum supported network protocol version
673 u16 maximum supported network protocol version
674 std::string player name
677 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
679 TOSERVER_INIT2 = 0x11,
681 Sent as an ACK for TOCLIENT_INIT.
682 After this, the server can send data.
684 [0] u16 TOSERVER_INIT2
687 TOSERVER_MODCHANNEL_JOIN = 0x17,
689 u16 channel name length
690 std::string channel name
693 TOSERVER_MODCHANNEL_LEAVE = 0x18,
695 u16 channel name length
696 std::string channel name
699 TOSERVER_MODCHANNEL_MSG = 0x19,
701 u16 channel name length
702 std::string channel name
707 TOSERVER_GETBLOCK = 0x20, // Obsolete
708 TOSERVER_ADDNODE = 0x21, // Obsolete
709 TOSERVER_REMOVENODE = 0x22, // Obsolete
711 TOSERVER_PLAYERPOS = 0x23,
714 [2] v3s32 position*100
715 [2+12] v3s32 speed*100
716 [2+12+12] s32 pitch*100
717 [2+12+12+4] s32 yaw*100
718 [2+12+12+4+4] u32 keyPressed
719 [2+12+12+4+4+1] u8 fov*80
720 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
723 TOSERVER_GOTBLOCKS = 0x24,
732 TOSERVER_DELETEDBLOCKS = 0x25,
741 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
742 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
743 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
744 TOSERVER_RELEASE = 0x29, // Obsolete
745 TOSERVER_SIGNTEXT = 0x30, // Obsolete
747 TOSERVER_INVENTORY_ACTION = 0x31,
749 See InventoryAction in inventorymanager.h
752 TOSERVER_CHAT_MESSAGE = 0x32,
758 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
759 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
761 TOSERVER_DAMAGE = 0x35,
766 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
768 TOSERVER_PLAYERITEM = 0x37,
770 Sent to change selected item.
772 [0] u16 TOSERVER_PLAYERITEM
776 TOSERVER_RESPAWN = 0x38,
781 TOSERVER_INTERACT = 0x39,
786 [5] u32 length of the next item
787 [9] serialized PointedThing
789 0: start digging (from undersurface) or use
790 1: stop digging (all parameters ignored)
792 3: place block or item (to abovesurface)
796 TOSERVER_REMOVED_SOUNDS = 0x3a,
802 TOSERVER_NODEMETA_FIELDS = 0x3b,
806 u8[len] form name (reserved for future use)
815 TOSERVER_INVENTORY_FIELDS = 0x3c,
818 u8[len] form name (reserved for future use)
827 TOSERVER_REQUEST_MEDIA = 0x40,
829 u16 number of files requested
836 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
837 TOSERVER_BREATH = 0x42, // Obsolete
839 TOSERVER_CLIENT_READY = 0x43,
846 u8[len] full_version_string
849 TOSERVER_FIRST_SRP = 0x50,
851 Belonging to AUTH_MECHANISM_FIRST_SRP.
854 std::string srp verification key
855 u8 is_empty (=1 if password is empty, 0 otherwise)
858 TOSERVER_SRP_BYTES_A = 0x51,
860 Belonging to AUTH_MECHANISM_SRP,
861 depending on current_login_based_on.
864 u8 current_login_based_on : on which version of the password's
865 hash this login is based on (0 legacy hash,
866 or 1 directly the password)
869 TOSERVER_SRP_BYTES_M = 0x52,
871 Belonging to AUTH_MECHANISM_SRP.
876 TOSERVER_NUM_MSG_TYPES = 0x53,
882 AUTH_MECHANISM_NONE = 0,
884 // SRP based on the legacy hash
885 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
887 // SRP based on the srp verification key
888 AUTH_MECHANISM_SRP = 1 << 1,
890 // Establishes a srp verification key, for first login and password changing
891 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
894 enum AccessDeniedCode {
895 SERVER_ACCESSDENIED_WRONG_PASSWORD,
896 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
897 SERVER_ACCESSDENIED_SINGLEPLAYER,
898 SERVER_ACCESSDENIED_WRONG_VERSION,
899 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
900 SERVER_ACCESSDENIED_WRONG_NAME,
901 SERVER_ACCESSDENIED_TOO_MANY_USERS,
902 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
903 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
904 SERVER_ACCESSDENIED_SERVER_FAIL,
905 SERVER_ACCESSDENIED_CUSTOM_STRING,
906 SERVER_ACCESSDENIED_SHUTDOWN,
907 SERVER_ACCESSDENIED_CRASH,
908 SERVER_ACCESSDENIED_MAX,
911 enum NetProtoCompressionMode {
912 NETPROTO_COMPRESSION_NONE = 0,
915 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
917 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
918 "The server is running in simple singleplayer mode. You cannot connect.",
919 "Your client's version is not supported.\nPlease contact server administrator.",
920 "Player name contains disallowed characters.",
921 "Player name not allowed.",
923 "Empty passwords are disallowed. Set a password and try again.",
924 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
925 "Server authentication failed. This is likely a server error.",
927 "Server shutting down.",
928 "This server has experienced an internal error. You will now be disconnected."
931 enum PlayerListModifer: u8
938 enum CSMRestrictionFlags : u64 {
939 CSM_RF_NONE = 0x00000000,
940 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Disable mods provided by clients
941 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
942 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
943 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
944 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
945 CSM_RF_ALL = 0xFFFFFFFF,