Editing Mod protocol
From EMule Wiki
Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to cut-n-paste the text into a text file and save it for later.
The administrator who locked it offered this explanation: site maintenance
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | = Under construction = | + | =Under construction = |
THIS IS NOT FINAL.. feel free to edit. | THIS IS NOT FINAL.. feel free to edit. | ||
== Introduction == | == Introduction == | ||
− | |||
− | + | Modprot is needed for more clean protocol extensions by eMule modders.... | |
− | + | The main idea is to set a bit in CT_EMULE_MISCOPTIONS2 in the initial hello. If that bit is set and receive by e eMule mod that is capable of processing extensions then that mod will send the options it is cabpale of in the response. and the first cleitn will also send back the protocol extensions it is capable of. | |
− | + | Important: | |
− | + | Clients that are not capable of processing the mod protocol(like official eMule/amule) will not set the mod bit in CT_EMULE_MISCOPTIONS2 and will never receive extended protocol information. | |
− | All mod communication is to be done over the OP_MODPROT/OP_MODPACKEDPROT | + | == Documentation == |
− | When a hello(answer) with a set mod bit is received | + | All mod communication is to be done over the OP_MODPROT/OP_MODPACKEDPROT, |
− | ConnectionEstablished | + | When a hello(answer) with a set mod bit is received ConnectionEstablished is to be delayed, and instead the mod info packet with the opcode OP_MODINFO is ti be sent, |
+ | ConnectionEstablished is to be triggered when the mod info packet is received. | ||
<pre> | <pre> | ||
A B | A B | ||
− | Hello ---> MB Set (see | + | Hello ---> MB Set (see ModBit is set) |
MB Set <--- Hello Answer | MB Set <--- Hello Answer | ||
ConEst <--- MInfo (Mod Info) | ConEst <--- MInfo (Mod Info) | ||
MInfo ---> ConEst (call ConnectionEstablished) | MInfo ---> ConEst (call ConnectionEstablished) | ||
</pre> | </pre> | ||
− | The mod info packet | + | The mod info packet have to contain eEmuleTags that announces supported features: |
<pre> | <pre> | ||
<uint 32> tag count | <uint 32> tag count | ||
Line 32: | Line 32: | ||
<emule tag n> | <emule tag n> | ||
</pre> | </pre> | ||
− | + | Only mod features are allowed to use that what was announces by both sides, | |
− | + | after the capability exchange all reminding opcodes > 0x01 (0x01 is mod info packet) are allowed to be used by clients in any way they want. | |
All further communication is not part of this specification. | All further communication is not part of this specification. | ||
== Protocol == | == Protocol == | ||
− | |||
− | + | === Hello === | |
+ | |||
+ | Set the modbit ot in in CT_EMULE_MISCOPTIONS2 | ||
in baseclient.cpp, void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data) | in baseclient.cpp, void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data) | ||
Line 69: | Line 70: | ||
</pre> | </pre> | ||
− | === | + | === Process hello. === |
− | + | ||
− | + | ||
baseclient.cpp bool CUpDownClient::ProcessHelloTypePacket(CSafeMemFile* data) | baseclient.cpp bool CUpDownClient::ProcessHelloTypePacket(CSafeMemFile* data) | ||
Line 102: | Line 101: | ||
</pre> | </pre> | ||
− | == | + | ==Send hello answer and modprot info == |
+ | |||
Listensocket.cpp bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode) | Listensocket.cpp bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode) | ||
Line 118: | Line 118: | ||
− | Example of | + | Example of sendmoinfopacket: |
<pre> | <pre> | ||
Line 156: | Line 156: | ||
</pre> | </pre> | ||
− | === | + | === delay ConnectionEstablished & send mod info packet === |
listensocket.cpp | listensocket.cpp | ||
Line 239: | Line 239: | ||
</pre> | </pre> | ||
− | === | + | === process modinfo packet === |
listensocket.cpp | listensocket.cpp | ||
Line 338: | Line 338: | ||
</pre> | </pre> | ||
− | === | + | === proces mod data example === |
+ | |||
EMSocket.cpp | EMSocket.cpp | ||
Line 453: | Line 454: | ||
</pre> | </pre> | ||
− | === | + | === additional modifications === |
+ | |||
Packets.cpp | Packets.cpp | ||
Line 483: | Line 485: | ||
</pre> | </pre> | ||
− | == | + | == backward compatibility == |
− | + | Modstring is still send and replied in hello packet to maintain backward compatibility. However a opcode for modstring will be defined for those who also want to move it to the mod protocol. A mod using the modbit MUST identify itself. (A mod that uses extensions but refuses to identify itslef CAN be considered a bad mod by some antileecher systems) | |
− | + | ||
− | + | == OPCODES== | |
<pre> | <pre> | ||
− | + | OP_MODPROT 0x57 | |
− | + | OP_MODPACKEDPROT 0x58 | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | OP_MODPROT | + | |
− | OP_MODPACKEDPROT | + | |
OP_MODINFOPACKET 0x01 | OP_MODINFOPACKET 0x01 | ||
</pre> | </pre> | ||
− | == | + | == TAGS defines == |
− | Tags used must be reserved in modprot topic at | + | Tags used must be reserved in modprot topic at emule-project.net. Source must be published withing 3 months for claiming a tag. |
− | + | ||
The range 0x01 - 0x1F is completely reserved. | The range 0x01 - 0x1F is completely reserved. | ||
− | Tags in the range from 0x20 - 0x7E are reserved for | + | Tags in the range from 0x20 - 0x7E are reserved for use full features, objections can be: |
− | #Modder uses too many tags ( | + | #Modder uses too many tags (If you need more than 5 you are doing something wrong probably. Note that also string tags are available that are not regulated) |
− | #Utterly useless or unimplementable feature | + | #Utterly useless or unimplementable feature, no other mod will ever reuse it. |
− | #Illegal feature | + | #Illegal feature |
− | The range 0x7F-FF is open and you can | + | The range 0x7F-FF is open and you can take any free tag you want, only object can be using to many tags (e.g. someone claims to need a range of 0x80 till 0xAF). |
{| style="font-size: 85%; text-align: Left;Border="1"; | {| style="font-size: 85%; text-align: Left;Border="1"; | ||
Line 557: | Line 519: | ||
|MISC_PROTOCOL_EXTENSIONS | |MISC_PROTOCOL_EXTENSIONS | ||
| 'M' 4D | | 'M' 4D | ||
− | | | + | |(use full mod extensions like [[NatT_protocol|NatT]], NeoXS, ICS, SCT, etc..) |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
|KAD_EMULE_BUDDYID | |KAD_EMULE_BUDDYID | ||
| '@' 40 | | '@' 40 | ||
− | | | + | |(for NatT by david xanatos) |
− | + | ||
|- | |- | ||
|XS_EMULE_BUDDYIP | |XS_EMULE_BUDDYIP | ||
| 'B' 42 | | 'B' 42 | ||
− | | | + | |(for NatT by david xanatos) |
− | + | ||
|- | |- | ||
|XS_EMULE_BUDDYUDP | |XS_EMULE_BUDDYUDP | ||
| 'b' 62 | | 'b' 62 | ||
− | | | + | |(for NatT by david xanatos) |
− | | | + | |- |
+ | |CT_MOD_VERSION | ||
+ | | 'U' 0x55 | ||
+ | | Modstring. Modstring MUST be sent either in hello OR Modprotocol (note that sending it in mod protocol is not backward compatible) | ||
|- | |- | ||
|NEO_PROTOCOL_EXTENSIONS | |NEO_PROTOCOL_EXTENSIONS | ||
|'N' 4E | |'N' 4E | ||
− | | | + | |(for future features by david xanatos) |
− | + | ||
|- | |- | ||
|NEO_PROTOCOL_EXTENSIONS2 | |NEO_PROTOCOL_EXTENSIONS2 | ||
|'n' 6E | |'n' 6E | ||
− | | | + | |(for future features by david xanatos) |
− | + | ||
|- | |- | ||
|} | |} | ||
Line 599: | Line 549: | ||
* MISC_PROTOCOL_EXTENSIONS: | * MISC_PROTOCOL_EXTENSIONS: | ||
+ | <pre> | ||
+ | [bit 1] // Unsolicited Part Status (idea from netfinity, allows our client ro recieve filestatus at any time) | ||
+ | [bit 2] // LowID UDP Ping Support (notifyes a fix form xman1 that allow the remote low ID to use udp reasks) // NEO: MOD - [NewUploadState] | ||
+ | [bit 3] // UDP Mod File Status | ||
+ | [bit 4] // Neo SCT | ||
+ | [bit 5] // ICSv1 Regular Version | ||
+ | [bit 6] // ICSv2 Neo Version | ||
+ | [bit 7] // Real Part Status | ||
+ | [bit 8] // reserved | ||
− | + | [bit 9] // NXS - [NeoXS] | |
− | + | [bit 10] // XSB - [XSBuddy] | |
− | + | [bit 11] // NATT - [NatTraversal] | |
− | + | [bit 12] // RTP - [ReuseTCPPort] | |
− | + | [bits 13-16] // reserved for more NatT stuff | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | [bits 16-24] // unused | |
− | + | [bits 25-32] // unused | |
+ | </pre> | ||
== See also == | == See also == | ||
References to emule protocol... | References to emule protocol... | ||
− |