Mod protocol

From EMule Wiki
(Difference between revisions)
Jump to: navigation, search
(Undo revision 2952 by Izegiwera (Talk))
 
Line 1: Line 1:
>= Under construction =
+
= Under construction =
 
THIS IS NOT FINAL.. feel free to edit.  
 
THIS IS NOT FINAL.. feel free to edit.  
  
Line 17: Line 17:
 
When a hello(answer) with a set mod bit is received the ConnectionEstablished has to be delayed. Instead of that the mod info packet with the opcode OP_MODINFOPACKET is to be sent.
 
When a hello(answer) with a set mod bit is received the ConnectionEstablished has to be delayed. Instead of that the mod info packet with the opcode OP_MODINFOPACKET is to be sent.
 
ConnectionEstablished will be triggered when the mod info packet is received.
 
ConnectionEstablished will be triggered when the mod info packet is received.
<pre>
+
<pre>
 
A              B
 
A              B
Hello  ---&gt;   MB Set (see if ModBit is set)
+
Hello  --->   MB Set (see if ModBit is set)
MB Set  &lt;---    Hello Answer
+
MB Set  <---    Hello Answer
ConEst  &lt;---    MInfo (Mod Info)
+
ConEst  <---    MInfo (Mod Info)
MInfo  ---&gt;   ConEst (call ConnectionEstablished)
+
MInfo  --->   ConEst (call ConnectionEstablished)
&lt;/pre&gt;
+
</pre>
 
The mod info packet has to contain eMuleTags that announce the supported features. The packet is made up this way:
 
The mod info packet has to contain eMuleTags that announce the supported features. The packet is made up this way:
&lt;pre&gt;
+
<pre>
&lt;uint 32&gt; tag count
+
<uint 32> tag count
&lt;emule tag 1&gt;
+
<emule tag 1>
&lt;emule tag 2&gt;
+
<emule tag 2>
 
...
 
...
&lt;emule tag n&gt;
+
<emule tag n>
&lt;/pre&gt;
+
</pre>
 
It's only allowed to use mod features it their capability was announced by both sides.
 
It's only allowed to use mod features it their capability was announced by both sides.
 
After the capability exchange via OP_MODINFOPACKET all remaining opcodes are allowed to be used by clients in any way they want.  
 
After the capability exchange via OP_MODINFOPACKET all remaining opcodes are allowed to be used by clients in any way they want.  
Line 43: Line 43:
  
 
in baseclient.cpp,  void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)
 
in baseclient.cpp,  void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)
&lt;pre&gt;
+
<pre>
 
// eMule Misc. Options #2
 
// eMule Misc. Options #2
 
const UINT uKadVersion = KADEMLIA_VERSION;
 
const UINT uKadVersion = KADEMLIA_VERSION;
Line 49: Line 49:
 
const UINT uExtMultiPacket = 1;
 
const UINT uExtMultiPacket = 1;
 
// Set the Mod Bit
 
// Set the Mod Bit
const UINT uModProt = 1; // mod bit // NEO: NMP - [NeoModProt] &lt;-- Xanatos --
+
const UINT uModProt = 1; // mod bit // NEO: NMP - [NeoModProt] <-- Xanatos --
 
const UINT uSupportsCryptLayer = thePrefs.IsClientCryptLayerSupported() ? 1 : 0;
 
const UINT uSupportsCryptLayer = thePrefs.IsClientCryptLayerSupported() ? 1 : 0;
 
const UINT uRequestsCryptLayer = thePrefs.IsClientCryptLayerRequested() ? 1 : 0;
 
const UINT uRequestsCryptLayer = thePrefs.IsClientCryptLayerRequested() ? 1 : 0;
Line 57: Line 57:
 
CTag tagMisOptions2(CT_EMULE_MISCOPTIONS2,  
 
CTag tagMisOptions2(CT_EMULE_MISCOPTIONS2,  
 
// (RESERVED     )
 
// (RESERVED     )
(uSupportsSourceEx2 &lt;&lt; 10) |
+
(uSupportsSourceEx2 << 10) |
(uRequiresCryptLayer &lt;&lt; 9) |
+
(uRequiresCryptLayer << 9) |
(uRequestsCryptLayer &lt;&lt; 8) |
+
(uRequestsCryptLayer << 8) |
(uSupportsCryptLayer &lt;&lt; 7) |
+
(uSupportsCryptLayer << 7) |
(uModProt &lt;&lt; 6) |
+
(uModProt << 6) |
(uExtMultiPacket &lt;&lt; 5) |
+
(uExtMultiPacket << 5) |
(uSupportLargeFiles &lt;&lt; 4) |
+
(uSupportLargeFiles << 4) |
(uKadVersion &lt;&lt; 0)  
+
(uKadVersion << 0)  
 
);
 
);
 
tagMisOptions2.WriteTagToFile(data);
 
tagMisOptions2.WriteTagToFile(data);
&lt;/pre&gt;
+
</pre>
  
 
=== Processing hello(answer) packets ===
 
=== Processing hello(answer) packets ===
Line 74: Line 74:
  
 
baseclient.cpp bool CUpDownClient::ProcessHelloTypePacket(CSafeMemFile* data)
 
baseclient.cpp bool CUpDownClient::ProcessHelloTypePacket(CSafeMemFile* data)
&lt;pre&gt;
+
<pre>
 
case CT_EMULE_MISCOPTIONS2:
 
case CT_EMULE_MISCOPTIONS2:
 
// 21 Reserved
 
// 21 Reserved
Line 86: Line 86:
 
//  4 Kad Version
 
//  4 Kad Version
 
