Merge Mendax into protocol/ for easy development.

This commit is contained in:
md_5 2013-02-09 19:03:45 +11:00
commit d5bf71b4b7
15 changed files with 486 additions and 0 deletions

34
protocol/.gitignore vendored Normal file
View File

@ -0,0 +1,34 @@
# Eclipse stuff
/.classpath
/.project
/.settings
# netbeans
/nbproject
/nbactions.xml
/nb-configuration.xml
# we use maven!
/build.xml
# maven
/target
/dependency-reduced-pom.xml
# vim
.*.sw[a-p]
# various other potential build files
/build
/bin
/dist
/manifest.mf
# Mac filesystem dust
/.DS_Store
# intellij
*.iml
*.ipr
*.iws
.idea/

20
protocol/README.md Normal file
View File

@ -0,0 +1,20 @@
Mendax
======
The Minecraft protocol is a lie!
--------------------------------
Mendax is a predominantly I Minecraft protocol parser and inspector. It also includes a built in proxy.
History
-------
MinecraftProtocolLib was designed to be the most efficient way of separating the Minecraft protocol into byte arrays. With other tools like SMProxy by @SirCmpwn and MinerHat by @sk89q becoming obsolete, the decision was made to expand MinecraftProtocolLib into a parser as well. Mendax is that parser.
With no runtime dependencies Mendax is the perfect choice for use in your next Java, Minecraft related project.
Operation
---------
Mendax has 2 modes of operation.
- Parsing Mode - Bytes are read from an InputStream and returned in byte arrays. This mode is the most efficient, however the raw data itself is not very useful
- Inspection Mode - Bytes are read from an InputStream and Packet objects are returned. These packet objects contain all useable information about a packet. In this mode Items, Locations and Compressed Data are expanded into their own fields and data types.
>Please note that the above features may not be entirely implemented in the current version of Mendax. Additionally breaking changes may occur without warning, however they should all be easy to update.

25
protocol/pom.xml Normal file
View File

