docs/dc1.txt

   1
   2    direct connect messages
   3    ========================
   4
   5    by suxxx@users.sourceforge.net
   6    December 21, 2001
   7
   8    0. Foreward
   9
  10
  11    This is a open spezification of the neo-modus.com direct connect protocol.
  12    If you find here some errors, please write me a mail.
  13    This direct connect protocol spezifcations describe the client<->server and the
  14    server<->server commands. And a little bit the client<->client protocol.
  15
  16    1.  Client-Server protocol
  17
  18    direct connect uses TCP for client to server communication. The servers called "Hubs" runs
  19    on port 411.
  20
  21    each message to/from the server is in the form of
  22
  23
  24    <command>|
  25
  26    the | specifies the end of each command.
  27    each command starts with a $.
  28
  29    if the packed starting without a $ then the packed is a public chat message.
  30    each public chat message is in the form of
  31
  32    <<username>> <chattext>|
  33
  34
  35    the | specifies the end of each public chat message.
  36
  37    2. Command Types (client to server)
  38
  39    The following section describes the format of the Commands
  40    Each field is denoted with <>.  The fields in the command are separated
  41    by a single space character (ASCII 32). And each Command ends with a | (pipe)
  42    All Commands are casesensetiv
  43
  44    command    sended by description of the subcomands and the format
  45    =============================================================================================
  46
  47
  48    $Lock    SERVER    First message from server to client. thats a security check.
  49             the client must send a $Key command as answer.
  50
  51             Format: $Lock <lockcode>
  52
  53    $Key     CLIENT    This is the Clients first message to the server.
  54             the client sends a Key. this key will be calculated from the
  55             <lockcode>.
  56
  57             Format: $Key <keycode>
  58
  59
  60    $HubName   SERVER    The server sends his name to the client. Mostly with a welcome message.
  61
  62             Format: $HubName <hubname>
  63
  64    $ValidateNick  CLIENT   The Client sends his Username to the Server.
  65             If the Username is already in use or wrong, the server sends a $ValidateDenide message.
  66
  67             Format: $ValidateNick <nickname>
  68
  69    $ValidateDenide    SERVER   If the Username already in use or wrong, the server sends this message.
  70
  71             the client must take another Username and send $ValidateNick again.
  72
  73             Format: $ValidateDenide <thebadnickname>
  74
  75    $GetPass   SERVER    Sends from server to the connected client, if the username is password protected.
  76
  77             Format: $GetPass
  78
  79    $MyPass    CLIENT    The client sends this message to the server to send the password.
  80
  81             Format: $MyPass <password>
  82
  83
  84    $BadPass   SERVER    If the password is wrong, the server sends this message and closes the connection
  85
  86             Format: $BadPass
  87
  88    $Version   CLIENT    The client sends the version of the clientsoftware to the server
  89
  90             Format: $Version <versionnumber>
  91
  92    $Hello     SERVER    If a new client connected, the server sends to all clients this message.
  93
  94
  95             Format: $Hello <nickname>
  96
  97    $LogedIn   SERVER    If a operator connected, the server sends this message to the connected
  98             user. (to enable the admin menue eg.)
  99
 100             Format: $LogedIn <nickname>
 101
 102    $MyInfo    CLIENT    This message informs the server about the Userinfos.
 103          SERVER   This message will send from server too as response to $GetINFO.
 104
 105             Format: $MyINFO $ALL <nickname> <description>$ $<speed>\x01$<email>$<sharedsizeinbyte$
 106
 107             "\x01" stands for (as ascii char):
 108             1 = normal
 109             2 = away
 110             3 = away
 111             4 = fileserver
 112             5 = fileserver
 113             6 = fileserver away
 114             7 = fileserver away
 115             8 = speeduser
 116             9 = speeduser
 117             10 = speeduser away
 118
 119             12 = speeduser away
 120
 121    $GetINFO   CLIENT    This message reqests the userinfos from a other user.
 122
 123             Format: $GetINFO <nickname> <ownnickname>
 124
 125    $GetNickList   CLIENT   This message sends the client to request the nicklist and the oplist.
 126
 127             Format: $GetNickList
 128
 129    $NickList  SERVER    This message sends the server to a client, when the client request the nicklist.
 130
 131
 132             Format: $NickList <nickname1>$$<nickname2>$$
 133
 134    $OpList    SERVER    This message sends the server to a client, when the client request the nicklist.
 135             This message will send too, when a new op connected. (to all connected users)
 136
 137             Format: $OpList <nickname1>$$<nickname2>$$
 138
 139    $To    CLIENT    This message sends the client to the server to send a private message to a spezific user
 140          SERVER   The same message sends the server to the spezific user
 141
 142
 143             Format: $To: <nickname> From: <ownnickname> $<ownnickname> <message>
 144
 145    $ConnectToMe   CLIENT   This message sends the client to the server to send a connection request to a spezific user
 146          SERVER   The same message sends the server to the spezific user
 147
 148             Format: $ConnectToMe <nickname> <ownip>:<ownlistenport>
 149
 150    $MultiConnectToMe  CLIENT   The same message as $ConnectToMe. That message will send by client, when other user
 151             is on a other Hub.
 152
 153    $RevConnectToMe    CLIENT   This message sends the client to the server to send a connection request to a spezific user
 154
 155          SERVER   The same message sends the server to the spezific user
 156             The client sends this message, when he is behind a firewall.
 157             When the other client received the message it must send a $ConnectToMe that the firewalld User.
 158             could connect.
 159
 160             Format: $RevConnectToMe <ownnick> <nickname>
 161
 162    $Search    CLIENT    This message will send to search a file.
 163          SERVER   The same message sends the server to the spezific user
 164
 165             Passive:
 166
 167             Format: $Search Hub:<ownnickname> <cmd1>?<cmd2>?cmd3>?<cmd4>?<cmd5>
 168             Active:
 169             Format: $Search <ownip>:<ownlistenport> <cmd1>?<cmd2>?cmd3>?<cmd4>?<cmd5>
 170
 171             <cmd1> sets search for sizelimit Yes or No (Yes = T and No = F)
 172             <cmd2> search sizelimit "At Least" or "At Most" ("At Least" = F and "At Most" = T)
 173             <cmd3> sizelimit. if <cmd1> is "F" then <cmd3> is 0 else the sizelimit in bytes
 174             <cmd4> the filetype ("Any" is 1, "Audio" is 2 an so on)
 175             <cmd5> is the search value. If you insert "mp3 techno" you must replace the " " with a "$"
 176
 177    $MultiSearch   CLIENT   The same message as $Search. That message will send by client, when the search on all hubs
 178
 179             checkbox is enabled.
 180
 181    $SR    CLIENT    This is the Searchrespond for passive searching. if a active user find some files that
 182          SERVER   matches the searchrequest. it will send this message. the server will forward this message only
 183             to the user that had start the searchrequest.
 184
 185             Format: $SR <ownname> <filenamewithpath)\x05<filesizeinbytes> <current openslots>/<allopenslots>\x05<hubname> (<hubip>:<hubport>)
 186             "\x05" is ascii char 5
 187
 188    $Kick    CLIENT    This message could only sends an operator. This command will kick another user.
 189
 190
 191             Format: $Kick <nickname>
 192
 193    $OpForceMove   CLIENT   This message could only sends an operator. This command will redirect another user.
 194
 195             Format: $OpForceMove $Who:<nickname>$Where:<iptoredirect><Msg:<a message>
 196
 197    $ForceMove   SERVER   This message will sends by the server to a client, that he must connect to another hub.
 198             Server dont kick the user, the client must disconnect!
 199
 200             Format: $ForceMove <ipaddress>
 201
 202
 203    $Quit    SERVER    This message will send to all clients, when a user disconnects
 204
 205             Format: $Quit <nickname>
 206
 207
 208
 209    3.  Server-Server protocol
 210
 211    direct connect uses UDP for server to server communication.
 212
 213    each message is in the form of
 214
 215
 216    <command>|
 217
 218    the | specifies the end of each command.
 219    each command starts with a $.
 220
 221    4. Command Types (server to server)
 222
 223    The following section describes the format of the Commands
 224    Each field is denoted with <>.  The fields in the command are separated
 225    by a single space character (ASCII 32). And each Command ends with a | (pipe)
 226
 227    All Commands are casesensetiv
 228
 229    command    description of the subcomands and the format
 230    ============================================================================================
 231
 232    $Up    This message will send as heardbeat request to each linked server.
 233
 234          Format: $Up <linkedserverpassword> <ownip>
 235
 236    $UpToo     This message will send as heardbeat response to the requesting server
 237
 238
 239          Format: $UpToo <linkedserverpassword> <ownip>
 240
 241    $Search    This message will send from a server to each linked server, when a user
 242          searches with $MultiSearch
 243
 244          Format: $Search <ownip>:<ownlistenport> <cmd1>?<cmd2>?cmd3>?<cmd4>?<cmd5>
 245
 246          <cmd1> sets search for sizelimit Yes or No (Yes = T and No = F)
 247          <cmd2> search sizelimit "At Least" or "At Most" ("At Least" = F and "At Most" = T)
 248          <cmd3> sizelimit. if <cmd1> is "F" then <cmd3> is 0 else the sizelimit in bytes
 249          <cmd4> the filetype ("Any" is 1, "Audio" is 2 an so on)
 250
 251          <cmd5> is the search value. If you insert "mp3 techno" you must replace the " " with a "$"
 252
 253
 254    $ConnectToMe   This message sends the server to each linked server, when a user sends the $MultiConnectToMe
 255          message.
 256
 257          Format: $ConnectToMe <nickname> <ownip>:<ownlistenport>
 258
 259
 260    5.  client-client protocol
 261
 262
 263    direct connect uses TCP for client to client communication.
 264    normaly the client listen at port 412 for client connections.
 265    but if the port already in use it uses 413,414 and so on..
 266
 267    After a $ConnectToMe over the Server a Client Connects the other one.
 268
 269    each message is in the form of
 270
 271    <command>|
 272
 273    the | specifies the end of each command.
 274
 275    each command starts with a $.
 276
 277    6. Command Types (client to client)
 278
 279    The following section describes the format of the Commands
 280    Each field is denoted with <>.  The fields in the command are separated
 281    by a single space character (ASCII 32). And each Command ends with a | (pipe)
 282    All Commands are casesensetiv
 283
 284    Client number 1 is the user who connecting
 285    Client number 2 is the use who listen
 286
 287
 288    command  from client num    description of the subcomands and the format
 289    ============================================================================================
 290
 291    $MyNick  CLIENT 2    The listen User sends his Name when a user connecting.
 292        CLIENT 1   After the Lock/Key handshake the connected client sends MyNick too
 293
 294             Format: $MyNick <ownnickname>
 295
 296    $Lock  CLIENT 2    After the $MyNick command the listen user sends a $Lock command.
 297        CLIENT 1   After the first handshake, the connecting client sends a $Lock code too.
 298
 299             Format: $Lock <lockcode>
 300
 301    $Key   CLIENT 1    This is the first message to the listen user.
 302        CLIENT 2
 303             the key will be calculated from the <lockcode>.
 304
 305             Format: $Key <keycode>
 306
 307    $Direction CLIENT 2   ???? for passive or active mode downloading???
 308
 309             Format: $Direction <direction> <anumber>
 310
 311
 312     could be "Upload" or "Download"
 313     ???
 314
 315    $GetListLenCLIENT 1   with this command the client requestes the filesize of the
 316             sharelist.
 317
 318             Format: $GetListLen
 319
 320    $ListLen CLIENT 2    this is the answer to $GetListLen.
 321
 322
 323             Format: $ListLen <sizeinbyte>
 324
 325    $MaxedOutCLIENT 2    this will send, when no freeslots available
 326
 327             Format: $MaxedOut
 328
 329    $Error   CLIENT 2    this will send when a error occures.. like file not found eg
 330
 331             Format: $Error <errormessage>
 332
 333    $Send  CLIENT 2    informs the other client, that the upload will start.
 334
 335        CLIENT 1   informa a client tha he could start with the upload
 336
 337             Format: $Send
 338
 339    $Get   CLIENT 1    requests a file from the other client.
 340
 341             Format: $Get <filenameandpath>$<resumecount>
 342
 343    $FileLengthCLIENT 2   after a $Get request, the other the other client sends
 344             the filesize.
 345
 346
 347             Format: $FileLength <sizeinbytes>
 348
 349    $CanceledCLIENT 1    Cancel a transfer
 350        CLIENT 2
 351
 352             Format: $Canceled
 353
 354    Download Example:
 355
 356    Client 1 connects Client 2
 357
 358
 359    //handshake
 360    CL2: $MyNick <nickname>
 361    CL2: $Lock <lockcode>
 362    CL1: $Key <keycode>
 363    CL1: $Lock <lockcode>
 364    CL2: $Key <keycode>
 365    CL1: $MyNick <nickname>
 366    //handshake
 367
 368    //unknown
 369    CL2: $Direction <direction> <anumber>
 370
 371    //unknown
 372
 373    //request shared listfilesize
 374    CL1: $GetListLen
 375    CL2: $ListLen <sizeinbyte>
 376    //request shared listfilesize
 377
 378    //request the shared filelist
 379    CL1: $Get MyList.DcLst$1
 380    CL2: $FileLength <sizeinbytes>
 381    //request the shared filelist
 382
 383
 384    //starttransfer
 385    CL1: $Send
 386    //starttransfer
 387
 388    After the $Send command, the sharing client sending the file...
 389
 390
 391    7. Copyright
 392
 393    direct connect is a trademark of neo-modus.com
 394
 395
 396    this protocol specs writen and analyst by suxxx
 397    without any help from neo-modus.com if you want
 398    information about the protocol or if you have
 399    information about some messages eg.write me a mail.
 400
 401 Telechargement dans DC:
 402
 403 --- envoie -->
 404 $MyNick toto2002|
 405 $Lock O5SGVKT;U)>]aoK\a>2jTtv_RQk9J8bl0y+0B;gWV(;sNvAdlgf'Gvm8g4=a.-&@6Cp'GwaufkSKIX68i%>\, Pk=(iNeJXH>+1blGZ2.|
 406
 407 <-- recoit --
 408 $MyNick.[BBB]WizardOne|
 409 $Lock EXTENDEDPROTOCOLABCABCABCABCABCABC Pk=DCPLUSPLUS0.1763kABCABC|
 410 $Direction Upload 666|
 411 $Key...fA......q6..Bq.........0.%7'....%.'.....1...sR.......U.5...0.fgW3u..aA1..........&.|
 412
 413 --- envoie -->
 414 $Direction Download 9708|
 415 $Key.........A......0.0..0..0..0..0..0.|
 416 $Get.upload\-.=.Misc.=.-\WIN.XP.CODE.txt$1|
 417
 418 <-- recoit --
 419 $FileLength.112|
 420
 421 --- envoie -->
 422 $Send|
 423
 424 <- recoit
 425 ................. Le fichier .....................
 426
 427 $Direction Upload/Download level|
 428
 429
 430
 431
 432