if (temptag.IsInt()) {
 
if (temptag.IsInt()) {
m_fSupportsSourceEx2 = (temptag.GetInt() &gt;&gt; 10) &amp; 0x01;
+
m_fSupportsSourceEx2 = (temptag.GetInt() >> 10) & 0x01;
m_fRequiresCryptLayer = (temptag.GetInt() &gt;&gt; 9) &amp; 0x01;
+
m_fRequiresCryptLayer = (temptag.GetInt() >> 9) & 0x01;
m_fRequestsCryptLayer = (temptag.GetInt() &gt;&gt; 8) &amp; 0x01;
+
m_fRequestsCryptLayer = (temptag.GetInt() >> 8) & 0x01;
m_fSupportsCryptLayer = (temptag.GetInt() &gt;&gt; 7) &amp; 0x01;
+
m_fSupportsCryptLayer = (temptag.GetInt() >> 7) & 0x01;
 
// read the mod bit
 
// read the mod bit
m_fSupportsModProt = (temptag.GetInt() &gt;&gt; 6) &amp; 0x01; // NEO: NMP - [NeoModProt] &lt;-- Xanatos --
+
m_fSupportsModProt = (temptag.GetInt() >> 6) & 0x01; // NEO: NMP - [NeoModProt] <-- Xanatos --
m_fExtMultiPacket = (temptag.GetInt() &gt;&gt; 5) &amp; 0x01;
+
m_fExtMultiPacket = (temptag.GetInt() >> 5) & 0x01;
m_fSupportsLargeFiles  = (temptag.GetInt() &gt;&gt; 4) &amp; 0x01;
+
m_fSupportsLargeFiles  = (temptag.GetInt() >> 4) & 0x01;
m_byKadVersion = (uint8)((temptag.GetInt() &gt;&gt; 0) &amp; 0x0f);
+
m_byKadVersion = (uint8)((temptag.GetInt() >> 0) & 0x0f);
 
dwEmuleTags |= 8;
 
dwEmuleTags |= 8;
 
if (bDbgInfo)
 
if (bDbgInfo)
m_strHelloInfo.AppendFormat(_T(&quot;\n  KadVersion=%u, LargeFiles=%u ExtMultiPacket=%u CryptLayerSupport=%u CryptLayerRequest=%u CryptLayerRequires=%u m_fSupportsSourceEx2=%u&quot;), m_byKadVersion, m_fSupportsLargeFiles, m_fExtMultiPacket, m_fSupportsCryptLayer, m_fRequestsCryptLayer, m_fRequiresCryptLayer, m_fSupportsSourceEx2);
+
m_strHelloInfo.AppendFormat(_T("\n  KadVersion=%u, LargeFiles=%u ExtMultiPacket=%u CryptLayerSupport=%u CryptLayerRequest=%u CryptLayerRequires=%u m_fSupportsSourceEx2=%u"), m_byKadVersion, m_fSupportsLargeFiles, m_fExtMultiPacket, m_fSupportsCryptLayer, m_fRequestsCryptLayer, m_fRequiresCryptLayer, m_fSupportsSourceEx2);
m_fRequestsCryptLayer &amp;= m_fSupportsCryptLayer;
+
m_fRequestsCryptLayer &= m_fSupportsCryptLayer;
m_fRequiresCryptLayer &amp;= m_fRequestsCryptLayer;
+
m_fRequiresCryptLayer &= m_fRequestsCryptLayer;
&lt;/pre&gt;
+
</pre>
  
 
== Sending hello answer and modprot info ==
 
== Sending 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)
&lt;pre&gt;if (client-&gt;GetHashType() == SO_EMULE &amp;&amp; !bIsMuleHello)
+
<pre>if (client->GetHashType() == SO_EMULE && !bIsMuleHello)
client-&gt;SendMuleInfoPacket(false);
+
client->SendMuleInfoPacket(false);
  
client-&gt;SendHelloAnswer();
+
client->SendHelloAnswer();
  
 
if (client)
 
if (client)
 
{
 
{
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
if(client-&gt;GetNeoModProtVersion())
+
if(client->GetNeoModProtVersion())
client-&gt;SendModInfoPacket();
+
client->SendModInfoPacket();
&lt;/pre&gt;
+
</pre>
  
  
 
Example of SendModInfoPacket:
 
Example of SendModInfoPacket:
  
&lt;pre&gt;
+
<pre>
 
void CUpDownClient::SendModInfoPacket(){
 
void CUpDownClient::SendModInfoPacket(){
 
if (socket == NULL){ // first we check if we have a valid socket, actualy we was called form the socket so this check is rather unnesesery, but in case
 
if (socket == NULL){ // first we check if we have a valid socket, actualy we was called form the socket so this check is rather unnesesery, but in case
Line 136: Line 136:
 
// in this sample its an normal tag with an uint8 ID, its the modstring 0x55 = 'T'
 
// in this sample its an normal tag with an uint8 ID, its the modstring 0x55 = 'T'
 
data.WriteUInt32(tagcount); // nr. of tags
 
data.WriteUInt32(tagcount); // nr. of tags
CTag tagPartStatus(0x55,_T(&quot;TestMod&quot;));
+
CTag tagPartStatus(0x55,_T("TestMod"));
tagPartStatus.WriteNewEd2kTag(&amp;data);
+
tagPartStatus.WriteNewEd2kTag(&data);
  
 
// write the secund tag (Nr.2)
 
// write the secund tag (Nr.2)
 
// in this sample its an custom named tag with an string as ID
 
// in this sample its an custom named tag with an string as ID
CTag tagMyMail(&quot;Mod:eMail&quot;,_T(&quot;User@Domain.com&quot;));
+
CTag tagMyMail("Mod:eMail",_T("User@Domain.com"));
tagMyMail.WriteNewEd2kTag(&amp;data);
+
tagMyMail.WriteNewEd2kTag(&data);
 
 
 
// we are done writing tags
 
// we are done writing tags
  
 
// now we create a packet and put what we have writen in it
 
// now we create a packet and put what we have writen in it
Packet* packet = new Packet(&amp;data,OP_MODPROT);
+
Packet* packet = new Packet(&data,OP_MODPROT);
packet-&gt;opcode = OP_MODINFOPACKET;
+
packet->opcode = OP_MODINFOPACKET;
if (thePrefs.GetDebugClientTCPLevel() &gt; 0)
+
if (thePrefs.GetDebugClientTCPLevel() > 0)
DebugSend(&quot;OP__ModInfoPacket&quot;, this);
+
DebugSend("OP__ModInfoPacket", this);
theStats.AddUpDataOverheadOther(packet-&gt;size);
+
theStats.AddUpDataOverheadOther(packet->size);
socket-&gt;SendPacket(packet,true,true); // we send the packet
+
socket->SendPacket(packet,true,true); // we send the packet
 
}
 
}
&lt;/pre&gt;
+
</pre>
  
=== Delaying ConnectionEstablished &amp; sending the mod info packet ===
+
=== Delaying ConnectionEstablished & sending the mod info packet ===
  
 
listensocket.cpp
 
listensocket.cpp
 
bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)
 
bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)
&lt;pre&gt;
+
<pre>
 
case OP_HELLOANSWER:
 
case OP_HELLOANSWER:
 
{
 
{
 
theStats.AddDownDataOverheadOther(size);
 
theStats.AddDownDataOverheadOther(size);
client-&gt;ProcessHelloAnswer(packet,size);
+
client->ProcessHelloAnswer(packet,size);
if (thePrefs.GetDebugClientTCPLevel() &gt; 0){
+
if (thePrefs.GetDebugClientTCPLevel() > 0){
DebugRecv(&quot;OP_HelloAnswer&quot;, client);
+
DebugRecv("OP_HelloAnswer", client);
Debug(_T(&quot; %s\n&quot;), client-&gt;DbgGetHelloInfo());
+
Debug(_T(" %s\n"), client->DbgGetHelloInfo());
 
}
 
}
  
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
if(client-&gt;SupportsModProt() == 0) // check for mod prot
+
if(client->SupportsModProt() == 0) // check for mod prot
 
// we will start the SUI when we recieve the mod info packet
 
// we will start the SUI when we recieve the mod info packet
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
{
 
{
 
// start secure identification, if
 
// start secure identification, if
 
//  - we have received OP_EMULEINFO and OP_HELLOANSWER (old eMule)
 
//  - we have received OP_EMULEINFO and OP_HELLOANSWER (old eMule)
 
// - we have received eMule-OP_HELLOANSWER (new eMule)
 
// - we have received eMule-OP_HELLOANSWER (new eMule)
if (client-&gt;GetInfoPacketsReceived() == IP_BOTH)
+
if (client->GetInfoPacketsReceived() == IP_BOTH)
client-&gt;InfoPacketsReceived();
+
client->InfoPacketsReceived();
 
}
 
}
  
 
if (client)
 
if (client)
 
{
 
{
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
if (client-&gt;SupportsModProt()) // if this cleint uses mod protocol extensions
+
if (client->SupportsModProt()) // if this cleint uses mod protocol extensions
client-&gt;SendModInfoPacket(); // we send him the mod info packet with our rxtensions
+
client->SendModInfoPacket(); // we send him the mod info packet with our rxtensions
 
else // we *dont* call ConnectionEstablished at this point,
 
else // we *dont* call ConnectionEstablished at this point,
 
// when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
 
// when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
{
 
{
client-&gt;ConnectionEstablished();
+
client->ConnectionEstablished();
theApp.emuledlg-&gt;transferwnd-&gt;clientlistctrl.RefreshClient(client);
+
theApp.emuledlg->transferwnd->clientlistctrl.RefreshClient(client);
 
}
 
}
 
}
 
}
 
break;
 
break;
 
}
 
}
&lt;/pre&gt;
+
</pre>
  
 
listensocket.cpp
 
listensocket.cpp
 
bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)
 
bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)
&lt;pre&gt;
+
<pre>
 
case OP_HELLO:
 
case OP_HELLO:
 
{
 
{
Line 208: Line 208:
 
if (client)
 
if (client)
 
{
 
{
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
if(client-&gt;SupportsModProt()) // if this cleint uses mod protocol extensions
+
if(client->SupportsModProt()) // if this cleint uses mod protocol extensions
client-&gt;SendModInfoPacket(); // we send him the mod info packet with our rxtensions
+
client->SendModInfoPacket(); // we send him the mod info packet with our rxtensions
 
else // we *dont* call ConnectionEstablished at this point,
 
else // we *dont* call ConnectionEstablished at this point,
 
// when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
 
// when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
client-&gt;ConnectionEstablished();
+
client->ConnectionEstablished();
 
}
 
}
  
Line 220: Line 220:
 
if(client)
 
if(client)
 
{
 
{
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
if(client-&gt;SupportsModProt() == 0) // check for mod prot
+
if(client->SupportsModProt() == 0) // check for mod prot
 
// we will start the SUI when we recieve the mod info packet
 
// we will start the SUI when we recieve the mod info packet
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
{
 
{
  
 
// start secure identification, if
 
// start secure identification, if
 
// - we have received eMule-OP_HELLO (new eMule)
 
// - we have received eMule-OP_HELLO (new eMule)
if (client-&gt;GetInfoPacketsReceived() == IP_BOTH)
+
if (client->GetInfoPacketsReceived() == IP_BOTH)
client-&gt;InfoPacketsReceived();
+
client->InfoPacketsReceived();
 
}
 
}
  
if( client-&gt;GetKadPort() )
+
if( client->GetKadPort() )
Kademlia::CKademlia::Bootstrap(ntohl(client-&gt;GetIP()), client-&gt;GetKadPort(), (client-&gt;GetKadVersion() &gt; 1));
+
Kademlia::CKademlia::Bootstrap(ntohl(client->GetIP()), client->GetKadPort(), (client->GetKadVersion() > 1));
 
}
 
}
 
break;
 
break;
 
}
 
}
&lt;/pre&gt;
+
</pre>
  
 
=== Processing the modinfo packet ===
 
=== Processing the modinfo packet ===
  
 
listensocket.cpp
 
listensocket.cpp
&lt;pre&gt;
+
<pre>
 
bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
 
bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
 
{
 
{
Line 254: Line 254:
 
throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
 
throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
 
}
 
}
if (thePrefs.m_iDbgHeap &gt;= 2)
+
if (thePrefs.m_iDbgHeap >= 2)
 
ASSERT_VALID(client);
 
ASSERT_VALID(client);
  
Line 261: Line 261:
 
case OP_MODINFOPACKET:
 
case OP_MODINFOPACKET:
 
{
 
{
if (thePrefs.GetDebugClientTCPLevel() &gt; 0)
+
if (thePrefs.GetDebugClientTCPLevel() > 0)
DebugRecv(&quot;OP__ModInfoPacket&quot;, client);
+
DebugRecv("OP__ModInfoPacket", client);
 
theStats.AddDownDataOverheadOther(uRawSize);
 
theStats.AddDownDataOverheadOther(uRawSize);
  
if(client-&gt;GetNeoModProtVersion() == 0)
+
if(client->GetNeoModProtVersion() == 0)
throw CString(_T(&quot;Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!&quot;));
+
throw CString(_T("Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!"));
  
client-&gt;ProcessModInfoPacket(packet,size);
+
client->ProcessModInfoPacket(packet,size);
  
 
// Now after we have all informations about the cleint the connection is established
 
// Now after we have all informations about the cleint the connection is established
client-&gt;ConnectionEstablished();
+
client->ConnectionEstablished();
  
 
// start secure identification, if
 
// start secure identification, if
 
//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
 
//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
if (client-&gt;GetInfoPacketsReceived() == IP_BOTH)
+
if (client->GetInfoPacketsReceived() == IP_BOTH)
client-&gt;InfoPacketsReceived();
+
client->InfoPacketsReceived();
 
break;
 
break;
 
}
 
}
Line 284: Line 284:
 
{
 
{
 
...
 
...
&lt;/pre&gt;
+
</pre>
  
  
Line 291: Line 291:
  
 
baseclient.cpp
 
baseclient.cpp
&lt;pre&gt;
+
<pre>
 
void CUpDownClient::ProcessModInfoPacket(const uchar* pachPacket, uint32 nSize)
 
void CUpDownClient::ProcessModInfoPacket(const uchar* pachPacket, uint32 nSize)
 
{
 
{
Line 301: Line 301:
 
uint32 tagcount = data.ReadUInt32();
 
uint32 tagcount = data.ReadUInt32();
 
if (bDbgInfo)
 
if (bDbgInfo)
m_strModInfo.AppendFormat(_T(&quot; Tags=%u&quot;), (UINT)tagcount);
+
m_strModInfo.AppendFormat(_T(" Tags=%u"), (UINT)tagcount);
 
// now we are going to read all of them
 
// now we are going to read all of them
for (uint32 i = 0; i &lt; tagcount; i++)
+
for (uint32 i = 0; i < tagcount; i++)
 
{
 
{
CTag temptag(&amp;data, false);
+
CTag temptag(&data, false);
 
switch (temptag.GetNameID()) // here we distinguish only tags with an uint8 ID, all named tags are handled below
 
switch (temptag.GetNameID()) // here we distinguish only tags with an uint8 ID, all named tags are handled below
 
{
 
{
 
case 0x55:
 
case 0x55:
 
if (temptag.IsStr())
 
if (temptag.IsStr())
Log(_T(&quot;ModString %s&quot;, temptag.GetStr()));
+
Log(_T("ModString %s", temptag.GetStr()));
 
else if (bDbgInfo)
 
else if (bDbgInfo)
m_strModInfo.AppendFormat(_T(&quot;\n  ***UnkType=%s&quot;), temptag.GetFullInfo());
+
m_strModInfo.AppendFormat(_T("\n  ***UnkType=%s"), temptag.GetFullInfo());
 
break;
 
break;
  
Line 318: Line 318:
  
 
// now we habdle custom named tags, we use a series of (else)if's and strcmp, note: this is *not* unicide!!!
 
// now we habdle custom named tags, we use a series of (else)if's and strcmp, note: this is *not* unicide!!!
if(strcmp(temptag.GetName(),&quot;Mod:Hello&quot;) == 0)
+
if(strcmp(temptag.GetName(),"Mod:Hello") == 0)
 
{
 
{
 
if(temptag.IsStr())
 
if(temptag.IsStr())
Log(LOG_SUCCESS,_T(&quot;*** Greathings from %s: %s&quot;),GetUserName(),temptag.GetStr());
+
Log(LOG_SUCCESS,_T("*** Greathings from %s: %s"),GetUserName(),temptag.GetStr());
 
}
 
}
 
else
 
else
  
 
if (bDbgInfo)
 
if (bDbgInfo)
m_strModInfo.AppendFormat(_T(&quot;\n  ***UnkTag=%s&quot;), temptag.GetFullInfo());
+
m_strModInfo.AppendFormat(_T("\n  ***UnkTag=%s"), temptag.GetFullInfo());
 
}
 
}
 
}
 
}
  
 
// some debug output
 
// some debug output
if (bDbgInfo &amp;&amp; data.GetPosition() &lt; data.GetLength()){
+
if (bDbgInfo && data.GetPosition() < data.GetLength()){
m_strModInfo.AppendFormat(_T(&quot;\n  ***AddData: %u bytes&quot;), data.GetLength() - data.GetPosition());
+
m_strModInfo.AppendFormat(_T("\n  ***AddData: %u bytes"), data.GetLength() - data.GetPosition());
 
}
 
}
 
}
 
}
  
&lt;/pre&gt;
+
</pre>
  
 
=== Processing mod data example ===  
 
=== Processing mod data example ===  
Line 342: Line 342:
 
EMSocket.cpp
 
EMSocket.cpp
 
void CEMSocket::OnReceive(int nErrorCode)
 
void CEMSocket::OnReceive(int nErrorCode)
&lt;pre&gt;
+
<pre>
switch (pendingPacket-&gt;prot){
+
switch (pendingPacket->prot){
 
case OP_EDONKEYPROT:
 
case OP_EDONKEYPROT:
 
case OP_PACKEDPROT:
 
case OP_PACKEDPROT:
 
case OP_EMULEPROT:
 
case OP_EMULEPROT:
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
 
// We have to accept also mod packet
 
// We have to accept also mod packet
 
case OP_MODPACKEDPROT:
 
case OP_MODPACKEDPROT:
 
case OP_MODPROT:
 
case OP_MODPROT:
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
break;
 
break;
 
default:
 
default:
EMTrace(&quot;CEMSocket::OnReceive ERROR Wrong header&quot;);
+
EMTrace("CEMSocket::OnReceive ERROR Wrong header");
 
delete pendingPacket;
 
delete pendingPacket;
 
pendingPacket = NULL;
 
pendingPacket = NULL;
Line 360: Line 360:
 
return;
 
return;
 
}
 
}
&lt;/pre&gt;
+
</pre>
  
  
 
listensocket.cpp
 
listensocket.cpp
 
bool CClientReqSocket::PacketReceivedCppEH(Packet* packet)
 
bool CClientReqSocket::PacketReceivedCppEH(Packet* packet)
&lt;pre&gt;
+
<pre>
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
 
// dispatch mod packets to the right processing functions
 
// dispatch mod packets to the right processing functions
 
case OP_MODPACKEDPROT:
 
case OP_MODPACKEDPROT:
if (!packet-&gt;UnPackPacket()){
+
if (!packet->UnPackPacket()){
 
if (thePrefs.GetVerbose())
 
if (thePrefs.GetVerbose())
AddDebugLogLine(false, _T(&quot;Failed to decompress client Mod TCP packet; %s; %s&quot;), DbgGetClientTCPPacket(packet-&gt;prot, packet-&gt;opcode, packet-&gt;size), DbgGetClientInfo());
+
AddDebugLogLine(false, _T("Failed to decompress client Mod TCP packet; %s; %s"), DbgGetClientTCPPacket(packet->prot, packet->opcode, packet->size), DbgGetClientInfo());
 
bResult = false;
 
bResult = false;
 
break;
 
break;
 
}
 
}
 
case OP_MODPROT:
 
case OP_MODPROT:
bResult = ProcessModPacket((const BYTE*)packet-&gt;pBuffer, packet-&gt;size, packet-&gt;opcode, uRawSize);
+
bResult = ProcessModPacket((const BYTE*)packet->pBuffer, packet->size, packet->opcode, uRawSize);
 
break;
 
break;
&lt;/pre&gt;
+
</pre>
&lt;pre&gt;
+
<pre>
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
 
bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
 
bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
 
{
 
{
Line 393: Line 393:
 
throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
 
throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
 
}
 
}
if (thePrefs.m_iDbgHeap &gt;= 2)
+
if (thePrefs.m_iDbgHeap >= 2)
 
ASSERT_VALID(client);
 
ASSERT_VALID(client);
  
Line 401: Line 401:
 
case OP_MODINFOPACKET:
 
case OP_MODINFOPACKET:
 
{
 
{
if (thePrefs.GetDebugClientTCPLevel() &gt; 0)
+
if (thePrefs.GetDebugClientTCPLevel() > 0)
DebugRecv(&quot;OP__ModInfoPacket&quot;, client);
+
DebugRecv("OP__ModInfoPacket", client);
 
theStats.AddDownDataOverheadOther(uRawSize);
 
theStats.AddDownDataOverheadOther(uRawSize);
  
if(client-&gt;SupportsModProt() == 0) // just pure formality
+
if(client->SupportsModProt() == 0) // just pure formality
throw CString(_T(&quot;Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!&quot;));
+
throw CString(_T("Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!"));
  
 
// Process the packet
 
// Process the packet
client-&gt;ProcessModInfoPacket(packet,size);
+
client->ProcessModInfoPacket(packet,size);
  
 
// Now after we have all informations about the cleint the connection is established
 
// Now after we have all informations about the cleint the connection is established
client-&gt;ConnectionEstablished();
+
client->ConnectionEstablished();
  
 
// start secure identification, if
 
// start secure identification, if
 
//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
 
//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
if (client-&gt;GetInfoPacketsReceived() == IP_BOTH)
+
if (client->GetInfoPacketsReceived() == IP_BOTH)
client-&gt;InfoPacketsReceived();
+
client->InfoPacketsReceived();
 
break;
 
break;
 
}
 
}
Line 424: Line 424:
 
 
 
theStats.AddDownDataOverheadOther(uRawSize);
 
theStats.AddDownDataOverheadOther(uRawSize);
PacketToDebugLogLine(_T(&quot;ModProt&quot;), packet, size, opcode);
+
PacketToDebugLogLine(_T("ModProt"), packet, size, opcode);
 
}
 
}
 
}
 
}
 
