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.
181 #define LATEST_PROTOCOL_VERSION 35
183 // Server's supported network protocol range
184 #define SERVER_PROTOCOL_VERSION_MIN 24
185 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
187 // Client's supported network protocol range
188 // The minimal version depends on whether
189 // send_pre_v25_init is enabled or not
190 #define CLIENT_PROTOCOL_VERSION_MIN 25
191 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
192 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
194 // Constant that differentiates the protocol from random data and other protocols
195 #define PROTOCOL_ID 0x4f457403
197 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
198 // base64-encoded SHA-1 (27+\0).
200 #define FORMSPEC_API_VERSION 1
201 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
203 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
207 TOCLIENT_HELLO = 0x02,
209 Sent after TOSERVER_INIT.
211 u8 deployed serialisation version
212 u16 deployed network compression mode
213 u16 deployed protocol version
214 u32 supported auth methods
215 std::string username that should be used for legacy hash (for proper casing)
217 TOCLIENT_AUTH_ACCEPT = 0x03,
219 Message from server to accept auth.
221 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
223 f1000 recommended send interval
224 u32 : supported auth methods for sudo mode
225 (where the user can change their password)
227 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
229 Sent to client to show it is in sudo mode now.
231 TOCLIENT_DENY_SUDO_MODE = 0x05,
233 Signals client that sudo mode auth failed.
235 TOCLIENT_INIT_LEGACY = 0x10,
237 Server's reply to TOSERVER_INIT.
238 Sent second after connected.
240 [0] u16 TOSERVER_INIT
241 [2] u8 deployed version
242 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
243 [12] u64 map seed (new as of 2011-02-27)
244 [20] f1000 recommended send interval (in seconds) (new as of 14)
246 NOTE: The position in here is deprecated; position is
247 explicitly sent afterwards
249 TOCLIENT_ACCESS_DENIED = 0x0A,
252 std::string custom reason (if needed, otherwise "")
255 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
256 TOCLIENT_ADDNODE = 0x21,
260 u8 keep_metadata // Added in protocol version 22
262 TOCLIENT_REMOVENODE = 0x22,
264 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
267 // Followed by an arbitary number of these:
268 // Number is determined from packet length.
270 [N+2] v3s32 position*100
271 [N+2+12] v3s32 speed*100
272 [N+2+12+12] s32 pitch*100
273 [N+2+12+12+4] s32 yaw*100
276 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
279 // Followed by an arbitary number of these:
280 // Number is determined from packet length.
285 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
287 TOCLIENT_SECTORMETA = 0x26, // Obsolete
291 [3...] v2s16 pos + sector metadata
294 TOCLIENT_INVENTORY = 0x27,
297 [2] serialized inventory
300 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
304 u16 number of player positions
317 TOCLIENT_TIME_OF_DAY = 0x29,
320 Added in a later version:
324 TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
326 u32 CSMFlavourLimits byteflag
329 // (oops, there is some gap here)
331 TOCLIENT_CHAT_MESSAGE = 0x2F,
335 u16 sendername length
341 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Deprecated by proto v35
347 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
349 u16 count of removed objects
350 for all removed objects {
353 u16 count of added objects
354 for all added objects {
357 u32 initialization data length
358 string initialization data
362 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
377 TOCLIENT_MOVE_PLAYER = 0x34,
379 v3f1000 player position
384 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
390 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
392 u16 count of player items
393 for all player items {
395 u16 length of serialized item
396 string serialized item
400 TOCLIENT_DEATHSCREEN = 0x37,
402 u8 bool set camera point target
403 v3f1000 camera point target (to point the death cause or whatever)
406 TOCLIENT_MEDIA = 0x38,
408 u16 total number of texture bunches
409 u16 index of this bunch
410 u32 number of files in this bunch
417 u16 length of remote media server url (if applicable)
421 TOCLIENT_TOOLDEF = 0x39,
423 u32 length of the next item
424 serialized ToolDefManager
427 TOCLIENT_NODEDEF = 0x3a,
429 u32 length of the next item
430 serialized NodeDefManager
433 TOCLIENT_CRAFTITEMDEF = 0x3b,
435 u32 length of the next item
436 serialized CraftiItemDefManager
439 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
446 u16 length of sha1_digest
451 TOCLIENT_ITEMDEF = 0x3d,
453 u32 length of next item
454 serialized ItemDefManager
457 TOCLIENT_PLAY_SOUND = 0x3f,
463 u8 type (0=local, 1=positional, 2=object)
464 s32[3] pos_nodes*10000
469 TOCLIENT_STOP_SOUND = 0x40,
474 TOCLIENT_PRIVILEGES = 0x41,
476 u16 number of privileges
482 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
488 TOCLIENT_DETACHED_INVENTORY = 0x43,
493 [2] serialized inventory
496 TOCLIENT_SHOW_FORMSPEC = 0x44,
505 TOCLIENT_MOVEMENT = 0x45,
507 f1000 movement_acceleration_default
508 f1000 movement_acceleration_air
509 f1000 movement_acceleration_fast
510 f1000 movement_speed_walk
511 f1000 movement_speed_crouch
512 f1000 movement_speed_fast
513 f1000 movement_speed_climb
514 f1000 movement_speed_jump
515 f1000 movement_liquid_fluidity
516 f1000 movement_liquid_fluidity_smooth
517 f1000 movement_liquid_sink
518 f1000 movement_gravity
521 TOCLIENT_SPAWN_PARTICLE = 0x46,
528 u8 bool collisiondetection
535 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
549 u8 bool collisiondetection
557 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
562 TOCLIENT_HUDADD = 0x49,
581 TOCLIENT_HUDRM = 0x4a,
586 TOCLIENT_HUDCHANGE = 0x4b,
596 TOCLIENT_HUD_SET_FLAGS = 0x4c,
602 TOCLIENT_HUD_SET_PARAM = 0x4d,
609 TOCLIENT_BREATH = 0x4e,
614 TOCLIENT_SET_SKY = 0x4f,
626 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
628 u8 do_override (boolean)
629 u16 day-night ratio 0...65535
632 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
641 TOCLIENT_EYE_OFFSET = 0x52,
647 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
652 TOCLIENT_CLOUD_PARAMS = 0x54,
655 u8[4] color_diffuse (ARGB)
656 u8[4] color_ambient (ARGB)
662 TOCLIENT_FADE_SOUND = 0x55,
668 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
671 u16 number of players
677 TOCLIENT_SRP_BYTES_S_B = 0x60,
679 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
685 TOCLIENT_NUM_MSG_TYPES = 0x61,
690 TOSERVER_INIT = 0x02,
692 Sent first after connected.
694 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
695 u16 supported network compression modes
696 u16 minimum supported network protocol version
697 u16 maximum supported network protocol version
698 std::string player name
701 TOSERVER_INIT_LEGACY = 0x10,
703 Sent first after connected.
705 [0] u16 TOSERVER_INIT_LEGACY
706 [2] u8 SER_FMT_VER_HIGHEST_READ
707 [3] u8[20] player_name
708 [23] u8[28] password (new in some version)
709 [51] u16 minimum supported network protocol version (added sometime)
710 [53] u16 maximum supported network protocol version (added later than the previous one)
713 TOSERVER_INIT2 = 0x11,
715 Sent as an ACK for TOCLIENT_INIT.
716 After this, the server can send data.
718 [0] u16 TOSERVER_INIT2
721 TOSERVER_GETBLOCK=0x20, // Obsolete
722 TOSERVER_ADDNODE = 0x21, // Obsolete
723 TOSERVER_REMOVENODE = 0x22, // Obsolete
725 TOSERVER_PLAYERPOS = 0x23,
728 [2] v3s32 position*100
729 [2+12] v3s32 speed*100
730 [2+12+12] s32 pitch*100
731 [2+12+12+4] s32 yaw*100
732 [2+12+12+4+4] u32 keyPressed
733 [2+12+12+4+4+1] u8 fov*80
734 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
737 TOSERVER_GOTBLOCKS = 0x24,
746 TOSERVER_DELETEDBLOCKS = 0x25,
755 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
762 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
766 [2] u8 button (0=left, 1=right)
772 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
777 [3] v3s16 nodepos_undersurface
778 [9] v3s16 nodepos_abovesurface
781 0: start digging (from undersurface)
782 1: place block (to abovesurface)
783 2: stop digging (all parameters ignored)
787 TOSERVER_RELEASE = 0x29, // Obsolete
789 // (oops, there is some gap here)
791 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
799 TOSERVER_INVENTORY_ACTION = 0x31,
801 See InventoryAction in inventorymanager.h
804 TOSERVER_CHAT_MESSAGE = 0x32,
810 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
817 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
821 [2] u8 button (0=left, 1=right)
826 TOSERVER_DAMAGE = 0x35,
831 TOSERVER_PASSWORD_LEGACY = 0x36,
833 Sent to change password.
835 [0] u16 TOSERVER_PASSWORD
836 [2] u8[28] old password
837 [30] u8[28] new password
840 TOSERVER_PLAYERITEM = 0x37,
842 Sent to change selected item.
844 [0] u16 TOSERVER_PLAYERITEM
848 TOSERVER_RESPAWN = 0x38,
853 TOSERVER_INTERACT = 0x39,
858 [5] u32 length of the next item
859 [9] serialized PointedThing
861 0: start digging (from undersurface) or use
862 1: stop digging (all parameters ignored)
864 3: place block or item (to abovesurface)
867 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
870 TOSERVER_REMOVED_SOUNDS = 0x3a,
876 TOSERVER_NODEMETA_FIELDS = 0x3b,
880 u8[len] form name (reserved for future use)
889 TOSERVER_INVENTORY_FIELDS = 0x3c,
892 u8[len] form name (reserved for future use)
901 TOSERVER_REQUEST_MEDIA = 0x40,
903 u16 number of files requested
910 TOSERVER_RECEIVED_MEDIA = 0x41,
915 TOSERVER_BREATH = 0x42, // Obsolete
920 TOSERVER_CLIENT_READY = 0x43,
927 u8[len] full_version_string
930 TOSERVER_FIRST_SRP = 0x50,
932 Belonging to AUTH_MECHANISM_FIRST_SRP.
935 std::string srp verification key
936 u8 is_empty (=1 if password is empty, 0 otherwise)
939 TOSERVER_SRP_BYTES_A = 0x51,
941 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
942 depending on current_login_based_on.
945 u8 current_login_based_on : on which version of the password's
946 hash this login is based on (0 legacy hash,
947 or 1 directly the password)
950 TOSERVER_SRP_BYTES_M = 0x52,
952 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
957 TOSERVER_NUM_MSG_TYPES = 0x53,
963 AUTH_MECHANISM_NONE = 0,
965 // SRP based on the legacy hash
966 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
968 // SRP based on the srp verification key
969 AUTH_MECHANISM_SRP = 1 << 1,
971 // Establishes a srp verification key, for first login and password changing
972 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
975 enum AccessDeniedCode {
976 SERVER_ACCESSDENIED_WRONG_PASSWORD,
977 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
978 SERVER_ACCESSDENIED_SINGLEPLAYER,
979 SERVER_ACCESSDENIED_WRONG_VERSION,
980 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
981 SERVER_ACCESSDENIED_WRONG_NAME,
982 SERVER_ACCESSDENIED_TOO_MANY_USERS,
983 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
984 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
985 SERVER_ACCESSDENIED_SERVER_FAIL,
986 SERVER_ACCESSDENIED_CUSTOM_STRING,
987 SERVER_ACCESSDENIED_SHUTDOWN,
988 SERVER_ACCESSDENIED_CRASH,
989 SERVER_ACCESSDENIED_MAX,
992 enum NetProtoCompressionMode {
993 NETPROTO_COMPRESSION_NONE = 0,
996 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
998 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
999 "The server is running in simple singleplayer mode. You cannot connect.",
1000 "Your client's version is not supported.\nPlease contact server administrator.",
1001 "Player name contains disallowed characters.",
1002 "Player name not allowed.",
1004 "Empty passwords are disallowed. Set a password and try again.",
1005 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
1006 "Server authentication failed. This is likely a server error.",
1008 "Server shutting down.",
1009 "This server has experienced an internal error. You will now be disconnected."
1012 enum PlayerListModifer: u8
1019 enum CSMFlavourLimit : u64 {
1020 CSM_FL_NONE = 0x00000000,
1021 CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
1022 CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
1023 CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
1024 CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
1025 CSM_FL_ALL = 0xFFFFFFFF,