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
179 #define LATEST_PROTOCOL_VERSION 35
181 // Server's supported network protocol range
182 #define SERVER_PROTOCOL_VERSION_MIN 24
183 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
185 // Client's supported network protocol range
186 // The minimal version depends on whether
187 // send_pre_v25_init is enabled or not
188 #define CLIENT_PROTOCOL_VERSION_MIN 25
189 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
190 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
192 // Constant that differentiates the protocol from random data and other protocols
193 #define PROTOCOL_ID 0x4f457403
195 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
196 // base64-encoded SHA-1 (27+\0).
198 #define FORMSPEC_API_VERSION 1
199 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
201 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
205 TOCLIENT_HELLO = 0x02,
207 Sent after TOSERVER_INIT.
209 u8 deployed serialisation version
210 u16 deployed network compression mode
211 u16 deployed protocol version
212 u32 supported auth methods
213 std::string username that should be used for legacy hash (for proper casing)
215 TOCLIENT_AUTH_ACCEPT = 0x03,
217 Message from server to accept auth.
219 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
221 f1000 recommended send interval
222 u32 : supported auth methods for sudo mode
223 (where the user can change their password)
225 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
227 Sent to client to show it is in sudo mode now.
229 TOCLIENT_DENY_SUDO_MODE = 0x05,
231 Signals client that sudo mode auth failed.
233 TOCLIENT_INIT_LEGACY = 0x10,
235 Server's reply to TOSERVER_INIT.
236 Sent second after connected.
238 [0] u16 TOSERVER_INIT
239 [2] u8 deployed version
240 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
241 [12] u64 map seed (new as of 2011-02-27)
242 [20] f1000 recommended send interval (in seconds) (new as of 14)
244 NOTE: The position in here is deprecated; position is
245 explicitly sent afterwards
247 TOCLIENT_ACCESS_DENIED = 0x0A,
250 std::string custom reason (if needed, otherwise "")
253 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
254 TOCLIENT_ADDNODE = 0x21,
258 u8 keep_metadata // Added in protocol version 22
260 TOCLIENT_REMOVENODE = 0x22,
262 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
265 // Followed by an arbitary number of these:
266 // Number is determined from packet length.
268 [N+2] v3s32 position*100
269 [N+2+12] v3s32 speed*100
270 [N+2+12+12] s32 pitch*100
271 [N+2+12+12+4] s32 yaw*100
274 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
277 // Followed by an arbitary number of these:
278 // Number is determined from packet length.
283 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
285 TOCLIENT_SECTORMETA = 0x26, // Obsolete
289 [3...] v2s16 pos + sector metadata
292 TOCLIENT_INVENTORY = 0x27,
295 [2] serialized inventory
298 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
302 u16 number of player positions
315 TOCLIENT_TIME_OF_DAY = 0x29,
318 Added in a later version:
322 TOCLIENT_CSM_FLAVOUR_LIMITS = 0x2A,
324 u32 CSMFlavourLimits byteflag
327 // (oops, there is some gap here)
329 TOCLIENT_CHAT_MESSAGE = 0x2F,
333 u16 sendername length
339 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Deprecated by proto v35
345 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
347 u16 count of removed objects
348 for all removed objects {
351 u16 count of added objects
352 for all added objects {
355 u32 initialization data length
356 string initialization data
360 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
375 TOCLIENT_MOVE_PLAYER = 0x34,
377 v3f1000 player position
382 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
388 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
390 u16 count of player items
391 for all player items {
393 u16 length of serialized item
394 string serialized item
398 TOCLIENT_DEATHSCREEN = 0x37,
400 u8 bool set camera point target
401 v3f1000 camera point target (to point the death cause or whatever)
404 TOCLIENT_MEDIA = 0x38,
406 u16 total number of texture bunches
407 u16 index of this bunch
408 u32 number of files in this bunch
415 u16 length of remote media server url (if applicable)
419 TOCLIENT_TOOLDEF = 0x39,
421 u32 length of the next item
422 serialized ToolDefManager
425 TOCLIENT_NODEDEF = 0x3a,
427 u32 length of the next item
428 serialized NodeDefManager
431 TOCLIENT_CRAFTITEMDEF = 0x3b,
433 u32 length of the next item
434 serialized CraftiItemDefManager
437 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
444 u16 length of sha1_digest
449 TOCLIENT_ITEMDEF = 0x3d,
451 u32 length of next item
452 serialized ItemDefManager
455 TOCLIENT_PLAY_SOUND = 0x3f,
461 u8 type (0=local, 1=positional, 2=object)
462 s32[3] pos_nodes*10000
467 TOCLIENT_STOP_SOUND = 0x40,
472 TOCLIENT_PRIVILEGES = 0x41,
474 u16 number of privileges
480 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
486 TOCLIENT_DETACHED_INVENTORY = 0x43,
491 [2] serialized inventory
494 TOCLIENT_SHOW_FORMSPEC = 0x44,
503 TOCLIENT_MOVEMENT = 0x45,
505 f1000 movement_acceleration_default
506 f1000 movement_acceleration_air
507 f1000 movement_acceleration_fast
508 f1000 movement_speed_walk
509 f1000 movement_speed_crouch
510 f1000 movement_speed_fast
511 f1000 movement_speed_climb
512 f1000 movement_speed_jump
513 f1000 movement_liquid_fluidity
514 f1000 movement_liquid_fluidity_smooth
515 f1000 movement_liquid_sink
516 f1000 movement_gravity
519 TOCLIENT_SPAWN_PARTICLE = 0x46,
526 u8 bool collisiondetection
533 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
547 u8 bool collisiondetection
555 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
560 TOCLIENT_HUDADD = 0x49,
579 TOCLIENT_HUDRM = 0x4a,
584 TOCLIENT_HUDCHANGE = 0x4b,
594 TOCLIENT_HUD_SET_FLAGS = 0x4c,
600 TOCLIENT_HUD_SET_PARAM = 0x4d,
607 TOCLIENT_BREATH = 0x4e,
612 TOCLIENT_SET_SKY = 0x4f,
624 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
626 u8 do_override (boolean)
627 u16 day-night ratio 0...65535
630 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
639 TOCLIENT_EYE_OFFSET = 0x52,
645 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
650 TOCLIENT_CLOUD_PARAMS = 0x54,
653 u8[4] color_diffuse (ARGB)
654 u8[4] color_ambient (ARGB)
660 TOCLIENT_FADE_SOUND = 0x55,
666 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
669 u16 number of players
675 TOCLIENT_SRP_BYTES_S_B = 0x60,
677 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
683 TOCLIENT_NUM_MSG_TYPES = 0x61,
688 TOSERVER_INIT = 0x02,
690 Sent first after connected.
692 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
693 u16 supported network compression modes
694 u16 minimum supported network protocol version
695 u16 maximum supported network protocol version
696 std::string player name
699 TOSERVER_INIT_LEGACY = 0x10,
701 Sent first after connected.
703 [0] u16 TOSERVER_INIT_LEGACY
704 [2] u8 SER_FMT_VER_HIGHEST_READ
705 [3] u8[20] player_name
706 [23] u8[28] password (new in some version)
707 [51] u16 minimum supported network protocol version (added sometime)
708 [53] u16 maximum supported network protocol version (added later than the previous one)
711 TOSERVER_INIT2 = 0x11,
713 Sent as an ACK for TOCLIENT_INIT.
714 After this, the server can send data.
716 [0] u16 TOSERVER_INIT2
719 TOSERVER_GETBLOCK=0x20, // Obsolete
720 TOSERVER_ADDNODE = 0x21, // Obsolete
721 TOSERVER_REMOVENODE = 0x22, // Obsolete
723 TOSERVER_PLAYERPOS = 0x23,
726 [2] v3s32 position*100
727 [2+12] v3s32 speed*100
728 [2+12+12] s32 pitch*100
729 [2+12+12+4] s32 yaw*100
730 [2+12+12+4+4] u32 keyPressed
731 [2+12+12+4+4+1] u8 fov*80
732 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
735 TOSERVER_GOTBLOCKS = 0x24,
744 TOSERVER_DELETEDBLOCKS = 0x25,
753 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
760 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
764 [2] u8 button (0=left, 1=right)
770 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
775 [3] v3s16 nodepos_undersurface
776 [9] v3s16 nodepos_abovesurface
779 0: start digging (from undersurface)
780 1: place block (to abovesurface)
781 2: stop digging (all parameters ignored)
785 TOSERVER_RELEASE = 0x29, // Obsolete
787 // (oops, there is some gap here)
789 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
797 TOSERVER_INVENTORY_ACTION = 0x31,
799 See InventoryAction in inventorymanager.h
802 TOSERVER_CHAT_MESSAGE = 0x32,
808 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
815 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
819 [2] u8 button (0=left, 1=right)
824 TOSERVER_DAMAGE = 0x35,
829 TOSERVER_PASSWORD_LEGACY = 0x36,
831 Sent to change password.
833 [0] u16 TOSERVER_PASSWORD
834 [2] u8[28] old password
835 [30] u8[28] new password
838 TOSERVER_PLAYERITEM = 0x37,
840 Sent to change selected item.
842 [0] u16 TOSERVER_PLAYERITEM
846 TOSERVER_RESPAWN = 0x38,
851 TOSERVER_INTERACT = 0x39,
856 [5] u32 length of the next item
857 [9] serialized PointedThing
859 0: start digging (from undersurface) or use
860 1: stop digging (all parameters ignored)
862 3: place block or item (to abovesurface)
865 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
868 TOSERVER_REMOVED_SOUNDS = 0x3a,
874 TOSERVER_NODEMETA_FIELDS = 0x3b,
878 u8[len] form name (reserved for future use)
887 TOSERVER_INVENTORY_FIELDS = 0x3c,
890 u8[len] form name (reserved for future use)
899 TOSERVER_REQUEST_MEDIA = 0x40,
901 u16 number of files requested
908 TOSERVER_RECEIVED_MEDIA = 0x41,
913 TOSERVER_BREATH = 0x42, // Obsolete
918 TOSERVER_CLIENT_READY = 0x43,
925 u8[len] full_version_string
928 TOSERVER_FIRST_SRP = 0x50,
930 Belonging to AUTH_MECHANISM_FIRST_SRP.
933 std::string srp verification key
934 u8 is_empty (=1 if password is empty, 0 otherwise)
937 TOSERVER_SRP_BYTES_A = 0x51,
939 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
940 depending on current_login_based_on.
943 u8 current_login_based_on : on which version of the password's
944 hash this login is based on (0 legacy hash,
945 or 1 directly the password)
948 TOSERVER_SRP_BYTES_M = 0x52,
950 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
955 TOSERVER_NUM_MSG_TYPES = 0x53,
961 AUTH_MECHANISM_NONE = 0,
963 // SRP based on the legacy hash
964 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
966 // SRP based on the srp verification key
967 AUTH_MECHANISM_SRP = 1 << 1,
969 // Establishes a srp verification key, for first login and password changing
970 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
973 enum AccessDeniedCode {
974 SERVER_ACCESSDENIED_WRONG_PASSWORD,
975 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
976 SERVER_ACCESSDENIED_SINGLEPLAYER,
977 SERVER_ACCESSDENIED_WRONG_VERSION,
978 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
979 SERVER_ACCESSDENIED_WRONG_NAME,
980 SERVER_ACCESSDENIED_TOO_MANY_USERS,
981 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
982 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
983 SERVER_ACCESSDENIED_SERVER_FAIL,
984 SERVER_ACCESSDENIED_CUSTOM_STRING,
985 SERVER_ACCESSDENIED_SHUTDOWN,
986 SERVER_ACCESSDENIED_CRASH,
987 SERVER_ACCESSDENIED_MAX,
990 enum NetProtoCompressionMode {
991 NETPROTO_COMPRESSION_NONE = 0,
994 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
996 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
997 "The server is running in simple singleplayer mode. You cannot connect.",
998 "Your client's version is not supported.\nPlease contact server administrator.",
999 "Player name contains disallowed characters.",
1000 "Player name not allowed.",
1002 "Empty passwords are disallowed. Set a password and try again.",
1003 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
1004 "Server authentication failed. This is likely a server error.",
1006 "Server shutting down.",
1007 "This server has experienced an internal error. You will now be disconnected."
1010 enum PlayerListModifer: u8
1017 enum CSMFlavourLimit : u64 {
1018 CSM_FL_NONE = 0x00000000,
1019 CSM_FL_LOOKUP_NODES = 0x00000001, // Limit node lookups
1020 CSM_FL_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
1021 CSM_FL_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
1022 CSM_FL_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
1023 CSM_FL_ALL = 0xFFFFFFFF,