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
184 #define LATEST_PROTOCOL_VERSION 36
186 // Server's supported network protocol range
187 #define SERVER_PROTOCOL_VERSION_MIN 36
188 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
190 // Client's supported network protocol range
191 // The minimal version depends on whether
192 // send_pre_v25_init is enabled or not
193 #define CLIENT_PROTOCOL_VERSION_MIN 36
194 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
196 // Constant that differentiates the protocol from random data and other protocols
197 #define PROTOCOL_ID 0x4f457403
199 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
200 // base64-encoded SHA-1 (27+\0).
202 #define FORMSPEC_API_VERSION 1
203 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
205 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
209 TOCLIENT_HELLO = 0x02,
211 Sent after TOSERVER_INIT.
213 u8 deployed serialisation version
214 u16 deployed network compression mode
215 u16 deployed protocol version
216 u32 supported auth methods
217 std::string username that should be used for legacy hash (for proper casing)
219 TOCLIENT_AUTH_ACCEPT = 0x03,
221 Message from server to accept auth.
223 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
225 f1000 recommended send interval
226 u32 : supported auth methods for sudo mode
227 (where the user can change their password)
229 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
231 Sent to client to show it is in sudo mode now.
233 TOCLIENT_DENY_SUDO_MODE = 0x05,
235 Signals client that sudo mode auth failed.
237 TOCLIENT_ACCESS_DENIED = 0x0A,
240 std::string custom reason (if needed, otherwise "")
244 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
246 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
247 TOCLIENT_ADDNODE = 0x21,
251 u8 keep_metadata // Added in protocol version 22
253 TOCLIENT_REMOVENODE = 0x22,
255 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
256 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
257 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
258 TOCLIENT_SECTORMETA = 0x26, // Obsolete
260 TOCLIENT_INVENTORY = 0x27,
263 [2] serialized inventory
266 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
268 TOCLIENT_TIME_OF_DAY = 0x29,
271 Added in a later version:
275 TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
277 u32 CSMFlavourLimits byteflag
280 // (oops, there is some gap here)
282 TOCLIENT_CHAT_MESSAGE = 0x2F,
286 u16 sendername length
292 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
294 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
296 u16 count of removed objects
297 for all removed objects {
300 u16 count of added objects
301 for all added objects {
304 u32 initialization data length
305 string initialization data
309 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
324 TOCLIENT_MOVE_PLAYER = 0x34,
326 v3f1000 player position
331 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
337 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
339 TOCLIENT_DEATHSCREEN = 0x37,
341 u8 bool set camera point target
342 v3f1000 camera point target (to point the death cause or whatever)
345 TOCLIENT_MEDIA = 0x38,
347 u16 total number of texture bunches
348 u16 index of this bunch
349 u32 number of files in this bunch
356 u16 length of remote media server url (if applicable)
360 TOCLIENT_TOOLDEF = 0x39,
362 u32 length of the next item
363 serialized ToolDefManager
366 TOCLIENT_NODEDEF = 0x3a,
368 u32 length of the next item
369 serialized NodeDefManager
372 TOCLIENT_CRAFTITEMDEF = 0x3b,
374 u32 length of the next item
375 serialized CraftiItemDefManager
378 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
385 u16 length of sha1_digest
390 TOCLIENT_ITEMDEF = 0x3d,
392 u32 length of next item
393 serialized ItemDefManager
396 TOCLIENT_PLAY_SOUND = 0x3f,
402 u8 type (0=local, 1=positional, 2=object)
403 s32[3] pos_nodes*10000
408 TOCLIENT_STOP_SOUND = 0x40,
413 TOCLIENT_PRIVILEGES = 0x41,
415 u16 number of privileges
421 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
427 TOCLIENT_DETACHED_INVENTORY = 0x43,
432 [2] serialized inventory
435 TOCLIENT_SHOW_FORMSPEC = 0x44,
444 TOCLIENT_MOVEMENT = 0x45,
446 f1000 movement_acceleration_default
447 f1000 movement_acceleration_air
448 f1000 movement_acceleration_fast
449 f1000 movement_speed_walk
450 f1000 movement_speed_crouch
451 f1000 movement_speed_fast
452 f1000 movement_speed_climb
453 f1000 movement_speed_jump
454 f1000 movement_liquid_fluidity
455 f1000 movement_liquid_fluidity_smooth
456 f1000 movement_liquid_sink
457 f1000 movement_gravity
460 TOCLIENT_SPAWN_PARTICLE = 0x46,
467 u8 bool collisiondetection
474 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
488 u8 bool collisiondetection
496 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
498 TOCLIENT_HUDADD = 0x49,
517 TOCLIENT_HUDRM = 0x4a,
522 TOCLIENT_HUDCHANGE = 0x4b,
532 TOCLIENT_HUD_SET_FLAGS = 0x4c,
538 TOCLIENT_HUD_SET_PARAM = 0x4d,
545 TOCLIENT_BREATH = 0x4e,
550 TOCLIENT_SET_SKY = 0x4f,
562 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
564 u8 do_override (boolean)
565 u16 day-night ratio 0...65535
568 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
577 TOCLIENT_EYE_OFFSET = 0x52,
583 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
588 TOCLIENT_CLOUD_PARAMS = 0x54,
591 u8[4] color_diffuse (ARGB)
592 u8[4] color_ambient (ARGB)
598 TOCLIENT_FADE_SOUND = 0x55,
604 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
607 u16 number of players
613 TOCLIENT_SRP_BYTES_S_B = 0x60,
615 Belonging to AUTH_MECHANISM_SRP.
621 TOCLIENT_NUM_MSG_TYPES = 0x61,
626 TOSERVER_INIT = 0x02,
628 Sent first after connected.
630 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
631 u16 supported network compression modes
632 u16 minimum supported network protocol version
633 u16 maximum supported network protocol version
634 std::string player name
637 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
639 TOSERVER_INIT2 = 0x11,
641 Sent as an ACK for TOCLIENT_INIT.
642 After this, the server can send data.
644 [0] u16 TOSERVER_INIT2
647 TOSERVER_GETBLOCK = 0x20, // Obsolete
648 TOSERVER_ADDNODE = 0x21, // Obsolete
649 TOSERVER_REMOVENODE = 0x22, // Obsolete
651 TOSERVER_PLAYERPOS = 0x23,
654 [2] v3s32 position*100
655 [2+12] v3s32 speed*100
656 [2+12+12] s32 pitch*100
657 [2+12+12+4] s32 yaw*100
658 [2+12+12+4+4] u32 keyPressed
659 [2+12+12+4+4+1] u8 fov*80
660 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
663 TOSERVER_GOTBLOCKS = 0x24,
672 TOSERVER_DELETEDBLOCKS = 0x25,
681 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
682 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
683 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
684 TOSERVER_RELEASE = 0x29, // Obsolete
685 TOSERVER_SIGNTEXT = 0x30, // Obsolete
687 TOSERVER_INVENTORY_ACTION = 0x31,
689 See InventoryAction in inventorymanager.h
692 TOSERVER_CHAT_MESSAGE = 0x32,
698 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
699 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
701 TOSERVER_DAMAGE = 0x35,
706 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
708 TOSERVER_PLAYERITEM = 0x37,
710 Sent to change selected item.
712 [0] u16 TOSERVER_PLAYERITEM
716 TOSERVER_RESPAWN = 0x38,
721 TOSERVER_INTERACT = 0x39,
726 [5] u32 length of the next item
727 [9] serialized PointedThing
729 0: start digging (from undersurface) or use
730 1: stop digging (all parameters ignored)
732 3: place block or item (to abovesurface)
736 TOSERVER_REMOVED_SOUNDS = 0x3a,
742 TOSERVER_NODEMETA_FIELDS = 0x3b,
746 u8[len] form name (reserved for future use)
755 TOSERVER_INVENTORY_FIELDS = 0x3c,
758 u8[len] form name (reserved for future use)
767 TOSERVER_REQUEST_MEDIA = 0x40,
769 u16 number of files requested
776 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
777 TOSERVER_BREATH = 0x42, // Obsolete
779 TOSERVER_CLIENT_READY = 0x43,
786 u8[len] full_version_string
789 TOSERVER_FIRST_SRP = 0x50,
791 Belonging to AUTH_MECHANISM_FIRST_SRP.
794 std::string srp verification key
795 u8 is_empty (=1 if password is empty, 0 otherwise)
798 TOSERVER_SRP_BYTES_A = 0x51,
800 Belonging to AUTH_MECHANISM_SRP,
801 depending on current_login_based_on.
804 u8 current_login_based_on : on which version of the password's
805 hash this login is based on (0 legacy hash,
806 or 1 directly the password)
809 TOSERVER_SRP_BYTES_M = 0x52,
811 Belonging to AUTH_MECHANISM_SRP.
816 TOSERVER_NUM_MSG_TYPES = 0x53,
822 AUTH_MECHANISM_NONE = 0,
824 // SRP based on the legacy hash
825 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
827 // SRP based on the srp verification key
828 AUTH_MECHANISM_SRP = 1 << 1,
830 // Establishes a srp verification key, for first login and password changing
831 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
834 enum AccessDeniedCode {
835 SERVER_ACCESSDENIED_WRONG_PASSWORD,
836 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
837 SERVER_ACCESSDENIED_SINGLEPLAYER,
838 SERVER_ACCESSDENIED_WRONG_VERSION,
839 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
840 SERVER_ACCESSDENIED_WRONG_NAME,
841 SERVER_ACCESSDENIED_TOO_MANY_USERS,
842 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
843 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
844 SERVER_ACCESSDENIED_SERVER_FAIL,
845 SERVER_ACCESSDENIED_CUSTOM_STRING,
846 SERVER_ACCESSDENIED_SHUTDOWN,
847 SERVER_ACCESSDENIED_CRASH,
848 SERVER_ACCESSDENIED_MAX,
851 enum NetProtoCompressionMode {
852 NETPROTO_COMPRESSION_NONE = 0,
855 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
857 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
858 "The server is running in simple singleplayer mode. You cannot connect.",
859 "Your client's version is not supported.\nPlease contact server administrator.",
860 "Player name contains disallowed characters.",
861 "Player name not allowed.",
863 "Empty passwords are disallowed. Set a password and try again.",
864 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
865 "Server authentication failed. This is likely a server error.",
867 "Server shutting down.",
868 "This server has experienced an internal error. You will now be disconnected."
871 enum PlayerListModifer: u8
878 enum CSMFlavourLimit : u64 {
879 CSM_FL_NONE = 0x00000000,
880 CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
881 CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
882 CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
883 CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
884 CSM_FL_ALL = 0xFFFFFFFF,