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
192 Redo detached inventory sending
193 Add TOCLIENT_NODEMETA_CHANGED
194 New network float format
195 ContentFeatures version 13
196 Add full Euler rotations instead of just yaw
197 Add TOCLIENT_PLAYER_SPEED
199 Incremental inventory sending mode
200 Unknown inventory serialization fields no longer throw an error
201 Mod-specific formspec version
202 Player FOV override API
203 "ephemeral" added to TOCLIENT_PLAY_SOUND
206 #define LATEST_PROTOCOL_VERSION 38
207 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
209 // Server's supported network protocol range
210 #define SERVER_PROTOCOL_VERSION_MIN 37
211 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
213 // Client's supported network protocol range
214 // The minimal version depends on whether
215 // send_pre_v25_init is enabled or not
216 #define CLIENT_PROTOCOL_VERSION_MIN 37
217 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
219 // Constant that differentiates the protocol from random data and other protocols
220 #define PROTOCOL_ID 0x4f457403
222 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
223 // base64-encoded SHA-1 (27+\0).
226 Changes by FORMSPEC_API_VERSION:
231 Forced real coordinates
232 background9[]: 9-slice scaling parameters
234 Formspec elements are drawn in the order of definition
235 bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
236 box[] and image[] elements enable clipping by default
238 #define FORMSPEC_API_VERSION 3
240 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
242 typedef u16 session_t;
246 TOCLIENT_HELLO = 0x02,
248 Sent after TOSERVER_INIT.
250 u8 deployed serialisation version
251 u16 deployed network compression mode
252 u16 deployed protocol version
253 u32 supported auth methods
254 std::string username that should be used for legacy hash (for proper casing)
256 TOCLIENT_AUTH_ACCEPT = 0x03,
258 Message from server to accept auth.
260 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
262 f1000 recommended send interval
263 u32 : supported auth methods for sudo mode
264 (where the user can change their password)
266 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
268 Sent to client to show it is in sudo mode now.
270 TOCLIENT_DENY_SUDO_MODE = 0x05,
272 Signals client that sudo mode auth failed.
274 TOCLIENT_ACCESS_DENIED = 0x0A,
277 std::string custom reason (if needed, otherwise "")
281 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
283 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
284 TOCLIENT_ADDNODE = 0x21,
288 u8 keep_metadata // Added in protocol version 22
290 TOCLIENT_REMOVENODE = 0x22,
292 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
293 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
294 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
295 TOCLIENT_SECTORMETA = 0x26, // Obsolete
297 TOCLIENT_INVENTORY = 0x27,
300 [2] serialized inventory
303 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
305 TOCLIENT_TIME_OF_DAY = 0x29,
308 Added in a later version:
312 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
314 u32 CSMRestrictionFlags byteflag
317 TOCLIENT_PLAYER_SPEED = 0x2B,
322 // (oops, there is some gap here)
324 TOCLIENT_CHAT_MESSAGE = 0x2F,
328 u16 sendername length
334 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
336 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
338 u16 count of removed objects
339 for all removed objects {
342 u16 count of added objects
343 for all added objects {
346 u32 initialization data length
347 string initialization data
351 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
366 TOCLIENT_MOVE_PLAYER = 0x34,
368 v3f1000 player position
373 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
381 Sends an FOV override/multiplier to client.
387 TOCLIENT_DEATHSCREEN = 0x37,
389 u8 bool set camera point target
390 v3f1000 camera point target (to point the death cause or whatever)
393 TOCLIENT_MEDIA = 0x38,
395 u16 total number of texture bunches
396 u16 index of this bunch
397 u32 number of files in this bunch
404 u16 length of remote media server url (if applicable)
408 TOCLIENT_TOOLDEF = 0x39,
410 u32 length of the next item
411 serialized ToolDefManager
414 TOCLIENT_NODEDEF = 0x3a,
416 u32 length of the next item
417 serialized NodeDefManager
420 TOCLIENT_CRAFTITEMDEF = 0x3b,
422 u32 length of the next item
423 serialized CraftiItemDefManager
426 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
433 u16 length of sha1_digest
438 TOCLIENT_ITEMDEF = 0x3d,
440 u32 length of next item
441 serialized ItemDefManager
444 TOCLIENT_PLAY_SOUND = 0x3f,
450 u8 type (0=local, 1=positional, 2=object)
451 s32[3] pos_nodes*10000
457 TOCLIENT_STOP_SOUND = 0x40,
462 TOCLIENT_PRIVILEGES = 0x41,
464 u16 number of privileges
470 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
476 TOCLIENT_DETACHED_INVENTORY = 0x43,
481 [2] serialized inventory
484 TOCLIENT_SHOW_FORMSPEC = 0x44,
493 TOCLIENT_MOVEMENT = 0x45,
495 f1000 movement_acceleration_default
496 f1000 movement_acceleration_air
497 f1000 movement_acceleration_fast
498 f1000 movement_speed_walk
499 f1000 movement_speed_crouch
500 f1000 movement_speed_fast
501 f1000 movement_speed_climb
502 f1000 movement_speed_jump
503 f1000 movement_liquid_fluidity
504 f1000 movement_liquid_fluidity_smooth
505 f1000 movement_liquid_sink
506 f1000 movement_gravity
509 TOCLIENT_SPAWN_PARTICLE = 0x46,
516 u8 bool collisiondetection
521 TileAnimation animation
526 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
540 u8 bool collisiondetection
546 TileAnimation animation
551 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
553 TOCLIENT_HUDADD = 0x49,
573 TOCLIENT_HUDRM = 0x4a,
578 TOCLIENT_HUDCHANGE = 0x4b,
588 TOCLIENT_HUD_SET_FLAGS = 0x4c,
594 TOCLIENT_HUD_SET_PARAM = 0x4d,
601 TOCLIENT_BREATH = 0x4e,
606 TOCLIENT_SET_SKY = 0x4f,
618 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
620 u8 do_override (boolean)
621 u16 day-night ratio 0...65535
624 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
633 TOCLIENT_EYE_OFFSET = 0x52,
639 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
644 TOCLIENT_CLOUD_PARAMS = 0x54,
647 u8[4] color_diffuse (ARGB)
648 u8[4] color_ambient (ARGB)
654 TOCLIENT_FADE_SOUND = 0x55,
660 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
663 u16 number of players
669 TOCLIENT_MODCHANNEL_MSG = 0x57,
671 u16 channel name length
672 std::string channel name
673 u16 channel name sender
674 std::string channel name
679 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
682 u16 channel name length
683 std::string channel name
686 TOCLIENT_NODEMETA_CHANGED = 0x59,
688 serialized and compressed node metadata
691 TOCLIENT_SRP_BYTES_S_B = 0x60,
693 Belonging to AUTH_MECHANISM_SRP.
699 TOCLIENT_FORMSPEC_PREPEND = 0x61,
705 TOCLIENT_NUM_MSG_TYPES = 0x62,
710 TOSERVER_INIT = 0x02,
712 Sent first after connected.
714 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
715 u16 supported network compression modes
716 u16 minimum supported network protocol version
717 u16 maximum supported network protocol version
718 std::string player name
721 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
723 TOSERVER_INIT2 = 0x11,
725 Sent as an ACK for TOCLIENT_INIT.
726 After this, the server can send data.
728 [0] u16 TOSERVER_INIT2
731 TOSERVER_MODCHANNEL_JOIN = 0x17,
733 u16 channel name length
734 std::string channel name
737 TOSERVER_MODCHANNEL_LEAVE = 0x18,
739 u16 channel name length
740 std::string channel name
743 TOSERVER_MODCHANNEL_MSG = 0x19,
745 u16 channel name length
746 std::string channel name
751 TOSERVER_GETBLOCK = 0x20, // Obsolete
752 TOSERVER_ADDNODE = 0x21, // Obsolete
753 TOSERVER_REMOVENODE = 0x22, // Obsolete
755 TOSERVER_PLAYERPOS = 0x23,
758 [2] v3s32 position*100
759 [2+12] v3s32 speed*100
760 [2+12+12] s32 pitch*100
761 [2+12+12+4] s32 yaw*100
762 [2+12+12+4+4] u32 keyPressed
763 [2+12+12+4+4+1] u8 fov*80
764 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
767 TOSERVER_GOTBLOCKS = 0x24,
776 TOSERVER_DELETEDBLOCKS = 0x25,
785 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
786 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
787 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
788 TOSERVER_RELEASE = 0x29, // Obsolete
789 TOSERVER_SIGNTEXT = 0x30, // Obsolete
791 TOSERVER_INVENTORY_ACTION = 0x31,
793 See InventoryAction in inventorymanager.h
796 TOSERVER_CHAT_MESSAGE = 0x32,
802 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
803 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
805 TOSERVER_DAMAGE = 0x35,
810 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
812 TOSERVER_PLAYERITEM = 0x37,
814 Sent to change selected item.
816 [0] u16 TOSERVER_PLAYERITEM
820 TOSERVER_RESPAWN = 0x38,
825 TOSERVER_INTERACT = 0x39,
830 [5] u32 length of the next item
831 [9] serialized PointedThing
833 0: start digging (from undersurface) or use
834 1: stop digging (all parameters ignored)
836 3: place block or item (to abovesurface)
840 TOSERVER_REMOVED_SOUNDS = 0x3a,
846 TOSERVER_NODEMETA_FIELDS = 0x3b,
850 u8[len] form name (reserved for future use)
859 TOSERVER_INVENTORY_FIELDS = 0x3c,
862 u8[len] form name (reserved for future use)
871 TOSERVER_REQUEST_MEDIA = 0x40,
873 u16 number of files requested
880 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
881 TOSERVER_BREATH = 0x42, // Obsolete
883 TOSERVER_CLIENT_READY = 0x43,
890 u8[len] full_version_string
893 TOSERVER_FIRST_SRP = 0x50,
895 Belonging to AUTH_MECHANISM_FIRST_SRP.
898 std::string srp verification key
899 u8 is_empty (=1 if password is empty, 0 otherwise)
902 TOSERVER_SRP_BYTES_A = 0x51,
904 Belonging to AUTH_MECHANISM_SRP,
905 depending on current_login_based_on.
908 u8 current_login_based_on : on which version of the password's
909 hash this login is based on (0 legacy hash,
910 or 1 directly the password)
913 TOSERVER_SRP_BYTES_M = 0x52,
915 Belonging to AUTH_MECHANISM_SRP.
920 TOSERVER_NUM_MSG_TYPES = 0x53,
926 AUTH_MECHANISM_NONE = 0,
928 // SRP based on the legacy hash
929 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
931 // SRP based on the srp verification key
932 AUTH_MECHANISM_SRP = 1 << 1,
934 // Establishes a srp verification key, for first login and password changing
935 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
938 enum AccessDeniedCode {
939 SERVER_ACCESSDENIED_WRONG_PASSWORD,
940 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
941 SERVER_ACCESSDENIED_SINGLEPLAYER,
942 SERVER_ACCESSDENIED_WRONG_VERSION,
943 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
944 SERVER_ACCESSDENIED_WRONG_NAME,
945 SERVER_ACCESSDENIED_TOO_MANY_USERS,
946 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
947 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
948 SERVER_ACCESSDENIED_SERVER_FAIL,
949 SERVER_ACCESSDENIED_CUSTOM_STRING,
950 SERVER_ACCESSDENIED_SHUTDOWN,
951 SERVER_ACCESSDENIED_CRASH,
952 SERVER_ACCESSDENIED_MAX,
955 enum NetProtoCompressionMode {
956 NETPROTO_COMPRESSION_NONE = 0,
959 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
961 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
962 "The server is running in simple singleplayer mode. You cannot connect.",
963 "Your client's version is not supported.\nPlease contact server administrator.",
964 "Player name contains disallowed characters.",
965 "Player name not allowed.",
967 "Empty passwords are disallowed. Set a password and try again.",
968 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
969 "Server authentication failed. This is likely a server error.",
971 "Server shutting down.",
972 "This server has experienced an internal error. You will now be disconnected."
975 enum PlayerListModifer: u8
982 enum CSMRestrictionFlags : u64 {
983 CSM_RF_NONE = 0x00000000,
984 // Until server-sent CSM and verifying of builtin are complete,
985 // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
986 // When those are complete, this should return to only being a restriction on the
987 // loading of client mods.
988 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
989 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
990 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
991 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
992 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
993 CSM_RF_READ_PLAYERINFO = 0x00000020, // Disable player info lookups
994 CSM_RF_ALL = 0xFFFFFFFF,
997 enum InteractAction : u8
999 INTERACT_START_DIGGING, // 0: start digging (from undersurface) or use
1000 INTERACT_STOP_DIGGING, // 1: stop digging (all parameters ignored)
1001 INTERACT_DIGGING_COMPLETED, // 2: digging completed
1002 INTERACT_PLACE, // 3: place block or item (to abovesurface)
1003 INTERACT_USE, // 4: use item
1004 INTERACT_ACTIVATE // 5: rightclick air ("activate")