User:Sean/ClassicPrototest - Revision history

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:41Z

← Older revision	Revision as of 17:32, 9 April 2019
(No difference)

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:41Z

← Older revision	Revision as of 17:32, 9 April 2019
(No difference)

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:41Z

← Older revision	Revision as of 17:32, 9 April 2019
(No difference)

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:41Z

← Older revision		Revision as of 17:32, 9 April 2019
Line 31:		Line 31:
	The simplest way to send a heartbeat is to open a TCP socket to port 80 on minecraft.net, and send the following (with the values changed, obviously):		The simplest way to send a heartbeat is to open a TCP socket to port 80 on minecraft.net, and send the following (with the values changed, obviously):

	'''GET /heartbeat.jsp?port=25565&max=32&name=My%20Server&public=True&version=7&salt=wo6kVAHjxoJcInKx&users=0''', plus a CRLF(Carriage-return and Line feed).		<tt>'''GET /heartbeat.jsp?port=25565&max=32&name=My%20Server&public=True&version=7&salt=wo6kVAHjxoJcInKx&users=0'''</tt>, plus a CRLF(Carriage-return and Line feed).

	Make sure any strings, like name, are escaped.		Make sure any strings, like name, are escaped.

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:22Z

← Older revision	Revision as of 17:32, 9 April 2019
(No difference)

imported>Sean at 17:32, 9 April 2019

2019-04-09T17:32:22Z

