]> git.lizzy.rs Git - minetest.git/blobdiff - src/network/networkprotocol.h
Fix interact range check (thanks to @lhofhansl)
[minetest.git] / src / network / networkprotocol.h
index ba934957d7b70ca31cb67e74127a8f4ee3f7f34a..018b392b63b9134ff0ff00f39d0d774f931f6d64 100644 (file)
@@ -120,21 +120,37 @@ with this program; if not, write to the Free Software Foundation, Inc.,
                        permit translation
                Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
                        reading u32
-               Add TOSERVER_INIT new opcode (0x02) for client presentation to server
-               Add TOSERVER_AUTH new opcode (0x03) for client authentication
+               Add new opcode TOSERVER_INIT for client presentation to server
+               Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
+                       TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
+                       for the three supported auth mechanisms around srp
+               Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
+                       for sudo mode handling (auth mech generic way of changing password).
                Add TOCLIENT_HELLO for presenting server to client after client
                        presentation
-               Add TOCLIENT_AUTH_ACCEPT to accept connexion from client
+               Add TOCLIENT_AUTH_ACCEPT to accept connection from client
+               Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
+       PROTOCOL_VERSION 26:
+               Add TileDef tileable_horizontal, tileable_vertical flags
+       PROTOCOL_VERSION 27:
+               backface_culling: backwards compatibility for playing with
+               newer client on pre-27 servers.
+               Add nodedef v3 - connected nodeboxes
+       PROTOCOL_VERSION 28:
+               CPT2_MESHOPTIONS
 */
 
-#define LATEST_PROTOCOL_VERSION 24
+#define LATEST_PROTOCOL_VERSION 28
 
 // Server's supported network protocol range
 #define SERVER_PROTOCOL_VERSION_MIN 13
 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 
 // Client's supported network protocol range
-#define CLIENT_PROTOCOL_VERSION_MIN 13
+// The minimal version depends on whether
+// send_pre_v25_init is enabled or not
+#define CLIENT_PROTOCOL_VERSION_MIN 25
+#define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 13
 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 
 // Constant that differentiates the protocol from random data and other protocols