@ -0,0 +1,25 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>net.md-5</groupId>
<artifactId>mendax</artifactId>
<version>1.4.6-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Mendax</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,127 @@
package net.md_5.mendax;
import static net.md_5.mendax.PacketDefinitions.OpCode.*;
public class PacketDefinitions {
public static final OpCode[][] opCodes = new OpCode[256][];
public enum OpCode {
BOOLEAN, BULK_CHUNK, BYTE, BYTE_INT, DOUBLE, FLOAT, INT, INT_3, INT_BYTE, ITEM, LONG, METADATA, OPTIONAL_MOTION, SHORT, SHORT_BYTE, SHORT_ITEM, STRING, USHORT_BYTE
}
static {
opCodes[0x00] = new OpCode[]{INT};
opCodes[0x01] = new OpCode[]{INT, STRING, BYTE, BYTE, BYTE, BYTE, BYTE};
opCodes[0x02] = new OpCode[]{BYTE, STRING, STRING, INT};
opCodes[0x03] = new OpCode[]{STRING};
opCodes[0x04] = new OpCode[]{LONG, LONG};
opCodes[0x05] = new OpCode[]{INT, SHORT, ITEM};
opCodes[0x06] = new OpCode[]{INT, INT, INT};
opCodes[0x07] = new OpCode[]{INT, INT, BOOLEAN};
opCodes[0x08] = new OpCode[]{SHORT, SHORT, FLOAT};
opCodes[0x09] = new OpCode[]{INT, BYTE, BYTE, SHORT, STRING};
opCodes[0x0A] = new OpCode[]{BOOLEAN};
opCodes[0x0B] = new OpCode[]{DOUBLE, DOUBLE, DOUBLE, DOUBLE, BOOLEAN};
opCodes[0x0C] = new OpCode[]{FLOAT, FLOAT, BOOLEAN};
opCodes[0x0D] = new OpCode[]{DOUBLE, DOUBLE, DOUBLE, DOUBLE, FLOAT, FLOAT, BOOLEAN};
opCodes[0x0E] = new OpCode[]{BYTE, INT, BYTE, INT, BYTE};
opCodes[0x0F] = new OpCode[]{INT, BYTE, INT, BYTE, ITEM, BYTE, BYTE, BYTE};
opCodes[0x10] = new OpCode[]{SHORT};
opCodes[0x11] = new OpCode[]{INT, BYTE, INT, BYTE, INT};
opCodes[0x12] = new OpCode[]{INT, BYTE};
opCodes[0x13] = new OpCode[]{INT, BYTE};
opCodes[0x14] = new OpCode[]{INT, STRING, INT, INT, INT, BYTE, BYTE, SHORT, METADATA};
opCodes[0x16] = new OpCode[]{INT, INT};
opCodes[0x17] = new OpCode[]{INT, BYTE, INT, INT, INT, BYTE, BYTE, OPTIONAL_MOTION};
opCodes[0x18] = new OpCode[]{INT, BYTE, INT, INT, INT, BYTE, BYTE, BYTE, SHORT, SHORT, SHORT, METADATA};
opCodes[0x19] = new OpCode[]{INT, STRING, INT, INT, INT, INT};
opCodes[0x1A] = new OpCode[]{INT, INT, INT, INT, SHORT};
opCodes[0x1B] = null; // Does not exist
opCodes[0x1C] = new OpCode[]{INT, SHORT, SHORT, SHORT};
opCodes[0x1D] = new OpCode[]{BYTE_INT};
opCodes[0x1E] = new OpCode[]{INT};
opCodes[0x1F] = new OpCode[]{INT, BYTE, BYTE, BYTE};
opCodes[0x20] = new OpCode[]{INT, BYTE, BYTE};
opCodes[0x21] = new OpCode[]{INT, BYTE, BYTE, BYTE, BYTE, BYTE};
opCodes[0x22] = new OpCode[]{INT, INT, INT, INT, BYTE, BYTE};
opCodes[0x23] = new OpCode[]{INT, BYTE};
opCodes[0x24] = null; // Does not exist
opCodes[0x25] = null; // Does not exist
opCodes[0x26] = new OpCode[]{INT, BYTE};
opCodes[0x27] = new OpCode[]{INT, INT};
opCodes[0x28] = new OpCode[]{INT, METADATA};
opCodes[0x29] = new OpCode[]{INT, BYTE, BYTE, SHORT};
opCodes[0x2A] = new OpCode[]{INT, BYTE};
opCodes[0x2B] = new OpCode[]{FLOAT, SHORT, SHORT};
//
//
// 0x2C -> 0x32 Do not exist
//
//
opCodes[0x33] = new OpCode[]{INT, INT, BOOLEAN, SHORT, SHORT, INT_BYTE};
opCodes[0x34] = new OpCode[]{INT, INT, SHORT, INT_BYTE};
opCodes[0x35] = new OpCode[]{INT, BYTE, INT, SHORT, BYTE};
opCodes[0x36] = new OpCode[]{INT, SHORT, INT, BYTE, BYTE, SHORT};
opCodes[0x37] = new OpCode[]{INT, INT, INT, INT, BYTE};
opCodes[0x38] = new OpCode[]{BULK_CHUNK};
opCodes[0x39] = null; // Does not exist
opCodes[0x3A] = null; // Does not exist
opCodes[0x3B] = null; // Does not exist
opCodes[0x3C] = new OpCode[]{DOUBLE, DOUBLE, DOUBLE, FLOAT, INT_3, FLOAT, FLOAT, FLOAT};
opCodes[0x3D] = new OpCode[]{INT, INT, BYTE, INT, INT, BOOLEAN};
opCodes[0x3E] = new OpCode[]{STRING, INT, INT, INT, FLOAT, BYTE};
//
//
// 0x3F -> 0x45 Do not exist
//
//
opCodes[0x46] = new OpCode[]{BYTE, BYTE};
opCodes[0x47] = new OpCode[]{INT, BYTE, INT, INT, INT};
//
//
// 0x4A -> 0x63 Do not exist
//
//
opCodes[0x64] = new OpCode[]{BYTE, BYTE, STRING, BYTE};
opCodes[0x65] = new OpCode[]{BYTE};
opCodes[0x66] = new OpCode[]{BYTE, SHORT, BYTE, SHORT, BOOLEAN, ITEM};
opCodes[0x67] = new OpCode[]{BYTE, SHORT, ITEM};
opCodes[0x68] = new OpCode[]{BYTE, SHORT_ITEM};
opCodes[0x69] = new OpCode[]{BYTE, SHORT, SHORT};
opCodes[0x6A] = new OpCode[]{BYTE, SHORT, BOOLEAN};
opCodes[0x6B] = new OpCode[]{SHORT, ITEM};
opCodes[0x6C] = new OpCode[]{BYTE, BYTE};
//
//
// 0x6D -> 0x81 Do not exist
//
//
opCodes[0x82] = new OpCode[]{INT, SHORT, INT, STRING, STRING, STRING, STRING};
opCodes[0x83] = new OpCode[]{SHORT, SHORT, USHORT_BYTE};
opCodes[0x84] = new OpCode[]{INT, SHORT, INT, BYTE, SHORT_BYTE};
//
//
// 0x85 -> 0xC7 Do not exist
//
//
opCodes[0xC8] = new OpCode[]{INT, BYTE};
opCodes[0xC9] = new OpCode[]{STRING, BOOLEAN, SHORT};
opCodes[0xCA] = new OpCode[]{BYTE, BYTE, BYTE};
opCodes[0xCB] = new OpCode[]{STRING};
opCodes[0xCC] = new OpCode[]{STRING, BYTE, BYTE, BYTE, BOOLEAN};
opCodes[0xCD] = new OpCode[]{BYTE};
//
//
// 0xCE -> 0xF9 Do not exist
//
//
opCodes[0xFA] = new OpCode[]{STRING, SHORT_BYTE};
opCodes[0xFB] = null; // Does not exist
opCodes[0xFC] = new OpCode[]{SHORT_BYTE, SHORT_BYTE};
opCodes[0xFD] = new OpCode[]{STRING, SHORT_BYTE, SHORT_BYTE};
opCodes[0xFE] = new OpCode[]{}; // Should be byte, screw you too bitchy server admins!
opCodes[0xFF] = new OpCode[]{STRING};
}
}