catch(CFileException* error)
 
catch(CFileException* error)
 
{
 
{
error-&gt;Delete();
+
error->Delete();
 
throw GetResString(IDS_ERR_INVALIDPACKAGE);
 
throw GetResString(IDS_ERR_INVALIDPACKAGE);
 
}
 
}
 
catch(CMemoryException* error)
 
catch(CMemoryException* error)
 
{
 
{
error-&gt;Delete();
+
error->Delete();
throw CString(_T(&quot;Memory exception&quot;));
+
throw CString(_T("Memory exception"));
 
}
 
}
 
}
 
}
 
catch(CString error)
 
catch(CString error)
 
{
 
{
if (thePrefs.GetVerbose() &amp;&amp; !error.IsEmpty())
+
if (thePrefs.GetVerbose() && !error.IsEmpty())
DebugLogWarning(_T(&quot;Error: %s - while processing Mod packet: opcode=%s  size=%u; %s&quot;), error, DbgGetMuleClientTCPOpcode(opcode), size, DbgGetClientInfo());
+
DebugLogWarning(_T("Error: %s - while processing Mod packet: opcode=%s  size=%u; %s"), error, DbgGetMuleClientTCPOpcode(opcode), size, DbgGetClientInfo());
 
// Note: don't disconnect cleints on mod prot errors, the extensions are just addons and if thay fail the client will work anyway
 
// Note: don't disconnect cleints on mod prot errors, the extensions are just addons and if thay fail the client will work anyway
 
//if (client)
 
//if (client)
// client-&gt;SetDownloadState(DS_ERROR, _T(&quot;ProcessModPacket error. &quot;) + error);
+
// client->SetDownloadState(DS_ERROR, _T("ProcessModPacket error. ") + error);
//Disconnect(_T(&quot;ProcessModPacket error. &quot;) + error);  
+
//Disconnect(_T("ProcessModPacket error. ") + error);  
 
//return false;
 
//return false;
 
}
 
}
 