@@ -151,14 +167,33 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 enum ToClientCommand
 {
        TOCLIENT_HELLO = 0x02,
-       TOCLIENT_AUTH_ACCEPT = 0x03,
-       TOCLIENT_ACCESS_DENIED = 0x0A,
        /*
-               u16 command
-               u16 reason_length
-               wstring reason
+               Sent after TOSERVER_INIT.
+
+               u8 deployed serialisation version
+               u16 deployed network compression mode
+               u16 deployed protocol version
+               u32 supported auth methods
+               std::string username that should be used for legacy hash (for proper casing)
        */
+       TOCLIENT_AUTH_ACCEPT = 0x03,
+       /*
+               Message from server to accept auth.
 
+               v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
+               u64 map seed
+               f1000 recommended send interval
+               u32 : supported auth methods for sudo mode
+                     (where the user can change their password)
+       */
+       TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
+       /*
+               Sent to client to show it is in sudo mode now.
+       */
+       TOCLIENT_DENY_SUDO_MODE = 0x05,
+       /*
+               Signals client that sudo mode auth failed.
+       */
        TOCLIENT_INIT_LEGACY = 0x10,
        /*
                Server's reply to TOSERVER_INIT.
@@ -173,11 +208,15 @@ enum ToClientCommand
                NOTE: The position in here is deprecated; position is
                      explicitly sent afterwards
        */
-
+       TOCLIENT_ACCESS_DENIED = 0x0A,
+       /*
+               u8 reason
+               std::string custom reason (if needed, otherwise "")
+               u8 (bool) reconnect
+       */
        TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
        TOCLIENT_ADDNODE = 0x21,
        /*
-               u16 command
                v3s16 position
                serialized mapnode
                u8 keep_metadata // Added in protocol version 22
@@ -224,7 +263,6 @@ enum ToClientCommand
        /*
                Sent as unreliable.
 
-               u16 command
                u16 number of player positions
                for each player:
                        u16 peer_id
@@ -240,7 +278,6 @@ enum ToClientCommand
 
        TOCLIENT_TIME_OF_DAY = 0x29,
        /*
-               u16 command
                u16 time (0-23999)
                Added in a later version:
                f1000 time_speed
@@ -250,14 +287,12 @@ enum ToClientCommand
 
        TOCLIENT_CHAT_MESSAGE = 0x30,
        /*
-               u16 command
                u16 length
                wstring message
        */
 
        TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
        /*
-               u16 command
                u16 count of removed objects
                for all removed objects {
                        u16 id
@@ -273,7 +308,6 @@ enum ToClientCommand
 
        TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
        /*
-               u16 command
                for all objects
                {
                        u16 id
@@ -284,13 +318,11 @@ enum ToClientCommand
 
        TOCLIENT_HP = 0x33,
        /*
-               u16 command
                u8 hp
        */
 
        TOCLIENT_MOVE_PLAYER = 0x34,
        /*
-               u16 command
                v3f1000 player position
                f1000 player pitch
                f1000 player yaw
@@ -298,14 +330,12 @@ enum ToClientCommand
 
        TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
        /*
-               u16 command
                u16 reason_length
                wstring reason
        */
 
        TOCLIENT_PLAYERITEM = 0x36, // Obsolete
        /*
-               u16 command
                u16 count of player items
                for all player items {
                        u16 peer id
@@ -316,14 +346,12 @@ enum ToClientCommand
 
        TOCLIENT_DEATHSCREEN = 0x37,
        /*
-               u16 command
                u8 bool set camera point target
                v3f1000 camera point target (to point the death cause or whatever)
        */
 
        TOCLIENT_MEDIA = 0x38,
        /*
-               u16 command
                u16 total number of texture bunches
                u16 index of this bunch
                u32 number of files in this bunch
@@ -339,21 +367,18 @@ enum ToClientCommand
 
        TOCLIENT_TOOLDEF = 0x39,
        /*
-               u16 command
                u32 length of the next item
                serialized ToolDefManager
        */
 
        TOCLIENT_NODEDEF = 0x3a,
        /*
-               u16 command
                u32 length of the next item
                serialized NodeDefManager
        */
 
        TOCLIENT_CRAFTITEMDEF = 0x3b,
        /*
-               u16 command
                u32 length of the next item
                serialized CraftiItemDefManager
        */
@@ -361,7 +386,6 @@ enum ToClientCommand
        TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 
        /*
-               u16 command
                u32 number of files
                for each texture {
                        u16 length of name
@@ -373,14 +397,12 @@ enum ToClientCommand
 
        TOCLIENT_ITEMDEF = 0x3d,
        /*
-               u16 command
                u32 length of next item
                serialized ItemDefManager
        */
 
        TOCLIENT_PLAY_SOUND = 0x3f,
        /*
-               u16 command
                s32 sound_id
                u16 len
                u8[len] sound name
@@ -393,13 +415,11 @@ enum ToClientCommand
 
        TOCLIENT_STOP_SOUND = 0x40,
        /*
-               u16 command
                s32 sound_id
        */
 
        TOCLIENT_PRIVILEGES = 0x41,
        /*
-               u16 command
                u16 number of privileges
                for each privilege
                        u16 len
@@ -408,7 +428,6 @@ enum ToClientCommand
 
        TOCLIENT_INVENTORY_FORMSPEC = 0x42,
        /*
-               u16 command
                u32 len
                u8[len] formspec
        */
@@ -432,7 +451,6 @@ enum ToClientCommand
 
        TOCLIENT_MOVEMENT = 0x45,
        /*
-               u16 command
                f1000 movement_acceleration_default
                f1000 movement_acceleration_air
                f1000 movement_acceleration_fast
@@ -449,7 +467,6 @@ enum ToClientCommand
 
        TOCLIENT_SPAWN_PARTICLE = 0x46,
        /*
-               u16 command
                v3f1000 pos
                v3f1000 velocity
                v3f1000 acceleration
@@ -459,11 +476,11 @@ enum ToClientCommand
                u8 bool vertical
                u32 len
                u8[len] texture
+               u8 collision_removal
        */
 
        TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
        /*
-               u16 command
                u16 amount
                f1000 spawntime
                v3f1000 minpos
@@ -481,17 +498,16 @@ enum ToClientCommand
                u32 len
                u8[len] texture
                u32 id
+               u8 collision_removal
        */
 
        TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
        /*
-               u16 command
                u16 id
        */
 
        TOCLIENT_HUDADD = 0x49,
        /*
-               u16 command
                u32 id
                u8 type
                v2f1000 pos
@@ -511,13 +527,11 @@ enum ToClientCommand
 
        TOCLIENT_HUDRM = 0x4a,
        /*
-               u16 command
                u32 id
        */
 
        TOCLIENT_HUDCHANGE = 0x4b,
        /*
-               u16 command
                u32 id
                u8 stat
                [v2f1000 data |
@@ -528,14 +542,12 @@ enum ToClientCommand
 
        TOCLIENT_HUD_SET_FLAGS = 0x4c,
        /*
-               u16 command
                u32 flags
                u32 mask
        */
 
        TOCLIENT_HUD_SET_PARAM = 0x4d,
        /*
-               u16 command
                u16 param
                u16 len
                u8[len] value
@@ -543,13 +555,11 @@ enum ToClientCommand
 
        TOCLIENT_BREATH = 0x4e,
        /*
-               u16 command
                u16 breath
        */
 
        TOCLIENT_SET_SKY = 0x4f,
        /*
-               u16 command
                u8[4] color (ARGB)
                u8 len
                u8[len] type
@@ -561,14 +571,12 @@ enum ToClientCommand
 
        TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
        /*
-               u16 command
                u8 do_override (boolean)
                u16 day-night ratio 0...65535
        */
 
        TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
        /*
-               u16 command
                v2s32 stand/idle
                v2s32 walk
                v2s32 dig
@@ -578,18 +586,24 @@ enum ToClientCommand
 
        TOCLIENT_EYE_OFFSET = 0x52,
        /*
-               u16 command
                v3f1000 first
                v3f1000 third
        */
 
        TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
        /*
-               u16 command
                u32 id
        */
 
-       TOCLIENT_NUM_MSG_TYPES = 0x54,
+       TOCLIENT_SRP_BYTES_S_B = 0x60,
+       /*
+               Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
+
+               std::string bytes_s
+               std::string bytes_B
+       */
+
+       TOCLIENT_NUM_MSG_TYPES = 0x61,
 };
 
 enum ToServerCommand
