Merge upstream

Author: Scarsz

.github/FUNDING.yml

@@ -1,3 +1 @@
 # These are supported funding model platforms
-
-issuehunt: PrismarineJS/node-minecraft-protocol

.github/workflows/ci.yml

@@ -13,7 +13,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        mcVersion: ['1.7', '1.8', '1.9', '1.10', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17', '1.17.1', '1.18']
+        mcVersion: ['1.7', '1.8', '1.9', '1.10', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.5', '1.17', '1.17.1', '1.18.2', '1.19']
+      fail-fast: false
 
     steps:
     - uses: actions/checkout@v2

docs/API.md

@@ -15,17 +15,23 @@ automatically logged in and validated against mojang's auth.
  * beforePing : allow customisation of the answer to ping the server does. 
  It takes a function with argument response and client, response is the default json response, and client is client who sent a ping.
  It can take as third argument a callback. If the callback is passed, the function should pass its result to the callback, if not it should return.
+ If the result is `false` instead of a response object then the connection is terminated and no ping is returned to the client.
  * beforeLogin : allow customisation of client before the `success` packet is sent.
  It takes a function with argument client and should be synchronous for the server to wait for completion before continuing execution.
  * motd : default to "A Minecraft server"
+ * motdMsg : A json object of the chat message to use instead of `motd`. Can be build using [prismarine-chat](https://github.com/PrismarineJS/prismarine-chat) and calling .toJSON(). Not used with legacy pings.
  * maxPlayers : default to 20
  * keepAlive : send keep alive packets : default to true
- * version : 1.8 or 1.9 : default to 1.8
+ * version : the version of the server, defaults to the latest version. Set version to `false` to enable dynamic cross version support.
+ * fallbackVersion (optional) : the version that should be used as a fallback, if the client version isn't supported, only works with dynamic cross version support.
+ * favicon (optional) : the favicon to set, base64 encoded
  * customPackets (optional) : an object index by version/state/direction/name, see client_custom_packet for an example
  * errorHandler : A way to override the default error handler for client errors. A function that takes a Client and an error.
  The default kicks the client.
  * hideErrors : do not display errors, default to false
- * agent : a http agent that can be used to set proxy settings for yggdrasil authentication confirmation (see proxy-agent on npm) 
+ * agent : a http agent that can be used to set proxy settings for yggdrasil authentication confirmation (see proxy-agent on npm)
+ * validateChannelProtocol (optional) : whether or not to enable protocol validation for custom protocols using plugin channels for the connected clients. Defaults to true
+ * enforceSecureProfile (optional) : Kick clients that do not have chat signing keys from Mojang (1.19+)
 
 ## mc.Server(version,[customPackets])
 
@@ -35,6 +41,10 @@ Create a server instance for `version` of minecraft.
 
 Write a packet to all `clients` but encode it only once.
 
+### client.verifyMessage(packet) : boolean
+
+Verifies if player's chat message packet was signed with their Mojang provided key
+
 ### server.onlineModeExceptions
 
 This is a plain old JavaScript object. Add a key with the username you want to
@@ -72,6 +82,14 @@ Called when a client connects, but before any login has happened. Takes a
 
 Called when a client is logged in against server. Takes a `Client` parameter.
 
+### `listening` event
+
+Called when the server is listening for connections. This means that the server is ready to accept incoming connections.
+
+### `close` event
+
+Called when the server is no longer listening to incoming connections.
+
 
 ## mc.createClient(options)
 
@@ -80,16 +98,20 @@ Returns a `Client` instance and perform login.
 `options` is an object containing the properties :
  * username
  * port : default to 25565
- * auth : the type of account to use, either `microsoft` or `mojang`. default to 'mojang'
+ * auth : the type of account to use, either `microsoft`, `mojang`, `offline` or `function (client, options) => void`. defaults to 'offline'.
  * password : can be omitted
    * (microsoft account) leave this blank to use device code auth. If you provide
    a password, we try to do username and password auth, but this does not always work.
    * (mojang account) If provided, we auth with the username and password. If this
    is blank, and `profilesFolder` is specified, we auth with the tokens there instead.
    If neither `password` or `profilesFolder` are specified, we connect in offline mode.
  * host : default to localhost
- * clientToken : generated if a password is given
- * accessToken : generated if a password or microsoft account is given
+ * session : An object holding clientToken, accessToken and selectedProfile. Generated after logging in using username + password with mojang auth or after logging in using microsoft auth. `clientToken`, `accessToken` and `selectedProfile: {name: '<username>', id: '<selected profile uuid>'}` can be set inside of `session` when using createClient to login with a client and access Token instead of a password. `session` is also emitted by the `Client` instance with the event 'session' after successful authentication. 
+   * clientToken : generated if a password is given or can be set when when using createClient
+   * accessToken : generated if a password or microsoft account is given or can be set when using createBot
+   * selectedProfile : generated if a password or microsoft account is given. Can be set as a object with property `name` and `id` that specifies the selected profile.
+     * name : The selected profiles in game name needed for logging in with access and client Tokens.
+     * id : The selected profiles uuid in short form (without `-`) needed for logging in with access and client Tokens.
  * authServer : auth server, default to https://authserver.mojang.com
  * sessionServer : session server, default to https://sessionserver.mojang.com
  * keepAlive : send keep alive packets : default to true
@@ -111,7 +133,8 @@ Returns a `Client` instance and perform login.
  * onMsaCode(data) : (optional) callback called when signing in with a microsoft account
  with device code auth. `data` is an object documented [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-device-code#device-authorization-response)
  * id : a numeric client id used for referring to multiple clients in a server
-
+ * validateChannelProtocol (optional) : whether or not to enable protocol validation for custom protocols using plugin channels. Defaults to true
+ * disableChatSigning (optional) : Don't try obtaining chat signing keys from Mojang (1.19+)
 
 ## mc.Client(isServer,version,[customPackets])
 
@@ -250,6 +273,13 @@ Start emitting channel events of the given name on the client object.
 
 Unregister a channel `name` and send the unregister packet if `custom` is true.
 
+### client.signMessage(message: string, timestamp: BigInt, salt?: number) : Buffer
+
+Generate a signature for a chat message to be sent to server
+
+### client.verifyMessage(publicKey: Buffer | KeyObject, packet) : boolean
+
+Verifies a player chat packet sent by another player against their public key
 
 ## Not Immediately Obvious Data Type Formats
 
@@ -318,6 +348,10 @@ The minecraft protocol states.
 
 The supported minecraft versions.
 
+## mc.defaultVersion
+
+The current default minecraft version.
+
 ## mc.createSerializer({ state = states.HANDSHAKING, isServer = false , version})
 
 Returns a minecraft protocol [serializer](https://github.com/roblabla/ProtoDef#serializerprotomaintype) for these parameters.

docs/FAQ.md

@@ -1,20 +1,29 @@
-## FAQ
+# FAQ
 
 This Frequently Asked Question document is meant to help people for the most common things.
 
-### How to hide errors ?
+## How to hide errors ?
 
 Use `hideErrors: true` in createClient options
 You may also choose to add these listeners :
+
 ```js
 client.on('error', () => {})
 client.on('end', () => {})
 ```
 
-### How can I make a proxy with this ?
+## How can I make a proxy with this ?
+
+* Check out our WIP proxy lib <https://github.com/PrismarineJS/prismarine-proxy>
+* See this example <https://github.com/PrismarineJS/node-minecraft-protocol/tree/master/examples/proxy>
+* Read this issue <https://github.com/PrismarineJS/node-minecraft-protocol/issues/712>
+* check out <https://github.com/Heath123/pakkit>
+* Check out this app <https://github.com/wvffle/minecraft-packet-debugger>
+
+## Can you support alternative auth methods?
+
+Supporting alternative authentcation methods has been a long standing issue with Prismarine for awhile. We do add support for using your own custom authentication method by providing a function to the `options.auth` property. In order to keep the legitimacy of the project, and to prevent bad attention from Mojang, we will not be supporting any custom authentication methods in the official repositories.
+
+It is up to the end user to support and maintain the authentication protocol if this is used as support in many of the official channels will be limited.
 
-* Check out our WIP proxy lib https://github.com/PrismarineJS/prismarine-proxy
-* See this example https://github.com/PrismarineJS/node-minecraft-protocol/tree/master/examples/proxy
-* Read this issue https://github.com/PrismarineJS/node-minecraft-protocol/issues/712
-* check out https://github.com/Heath123/pakkit
-* Check out this app https://github.com/wvffle/minecraft-packet-debugger
+If you still wish to proceed, please make sure to throughly read and attempt to understand all implementations of the authentcation you wish to implement. Using an non-official authentication server can make you vulnerable to all different kinds of attacks which are not limited to insecure and/or malicious code! We will not be held responsible for anything you mess up.

docs/HISTORY.md

@@ -1,5 +1,61 @@
 # History
 
+* Fix new types not being optional. (@IceTank) [#1033](https://github.com/PrismarineJS/node-minecraft-protocol/pull/1033)
+
+## 1.36.0
+
+* Use offline mode as default authentication, fallback to offline mode if invalid option. (@Kashalls)
+* Provide interface for using not at all supported alternative accounts. (@Kashalls)
+* 1.19 support (@extremeheat)
+* Fix unhandled promise rejection on ms auth (@IceTank)
+
+## 1.35.1
+
+* add custom minecraft type varlong which aliases to varint @rob9315
+
+## 1.35.0
+
+* Add option to not answer to pings (@matthi4s)
+* Add fallback version for dynamic version (@matthi4s) 
+* Add motdMsg to createServer (@IceTank & @U9G)
+* Bump mocha to 10.x
+* Bump standard to 17.x
+
+## 1.34.0
+
+* Export defaultVersion (@matthi4s)
+* Fix missing readable-stream types (@IceTank)
+
+## 1.33.0
+
+* Bump mcdata
+
+## 1.32.2
+
+* fix: cross version ping
+
+## 1.32.1
+
+* fix protocolValidation not being optional in .d.ts typings (@IceTank)
+
+## 1.32.0
+
+* add protocolValidation field to server and client options (@RichardDorian)
+* fix plugin channel registration (@RichardDorian)
+* allows false value for profilesFolder (@Robbilie)
+
+## 1.31.0
+
+* 1.18.2
+
+## 1.30.0
+
+* add reasons for client.end() & fix issues (@U5B)
+
+## 1.29.1
+
+* Remove entitlement check in microsoftAuth (#929)
+
 ## 1.29.0
 
 * 1.18.0 support

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.17 (21w07a, 1.17, 1.17.1), 1.18
+  , 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.17 (21w07a, 1.17, 1.17.1), 1.18 (1.18, 1.18.1 and 1.18.2), 1.19
  * Parses all packets and emits events with packet fields as JavaScript
    objects.
  * Send a packet by supplying fields as a JavaScript object.
@@ -51,9 +51,10 @@ node-minecraft-protocol is pluggable.
    create bots.
  * [flying-squid](https://github.com/PrismarineJS/flying-squid) - Create minecraft
    servers with a high level API, also a minecraft server by itself.
- * [pakkit](https://github.com/Heath123/pakkit) - A GUI tool to monitor Minecraft packets in real time, allowing you to view their data and interactively edit and resend them
- * [minecraft-packet-debugger](https://github.com/wvffle/minecraft-packet-debugger) - A tool to capture Minecraft packets in a buffer then view them in a browser
- * [aresrpg](https://github.com/aresrpg/aresrpg) - An open-source mmorpg minecraft server
+ * [pakkit](https://github.com/Heath123/pakkit) - A GUI tool to monitor Minecraft packets in real time, allowing you to view their data and interactively edit and resend them.
+ * [minecraft-packet-debugger](https://github.com/wvffle/minecraft-packet-debugger) - A tool to capture Minecraft packets in a buffer then view them in a browser.
+ * [aresrpg](https://github.com/aresrpg/aresrpg) - An open-source mmorpg minecraft server.
+ * [SteveProxy](https://github.com/SteveProxy/proxy) - Proxy for Minecraft with the ability to change the gameplay using plugins.
  * and [several thousands others](https://github.com/PrismarineJS/node-minecraft-protocol/network/dependents?package_id=UGFja2FnZS0xODEzMDk0OQ%3D%3D)
 
 ## Installation
@@ -77,7 +78,7 @@ var client = mc.createClient({
   port: 25565,         // optional
   username: "[email protected]",
   password: "12345678",
-  auth: 'mojang' // optional; by default uses mojang, if using a microsoft account, set to 'microsoft'
+  auth: 'microsoft' // optional; by default uses offline mode, if using a microsoft account, set to 'microsoft'
 });
 client.on('chat', function(packet) {
   // Listen for chat messages and echo them back.
@@ -91,7 +92,7 @@ client.on('chat', function(packet) {
 });
 ```
 
-If the server is in offline mode, you may leave out the `password` option.
+If the server is in offline mode, you may leave out the `password` option and switch auth to `offline`.
 You can also leave out `password` when using a Microsoft account. If provided, password based auth will be attempted first which may fail. *Note:* if using a Microsoft account, your account age must be >= 18 years old.
 
 ### Hello World server example