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
183 #define LATEST_PROTOCOL_VERSION 36
185 // Server's supported network protocol range
186 #define SERVER_PROTOCOL_VERSION_MIN 36
187 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
189 // Client's supported network protocol range
190 // The minimal version depends on whether
191 // send_pre_v25_init is enabled or not
192 #define CLIENT_PROTOCOL_VERSION_MIN 36
193 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
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_INIT_LEGACY = 0x10,
239 Server's reply to TOSERVER_INIT.
240 Sent second after connected.
242 [0] u16 TOSERVER_INIT
243 [2] u8 deployed version
244 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
245 [12] u64 map seed (new as of 2011-02-27)
246 [20] f1000 recommended send interval (in seconds) (new as of 14)
248 NOTE: The position in here is deprecated; position is
249 explicitly sent afterwards
251 TOCLIENT_ACCESS_DENIED = 0x0A,
254 std::string custom reason (if needed, otherwise "")
257 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
258 TOCLIENT_ADDNODE = 0x21,
262 u8 keep_metadata // Added in protocol version 22
264 TOCLIENT_REMOVENODE = 0x22,
266 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
269 // Followed by an arbitary number of these:
270 // Number is determined from packet length.
272 [N+2] v3s32 position*100
273 [N+2+12] v3s32 speed*100
274 [N+2+12+12] s32 pitch*100
275 [N+2+12+12+4] s32 yaw*100
278 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
281 // Followed by an arbitary number of these:
282 // Number is determined from packet length.
287 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
289 TOCLIENT_SECTORMETA = 0x26, // Obsolete
293 [3...] v2s16 pos + sector metadata
296 TOCLIENT_INVENTORY = 0x27,
299 [2] serialized inventory
302 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
306 u16 number of player positions
319 TOCLIENT_TIME_OF_DAY = 0x29,
322 Added in a later version:
326 TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
328 u32 CSMFlavourLimits byteflag
331 // (oops, there is some gap here)
333 TOCLIENT_CHAT_MESSAGE = 0x2F,
337 u16 sendername length
343 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Deprecated by proto v35
349 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
351 u16 count of removed objects
352 for all removed objects {
355 u16 count of added objects
356 for all added objects {
359 u32 initialization data length
360 string initialization data
364 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
379 TOCLIENT_MOVE_PLAYER = 0x34,
381 v3f1000 player position
386 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
392 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
394 u16 count of player items
395 for all player items {
397 u16 length of serialized item
398 string serialized item
402 TOCLIENT_DEATHSCREEN = 0x37,
404 u8 bool set camera point target
405 v3f1000 camera point target (to point the death cause or whatever)
408 TOCLIENT_MEDIA = 0x38,
410 u16 total number of texture bunches
411 u16 index of this bunch
412 u32 number of files in this bunch
419 u16 length of remote media server url (if applicable)
423 TOCLIENT_TOOLDEF = 0x39,
425 u32 length of the next item
426 serialized ToolDefManager
429 TOCLIENT_NODEDEF = 0x3a,
431 u32 length of the next item
432 serialized NodeDefManager
435 TOCLIENT_CRAFTITEMDEF = 0x3b,
437 u32 length of the next item
438 serialized CraftiItemDefManager
441 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
448 u16 length of sha1_digest
453 TOCLIENT_ITEMDEF = 0x3d,
455 u32 length of next item
456 serialized ItemDefManager
459 TOCLIENT_PLAY_SOUND = 0x3f,
465 u8 type (0=local, 1=positional, 2=object)
466 s32[3] pos_nodes*10000
471 TOCLIENT_STOP_SOUND = 0x40,
476 TOCLIENT_PRIVILEGES = 0x41,
478 u16 number of privileges
484 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
490 TOCLIENT_DETACHED_INVENTORY = 0x43,
495 [2] serialized inventory
498 TOCLIENT_SHOW_FORMSPEC = 0x44,
507 TOCLIENT_MOVEMENT = 0x45,
509 f1000 movement_acceleration_default
510 f1000 movement_acceleration_air
511 f1000 movement_acceleration_fast
512 f1000 movement_speed_walk
513 f1000 movement_speed_crouch
514 f1000 movement_speed_fast
515 f1000 movement_speed_climb
516 f1000 movement_speed_jump
517 f1000 movement_liquid_fluidity
518 f1000 movement_liquid_fluidity_smooth
519 f1000 movement_liquid_sink
520 f1000 movement_gravity
523 TOCLIENT_SPAWN_PARTICLE = 0x46,
530 u8 bool collisiondetection
537 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
551 u8 bool collisiondetection
559 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
564 TOCLIENT_HUDADD = 0x49,
583 TOCLIENT_HUDRM = 0x4a,
588 TOCLIENT_HUDCHANGE = 0x4b,
598 TOCLIENT_HUD_SET_FLAGS = 0x4c,
604 TOCLIENT_HUD_SET_PARAM = 0x4d,
611 TOCLIENT_BREATH = 0x4e,
616 TOCLIENT_SET_SKY = 0x4f,
628 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
630 u8 do_override (boolean)
631 u16 day-night ratio 0...65535
634 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
643 TOCLIENT_EYE_OFFSET = 0x52,
649 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
654 TOCLIENT_CLOUD_PARAMS = 0x54,
657 u8[4] color_diffuse (ARGB)
658 u8[4] color_ambient (ARGB)
664 TOCLIENT_FADE_SOUND = 0x55,
670 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
673 u16 number of players
679 TOCLIENT_SRP_BYTES_S_B = 0x60,
681 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
687 TOCLIENT_NUM_MSG_TYPES = 0x61,
692 TOSERVER_INIT = 0x02,
694 Sent first after connected.
696 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
697 u16 supported network compression modes
698 u16 minimum supported network protocol version
699 u16 maximum supported network protocol version
700 std::string player name
703 TOSERVER_INIT_LEGACY = 0x10,
705 Sent first after connected.
707 [0] u16 TOSERVER_INIT_LEGACY
708 [2] u8 SER_FMT_VER_HIGHEST_READ
709 [3] u8[20] player_name
710 [23] u8[28] password (new in some version)
711 [51] u16 minimum supported network protocol version (added sometime)
712 [53] u16 maximum supported network protocol version (added later than the previous one)
715 TOSERVER_INIT2 = 0x11,
717 Sent as an ACK for TOCLIENT_INIT.
718 After this, the server can send data.
720 [0] u16 TOSERVER_INIT2
723 TOSERVER_GETBLOCK=0x20, // Obsolete
724 TOSERVER_ADDNODE = 0x21, // Obsolete
725 TOSERVER_REMOVENODE = 0x22, // Obsolete
727 TOSERVER_PLAYERPOS = 0x23,
730 [2] v3s32 position*100
731 [2+12] v3s32 speed*100
732 [2+12+12] s32 pitch*100
733 [2+12+12+4] s32 yaw*100
734 [2+12+12+4+4] u32 keyPressed
735 [2+12+12+4+4+1] u8 fov*80
736 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
739 TOSERVER_GOTBLOCKS = 0x24,
748 TOSERVER_DELETEDBLOCKS = 0x25,
757 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
764 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
768 [2] u8 button (0=left, 1=right)
774 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
779 [3] v3s16 nodepos_undersurface
780 [9] v3s16 nodepos_abovesurface
783 0: start digging (from undersurface)
784 1: place block (to abovesurface)
785 2: stop digging (all parameters ignored)
789 TOSERVER_RELEASE = 0x29, // Obsolete
791 // (oops, there is some gap here)
793 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
801 TOSERVER_INVENTORY_ACTION = 0x31,
803 See InventoryAction in inventorymanager.h
806 TOSERVER_CHAT_MESSAGE = 0x32,
812 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
819 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
823 [2] u8 button (0=left, 1=right)
828 TOSERVER_DAMAGE = 0x35,
833 TOSERVER_PASSWORD_LEGACY = 0x36,
835 Sent to change password.
837 [0] u16 TOSERVER_PASSWORD
838 [2] u8[28] old password
839 [30] u8[28] new password
842 TOSERVER_PLAYERITEM = 0x37,
844 Sent to change selected item.
846 [0] u16 TOSERVER_PLAYERITEM
850 TOSERVER_RESPAWN = 0x38,
855 TOSERVER_INTERACT = 0x39,
860 [5] u32 length of the next item
861 [9] serialized PointedThing
863 0: start digging (from undersurface) or use
864 1: stop digging (all parameters ignored)
866 3: place block or item (to abovesurface)
869 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
872 TOSERVER_REMOVED_SOUNDS = 0x3a,
878 TOSERVER_NODEMETA_FIELDS = 0x3b,
882 u8[len] form name (reserved for future use)
891 TOSERVER_INVENTORY_FIELDS = 0x3c,
894 u8[len] form name (reserved for future use)
903 TOSERVER_REQUEST_MEDIA = 0x40,
905 u16 number of files requested
912 TOSERVER_RECEIVED_MEDIA = 0x41,
917 TOSERVER_BREATH = 0x42, // Obsolete
922 TOSERVER_CLIENT_READY = 0x43,
929 u8[len] full_version_string
932 TOSERVER_FIRST_SRP = 0x50,
934 Belonging to AUTH_MECHANISM_FIRST_SRP.
937 std::string srp verification key
938 u8 is_empty (=1 if password is empty, 0 otherwise)
941 TOSERVER_SRP_BYTES_A = 0x51,
943 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
944 depending on current_login_based_on.
947 u8 current_login_based_on : on which version of the password's
948 hash this login is based on (0 legacy hash,
949 or 1 directly the password)
952 TOSERVER_SRP_BYTES_M = 0x52,
954 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
959 TOSERVER_NUM_MSG_TYPES = 0x53,
965 AUTH_MECHANISM_NONE = 0,
967 // SRP based on the legacy hash
968 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
970 // SRP based on the srp verification key
971 AUTH_MECHANISM_SRP = 1 << 1,
973 // Establishes a srp verification key, for first login and password changing
974 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
977 enum AccessDeniedCode {
978 SERVER_ACCESSDENIED_WRONG_PASSWORD,
979 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
980 SERVER_ACCESSDENIED_SINGLEPLAYER,
981 SERVER_ACCESSDENIED_WRONG_VERSION,
982 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
983 SERVER_ACCESSDENIED_WRONG_NAME,
984 SERVER_ACCESSDENIED_TOO_MANY_USERS,
985 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
986 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
987 SERVER_ACCESSDENIED_SERVER_FAIL,
988 SERVER_ACCESSDENIED_CUSTOM_STRING,
989 SERVER_ACCESSDENIED_SHUTDOWN,
990 SERVER_ACCESSDENIED_CRASH,
991 SERVER_ACCESSDENIED_MAX,
994 enum NetProtoCompressionMode {
995 NETPROTO_COMPRESSION_NONE = 0,
998 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1000 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
1001 "The server is running in simple singleplayer mode. You cannot connect.",
1002 "Your client's version is not supported.\nPlease contact server administrator.",
1003 "Player name contains disallowed characters.",
1004 "Player name not allowed.",
1006 "Empty passwords are disallowed. Set a password and try again.",
1007 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
1008 "Server authentication failed. This is likely a server error.",
1010 "Server shutting down.",
1011 "This server has experienced an internal error. You will now be disconnected."
1014 enum PlayerListModifer: u8
1021 enum CSMFlavourLimit : u64 {
1022 CSM_FL_NONE = 0x00000000,
1023 CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
1024 CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
1025 CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
1026 CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
1027 CSM_FL_ALL = 0xFFFFFFFF,