View File

@ -0,0 +1,15 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
public class BulkChunk extends Instruction {
@Override
void read(DataInput in, byte[] buffer) throws IOException {
short count = in.readShort();
int size = in.readInt();
in.readBoolean();
skip(in, buffer, size + count * 12);
}
}

View File

@ -0,0 +1,21 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class ByteHeader extends Instruction {
private final Instruction child;
ByteHeader(Instruction child) {
this.child = child;
}
@Override
void read(DataInput in, byte[] buffer) throws IOException {
byte size = in.readByte();
for (byte b = 0; b < size; b++) {
child.read(in, buffer);
}
}
}

View File

@ -0,0 +1,62 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import net.md_5.mendax.PacketDefinitions;
import net.md_5.mendax.PacketDefinitions.OpCode;
public class DataInputPacketReader {
private static final Instruction[][] instructions = new Instruction[256][];
static {
for (int i = 0; i < instructions.length; i++) {
List<Instruction> output = new ArrayList<Instruction>();
OpCode[] enums = PacketDefinitions.opCodes[i];
if (enums != null) {
for (OpCode struct : enums) {
try {
output.add((Instruction) Instruction.class.getDeclaredField(struct.name()).get(null));
} catch (Exception ex) {
throw new UnsupportedOperationException("No definition for " + struct.name());
}
}
List<Instruction> crushed = new ArrayList<Instruction>();
int nextJumpSize = 0;
for (Instruction child : output) {
if (child instanceof Jump) {
nextJumpSize += ((Jump) child).len;
} else {
if (nextJumpSize != 0) {
crushed.add(new Jump(nextJumpSize));
}
crushed.add(child);
nextJumpSize = 0;
}
}
if (nextJumpSize != 0) {
crushed.add(new Jump(nextJumpSize));
}
instructions[i] = crushed.toArray(new Instruction[crushed.size()]);
}
}
}
public static void readPacket(DataInput in, byte[] buffer) throws IOException {
int packetId = in.readUnsignedByte();
Instruction[] packetDef = instructions[packetId];
if (packetDef == null) {
throw new IOException("Unknown packet id " + packetId);
}
for (Instruction instruction : packetDef) {
instruction.read(in, buffer);
}
}
}

