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
197 #define LATEST_PROTOCOL_VERSION 37
198 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
200 // Server's supported network protocol range
201 #define SERVER_PROTOCOL_VERSION_MIN 37
202 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
204 // Client's supported network protocol range
205 // The minimal version depends on whether
206 // send_pre_v25_init is enabled or not
207 #define CLIENT_PROTOCOL_VERSION_MIN 37
208 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
210 // Constant that differentiates the protocol from random data and other protocols
211 #define PROTOCOL_ID 0x4f457403
213 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
214 // base64-encoded SHA-1 (27+\0).
216 #define FORMSPEC_API_VERSION 1
217 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
219 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
221 typedef u16 session_t;
225 TOCLIENT_HELLO = 0x02,
227 Sent after TOSERVER_INIT.
229 u8 deployed serialisation version
230 u16 deployed network compression mode
231 u16 deployed protocol version
232 u32 supported auth methods
233 std::string username that should be used for legacy hash (for proper casing)
235 TOCLIENT_AUTH_ACCEPT = 0x03,
237 Message from server to accept auth.
239 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
241 f1000 recommended send interval
242 u32 : supported auth methods for sudo mode
243 (where the user can change their password)
245 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
247 Sent to client to show it is in sudo mode now.
249 TOCLIENT_DENY_SUDO_MODE = 0x05,
251 Signals client that sudo mode auth failed.
253 TOCLIENT_ACCESS_DENIED = 0x0A,
256 std::string custom reason (if needed, otherwise "")
260 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
262 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
263 TOCLIENT_ADDNODE = 0x21,
267 u8 keep_metadata // Added in protocol version 22
269 TOCLIENT_REMOVENODE = 0x22,
271 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
272 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
273 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
274 TOCLIENT_SECTORMETA = 0x26, // Obsolete
276 TOCLIENT_INVENTORY = 0x27,
279 [2] serialized inventory
282 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
284 TOCLIENT_TIME_OF_DAY = 0x29,
287 Added in a later version:
291 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
293 u32 CSMRestrictionFlags byteflag
296 // (oops, there is some gap here)
298 TOCLIENT_CHAT_MESSAGE = 0x2F,
302 u16 sendername length
308 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
310 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
312 u16 count of removed objects
313 for all removed objects {
316 u16 count of added objects
317 for all added objects {
320 u32 initialization data length
321 string initialization data
325 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
340 TOCLIENT_MOVE_PLAYER = 0x34,
342 v3f1000 player position
347 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
353 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
355 TOCLIENT_DEATHSCREEN = 0x37,
357 u8 bool set camera point target
358 v3f1000 camera point target (to point the death cause or whatever)
361 TOCLIENT_MEDIA = 0x38,
363 u16 total number of texture bunches
364 u16 index of this bunch
365 u32 number of files in this bunch
372 u16 length of remote media server url (if applicable)
376 TOCLIENT_TOOLDEF = 0x39,
378 u32 length of the next item
379 serialized ToolDefManager
382 TOCLIENT_NODEDEF = 0x3a,
384 u32 length of the next item
385 serialized NodeDefManager
388 TOCLIENT_CRAFTITEMDEF = 0x3b,
390 u32 length of the next item
391 serialized CraftiItemDefManager
394 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
401 u16 length of sha1_digest
406 TOCLIENT_ITEMDEF = 0x3d,
408 u32 length of next item
409 serialized ItemDefManager
412 TOCLIENT_PLAY_SOUND = 0x3f,
418 u8 type (0=local, 1=positional, 2=object)
419 s32[3] pos_nodes*10000
424 TOCLIENT_STOP_SOUND = 0x40,
429 TOCLIENT_PRIVILEGES = 0x41,
431 u16 number of privileges
437 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
443 TOCLIENT_DETACHED_INVENTORY = 0x43,
448 [2] serialized inventory
451 TOCLIENT_SHOW_FORMSPEC = 0x44,
460 TOCLIENT_MOVEMENT = 0x45,
462 f1000 movement_acceleration_default
463 f1000 movement_acceleration_air
464 f1000 movement_acceleration_fast
465 f1000 movement_speed_walk
466 f1000 movement_speed_crouch
467 f1000 movement_speed_fast
468 f1000 movement_speed_climb
469 f1000 movement_speed_jump
470 f1000 movement_liquid_fluidity
471 f1000 movement_liquid_fluidity_smooth
472 f1000 movement_liquid_sink
473 f1000 movement_gravity
476 TOCLIENT_SPAWN_PARTICLE = 0x46,
483 u8 bool collisiondetection
488 TileAnimation animation
493 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
507 u8 bool collisiondetection
513 TileAnimation animation
518 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
520 TOCLIENT_HUDADD = 0x49,
539 TOCLIENT_HUDRM = 0x4a,
544 TOCLIENT_HUDCHANGE = 0x4b,
554 TOCLIENT_HUD_SET_FLAGS = 0x4c,
560 TOCLIENT_HUD_SET_PARAM = 0x4d,
567 TOCLIENT_BREATH = 0x4e,
572 TOCLIENT_SET_SKY = 0x4f,
584 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
586 u8 do_override (boolean)
587 u16 day-night ratio 0...65535
590 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
599 TOCLIENT_EYE_OFFSET = 0x52,
605 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
610 TOCLIENT_CLOUD_PARAMS = 0x54,
613 u8[4] color_diffuse (ARGB)
614 u8[4] color_ambient (ARGB)
620 TOCLIENT_FADE_SOUND = 0x55,
626 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
629 u16 number of players
635 TOCLIENT_MODCHANNEL_MSG = 0x57,
637 u16 channel name length
638 std::string channel name
639 u16 channel name sender
640 std::string channel name
645 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
648 u16 channel name length
649 std::string channel name
652 TOCLIENT_NODEMETA_CHANGED = 0x59,
654 serialized and compressed node metadata
657 TOCLIENT_SRP_BYTES_S_B = 0x60,
659 Belonging to AUTH_MECHANISM_SRP.
665 TOCLIENT_FORMSPEC_PREPEND = 0x61,
671 TOCLIENT_NUM_MSG_TYPES = 0x62,
676 TOSERVER_INIT = 0x02,
678 Sent first after connected.
680 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
681 u16 supported network compression modes
682 u16 minimum supported network protocol version
683 u16 maximum supported network protocol version
684 std::string player name
687 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
689 TOSERVER_INIT2 = 0x11,
691 Sent as an ACK for TOCLIENT_INIT.
692 After this, the server can send data.
694 [0] u16 TOSERVER_INIT2
697 TOSERVER_MODCHANNEL_JOIN = 0x17,
699 u16 channel name length
700 std::string channel name
703 TOSERVER_MODCHANNEL_LEAVE = 0x18,
705 u16 channel name length
706 std::string channel name
709 TOSERVER_MODCHANNEL_MSG = 0x19,
711 u16 channel name length
712 std::string channel name
717 TOSERVER_GETBLOCK = 0x20, // Obsolete
718 TOSERVER_ADDNODE = 0x21, // Obsolete
719 TOSERVER_REMOVENODE = 0x22, // Obsolete
721 TOSERVER_PLAYERPOS = 0x23,
724 [2] v3s32 position*100
725 [2+12] v3s32 speed*100
726 [2+12+12] s32 pitch*100
727 [2+12+12+4] s32 yaw*100
728 [2+12+12+4+4] u32 keyPressed
729 [2+12+12+4+4+1] u8 fov*80
730 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
733 TOSERVER_GOTBLOCKS = 0x24,
742 TOSERVER_DELETEDBLOCKS = 0x25,
751 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
752 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
753 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
754 TOSERVER_RELEASE = 0x29, // Obsolete
755 TOSERVER_SIGNTEXT = 0x30, // Obsolete
757 TOSERVER_INVENTORY_ACTION = 0x31,
759 See InventoryAction in inventorymanager.h
762 TOSERVER_CHAT_MESSAGE = 0x32,
768 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
769 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
771 TOSERVER_DAMAGE = 0x35,
776 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
778 TOSERVER_PLAYERITEM = 0x37,
780 Sent to change selected item.
782 [0] u16 TOSERVER_PLAYERITEM
786 TOSERVER_RESPAWN = 0x38,
791 TOSERVER_INTERACT = 0x39,
796 [5] u32 length of the next item
797 [9] serialized PointedThing
799 0: start digging (from undersurface) or use
800 1: stop digging (all parameters ignored)
802 3: place block or item (to abovesurface)
806 TOSERVER_REMOVED_SOUNDS = 0x3a,
812 TOSERVER_NODEMETA_FIELDS = 0x3b,
816 u8[len] form name (reserved for future use)
825 TOSERVER_INVENTORY_FIELDS = 0x3c,
828 u8[len] form name (reserved for future use)
837 TOSERVER_REQUEST_MEDIA = 0x40,
839 u16 number of files requested
846 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
847 TOSERVER_BREATH = 0x42, // Obsolete
849 TOSERVER_CLIENT_READY = 0x43,
856 u8[len] full_version_string
859 TOSERVER_FIRST_SRP = 0x50,
861 Belonging to AUTH_MECHANISM_FIRST_SRP.
864 std::string srp verification key
865 u8 is_empty (=1 if password is empty, 0 otherwise)
868 TOSERVER_SRP_BYTES_A = 0x51,
870 Belonging to AUTH_MECHANISM_SRP,
871 depending on current_login_based_on.
874 u8 current_login_based_on : on which version of the password's
875 hash this login is based on (0 legacy hash,
876 or 1 directly the password)
879 TOSERVER_SRP_BYTES_M = 0x52,
881 Belonging to AUTH_MECHANISM_SRP.
886 TOSERVER_NUM_MSG_TYPES = 0x53,
892 AUTH_MECHANISM_NONE = 0,
894 // SRP based on the legacy hash
895 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
897 // SRP based on the srp verification key
898 AUTH_MECHANISM_SRP = 1 << 1,
900 // Establishes a srp verification key, for first login and password changing
901 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
904 enum AccessDeniedCode {
905 SERVER_ACCESSDENIED_WRONG_PASSWORD,
906 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
907 SERVER_ACCESSDENIED_SINGLEPLAYER,
908 SERVER_ACCESSDENIED_WRONG_VERSION,
909 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
910 SERVER_ACCESSDENIED_WRONG_NAME,
911 SERVER_ACCESSDENIED_TOO_MANY_USERS,
912 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
913 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
914 SERVER_ACCESSDENIED_SERVER_FAIL,
915 SERVER_ACCESSDENIED_CUSTOM_STRING,
916 SERVER_ACCESSDENIED_SHUTDOWN,
917 SERVER_ACCESSDENIED_CRASH,
918 SERVER_ACCESSDENIED_MAX,
921 enum NetProtoCompressionMode {
922 NETPROTO_COMPRESSION_NONE = 0,
925 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
927 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
928 "The server is running in simple singleplayer mode. You cannot connect.",
929 "Your client's version is not supported.\nPlease contact server administrator.",
930 "Player name contains disallowed characters.",
931 "Player name not allowed.",
933 "Empty passwords are disallowed. Set a password and try again.",
934 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
935 "Server authentication failed. This is likely a server error.",
937 "Server shutting down.",
938 "This server has experienced an internal error. You will now be disconnected."
941 enum PlayerListModifer: u8
948 enum CSMRestrictionFlags : u64 {
949 CSM_RF_NONE = 0x00000000,
950 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Disable mods provided by clients
951 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
952 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
953 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
954 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
955 CSM_RF_ALL = 0xFFFFFFFF,