return true;
 
return true;
  
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
&lt;/pre&gt;
+
</pre>
  
 
=== Additional modifications ===  
 
=== Additional modifications ===  
Line 457: Line 457:
 
Packets.cpp
 
Packets.cpp
 
void Packet::PackPacket()
 
void Packet::PackPacket()
&lt;pre&gt;
+
<pre>
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
 
if( prot == OP_MODPROT )
 
if( prot == OP_MODPROT )
 
prot = OP_MODPACKEDPROT;
 
prot = OP_MODPACKEDPROT;
 
else
 
else
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
if( prot == OP_KADEMLIAHEADER )
 
if( prot == OP_KADEMLIAHEADER )
 
prot = OP_KADEMLIAPACKEDPROT;
 
prot = OP_KADEMLIAPACKEDPROT;
 
else
 
else
 
prot = OP_PACKEDPROT;
 
prot = OP_PACKEDPROT;
&lt;/pre&gt;
+
</pre>
  
 
Packets.cpp
 
Packets.cpp
 
bool Packet::UnPackPacket(UINT uMaxDecompressedSize)
 
bool Packet::UnPackPacket(UINT uMaxDecompressedSize)
&lt;pre&gt;
+
<pre>
// NEO: NMP - [NeoModProt] -- Xanatos --&gt;
+
// NEO: NMP - [NeoModProt] -- Xanatos -->
 