View File

@ -0,0 +1,34 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
abstract class Instruction {
static final Instruction BOOLEAN = new Jump(1);
static final Instruction BULK_CHUNK = new BulkChunk();
static final Instruction BYTE = new Jump(1);
// BYTE_INT moved down
static final Instruction DOUBLE = new Jump(8);
static final Instruction FLOAT = new Jump(4);
static final Instruction INT = new Jump(4);
static final Instruction INT_3 = new IntHeader(new Jump(3));
static final Instruction INT_BYTE = new IntHeader(BYTE);
static final Instruction ITEM = new Item();
static final Instruction LONG = new Jump(8);
static final Instruction METADATA = new MetaData();
static final Instruction OPTIONAL_MOTION = new OptionalMotion();
static final Instruction SHORT = new Jump(2);
static final Instruction SHORT_BYTE = new ShortHeader(BYTE);
static final Instruction SHORT_ITEM = new ShortHeader(ITEM);
static final Instruction STRING = new ShortHeader(new Jump(2));
static final Instruction USHORT_BYTE = new UnsignedShortByte();
// Illegal forward references below this line
static final Instruction BYTE_INT = new ByteHeader(INT);
abstract void read(DataInput in, byte[] buffer) throws IOException;
final void skip(DataInput in, byte[] buffer, int len) throws IOException {
in.readFully(buffer, 0, len);
}
}

View File

@ -0,0 +1,21 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class IntHeader extends Instruction {
private final Instruction child;
IntHeader(Instruction child) {
this.child = child;
}
@Override
void read(DataInput in, byte[] buffer) throws IOException {
int size = in.readInt();
for (int i = 0; i < size; i++) {
child.read(in, buffer);
}
}
}

View File

@ -0,0 +1,16 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class Item extends Instruction {
@Override
void read(DataInput in, byte[] buffer) throws IOException {
short type = in.readShort();
if (type >= 0) {
skip(in, buffer, 3);
SHORT_BYTE.read(in, buffer);
}
}
}

View File

@ -0,0 +1,21 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class Jump extends Instruction {
final int len;
Jump(int len) {
if (len < 0) {
throw new IndexOutOfBoundsException();
}
this.len = len;
}
@Override
void read(DataInput in, byte[] buffer) throws IOException {
skip(in, buffer, len);
}
}

View File

@ -0,0 +1,41 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class MetaData extends Instruction {
@Override
void read(DataInput in, byte[] buffer) throws IOException {
int x = in.readUnsignedByte();
while (x != 127) {
int type = x >> 5;
switch (type) {
case 0:
BYTE.read(in, buffer);
break;
case 1:
SHORT.read(in, buffer);
break;
case 2:
INT.read(in, buffer);
break;
case 3:
FLOAT.read(in, buffer);
break;
case 4:
STRING.read(in, buffer);
break;
case 5:
ITEM.read(in, buffer);
break;
case 6:
skip(in, buffer, 12); // int, int, int
break;
default:
throw new IllegalArgumentException("Unknown metadata type " + type);
}
x = in.readUnsignedByte();
}
}
}

View File

@ -0,0 +1,15 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
public class OptionalMotion extends Instruction {
@Override
void read(DataInput in, byte[] buffer) throws IOException {
int data = in.readInt();
if (data > 0) {
skip(in, buffer, 6);
}
}
}

View File

@ -0,0 +1,21 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
class ShortHeader extends Instruction {
private final Instruction child;
ShortHeader(Instruction child) {
this.child = child;
}
@Override
void read(DataInput in, byte[] buffer) throws IOException {
short size = in.readShort();
for (short s = 0; s < size; s++) {
child.read(in, buffer);
}
}
}

View File

@ -0,0 +1,13 @@
package net.md_5.mendax.datainput;
import java.io.DataInput;
import java.io.IOException;
public class UnsignedShortByte extends Instruction {
@Override
void read(DataInput in, byte[] buffer) throws IOException {
int size = in.readUnsignedShort();
skip(in, buffer, size);
}
}