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_FLAVOUR_LIMITS to define which CSM flavour 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
185 #define LATEST_PROTOCOL_VERSION 36
187 // Server's supported network protocol range
188 #define SERVER_PROTOCOL_VERSION_MIN 36
189 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
191 // Client's supported network protocol range
192 // The minimal version depends on whether
193 // send_pre_v25_init is enabled or not
194 #define CLIENT_PROTOCOL_VERSION_MIN 36
195 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
197 // Constant that differentiates the protocol from random data and other protocols
198 #define PROTOCOL_ID 0x4f457403
200 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
201 // base64-encoded SHA-1 (27+\0).
203 #define FORMSPEC_API_VERSION 1
204 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
206 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
210 TOCLIENT_HELLO = 0x02,
212 Sent after TOSERVER_INIT.
214 u8 deployed serialisation version
215 u16 deployed network compression mode
216 u16 deployed protocol version
217 u32 supported auth methods
218 std::string username that should be used for legacy hash (for proper casing)
220 TOCLIENT_AUTH_ACCEPT = 0x03,
222 Message from server to accept auth.
224 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
226 f1000 recommended send interval
227 u32 : supported auth methods for sudo mode
228 (where the user can change their password)
230 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
232 Sent to client to show it is in sudo mode now.
234 TOCLIENT_DENY_SUDO_MODE = 0x05,
236 Signals client that sudo mode auth failed.
238 TOCLIENT_ACCESS_DENIED = 0x0A,
241 std::string custom reason (if needed, otherwise "")
245 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
247 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
248 TOCLIENT_ADDNODE = 0x21,
252 u8 keep_metadata // Added in protocol version 22
254 TOCLIENT_REMOVENODE = 0x22,
256 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
257 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
258 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
259 TOCLIENT_SECTORMETA = 0x26, // Obsolete
261 TOCLIENT_INVENTORY = 0x27,
264 [2] serialized inventory
267 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
269 TOCLIENT_TIME_OF_DAY = 0x29,
272 Added in a later version:
276 TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
278 u32 CSMFlavourLimits byteflag
281 // (oops, there is some gap here)
283 TOCLIENT_CHAT_MESSAGE = 0x2F,
287 u16 sendername length
293 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
295 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
297 u16 count of removed objects
298 for all removed objects {
301 u16 count of added objects
302 for all added objects {
305 u32 initialization data length
306 string initialization data
310 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
325 TOCLIENT_MOVE_PLAYER = 0x34,
327 v3f1000 player position
332 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
338 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
340 TOCLIENT_DEATHSCREEN = 0x37,
342 u8 bool set camera point target
343 v3f1000 camera point target (to point the death cause or whatever)
346 TOCLIENT_MEDIA = 0x38,
348 u16 total number of texture bunches
349 u16 index of this bunch
350 u32 number of files in this bunch
357 u16 length of remote media server url (if applicable)
361 TOCLIENT_TOOLDEF = 0x39,
363 u32 length of the next item
364 serialized ToolDefManager
367 TOCLIENT_NODEDEF = 0x3a,
369 u32 length of the next item
370 serialized NodeDefManager
373 TOCLIENT_CRAFTITEMDEF = 0x3b,
375 u32 length of the next item
376 serialized CraftiItemDefManager
379 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
386 u16 length of sha1_digest
391 TOCLIENT_ITEMDEF = 0x3d,
393 u32 length of next item
394 serialized ItemDefManager
397 TOCLIENT_PLAY_SOUND = 0x3f,
403 u8 type (0=local, 1=positional, 2=object)
404 s32[3] pos_nodes*10000
409 TOCLIENT_STOP_SOUND = 0x40,
414 TOCLIENT_PRIVILEGES = 0x41,
416 u16 number of privileges
422 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
428 TOCLIENT_DETACHED_INVENTORY = 0x43,
433 [2] serialized inventory
436 TOCLIENT_SHOW_FORMSPEC = 0x44,
445 TOCLIENT_MOVEMENT = 0x45,
447 f1000 movement_acceleration_default
448 f1000 movement_acceleration_air
449 f1000 movement_acceleration_fast
450 f1000 movement_speed_walk
451 f1000 movement_speed_crouch
452 f1000 movement_speed_fast
453 f1000 movement_speed_climb
454 f1000 movement_speed_jump
455 f1000 movement_liquid_fluidity
456 f1000 movement_liquid_fluidity_smooth
457 f1000 movement_liquid_sink
458 f1000 movement_gravity
461 TOCLIENT_SPAWN_PARTICLE = 0x46,
468 u8 bool collisiondetection
475 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
489 u8 bool collisiondetection
497 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
499 TOCLIENT_HUDADD = 0x49,
518 TOCLIENT_HUDRM = 0x4a,
523 TOCLIENT_HUDCHANGE = 0x4b,
533 TOCLIENT_HUD_SET_FLAGS = 0x4c,
539 TOCLIENT_HUD_SET_PARAM = 0x4d,
546 TOCLIENT_BREATH = 0x4e,
551 TOCLIENT_SET_SKY = 0x4f,
563 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
565 u8 do_override (boolean)
566 u16 day-night ratio 0...65535
569 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
578 TOCLIENT_EYE_OFFSET = 0x52,
584 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
589 TOCLIENT_CLOUD_PARAMS = 0x54,
592 u8[4] color_diffuse (ARGB)
593 u8[4] color_ambient (ARGB)
599 TOCLIENT_FADE_SOUND = 0x55,
605 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
608 u16 number of players
614 TOCLIENT_SRP_BYTES_S_B = 0x60,
616 Belonging to AUTH_MECHANISM_SRP.
622 TOCLIENT_NUM_MSG_TYPES = 0x61,
627 TOSERVER_INIT = 0x02,
629 Sent first after connected.
631 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
632 u16 supported network compression modes
633 u16 minimum supported network protocol version
634 u16 maximum supported network protocol version
635 std::string player name
638 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
640 TOSERVER_INIT2 = 0x11,
642 Sent as an ACK for TOCLIENT_INIT.
643 After this, the server can send data.
645 [0] u16 TOSERVER_INIT2
648 TOSERVER_GETBLOCK = 0x20, // Obsolete
649 TOSERVER_ADDNODE = 0x21, // Obsolete
650 TOSERVER_REMOVENODE = 0x22, // Obsolete
652 TOSERVER_PLAYERPOS = 0x23,
655 [2] v3s32 position*100
656 [2+12] v3s32 speed*100
657 [2+12+12] s32 pitch*100
658 [2+12+12+4] s32 yaw*100
659 [2+12+12+4+4] u32 keyPressed
660 [2+12+12+4+4+1] u8 fov*80
661 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
664 TOSERVER_GOTBLOCKS = 0x24,
673 TOSERVER_DELETEDBLOCKS = 0x25,
682 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
683 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
684 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
685 TOSERVER_RELEASE = 0x29, // Obsolete
686 TOSERVER_SIGNTEXT = 0x30, // Obsolete
688 TOSERVER_INVENTORY_ACTION = 0x31,
690 See InventoryAction in inventorymanager.h
693 TOSERVER_CHAT_MESSAGE = 0x32,
699 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
700 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
702 TOSERVER_DAMAGE = 0x35,
707 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
709 TOSERVER_PLAYERITEM = 0x37,
711 Sent to change selected item.
713 [0] u16 TOSERVER_PLAYERITEM
717 TOSERVER_RESPAWN = 0x38,
722 TOSERVER_INTERACT = 0x39,
727 [5] u32 length of the next item
728 [9] serialized PointedThing
730 0: start digging (from undersurface) or use
731 1: stop digging (all parameters ignored)
733 3: place block or item (to abovesurface)
737 TOSERVER_REMOVED_SOUNDS = 0x3a,
743 TOSERVER_NODEMETA_FIELDS = 0x3b,
747 u8[len] form name (reserved for future use)
756 TOSERVER_INVENTORY_FIELDS = 0x3c,
759 u8[len] form name (reserved for future use)
768 TOSERVER_REQUEST_MEDIA = 0x40,
770 u16 number of files requested
777 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
778 TOSERVER_BREATH = 0x42, // Obsolete
780 TOSERVER_CLIENT_READY = 0x43,
787 u8[len] full_version_string
790 TOSERVER_FIRST_SRP = 0x50,
792 Belonging to AUTH_MECHANISM_FIRST_SRP.
795 std::string srp verification key
796 u8 is_empty (=1 if password is empty, 0 otherwise)
799 TOSERVER_SRP_BYTES_A = 0x51,
801 Belonging to AUTH_MECHANISM_SRP,
802 depending on current_login_based_on.
805 u8 current_login_based_on : on which version of the password's
806 hash this login is based on (0 legacy hash,
807 or 1 directly the password)
810 TOSERVER_SRP_BYTES_M = 0x52,
812 Belonging to AUTH_MECHANISM_SRP.
817 TOSERVER_NUM_MSG_TYPES = 0x53,
823 AUTH_MECHANISM_NONE = 0,
825 // SRP based on the legacy hash
826 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
828 // SRP based on the srp verification key
829 AUTH_MECHANISM_SRP = 1 << 1,
831 // Establishes a srp verification key, for first login and password changing
832 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
835 enum AccessDeniedCode {
836 SERVER_ACCESSDENIED_WRONG_PASSWORD,
837 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
838 SERVER_ACCESSDENIED_SINGLEPLAYER,
839 SERVER_ACCESSDENIED_WRONG_VERSION,
840 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
841 SERVER_ACCESSDENIED_WRONG_NAME,
842 SERVER_ACCESSDENIED_TOO_MANY_USERS,
843 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
844 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
845 SERVER_ACCESSDENIED_SERVER_FAIL,
846 SERVER_ACCESSDENIED_CUSTOM_STRING,
847 SERVER_ACCESSDENIED_SHUTDOWN,
848 SERVER_ACCESSDENIED_CRASH,
849 SERVER_ACCESSDENIED_MAX,
852 enum NetProtoCompressionMode {
853 NETPROTO_COMPRESSION_NONE = 0,
856 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
858 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
859 "The server is running in simple singleplayer mode. You cannot connect.",
860 "Your client's version is not supported.\nPlease contact server administrator.",
861 "Player name contains disallowed characters.",
862 "Player name not allowed.",
864 "Empty passwords are disallowed. Set a password and try again.",
865 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
866 "Server authentication failed. This is likely a server error.",
868 "Server shutting down.",
869 "This server has experienced an internal error. You will now be disconnected."
872 enum PlayerListModifer: u8
879 enum CSMFlavourLimit : u64 {
880 CSM_FL_NONE = 0x00000000,
881 CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
882 CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
883 CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
884 CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
885 CSM_FL_ALL = 0xFFFFFFFF,