1.21.5 (#1408)

* 1.21.5

* Update client.js debug logging

* Update packetTest.js slots

* Update ci.yml

---------

Co-authored-by: Romain Beaumont <romain.rom1@gmail.com>

Author: extremeheat

.gitignore

@@ -3,4 +3,5 @@ test/npm-debug.log
 test/server_*
 package-lock.json
 versions/
-src/client/*.json
+src/client/*.json
+test_*

docs/README.md

@@ -13,7 +13,7 @@ Parse and serialize minecraft packets, plus authentication and encryption.
 
  * Supports Minecraft PC version 1.7.10, 1.8.8, 1.9 (15w40b, 1.9, 1.9.1-pre2, 1.9.2, 1.9.4),
   1.10 (16w20a, 1.10-pre1, 1.10, 1.10.1, 1.10.2), 1.11 (16w35a, 1.11, 1.11.2), 1.12 (17w15a, 17w18b, 1.12-pre4, 1.12, 1.12.1, 1.12.2), and 1.13 (17w50a, 1.13, 1.13.1, 1.13.2-pre1, 1.13.2-pre2, 1.13.2), 1.14 (1.14, 1.14.1, 1.14.3, 1.14.4)
-  , 1.15 (1.15, 1.15.1, 1.15.2) and 1.16 (20w13b, 20w14a, 1.16-rc1, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5), 1.17 (21w07a, 1.17, 1.17.1), 1.18 (1.18, 1.18.1 and 1.18.2), 1.19 (1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4), 1.20 (1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6), 1.21 (1.21, 1.21.1, 1.21.3, 1.21.4)
+  , 1.15 (1.15, 1.15.1, 1.15.2) and 1.16 (20w13b, 20w14a, 1.16-rc1, 1.16, 1.16.1, 1.16.2, 1.16.3, 1.16.4, 1.16.5), 1.17 (21w07a, 1.17, 1.17.1), 1.18 (1.18, 1.18.1 and 1.18.2), 1.19 (1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4), 1.20 (1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6), 1.21 (1.21, 1.21.1, 1.21.3, 1.21.4, 1.21.5)
  * Parses all packets and emits events with packet fields as JavaScript
    objects.
  * Send a packet by supplying fields as a JavaScript object.

examples/server/server.js

@@ -11,6 +11,10 @@ const options = {
 const server = mc.createServer(options)
 const mcData = require('minecraft-data')(server.version)
 const loginPacket = mcData.loginPacket
+
+// Global chat index counter for 1.21.5+
+let nextChatIndex = 1
+
 function chatText (text) {
   return mcData.supportFeature('chatPacketsUseNbtComponents')
     ? nbt.comp({ text: nbt.string(text) })
@@ -72,6 +76,7 @@ server.on('listening', function () {
 function sendBroadcastMessage (server, clients, message, sender) {
   if (mcData.supportFeature('signedChat')) {
     server.writeToClients(clients, 'player_chat', {
+      globalIndex: nextChatIndex++,
       plainMessage: message,
       signedChatContent: '',
       unsignedChatContent: chatText(message),

examples/server_helloworld/server_helloworld.js

@@ -10,6 +10,9 @@ const mcData = require('minecraft-data')(server.version)
 const loginPacket = mcData.loginPacket
 const nbt = require('prismarine-nbt')
 
+// Global chat index counter for 1.21.5+
+let nextChatIndex = 1
+
 function chatText (text) {
   return mcData.supportFeature('chatPacketsUseNbtComponents')
     ? nbt.comp({ text: nbt.string(text) })
@@ -65,6 +68,7 @@ server.on('playerJoin', function (client) {
   }
   if (mcData.supportFeature('signedChat')) {
     client.write('player_chat', {
+      globalIndex: nextChatIndex++,
       plainMessage: message,
       signedChatContent: '',
       unsignedChatContent: chatText(message),

src/client.js

@@ -1,9 +1,10 @@
 'use strict'
 const EventEmitter = require('events').EventEmitter
-const debug = require('debug')('minecraft-protocol')
 const compression = require('./transforms/compression')
 const framing = require('./transforms/framing')
 const states = require('./states')
+const debug = require('debug')('minecraft-protocol')
+const debugSkip = process.env.DEBUG_SKIP?.split(',') ?? []
 
 const createSerializer = require('./transforms/serializer').createSerializer
 const createDeserializer = require('./transforms/serializer').createDeserializer
@@ -89,8 +90,8 @@ class Client extends EventEmitter {
       parsed.metadata.name = parsed.data.name
       parsed.data = parsed.data.params
       parsed.metadata.state = state
-      debug('read packet ' + state + '.' + parsed.metadata.name)
-      if (debug.enabled) {
+      if (debug.enabled && !debugSkip.includes(parsed.metadata.name)) {
+        debug('read packet ' + state + '.' + parsed.metadata.name)
         const s = JSON.stringify(parsed.data, null, 2)
         debug(s && s.length > 10000 ? parsed.data : s)
       }
@@ -238,8 +239,10 @@ class Client extends EventEmitter {
 
   write (name, params) {
     if (!this.serializer.writable) { return }
-    debug('writing packet ' + this.state + '.' + name)
-    debug(params)
+    if (debug.enabled && !debugSkip.includes(name)) {
+      debug('writing packet ' + this.state + '.' + name)
+      debug(params)
+    }
     this.serializer.write({ name, params })
   }
 

src/client/chat.js

@@ -1,4 +1,5 @@
 const crypto = require('crypto')
+const { computeChatChecksum } = require('../datatypes/checksums')
 const concat = require('../transforms/binaryStream').concat
 const { processNbtMessage } = require('prismarine-chat')
 const messageExpireTime = 420000 // 7 minutes (ms)
@@ -192,6 +193,7 @@ module.exports = function (client, options) {
       const verified = !packet.unsignedChatContent && updateAndValidateSession(packet.senderUuid, packet.plainMessage, packet.signature, packet.index, packet.previousMessages, packet.salt, packet.timestamp) && !expired
       if (verified) client._signatureCache.push(packet.signature)
       client.emit('playerChat', {
+        globalIndex: packet.globalIndex,
         plainMessage: packet.plainMessage,
         unsignedContent: processMessage(packet.unsignedChatContent),
         type: packet.type,
@@ -363,14 +365,16 @@ module.exports = function (client, options) {
       if (mcData.supportFeature('useChatSessions')) { // 1.19.3+
         const { acknowledged, acknowledgements } = getAcknowledgements()
         const canSign = client.profileKeys && client._session
-        client.write((mcData.supportFeature('seperateSignedChatCommandPacket') && canSign) ? 'chat_command_signed' : 'chat_command', {
+        const chatPacket = {
           command,
           timestamp: options.timestamp,
           salt: options.salt,
           argumentSignatures: canSign ? signaturesForCommand(command, options.timestamp, options.salt, options.preview, acknowledgements) : [],
           messageCount: client._lastSeenMessages.pending,
+          checksum: computeChatChecksum(client._lastSeenMessages), // 1.21.5+
           acknowledged
-        })
+        }
+        client.write((mcData.supportFeature('seperateSignedChatCommandPacket') && canSign) ? 'chat_command_signed' : 'chat_command', chatPacket)
         client._lastSeenMessages.pending = 0
       } else {
         client.write('chat_command', {
@@ -383,6 +387,7 @@ module.exports = function (client, options) {
             messageSender: e.sender,
             messageSignature: e.signature
           })),
+          checksum: computeChatChecksum(client._lastSeenMessages),
           lastRejectedMessage: client._lastRejectedMessage
         })
       }
@@ -398,6 +403,7 @@ module.exports = function (client, options) {
         salt: options.salt,
         signature: (client.profileKeys && client._session) ? client.signMessage(message, options.timestamp, options.salt, undefined, acknowledgements) : undefined,
         offset: client._lastSeenMessages.pending,
+        checksum: computeChatChecksum(client._lastSeenMessages), // 1.21.5+
         acknowledged
       })
       client._lastSeenMessages.pending = 0
@@ -416,7 +422,8 @@ module.exports = function (client, options) {
           messageSender: e.sender,
           messageSignature: e.signature
         })),
-        lastRejectedMessage: client._lastRejectedMessage
+        lastRejectedMessage: client._lastRejectedMessage,
+        checksum: computeChatChecksum(client._lastSeenMessages) // 1.21.5+
       })
       client._lastSeenMessages.pending = 0
     } else if (client.serverFeatures.chatPreview) {

src/datatypes/checksums.js

@@ -0,0 +1,20 @@
+// Compute chat checksum using Java's Arrays.hashCode algorithm to match vanilla client
+function computeChatChecksum (lastSeenMessages) {
+  if (!lastSeenMessages || lastSeenMessages.length === 0) return 1
+
+  let checksum = 1
+  for (const message of lastSeenMessages) {
+    if (message.signature) {
+      let sigHash = 1
+      for (let i = 0; i < message.signature.length; i++) {
+        sigHash = (31 * sigHash + message.signature[i]) & 0xffffffff
+      }
+      checksum = (31 * checksum + sigHash) & 0xffffffff
+    }
+  }
+  // Convert to byte
+  const result = checksum & 0xff
+  return result === 0 ? 1 : result
+}
+
+module.exports = { computeChatChecksum }

src/server/chat.js

@@ -1,4 +1,5 @@
 const crypto = require('crypto')
+const { computeChatChecksum } = require('../datatypes/checksums')
 const concat = require('../transforms/binaryStream').concat
 const debug = require('debug')('minecraft-protocol')
 const messageExpireTime = 300000 // 5 min (ms)
@@ -104,6 +105,14 @@ module.exports = function (client, server, options) {
     }
     lastTimestamp = packet.timestamp
 
+    // Validate checksum for 1.21.5+
+    if (client.supportFeature('chatGlobalIndexAndChecksum') && options.enforceChatChecksum && packet.checksum !== undefined) {
+      const expectedChecksum = computeChatChecksum(client._lastSeenMessages || [])
+      if (packet.checksum !== 0 && packet.checksum !== expectedChecksum) {
+        return raise('multiplayer.disconnect.chat_validation_failed')
+      }
+    }
+
     // Checks here: 1) make sure client can chat, 2) chain/session is OK, 3) signature is OK, 4) log if expired
     if (client.settings.disabledChat) return raise('chat.disabled.options')
     if (client.supportFeature('chainedChatWithHashing')) validateMessageChain(packet) // 1.19.1

src/version.js

@@ -1,6 +1,6 @@
 'use strict'
 
 module.exports = {
-  defaultVersion: '1.21.1',
-  supportedVersions: ['1.7', '1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17.1', '1.18.2', '1.19', '1.19.2', '1.19.3', '1.19.4', '1.20', '1.20.1', '1.20.2', '1.20.4', '1.20.6', '1.21.1', '1.21.3', '1.21.4']
+  defaultVersion: '1.21.5',
+  supportedVersions: ['1.7', '1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17.1', '1.18.2', '1.19', '1.19.2', '1.19.3', '1.19.4', '1.20', '1.20.1', '1.20.2', '1.20.4', '1.20.6', '1.21.1', '1.21.3', '1.21.4', '1.21.5']
 }

test/clientTest.js

@@ -100,6 +100,8 @@ for (const supportedVersion of mc.supportedVersions) {
         })
       })
 
+      // chat/Style.java
+      const CLICK_EVENT = mcData.version['>=']('1.21.5') ? 'click_event' : 'clickEvent'
       it('connects successfully - offline mode', function (done) {
         const client = applyClientHelpers(mc.createClient({
           username: 'Player',
@@ -198,10 +200,9 @@ for (const supportedVersion of mc.supportedVersions) {
 
             if (chatCount === 1) {
               assert.strictEqual(plainMessage, 'hello everyone; I have logged in.')
-              assert.deepEqual(sender.clickEvent, {
-                action: 'suggest_command',
-                value: '/tell Player '
-              })
+              const clickEvent = sender[CLICK_EVENT]
+              assert.strictEqual(clickEvent.action, 'suggest_command')
+              assert.ok(['/tell Player ', '/msg Player '].includes(clickEvent.value || clickEvent.command))
               assert.strictEqual(sender.text, 'Player')
             } else if (chatCount === 2) {
               const plainSender = client.parseMessage(sender).toString()
@@ -222,7 +223,7 @@ for (const supportedVersion of mc.supportedVersions) {
           const message = JSON.parse(data.formattedMessage)
           if (chatCount === 1) {
             assert.strictEqual(message.translate, 'chat.type.text')
-            assert.deepEqual(message.with[0].clickEvent, {
+            assert.deepEqual(message.with[0][CLICK_EVENT], {
               action: 'suggest_command',
               value: mcData.version.version > 340 ? '/tell Player ' : '/msg Player '
             })