aboutsummaryrefslogtreecommitdiff
path: root/doc/protocol.txt
blob: b151f88d8b356d7941c777b9425e68b9363ef289 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
Minetest protocol (incomplete, early draft):
Updated 2011-06-18

A custom protocol over UDP.
Integers are big endian.
Refer to connection.{h,cpp} for further reference.

Initialization:
- A dummy reliable packet with peer_id=PEER_ID_INEXISTENT=0 is sent to the server:
	- Actually this can be sent without the reliable packet header, too, i guess,
	  but the sequence number in the header allows the sender to re-send the
	  packet without accidentally getting a double initialization.
	- Packet content:
		# Basic header
		u32 protocol_id = PROTOCOL_ID = 0x4f457403
		u16 sender_peer_id = PEER_ID_INEXISTENT = 0
		u8 channel = 0
		# Reliable packet header
		u8 type = TYPE_RELIABLE = 3
		u16 seqnum = SEQNUM_INITIAL = 65500
		# Original packet header
		u8 type = TYPE_ORIGINAL = 1
		# And no actual payload.
- Server responds with something like this:
	- Packet content:
		# Basic header
		u32 protocol_id = PROTOCOL_ID = 0x4f457403
		u16 sender_peer_id = PEER_ID_INEXISTENT = 0
		u8 channel = 0
		# Reliable packet header
		u8 type = TYPE_RELIABLE = 3
		u16 seqnum = SEQNUM_INITIAL = 65500
		# Control packet header
		u8 type = TYPE_CONTROL = 0
		u8 controltype = CONTROLTYPE_SET_PEER_ID = 1
		u16 peer_id_new = assigned peer id to client (other than 0 or 1)
- Then the connection can be disconnected by sending:
	- Packet content:
		# Basic header
		u32 protocol_id = PROTOCOL_ID = 0x4f457403
		u16 sender_peer_id = whatever was gotten in CONTROLTYPE_SET_PEER_ID
		u8 channel = 0
		# Control packet header
		u8 type = TYPE_CONTROL = 0
		u8 controltype = CONTROLTYPE_DISCO = 3

- Here's a quick untested connect-disconnect done in PHP:
# host: ip of server (use gethostbyname(hostname) to get from a dns name)
# port: port of server
function check_if_minetestserver_up($host, $port)
{
	$socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
	$timeout = array("sec" => 1, "usec" => 0);
	socket_set_option($socket, SOL_SOCKET, SO_RCVTIMEO, $timeout);
	$buf = "\x4f\x45\x74\x03\x00\x00\x00\x03\xff\xdc\x01";
	socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
	$buf = socket_read($socket, 1000);
	if($buf != "")
	{
		# We got a reply! read the peer id from it.
		$peer_id = substr($buf, 9, 2);
		
		# Disconnect
		$buf = "\x4f\x45\x74\x03".$peer_id."\x00\x00\x03";
		socket_sendto($socket, $buf, strlen($buf), 0, $host, $port);
		socket_close($socket);
		
		return true;
	}
	return false;
}

- Here's a Python script for checking if a minetest server is up, confirmed working
#!/usr/bin/env python
import sys, time, socket
address = ""
port = 30000
if len(sys.argv) <= 1:
    print("Usage: %s <address>" % sys.argv[0])
    exit()
if ':' in sys.argv[1]:
    address = sys.argv[1].split(':')[0]
    try:
        port = int(sys.argv[1].split(':')[1])
    except ValueError:
        print("Please specify a valid port")
        exit()
else:
    address = sys.argv[1]

try:
    start = time.time()
    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    sock.settimeout(2.0)
    buf = "\x4f\x45\x74\x03\x00\x00\x00\x01"
    sock.sendto(buf, (address, port))
    data, addr = sock.recvfrom(1000)
    if data:
        peer_id = data[12:14]
        buf = "\x4f\x45\x74\x03" + peer_id + "\x00\x00\x03"
        sock.sendto(buf, (address, port))
        sock.close()
        end = time.time()
        print("%s is up (%0.5fms)" % (sys.argv[1],end-start))
    else:
        print("%s seems to be down " % sys.argv[1])
except:
    print("%s seems to be down " % sys.argv[1])
e Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "server/activeobjectmgr.h" #include <algorithm> #include <queue> #include "test.h" #include "profiler.h" class TestServerActiveObject : public ServerActiveObject { public: TestServerActiveObject(const v3f &p = v3f()) : ServerActiveObject(nullptr, p) {} ~TestServerActiveObject() = default; ActiveObjectType getType() const override { return ACTIVEOBJECT_TYPE_TEST; } bool getCollisionBox(aabb3f *toset) const override { return false; } bool getSelectionBox(aabb3f *toset) const override { return false; } bool collideWithObjects() const override { return false; } }; class TestServerActiveObjectMgr : public TestBase { public: TestServerActiveObjectMgr() { TestManager::registerTestModule(this); } const char *getName() { return "TestServerActiveObjectMgr"; } void runTests(IGameDef *gamedef); void testFreeID(); void testRegisterObject(); void testRemoveObject(); void testGetObjectsInsideRadius(); void testGetAddedActiveObjectsAroundPos(); }; static TestServerActiveObjectMgr g_test_instance; void TestServerActiveObjectMgr::runTests(IGameDef *gamedef) { TEST(testFreeID); TEST(testRegisterObject) TEST(testRemoveObject) TEST(testGetObjectsInsideRadius); TEST(testGetAddedActiveObjectsAroundPos); } void clearSAOMgr(server::ActiveObjectMgr *saomgr) { auto clear_cb = [](ServerActiveObject *obj, u16 id) { delete obj; return true; }; saomgr->clear(clear_cb); } //////////////////////////////////////////////////////////////////////////////// void TestServerActiveObjectMgr::testFreeID() { server::ActiveObjectMgr saomgr; std::vector<u16> aoids; u16 aoid = saomgr.getFreeId(); // Ensure it's not the same id UASSERT(saomgr.getFreeId() != aoid); aoids.push_back(aoid); // Register basic objects, ensure we never found for (u8 i = 0; i < UINT8_MAX; i++) { // Register an object auto tsao = new TestServerActiveObject(); saomgr.registerObject(tsao); aoids.push_back(tsao->getId()); // Ensure next id is not in registered list UASSERT(std::find(aoids.begin(), aoids.end(), saomgr.getFreeId()) == aoids.end()); } clearSAOMgr(&saomgr); } void TestServerActiveObjectMgr::testRegisterObject() { server::ActiveObjectMgr saomgr; auto tsao = new TestServerActiveObject(); UASSERT(saomgr.registerObject(tsao)); u16 id = tsao->getId(); auto tsaoToCompare = saomgr.getActiveObject(id); UASSERT(tsaoToCompare->getId() == id); UASSERT(tsaoToCompare == tsao); tsao = new TestServerActiveObject(); UASSERT(saomgr.registerObject(tsao)); UASSERT(saomgr.getActiveObject(tsao->getId()) == tsao); UASSERT(saomgr.getActiveObject(tsao->getId()) != tsaoToCompare); clearSAOMgr(&saomgr); } void TestServerActiveObjectMgr::testRemoveObject() { server::ActiveObjectMgr saomgr; auto tsao = new TestServerActiveObject(); UASSERT(saomgr.registerObject(tsao)); u16 id = tsao->getId(); UASSERT(saomgr.getActiveObject(id) != nullptr) saomgr.removeObject(tsao->getId()); UASSERT(saomgr.getActiveObject(id) == nullptr); clearSAOMgr(&saomgr); } void TestServerActiveObjectMgr::testGetObjectsInsideRadius() { server::ActiveObjectMgr saomgr; static const v3f sao_pos[] = { v3f(10, 40, 10), v3f(740, 100, -304), v3f(-200, 100, -304), v3f(740, -740, -304), v3f(1500, -740, -304), }; for (const auto &p : sao_pos) { saomgr.registerObject(new TestServerActiveObject(p)); } std::vector<ServerActiveObject *> result; saomgr.getObjectsInsideRadius(v3f(), 50, result, nullptr); UASSERTCMP(int, ==, result.size(), 1); result.clear(); saomgr.getObjectsInsideRadius(v3f(), 750, result, nullptr); UASSERTCMP(int, ==, result.size(), 2); result.clear(); saomgr.getObjectsInsideRadius(v3f(), 750000, result, nullptr); UASSERTCMP(int, ==, result.size(), 5); result.clear(); auto include_obj_cb = [](ServerActiveObject *obj) { return (obj->getBasePosition().X != 10); }; saomgr.getObjectsInsideRadius(v3f(), 750000, result, include_obj_cb); UASSERTCMP(int, ==, result.size(), 4); clearSAOMgr(&saomgr); } void TestServerActiveObjectMgr::testGetAddedActiveObjectsAroundPos() { server::ActiveObjectMgr saomgr; static const v3f sao_pos[] = { v3f(10, 40, 10), v3f(740, 100, -304), v3f(-200, 100, -304), v3f(740, -740, -304), v3f(1500, -740, -304), }; for (const auto &p : sao_pos) { saomgr.registerObject(new TestServerActiveObject(p)); } std::queue<u16> result; std::set<u16> cur_objects; saomgr.getAddedActiveObjectsAroundPos(v3f(), 100, 50, cur_objects, result); UASSERTCMP(int, ==, result.size(), 1); result = std::queue<u16>(); cur_objects.clear(); saomgr.getAddedActiveObjectsAroundPos(v3f(), 740, 50, cur_objects, result); UASSERTCMP(int, ==, result.size(), 2); clearSAOMgr(&saomgr); }