← Older revision		Revision as of 17:32, 9 April 2019
Line 1:		Line 1:
	Documentation on the network protocol used by Minecraft Classic and clones ~~(e.g. [https://www.classicube.net ClassiCube])~~.		Documentation on the network protocol used by Minecraft Classic and clones.

	==~~ClassiCube~~ Communication==		==Minecraft.net Communication==
			'''Note:''' Minecraft Classic has not been available on minecraft.net for a long time. You may want to use alternative services, such as [https://www.classicube.net ClassiCube] or [https://www.retrocraft.net Retrocraft].
	===Heartbeats===		===Heartbeats===
	To be able to connect to a server in ~~ClassiCube~~ from the Server List, a server must broadcast to ~~classicube~~.net a so-called "heartbeat" every few minutes.		To be able to connect to a server in Minecraft Classic from the Server List, a server must broadcast to minecraft.net a so-called "heartbeat" every few minutes.

	~~Most servers broadcast~~ this heartbeat every 45 seconds.		The stock server broadcasts this heartbeat every 45 seconds.

	A "heartbeat" takes the form of an HTTP request to ~~<tt>https~~://www.~~classicube~~.net~~/server/heartbeat</tt> (<tt>~~/heartbeat.jsp~~</tt> is also accepted, and normal insecure HTTP can be used but is not recommended)~~.		A "heartbeat" takes the form of an HTTP request to http://www.minecraft.net/heartbeat.jsp.
	After sending a heartbeat, the URL for the server is returned ~~as the response body, or an error is returned in JSON format~~.		After sending a heartbeat, the URL for the server is returned.

	It can be a GET or POST request. A table of the required parameters is below:		It can be a GET or POST request. A table of the required parameters is below:
Line 20:		Line 21:
	\|name \|\| The name of the server		\|name \|\| The name of the server
	\|-		\|-
	\|public \|\| Whether the server is public (i.e. appears in the lobby) or not. Can be '''~~true~~''' or '''~~false~~''' ~~(case insensitive)~~		\|public \|\| Whether the server is public (i.e. appears in the lobby) or not. Can be '''True''' or '''False''', in that capitalisation.
	\|-		\|-
	\|salt \|\| A random ~~string of characters~~		\|version \|\| Minecraft version, this should be 7
			\|-
			\|salt \|\| A random, 16-character base-62 salt
	\|-		\|-
	\|users \|\| Number of users connected to the server		\|users \|\| Number of users connected to the server
	\|-
	~~\|software \|\| (optional) Name of the software running the server~~
	\|}		\|}
			The simplest way to send a heartbeat is to open a TCP socket to port 80 on minecraft.net, and send the following (with the values changed, obviously):

			'''GET /heartbeat.jsp?port=25565&max=32&name=My%20Server&public=True&version=7&salt=wo6kVAHjxoJcInKx&users=0''', plus a CRLF(Carriage-return and Line feed).

			Make sure any strings, like name, are escaped.

	~~Also see~~ the ~~[https://www~~.~~classicube~~.~~net~~/~~api/ ClassiCube API documentation]~~.		If everything goes well, in the response body you'll receive a URL to the server. Otherwise you'll get a nice HTML error message. There aren't an HTML headers to parse, as the HTTP version is not specified so HTTP/0.9 is used, which does not have headers.

	===User Authentication===		===User Authentication===
	The "key" provided when a user joins the server can be compared to the MD5 checksum of the server's "salt" plus the username to verify that the user is logged in to ~~ClassiCube~~ with that username. This is useful for establishing enough trust of the name provided to ban or op the player by name.		The "key" provided when a user joins the server can be compared to the MD5 checksum of the server's "salt" plus the username to verify that the user is logged in to minecraft.net with that username. This is useful for establishing enough trust of the name provided to ban or op the player by name.

	if (player.key == md5(server.salt + player.name)) {		<syntaxhighlight lang="Java">
	// player is logged in		if (player.key == md5(server.salt + player.name)) {
	} else {		// player is logged in via minecraft.net
	// player is forging the username		} else {
	}		// player is forging the username
			}
			</syntaxhighlight>

	Note: This means that you should make sure your "salt" is kept a secret and shared only with ~~the~~ heartbeat ~~interface~~. If your server's "salt" is visible anywhere to users, it is trivial for users to produce valid-looking "key"s without being logged in to ~~ClassiCube~~.		Note: This means that you should make sure your "salt" is kept a secret and shared only with heartbeat.jsp. If your server's "salt" is visible anywhere to users, it is trivial for users to produce valid-looking "key"s without being logged in to minecraft.net.

	===Skins===		===Skins===
	Skins for a player are downloaded by the client from '''~~https~~://~~www.classicube~~.net/~~skins~~/skinname.png''', where skinname is the name of the player. This means that the name for a player can be faked to give a desired skin.		Skins for a player are downloaded by the client from '''http://minecraft.net/skin/skinname.png''', where skinname is the name of the player. This means that the name for a player can be faked to give a desired skin.

	==Packet Protocol==		==Packet Protocol==

imported>Sean at 16:21, 9 April 2019

2019-04-09T16:21:09Z

← Older revision	Revision as of 16:21, 9 April 2019
(No difference)

imported>Sean at 16:21, 9 April 2019

2019-04-09T16:21:09Z

← Older revision		Revision as of 16:21, 9 April 2019
Line 32:		Line 32:

	===User Authentication===		===User Authentication===
	The "key" provided when a user joins the server can be compared to the MD5 checksum of the server's "salt" plus the username to verify that the user is logged in to ~~minecraft.net~~ with that username. This is useful for establishing enough trust of the name provided to ban or op the player by name.		The "key" provided when a user joins the server can be compared to the MD5 checksum of the server's "salt" plus the username to verify that the user is logged in to ClassiCube with that username. This is useful for establishing enough trust of the name provided to ban or op the player by name.

	if (player.key == md5(server.salt + player.name)) {		if (player.key == md5(server.salt + player.name)) {

imported>Sean at 16:19, 9 April 2019

2019-04-09T16:19:06Z

← Older revision	Revision as of 16:19, 9 April 2019
(No difference)

imported>Sean at 16:19, 9 April 2019

2019-04-09T16:19:06Z

← Older revision		Revision as of 16:19, 9 April 2019
Line 337:		Line 337:
	It is important to note that an ampersand at the end of a message that is not followed by a hex digit will crash all clients that receive it, so it is a must to sanitize chat messages received from clients.		It is important to note that an ampersand at the end of a message that is not followed by a hex digit will crash all clients that receive it, so it is a must to sanitize chat messages received from clients.

	The algorithm to get the RGB bytes from a color code is as follows:		The algorithm to get the RGB bytes from color code <tt>c</tt> is as follows:
	<syntaxhighlight lang="Java">		<syntaxhighlight lang="Java">
	int cc = "0123456789abcdef".indexOf(c);		int cc = "0123456789abcdef".indexOf(c);