if( prot == OP_MODPACKEDPROT )
 
if( prot == OP_MODPACKEDPROT )
 
prot = OP_MODPROT;
 
prot = OP_MODPROT;
 
else
 
else
// NEO: NMP END &lt;-- Xanatos --
+
// NEO: NMP END <-- Xanatos --
 
if( prot == OP_KADEMLIAPACKEDPROT )
 
if( prot == OP_KADEMLIAPACKEDPROT )
 
prot = OP_KADEMLIAHEADER;
 
prot = OP_KADEMLIAHEADER;
 
else
 
else
 
prot =  OP_EMULEPROT;
 
prot =  OP_EMULEPROT;
&lt;/pre&gt;
+
</pre>
  
 
== Backward compatibility ==
 
== Backward compatibility ==
Line 489: Line 489:
  
 
The proposed check to use would be like
 
The proposed check to use would be like
&lt;pre&gt;
+
<pre>
 
void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)
 
void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)
 
{
 
{
Line 496: Line 496:
 
uint32 tagcount = 6;
 
uint32 tagcount = 6;
  
if( theApp.clientlist-&gt;GetBuddy() &amp;&amp; theApp.IsFirewalled() )
+
if( theApp.clientlist->GetBuddy() && theApp.IsFirewalled() )
 
tagcount += 2;
 
tagcount += 2;
  
//&gt;&gt;&gt; MODPROT::Send Modstring to old mods only
+
//>>> MODPROT::Send Modstring to old mods only
const bool bSendModString = !SupportsModProt() &amp;&amp; (!m_strModVersion.IsEmpty() || !m_pszUsername);  
+
const bool bSendModString = !SupportsModProt() && (!m_strModVersion.IsEmpty() || !m_pszUsername);  
 
if(bSendModString)
 
if(bSendModString)
 
++tagcount;
 
++tagcount;
//&lt;&lt;&lt; MODPROT::Send Modstring to old mods only
+
//<<< MODPROT::Send Modstring to old mods only
  
data-&gt;WriteUInt32(tagcount);
+
data->WriteUInt32(tagcount);
 
...
 
...
 
...
 
...
 
tagMuleVersion.WriteTagToFile(data);
 
tagMuleVersion.WriteTagToFile(data);
  
//&gt;&gt;&gt; MODPROT::Send Modstring to old mods only
+
//>>> MODPROT::Send Modstring to old mods only
 
if(bSendModString)
 
if(bSendModString)
 
{
 
{
CTag tagMod(CT_MOD_VERSION, L&quot;My Mod String&quot;);
+
CTag tagMod(CT_MOD_VERSION, L"My Mod String");
 
tagMod.WriteTagToFile(data);
 
tagMod.WriteTagToFile(data);
 
}
 
}
//&lt;&lt;&lt; MODPROT::Send Modstring to old mods only
+
//<<< MODPROT::Send Modstring to old mods only
  
 
uint32 dwIP;
 
uint32 dwIP;
Line 522: Line 522:
 
...
 
...
 
...
 
...
&lt;/pre&gt;
+
</pre>
 
and similar for the info packet.
 
and similar for the info packet.
  
  
 
== OPCODE defines ==
 
== OPCODE defines ==
&lt;pre&gt;
+
<pre>
 
OP_MODPROT      0x4D
 
OP_MODPROT      0x4D
 
OP_MODPACKEDPROT 0x6D
 
OP_MODPACKEDPROT 0x6D
 
OP_MODINFOPACKET 0x01
 
OP_MODINFOPACKET 0x01
&lt;/pre&gt;
+
</pre>
  
 
== TAG defines ==
 
== TAG defines ==
Line 547: Line 547:
 
The range 0x7F-FF is open and you can claim any free tag you want, only objection can be the usage of too many tags (e.g. someone claims to need a range from 0x80 to 0xAF).
 
The range 0x7F-FF is open and you can claim any free tag you want, only objection can be the usage of too many tags (e.g. someone claims to need a range from 0x80 to 0xAF).
  
{| style=&quot;font-size: 85%; text-align: Left;Border=&quot;1&quot;;
+
{| style="font-size: 85%; text-align: Left;Border="1";
 
! rowspan=2 | TAGNAME  
 
! rowspan=2 | TAGNAME  
 
! rowspan=2 | VALUE
 
! rowspan=2 | VALUE
Line 611: Line 611:
  
  
&lt;nowiki&gt;*&lt;/nowiki&gt; The UDP Mod File Status bit is not only used for ICS but used in general. It also tells whether Mod Multi Packet with extended mod status should be sent over UDP or not.
+
<nowiki>*</nowiki> The UDP Mod File Status bit is not only used for ICS but used in general. It also tells whether Mod Multi Packet with extended mod status should be sent over UDP or not.
  
 
== See also ==  
 
== See also ==  
Line 617: Line 617:
 
References to emule protocol...
 
References to emule protocol...
 
[[category:Mod_protocol_extensions]]
 
[[category:Mod_protocol_extensions]]
 
----
 
<div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;">
 
----
 
=[http://asifetyr.co.cc Page Is Unavailable Due To Site Maintenance, Please Visit Reserve Copy Page]=
 
----
 
=[http://asifetyr.co.cc CLICK HERE]=
 
----
 
</div>
 

Latest revision as of 13:54, 18 November 2010

Contents

Under construction

THIS IS NOT FINAL.. feel free to edit.

Introduction

The 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 packet. If that bit is set and received by an eMule mod that is capable of processing extensions, then that mod will send the options it is capable of in the response and the first client 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.

Documentation

All mod communication is to be done over the OP_MODPROT/OP_MODPACKEDPROT. When a hello(answer) with a set mod bit is received the ConnectionEstablished has to be delayed. Instead of that the mod info packet with the opcode OP_MODINFOPACKET is to be sent. ConnectionEstablished will be triggered when the mod info packet is received.

A               B
Hello   --->    MB Set (see if ModBit is set)
MB Set  <---    Hello Answer
ConEst  <---    MInfo (Mod Info)
MInfo   --->    ConEst (call ConnectionEstablished)

The mod info packet has to contain eMuleTags that announce the supported features. The packet is made up this way:

<uint 32> tag count
<emule tag 1>
<emule tag 2>
...
<emule tag n>

It's only allowed to use mod features it their capability was announced by both sides. After the capability exchange via OP_MODINFOPACKET all remaining opcodes are allowed to be used by clients in any way they want. All further communication is not part of this specification.

Protocol

Sending Hello(answer) packets

Setting the modbit in CT_EMULE_MISCOPTIONS2

in baseclient.cpp, void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)

	// eMule Misc. Options #2
	const UINT uKadVersion			= KADEMLIA_VERSION;
	const UINT uSupportLargeFiles	= 1;
	const UINT uExtMultiPacket		= 1;
	// Set the Mod Bit
	const UINT uModProt				= 1; // mod bit // NEO: NMP - [NeoModProt] <-- Xanatos --
	const UINT uSupportsCryptLayer	= thePrefs.IsClientCryptLayerSupported() ? 1 : 0;
	const UINT uRequestsCryptLayer	= thePrefs.IsClientCryptLayerRequested() ? 1 : 0;
	const UINT uRequiresCryptLayer	= thePrefs.IsClientCryptLayerRequired() ? 1 : 0;
	const UINT uSupportsSourceEx2	= 1;

	CTag tagMisOptions2(CT_EMULE_MISCOPTIONS2, 
//				(RESERVED				     )
				(uSupportsSourceEx2		<< 10) |
				(uRequiresCryptLayer	<<  9) |
				(uRequestsCryptLayer	<<  8) |
				(uSupportsCryptLayer	<<  7) |
				(uModProt				<<  6) |
				(uExtMultiPacket		<<  5) |
				(uSupportLargeFiles		<<  4) |
				(uKadVersion			<<  0) 
				);
	tagMisOptions2.WriteTagToFile(data);

Processing hello(answer) packets

Read out the modbit from CT_EMULE_MISCOPTIONS2

baseclient.cpp bool CUpDownClient::ProcessHelloTypePacket(CSafeMemFile* data)

	case CT_EMULE_MISCOPTIONS2:
				//	21 Reserved
				//	 1 Supports SourceExachnge2 Packets, ignores SX1 Packet Version
				//	 1 Requires CryptLayer
				//	 1 Requests CryptLayer
				//	 1 Supports CryptLayer
				//	 1 Reserved (ModBit)
				//   1 Ext Multipacket (Hash+Size instead of Hash)
				//   1 Large Files (includes support for 64bit tags)
				//   4 Kad Version
				if (temptag.IsInt()) {
					m_fSupportsSourceEx2	= (temptag.GetInt() >>  10) & 0x01;
					m_fRequiresCryptLayer	= (temptag.GetInt() >>  9) & 0x01;
					m_fRequestsCryptLayer	= (temptag.GetInt() >>  8) & 0x01;
					m_fSupportsCryptLayer	= (temptag.GetInt() >>  7) & 0x01;
					// read the mod bit
					m_fSupportsModProt		= (temptag.GetInt() >>  6) & 0x01; // NEO: NMP - [NeoModProt] <-- Xanatos --
					m_fExtMultiPacket		= (temptag.GetInt() >>  5) & 0x01;
					m_fSupportsLargeFiles   = (temptag.GetInt() >>  4) & 0x01;
					m_byKadVersion			= (uint8)((temptag.GetInt() >>  0) & 0x0f);
					dwEmuleTags |= 8;
					if (bDbgInfo)
						m_strHelloInfo.AppendFormat(_T("\n  KadVersion=%u, LargeFiles=%u ExtMultiPacket=%u CryptLayerSupport=%u CryptLayerRequest=%u CryptLayerRequires=%u m_fSupportsSourceEx2=%u"), m_byKadVersion, m_fSupportsLargeFiles, m_fExtMultiPacket, m_fSupportsCryptLayer, m_fRequestsCryptLayer, m_fRequiresCryptLayer, m_fSupportsSourceEx2);
					m_fRequestsCryptLayer &= m_fSupportsCryptLayer;
					m_fRequiresCryptLayer &= m_fRequestsCryptLayer;

Sending hello answer and modprot info

Listensocket.cpp bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)

if (client->GetHashType() == SO_EMULE && !bIsMuleHello)
						client->SendMuleInfoPacket(false);

					client->SendHelloAnswer();

					if (client)
					{
						// NEO: NMP - [NeoModProt] -- Xanatos -->
						if(client->GetNeoModProtVersion())
							client->SendModInfoPacket();


Example of SendModInfoPacket:

void CUpDownClient::SendModInfoPacket(){
	if (socket == NULL){ // first we check if we have a valid socket, actualy we was called form the socket so this check is rather unnesesery, but in case
		ASSERT(0);
		return;
	}

	CSafeMemFile data(128);

	// write the amount of emule tags we intent to send
	// !!! this value must be correct !!! 
	uint32 tagcount=2;

	// write the first tag (Nr.1)
	// in this sample its an normal tag with an uint8 ID, its the modstring 0x55 = 'T'
	data.WriteUInt32(tagcount); // nr. of tags
	CTag tagPartStatus(0x55,_T("TestMod"));
	tagPartStatus.WriteNewEd2kTag(&data);

	// write the secund tag (Nr.2)
	// in this sample its an custom named tag with an string as ID
	CTag tagMyMail("Mod:eMail",_T("User@Domain.com"));
	tagMyMail.WriteNewEd2kTag(&data);
	
	// we are done writing tags

	// now we create a packet and put what we have writen in it
	Packet* packet = new Packet(&data,OP_MODPROT);
	packet->opcode = OP_MODINFOPACKET;
	if (thePrefs.GetDebugClientTCPLevel() > 0)
		DebugSend("OP__ModInfoPacket", this);
	theStats.AddUpDataOverheadOther(packet->size);
	socket->SendPacket(packet,true,true); // we send the packet
}

Delaying ConnectionEstablished & sending the mod info packet

listensocket.cpp bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)

				case OP_HELLOANSWER:
				{
					theStats.AddDownDataOverheadOther(size);
					client->ProcessHelloAnswer(packet,size);
					if (thePrefs.GetDebugClientTCPLevel() > 0){
						DebugRecv("OP_HelloAnswer", client);
						Debug(_T("  %s\n"), client->DbgGetHelloInfo());
					}

					// NEO: NMP - [NeoModProt] -- Xanatos -->
					if(client->SupportsModProt() == 0)	// check for mod prot
					// we will start the SUI when we recieve the mod info packet
					// NEO: NMP END <-- Xanatos --
					{
						// start secure identification, if
						//  - we have received OP_EMULEINFO and OP_HELLOANSWER (old eMule)
						//	- we have received eMule-OP_HELLOANSWER (new eMule)
						if (client->GetInfoPacketsReceived() == IP_BOTH)
							client->InfoPacketsReceived();
					}

					if (client)
					{
						// NEO: NMP - [NeoModProt] -- Xanatos -->
						if (client->SupportsModProt()) // if this cleint uses mod protocol extensions
							client->SendModInfoPacket(); // we send him the mod info packet with our rxtensions
						else // we *dont* call ConnectionEstablished at this point,
							 // when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
						// NEO: NMP END <-- Xanatos --
						{
							client->ConnectionEstablished();
							theApp.emuledlg->transferwnd->clientlistctrl.RefreshClient(client);
						}
					}
					break;
				}

listensocket.cpp bool CClientReqSocket::ProcessPacket(const BYTE* packet, uint32 size, UINT opcode)

				case OP_HELLO:
				{
					[..................]

					if (client)
					{
						// NEO: NMP - [NeoModProt] -- Xanatos -->
						if(client->SupportsModProt()) // if this cleint uses mod protocol extensions
							client->SendModInfoPacket(); // we send him the mod info packet with our rxtensions
						else // we *dont* call ConnectionEstablished at this point,
							 // when will call ConnectionEstablished when we recieve the Mod Info frm this cleint
						// NEO: NMP END <-- Xanatos --
							client->ConnectionEstablished();
					}

					ASSERT( client );
					if(client)
					{
						// NEO: NMP - [NeoModProt] -- Xanatos -->
						if(client->SupportsModProt() == 0) // check for mod prot
						// we will start the SUI when we recieve the mod info packet
						// NEO: NMP END <-- Xanatos --
						{

							// start secure identification, if
							//	- we have received eMule-OP_HELLO (new eMule)
							if (client->GetInfoPacketsReceived() == IP_BOTH)
								client->InfoPacketsReceived();
						}

						if( client->GetKadPort() )
							Kademlia::CKademlia::Bootstrap(ntohl(client->GetIP()), client->GetKadPort(), (client->GetKadVersion() > 1));
					}
					break;
				}

Processing the modinfo packet

listensocket.cpp

bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
{
	try
	{
		try
		{
			if (!client)
			{
				theStats.AddDownDataOverheadOther(uRawSize);
				throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
			}
			if (thePrefs.m_iDbgHeap >= 2)
				ASSERT_VALID(client);

			switch(opcode)
			{
				case OP_MODINFOPACKET:
				{
					if (thePrefs.GetDebugClientTCPLevel() > 0)
						DebugRecv("OP__ModInfoPacket", client);
					theStats.AddDownDataOverheadOther(uRawSize);

					if(client->GetNeoModProtVersion() == 0)
						throw CString(_T("Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!"));

					client->ProcessModInfoPacket(packet,size);

					// Now after we have all informations about the cleint the connection is established
					client->ConnectionEstablished();

					// start secure identification, if
					//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
					if (client->GetInfoPacketsReceived() == IP_BOTH)
						client->InfoPacketsReceived();
					break;
				}	

				// NEO: NMPm - [NeoModProtMultiPacket]
				case OP_MODMULTIPACKET: 
				{
...



baseclient.cpp

void CUpDownClient::ProcessModInfoPacket(const uchar* pachPacket, uint32 nSize)
{
	bool bDbgInfo = thePrefs.GetUseDebugDevice();
	CString m_strModInfo;
	CSafeMemFile data(pachPacket, nSize);

	// we read now the amount of tags that the sender put in th epacket
	uint32 tagcount = data.ReadUInt32();
	if (bDbgInfo)
		m_strModInfo.AppendFormat(_T("  Tags=%u"), (UINT)tagcount);
	// now we are going to read all of them
	for (uint32 i = 0; i < tagcount; i++)
	{
		CTag temptag(&data, false);
		switch (temptag.GetNameID()) // here we distinguish only tags with an uint8 ID, all named tags are handled below
		{
			case 0x55:
				if (temptag.IsStr())
					Log(_T("ModString %s", temptag.GetStr()));
				else if (bDbgInfo)
					m_strModInfo.AppendFormat(_T("\n  ***UnkType=%s"), temptag.GetFullInfo());
				break;

			default:

				// now we habdle custom named tags, we use a series of (else)if's and strcmp, note: this is *not* unicide!!!
				if(strcmp(temptag.GetName(),"Mod:Hello") == 0)
				{
					if(temptag.IsStr())
						Log(LOG_SUCCESS,_T("*** Greathings from %s: %s"),GetUserName(),temptag.GetStr());
				}
				else

				if (bDbgInfo)
					m_strModInfo.AppendFormat(_T("\n  ***UnkTag=%s"), temptag.GetFullInfo());
		}
	}

	// some debug output
	if (bDbgInfo && data.GetPosition() < data.GetLength()){
		m_strModInfo.AppendFormat(_T("\n  ***AddData: %u bytes"), data.GetLength() - data.GetPosition());
	}
}

Processing mod data example

EMSocket.cpp void CEMSocket::OnReceive(int nErrorCode)

switch (pendingPacket->prot){
				case OP_EDONKEYPROT:
				case OP_PACKEDPROT:
				case OP_EMULEPROT:
				// NEO: NMP - [NeoModProt] -- Xanatos -->
				// We have to accept also mod packet
				case OP_MODPACKEDPROT:
				case OP_MODPROT:
				// NEO: NMP END <-- Xanatos --
					break;
				default:
					EMTrace("CEMSocket::OnReceive ERROR Wrong header");
					delete pendingPacket;
					pendingPacket = NULL;
					OnError(ERR_WRONGHEADER);
					return;
			}


listensocket.cpp bool CClientReqSocket::PacketReceivedCppEH(Packet* packet)

		// NEO: NMP - [NeoModProt] -- Xanatos -->
		// dispatch mod packets to the right processing functions
		case OP_MODPACKEDPROT:
			if (!packet->UnPackPacket()){
				if (thePrefs.GetVerbose())
					AddDebugLogLine(false, _T("Failed to decompress client Mod TCP packet; %s; %s"), DbgGetClientTCPPacket(packet->prot, packet->opcode, packet->size), DbgGetClientInfo());
				bResult = false;
				break;
			}
		case OP_MODPROT:
			bResult = ProcessModPacket((const BYTE*)packet->pBuffer, packet->size, packet->opcode, uRawSize);
			break;
// NEO: NMP - [NeoModProt] -- Xanatos -->
bool CClientReqSocket::ProcessModPacket(const BYTE* packet, uint32 size, UINT opcode, UINT uRawSize)
{
	try
	{
		try
		{
			// we must have a cleint at this point !always!
			if (!client)
			{
				theStats.AddDownDataOverheadOther(uRawSize);
				throw GetResString(IDS_ERR_UNKNOWNCLIENTACTION);
			}
			if (thePrefs.m_iDbgHeap >= 2)
				ASSERT_VALID(client);

			switch(opcode) // dispatch particular packets
			{
				// for the mod prot v1 (capability exchange) only this one packet is relevant, the mod info packet
				case OP_MODINFOPACKET:
				{
					if (thePrefs.GetDebugClientTCPLevel() > 0)
						DebugRecv("OP__ModInfoPacket", client);
					theStats.AddDownDataOverheadOther(uRawSize);

					if(client->SupportsModProt() == 0) // just pure formality
						throw CString(_T("Recieved Neo Mod Info Packet from a cleint whitch doe snot support this feature!"));

					// Process the packet
					client->ProcessModInfoPacket(packet,size);

					// Now after we have all informations about the cleint the connection is established
					client->ConnectionEstablished();

					// start secure identification, if
					//  - we have received OP_MODINFOPACKET, (Neo Compatible new eMule mods)
					if (client->GetInfoPacketsReceived() == IP_BOTH)
						client->InfoPacketsReceived();
					break;
				}	

				default: // handle unknown packets
					
					theStats.AddDownDataOverheadOther(uRawSize);
					PacketToDebugLogLine(_T("ModProt"), packet, size, opcode);
			}
		}
		catch(CFileException* error)
		{
			error->Delete();
			throw GetResString(IDS_ERR_INVALIDPACKAGE);
		}
		catch(CMemoryException* error)
		{
			error->Delete();
			throw CString(_T("Memory exception"));
		}
	}
	catch(CString error)
	{
		if (thePrefs.GetVerbose() && !error.IsEmpty())
			DebugLogWarning(_T("Error: %s - while processing Mod packet: opcode=%s  size=%u; %s"), error, DbgGetMuleClientTCPOpcode(opcode), size, DbgGetClientInfo());
		// Note: don't disconnect cleints on mod prot errors, the extensions are just addons and if thay fail the client will work anyway
		//if (client)
		//	client->SetDownloadState(DS_ERROR, _T("ProcessModPacket error. ") + error);
		//Disconnect(_T("ProcessModPacket error. ") + error); 
		//return false;
	}
	return true;

// NEO: NMP END <-- Xanatos --

Additional modifications

Packets.cpp void Packet::PackPacket()

	// NEO: NMP - [NeoModProt] -- Xanatos -->
	if( prot == OP_MODPROT )
		prot = OP_MODPACKEDPROT;
	else
	// NEO: NMP END <-- Xanatos --
	if( prot == OP_KADEMLIAHEADER )
		prot = OP_KADEMLIAPACKEDPROT;
	else
		prot = OP_PACKEDPROT;

Packets.cpp bool Packet::UnPackPacket(UINT uMaxDecompressedSize)

		// NEO: NMP - [NeoModProt] -- Xanatos -->
		if( prot == OP_MODPACKEDPROT )
			prot = OP_MODPROT;
		else
		// NEO: NMP END <-- Xanatos --
		if( prot == OP_KADEMLIAPACKEDPROT )
			prot = OP_KADEMLIAHEADER;
		else
			prot =  OP_EMULEPROT;

Backward compatibility

The modstring is still send via hello(answer) packets but only if the remote client is using a mod and does not support the mod prot extension to maintain backward compatibility. Usage of CT_MOD_VERSION is proposed to move it to the mod protocol. A mod using the modbit MUST identify itself either via CT_MOD_VERSION in the hello(answer) packets or via modstring in the modinfo packet. NOTE: a mod that uses extensions but refuses to identify itself will most likely be considered a bad mod by some antileecher systems

The proposed check to use would be like

void CUpDownClient::SendHelloTypePacket(CSafeMemFile* data)
{
...
...
	uint32 tagcount = 6;

	if( theApp.clientlist->GetBuddy() && theApp.IsFirewalled() )
		tagcount += 2;

//>>> MODPROT::Send Modstring to old mods only
	const bool bSendModString = !SupportsModProt() && (!m_strModVersion.IsEmpty() || !m_pszUsername); 
	if(bSendModString)
		++tagcount;
//<<< MODPROT::Send Modstring to old mods only

	data->WriteUInt32(tagcount);
...
...
	tagMuleVersion.WriteTagToFile(data);

//>>> MODPROT::Send Modstring to old mods only
	if(bSendModString)
	{
		CTag tagMod(CT_MOD_VERSION, L"My Mod String");
		tagMod.WriteTagToFile(data);
	}
//<<< MODPROT::Send Modstring to old mods only

	uint32 dwIP;
	uint16 nPort;
...
...

and similar for the info packet.


OPCODE defines

OP_MODPROT       0x4D
OP_MODPACKEDPROT 0x6D
OP_MODINFOPACKET 0x01

TAG defines

Tags used must be reserved in modprot topic at http://forum.emule-project.net/ Sources must be published within 3 months after claiming a tag.

The range 0x01 - 0x1F is completely reserved.

Tags in the range from 0x20 - 0x7E are reserved for major features, possible objections can be:

  1. Modder uses too many tags (if you need more than 5 tags you are most likely doing something wrong. Note that string tags are also available - those are not regulated)
  2. Utterly useless or unimplementable feature (no other mod will ever use it)
  3. Illegal feature (should be clear)

The range 0x7F-FF is open and you can claim any free tag you want, only objection can be the usage of too many tags (e.g. someone claims to need a range from 0x80 to 0xAF).

TAGNAME VALUE Meaning Reserved by / source code
MISC_PROTOCOL_EXTENSIONS 'M' 4D used for full mod extensions like ICS, etc.. basic modprot
MISC_PROTOCOL_EXTENSIONS2 'm' 6D used for full mod extensions 2, reserved for future use basic modprot
CT_MOD_VERSION 'U' 0x55 Modstring basic modprot
KAD_EMULE_BUDDYID '@' 40 NatT David Xanatos
XS_EMULE_BUDDYIP 'B' 42 NatT David Xanatos
XS_EMULE_BUDDYUDP 'b' 62 NatT David Xanatos
NEO_PROTOCOL_EXTENSIONS 'N' 4E etc. David Xanatos
NEO_PROTOCOL_EXTENSIONS2 'n' 6E reserved for future Neo features David Xanatos


  • MISC_PROTOCOL_EXTENSIONS:
  [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)
  [bit 3]   // ICSv2 New Official Version
  [bit 4]   // UDP Mod File Status*
  [bit 5]   // NATT - [NatTraversal], XSB - [XSBuddy], RPT - [ReuseTCPPort]
  [bit 6]   // NXS - [NeoXS]
  [bit 7]   // SF comments v2
  [bit 8]   // SCT
  [bit 9]   // L2HAC


* The UDP Mod File Status bit is not only used for ICS but used in general. It also tells whether Mod Multi Packet with extended mod status should be sent over UDP or not.

See also

References to emule protocol...

Personal tools