@@ -598,18 +612,11 @@ enum ToServerCommand
        /*
                Sent first after connected.
 
-               [0] u16 TOSERVER_INIT
-               [2] u8 SER_FMT_VER_HIGHEST_READ
-               [3] u8 compression_modes
-       */
-
-       TOSERVER_AUTH = 0x03,
-       /*
-               Sent first after presentation (INIT).
-               [0] std::string player_name
-               [0+*] std::string password (new in some version)
-               [0+*+*] u16 minimum supported network protocol version (added sometime)
-               [0+*+*+2] u16 maximum supported network protocol version (added later than the previous one)
+               u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
+               u16 supported network compression modes
+               u16 minimum supported network protocol version
+               u16 maximum supported network protocol version
+               std::string player name
        */
 
        TOSERVER_INIT_LEGACY = 0x10,
@@ -644,6 +651,8 @@ enum ToServerCommand
                [2+12+12] s32 pitch*100
                [2+12+12+4] s32 yaw*100
                [2+12+12+4+4] u32 keyPressed
+               [2+12+12+4+4+1] u8 fov*80
+               [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
        */
 
        TOSERVER_GOTBLOCKS = 0x24,
@@ -702,7 +711,6 @@ enum ToServerCommand
 
        TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
        /*
-               u16 command
                v3s16 blockpos
                s16 id
                u16 textlen
@@ -716,14 +724,12 @@ enum ToServerCommand
 
        TOSERVER_CHAT_MESSAGE = 0x32,
        /*
-               u16 command
                u16 length
                wstring message
        */
 
        TOSERVER_SIGNNODETEXT = 0x33, // obsolete
        /*
-               u16 command
                v3s16 p
                u16 textlen
                textdata
@@ -740,7 +746,6 @@ enum ToServerCommand
 
        TOSERVER_DAMAGE = 0x35,
        /*
-               u16 command
                u8 amount
        */
 
@@ -785,14 +790,12 @@ enum ToServerCommand
 
        TOSERVER_REMOVED_SOUNDS = 0x3a,
        /*
-               u16 command
                u16 len
                s32[len] sound_id
        */
 
        TOSERVER_NODEMETA_FIELDS = 0x3b,
        /*
-               u16 command
                v3s16 p
                u16 len
                u8[len] form name (reserved for future use)
@@ -806,7 +809,6 @@ enum ToServerCommand
 
        TOSERVER_INVENTORY_FIELDS = 0x3c,
        /*
-               u16 command
                u16 len
                u8[len] form name (reserved for future use)
                u16 number of fields
@@ -817,18 +819,8 @@ enum ToServerCommand
                        u8[len] field value
        */
 
-       TOSERVER_PASSWORD = 0x3d,
-       /*
-               Sent to change password.
-
-               [0] u16 TOSERVER_PASSWORD
-               [2] std::string old password
-               [2+*] std::string new password
-       */
-
        TOSERVER_REQUEST_MEDIA = 0x40,
        /*
-               u16 command
                u16 number of files requested
                for each file {
                        u16 length of name
@@ -838,12 +830,11 @@ enum ToServerCommand
 
        TOSERVER_RECEIVED_MEDIA = 0x41,
        /*
-               u16 command
+               <no payload data>
        */
 
        TOSERVER_BREATH = 0x42,
        /*
-               u16 command
                u16 breath
        */
 
@@ -857,7 +848,49 @@ enum ToServerCommand
                u8[len] full_version_string
        */
 
-       TOSERVER_NUM_MSG_TYPES = 0x44,
+       TOSERVER_FIRST_SRP = 0x50,
+       /*
+               Belonging to AUTH_MECHANISM_FIRST_SRP.
+
+               std::string srp salt
+               std::string srp verification key
+               u8 is_empty (=1 if password is empty, 0 otherwise)
+       */
+
+       TOSERVER_SRP_BYTES_A = 0x51,
+       /*
+               Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
+                       depending on current_login_based_on.
+
+               std::string bytes_A
+               u8 current_login_based_on : on which version of the password's
+                                           hash this login is based on (0 legacy hash,
+                                           or 1 directly the password)
+       */
+
+       TOSERVER_SRP_BYTES_M = 0x52,
+       /*
+               Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
+
+               std::string bytes_M
+       */
+
+       TOSERVER_NUM_MSG_TYPES = 0x53,
+};
+
+enum AuthMechanism
+{
+       // reserved
+       AUTH_MECHANISM_NONE = 0,
+
+       // SRP based on the legacy hash
+       AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
+
+       // SRP based on the srp verification key
+       AUTH_MECHANISM_SRP = 1 << 1,
+
+       // Establishes a srp verification key, for first login and password changing
+       AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 };
 
 enum AccessDeniedCode {
@@ -872,11 +905,13 @@ enum AccessDeniedCode {
        SERVER_ACCESSDENIED_ALREADY_CONNECTED,
        SERVER_ACCESSDENIED_SERVER_FAIL,
        SERVER_ACCESSDENIED_CUSTOM_STRING,
+       SERVER_ACCESSDENIED_SHUTDOWN,
+       SERVER_ACCESSDENIED_CRASH,
        SERVER_ACCESSDENIED_MAX,
 };
 
 enum NetProtoCompressionMode {
-       NETPROTO_COMPRESSION_ZLIB = 0,
+       NETPROTO_COMPRESSION_NONE = 0,
 };
 
 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
@@ -889,8 +924,10 @@ const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
        "Too many users.",
        "Empty passwords are disallowed.  Set a password and try again.",
        "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
-       "Server authention failed.  This is likely a server error."
+       "Server authentication failed.  This is likely a server error.",
        "",
+       "Server shutting down.",
+       "This server has experienced an internal error. You will now be disconnected."
 };
 
 #endif