ADC Protocol Draft 0.11

Jacek Sieka

Table of Contents

1 Intro 2

1.1 About 2

1.2 Credits 2

2 Line protocol 2

2.1 General 2

2.2 Message syntax 2

2.3 Message types 3

2.4 Client identification 3

2.4.1 Session ID 3

2.4.2 Private ID 3

2.4.3 Client ID 4

3 Files 4

3.1 File names and structure 4

3.2 Hashes 4

3.3 File list 5

4 BASE messages 5

4.1 Client – Hub communication 5

4.2 Client – Client communication 6

4.3 Actions 6

4.3.1 STA 6

4.3.2 SUP 7

4.3.3 SID 7

4.3.4 INF 7

4.3.5 MSG 9

4.3.6 SCH 9

4.3.7 RES 10

4.3.8 CTM 10

4.3.9 RCM 10

4.3.10 GPA 10

4.3.11 PAS 10

4.3.12 QUI 11

4.3.13 DSC 11

4.3.14 GET 11

4.3.15 GFI 12

4.3.16 SND 12

5 Examples 12

5.1 Client – Hub connection 12

5.2 Client – Client connection 12

6 Standard Extensions <work-in-progress> 13

6.1 REGX - Regular expressions in searches 13

6.2 ZLIB - Compressed communication 13

6.2.1 ZLIB-FULL 13

6.2.2 ZLIB-GET 13

6.3 UCMD - User commands 13

6.3.1 CMD 13

6.4 ADCS - Secure ADC <work-in-progress> 14

6.4.1 Introduction 14

6.4.2 Client-Hub encryption 14

6.4.3 Client-Client encryption 14

1Intro

1.1About

ADC is a text protocol for a network similar to Direct Connect. The goal is to create a simple protocol that doesn’t require much effort neither in hub nor client, and is yet extensible. It addresses some of the issues in the NMDC protocol, the most interesting being extensibility, but definitely not all. The same protocol structure is used both for client-hub and client-client communication. This document is split into two parts; the first shows the structure of the protocol, while the second implements a specific system using this structure. ADC stands for anything you would like it to stand for; Advanced DC is the first neutral thing that springs to mind =).

1.2Credits

Many ideas for this I’ve taken from Jan Vidar Krey’s DCTNG draft, others come from the DC dev hub people (notably cologic, fusbar, farcry and sedulus). Oh, and not to forget, Jon Hess for the original DC idea.

2Line protocol

2.1General

2.2Message syntax

message ::= message_body? eol

message_body ::= (b_message_header | cih_message_header | d_message_header | f_message_header | u_message_header | message_header) (separator positional_parameter)* (separator named_parameter)*

b_message_header ::= 'B' command_name separator my_sid

cih_message_header ::= ('C' | 'I' | 'H') command_name

d_message_header ::= 'D' command_name separator my_sid separator target_sid

f_message_header ::= 'F' command_name separator my_sid separator (('+'|'-') feature_name)+

u_message_header ::= 'U' command_name separator my_cid

command_name ::= simple_alpha simple_alphanum simple_alphanum

positional_parameter ::= parameter_value

named_parameter ::= parameter_name parameter_value?

parameter_name ::= simple_alpha simple_alphanum

parameter_value ::= escaped_letter+

target_sid ::= encoded_sid

my_sid ::= encoded_sid

encoded_sid ::= base32_character{4}

my_cid ::= encoded_cid

encoded_cid ::= base32_character{39}

base32_character ::= simple_alpha | [2-7]

feature_name ::= simple_alpha simple_alphanum{3}

escaped_letter ::= [^ \#x0a] | escape 's' | escape 'n' | escape escape

escape ::= '\'

simple_alpha ::= [A-Z]

simple_alphanum ::= [A-Z0-9]

eol ::= #x0a

separator ::= ' '

2.3Message types

Message type specifies how messages should be routed, and thus which additional fields can be found in the message header. Clients should use the most limiting type, in terms of recipients, that makes sense for a particular message when sending it to the hub for distribution. Clients should disregard the message type when interpreting the message (after having parsed it). The following message types are defined:

B

Broadcast. Hub must send message to all connected clients, including the sender of the message.

C

Client message. Clients must use this message type when communicating directly over TCP.

D

Direct message. The hub must send the message to both the target_sid and my_sid users.

F

Feature broadcast. The hub must send message to all clients that support both all required (+) and no excluded (-) features named. The feature name is matched against the corresponding SU field in INF sent by each client.

H

Hub message. Clients must use this message type when a message is intended for the hub only.

I

Info message. Hubs must use this message type when sending a message to a client that didn't come from another client.

U

UDP message. Clients must use this message type when communicating directly over UDP.


2.4Client identification

Each client is identified by three different IDs, Session ID (SID), Private ID (PID) and Client ID (CID).

2.4.1Session ID

Session IDs appear in all communication that interacts with the hub. They identify a unique user on a single hub and are assigned by the hub during initial protocol negotiation. The hub may choose any SID for a connecting client apart from “0” (“AAAA” in base32). The hub may reuse SIDs as they become free when clients disconnect. SIDs are 20 bits and encoded using a 4-byte base32 encoded string.

2.4.2Private ID

Private IDs globally identify a unique client. They function during initial protocol negotiation to generate the CID, and are invisible to other clients. PIDs should be generated by hashing the MAC address of the generating client followed by the current time using the Tiger hash algorithm. Hubs and clients may not disclose PIDs to other clients; doing so weakens the security of the ADC network. Clients should should keep the same PID between sessions and hubs. PIDs are 192 bits and encoded using a 39 byte base32 encoded string.

2.4.3Client ID

Client IDs globally and publicly identify a unique client and underlie client to client communication. They are generated by hashing the 192 bit, unencoded PID with the Tiger hash algorithm. Hubs should register clients by CID. CIDs are 192 bits and encoded using a 39 byte base32 encoded string.

3Files

3.1File names and structure

Filenames are relative to a fictive root in the user’s share. ‘/’ separates directories, and each file or directory name must be unique in a case-insensitive context. All printable characters, including whitespace, are valid names for files, the ‘/’ and ‘\’ being escaped by ‘\’. Clients must then properly filter the filename for the target file system, as well as request filenames from other clients according to these rules. The special names ‘.’ and ‘..’ may not occur as a directory or filename; any file list received containing those must be ignored. Shared files are identified relative to the unnamed root ‘/’ (“/dir/subdir/filename.ext”), while extensions can add named roots to this namespace, preferably using their SUP name. “TTH/<root-base32>”, for example, locates a file in the share by TTH root rather than filename. Rootless filenames are special, for they may not appear in the file listing, and can be used to supply binary transfers of arbitrary data, but should not be used to avoid polluting the namespace by using a named root. All directory names must end with a ‘/’. Names in the unnamed root generally find little use identifying files, as the TTH root does so more effectively. Hence, commands that get files or file data may never use the unnamed root for selecting file.

The special, rootless filename “files.xml” specifies the full file listing, uncompressed, in XML using the UTF-8 encoding. Clients can then compress this list and offer the compressed one as relevant SUP features allow.

The special type “list” is used to browse partial lists. A partial file list has the same structure as a normal list, but directories may be tagged with an attribute ‘Incomplete=”1”’ to specify that they have unexpanded sub-entries. Only directory names in the unnamed root may be requested, for instance “/” and “/share/”. The content of that directory will then be sent to the requesting client to a depth chosen by the sending client (it should normally only send the directory level requested, but may choose to send more if there are few entries, for example a directory only containing a few files). The “Base” attribute of “FileListing” specifies which directory a particular file list represents.


3.2Hashes

ADC clients must share only files hashed using Merkle Hash trees, as defined by http://www.open-content.net/specs/draft-jchapweske-thex-02.html. The Tiger algorithm, as specified byhttp://www.cs.technion.ac.il/~biham/Reports/Tiger/, functions as the hash algorithm. A base segment size of 1024 bytes must be used when generating the tree, but clients may then discard parts of the tree as long as at least 7 levels are kept or a block granularity of 64 KiB is achieved.

Generally, the root of the tree serves to identify a file uniquely. Searches use it and it must be present in the file list. Further, the root of the file list must also be available, and discoverable via GFI. A client may also request the rest of the tree using the normal client-client transfer procedure. The root must be encoded using base32 encoding when converted to text.

3.3File list

Files.xml is the list of files intended for browsing. It has the following general structure:


<?xml version=”1.0” encoding=”utf-8” standalone=”yes”?>

<FileListing Version=”1” CID=”my-cid” Generator=”DC++ 0.401” Base=”/”>

<Directory Name=”share”>

<Directory Name=”DC++ Prerelease”>

<File Name=”DCPlusPlus.pdb” Size=”17648640” TTH=”xxxxxxxxx”/>

<File Name=”DCPlusPlus.exe” Size=”946176” TTH=”xxxxxxxxx”/>

</Directory>

<File Name=”ADC.doc” Size=”154112” TTH=”xxxxxxxxx”/>

</Directory>

<!-- Only used by partial lists -->

<Directory Name=”share2” Incomplete=”1”/>

</FileListing>


“encoding” must always be set to UTF-8. Clients must be prepared to handle XML files both with and without a BOM (byte order mark), although should not output one.

“Version” will not change unless a breaking change is done to the structure of the file.

“CID” is the CID of the client that generated the list.

“Generator” is for informative purposes only.

“Base” is used for partial file lists, but must be present even in the non-partial list.

“TTH” is the base32-encoded TTH root of the file.

“Incomplete” signals whether a directory in a partial file list contains unlisted items. “1” means the directory contains unlisted items, “0” that it does not. Incomplete=”0” is the default and may thus be omitted.

More information may be added to the file by extensions, but is not guaranteed to be interpreted by other clients.

4BASE messages

ADC clients/hubs that support the following messages may advertise the feature “BASE” in the PROTOCOL phase.

The connecting party will be known as client, the other as server. The server always controls state transitions. For each message, the action code and the message contexts under which it is valid are specified.

The message context specifies how the message may be received / sent. Hubs and clients may support using the message in additional contexts as well. The context codes are as follows:

F

From hub (hub-client TCP)

T

To hub (hub-client TCP)

C

Between clients (client-client TCP)

U

Between clients (client-client UDP)



For client-client communication, this protocol is identified by the string “ADC/1.0”.

In the descriptions of the commands, the message header and trailing named parameters have been omitted.

4.1Client – Hub communication

During login, the client goes through a number of stages. An action is valid only in the NORMAL stage unless otherwise noted. The stages, in login order, are PROTOCOL (feature support discovery), IDENTIFY (user identification, static checks), VERIFY (password check), NORMAL (normal operation) and DATA (for binary transfers).

4.2Client – Client communication

The client – client protocol use the same stages as client – hub, but clients are not required to support the VERIFY state and GPA/PAS commands. Support for VERIFY/GPA/PAS must be advertised as an extension. It is always the client that sends the first CTM/RCM command that is given control of the connection once the NORMAL state has been reached.

4.3Actions

4.3.1STA

STA code description

Contexts: F, T, C, U

States: All

Code

Status code in the form “xyy” where x specifies severity, and yy the specific error code. The severity and error code are treated separately, the same error could occur at different severity levels.


Severity values:

0 Success (used for confirming commands), error code must be “00” and an additional flag “FC” contains the FOURCC of the command being confirmed if applicable.

1 Recoverable (error but no disconnect)

2 Fatal (disconnect)


Error codes:

00 Generic, show description

x0 Same as 00, but categorized according to the rough structure set below

10 Generic hub error

11 Hub full

12 Hub disabled

20 Generic login/access error

21 Nick invalid

22 Nick taken

23 Invalid password

24 CID taken

25 Access denied, flag “FC” is the FOURCC of the offending command. Sent when a user is not allowed to execute a particular command

26 Registered users only

27 Invalid PID supplied

30 Kicks/bans/disconnects generic

31 Permanently banned

32 Temporarily banned, flag “TL” is an integer specifying the number of seconds left until it expires (This is used for kick as well…).

40 Protocol error

41 Transfer protocol unsupported, flag “TO” the token, flag “PR” the protocol string. The client receiving a CTM or RCM should send this if it doesn’t support the C-C protocol.

42 Direct connection failed, flag “TO” the token, flag “PR” the protocol string. The client receiving a CTM or RCM should send this if it tried but couldn’t connect.

42 Required INF field missing/bad, flag “FL” specifies the name of field.

43 Invalid state, flag “FC” the FOURCC of the offending command.

44 Required feature missing, flag “FC” specifies the FOURCC of the missing feature.

45 Invalid IP supplied in INF, flag “IP” specifies the correct IP.

50 Client-client / file transfer error

51 File not available

52 File part not available

53 Slots full

Description

Text description of the error, suitable for viewing directly by the user


Even if an error code is unknown by the client, it should display the text message alone. Error codes are used so that the client can take different action on different errors. Most error codes don’t have parameters and only make sense in C and I types.

4.3.2SUP

SUP ('AD' | 'RM') feature (separator ('AD' | 'RM') feature)*

Contexts: F, T, C

States: PROTOCOL, NORMAL

This command identifies which features a specific client / hub supports. The feature name consists of four uppercase letters, where the last letter may be changed to a number to indicate a revised version of the feature. A central register of known features should be kept, to avoid clashes. All ADC clients must support the BASE feature (unless a future revision takes its place), which is this protocol. The server may use any feature that the client indicates support for regardless of its own SUP, and vice versa.

This command can also be used to dynamically add / remove features, ‘AD’ meaning add and ‘RM’ remove.

When the server receives this message the first time, it should reply in kind, assign an SID to the client, send an INF about itself and move to the IDENTIFY state.

4.3.3SID

SID sid

Contexts: F

States: PROTOCOL

This command assigns a SID to a user who is currently logging on. The hub must send this command after SUP but before INF in the PROTOCOL state. The client, when it receives it, should send an INF about itself.

4.3.4INF

INF

Contexts: F, T, C

States: IDENTIFY, NORMAL

This command updates the information about a client. Each time this is received, it means that the fields specified have been added or updated. Each field is identified by two characters, directly followed by the data associated with that field. A field (and the effects of its presence) can be canceled by sending the field name without data. Clients must ignore fields they don’t recognize. Most of these fields are only interesting in the client-hub communication; during client-client this command is mainly used for identification purposes. Hubs can choose to require or ignore any or all of these fields; clients must work without any of them. Many of these fields, such as share size and client version, are purely informative, and should be taken with a grain of salt, as it is very easy to fake them. However, clients should strive to provide accurate data for the general health of the system, as providing invalid information probably will annoy a great deal of people. Updates are made in an incremental manner, by sending only the fields that have changed.

Fields:

ID

The CID of the client. Mandatory for C-C connections.

PD

The PID of the client. Hubs must check that the Tiger(PID) == CID and then discard the field before broadcasting it to other clients. Must not be sent in C-C connections.

I4

IPv4 address without port. A zero address (0.0.0.0) means that the server should replace it with the real IP of the client. Hubs must check that a specified address corresponds to what the client is connecting from to avoid DoS attacks, and only allow trusted clients to specify a different address. Clients should use the zero address when connecting, but may opt not to do so at the user's discretion. Any client that supports incoming TCPv4 connections must also add the feature TCP4 to their SU field.

I6

IPv6 address without port. A zero address (::) means that the server should replace it with the IP of the client. Any client that supports incoming TCPv6 connections must also add the feature TCP6 to their SU field.

U4

Client UDP port. Any client that supports incoming UDPv4 packets must also add the feature UDP4 to their SU field.

U6

Same as U4, but for IPv6. Any client that supports incoming UDPv6 packets must also add the feature UDP6 to their SU field.

SS

Share size in bytes, integer.

SF

Number of shared files, integer

VE

Client identification, version (client-specific, a short identifier then a floating-point version number is recommended). Hubs should not discriminate agains clients based on their VE tag but instead rely on SUP when it comes to which clients should be allowed (for example, “we only want regex clients”).

US

Maximum upload speed, bits/sec, integer

DS

Maximum download speed, bits/sec, integer

SL

Upload slots open, integer

AS

Automatic slot allocator speed limit, bytes/sec, integer. This is the recommended method of slot allocation, the client keeps opening slots as long as its total upload speed doesn’t exceed this value. SL then serves as a minimum number of slots open.

AM

Maximum number of slots open in automatic slot manager mode, integer.

EM

E-mail address, string.

NI

Nickname, string. The hub must ensure that this is unique in the hub up to case-sensitivity. Valid are all characters in the Unicode character set with code point above 32, although hubs may limit this further as they like with an appropriate error message.

When sent for hub, this is the nick that should be displayed before messages from the hub, and may also be used as short name for the hub.

DE

Description, string. Valid are all characters in the Unicode character set with code point equal to or greater than 32.

When sent by hub, this string should be displayed in the window title of the hub window (if one exists).

HN

Hubs where user is a normal user and in NORMAL state, integer. While connecting, clients should not count the hub they're connecting to. Hubs should increase one of the three the hub counts by one before passing the client to NORMAL state.

HR

Hubs where user is registered (had to supply password) and in NORMAL state, integer.

HO

Hubs where user is op and in NORMAL state, integer.

TO

Token, as received in RCM/CTM, when establishing a C-C connection.

OP

1=op

AW

1=Away

2=Extended away, not interested in hub chat (hubs may skip sending broadcast type MSG commands to clients with this flag)

BO

1=Bot (in particular, this means that the client does not support file transfers, and thus should never be queried for direct connections)

HI

1=Hidden, should not be shown on the user list.

HU

1=Hub, this INF is about the hub itself

SU

Comma-separated list of feature FOURCC's. This notifies other clients of extended capabilities of the connecting client. Use with discretion.


For OP, AW, BO, HI and HU, unspecified values are reserved for the future.


Hubs may mandate or discard any set of fields, but obviously the more the merrier (and clients could be disconnected for not sending some of them…).

Note; normally one would only accept an IP (I4 or I6) that is the same as the source IP of the connecting peer, allowing otherwise for trusted users only because your could channel DDoS attacks. Use caution when accepting unknown Ips. Only for trusted users one may allow a different IP or an IP from a different domain (Ipv4 or Ipv6) to be specified. If you fail to do this, your hub can be used as a medium for DDoS attacks.

When a hub receives this message in the IDENTIFY state, it should proceed to the VERIFY state by sending a PAS request or NORMAL state by starting sending the INF of all clients, where the INF of the connecting client must come last. When the hub that sends an INF about itself, the NI becomes hub name, VE version etc.

When the server receives this during client-client communication in IDENTIFY state, it should verify the ID and TO fields, send an INF about itself and pass to the NORMAL state.

4.3.5MSG

MSG text

Contexts: F, T

A chat message. The receiving clients should precede it with ‘<’ nick ‘>’, to allow for uniform message displays.

Flags:

PM<group-SID>

Private message, <group-SID> is the SID clients must send responses to. This field must contain the originating SID if this is a normal private conversation.

ME

1 = message should be displayed as /me in IRC (“*nick text”)


4.3.6SCH

SCH

Contexts: F, T, C, (U)

Search. Each parameter is an operator followed by a term. Each term is a two-letter code followed by the data to search for. Clients must ignore any unknown fields and complete the search request as if they were not present, unless no known fields are present in which case the client must ignore the search.

AN, NO, EX

String search term, where AN is include (and), NO is exclude (and not), and EX is extension. Each filename (including the path to it) should be matched using case insensitive substring search as follows: match all AN, remove those that match any NO, and make sure the extension matches at least one of the EX (if it is present). Extensions must be sent without the leading ‘.’.

LE

Smaller (less) than or equal size in bytes

GE

Larger (greater) than or equal size in bytes

EQ

Exact size in bytes

TO

Token, string. Used by the client to tell one search from the other. If present, the responding client must copy this field to each search result.

TR

Tiger tree hash root, encoded with base32.

TY

File type, to be chosen from the following (none specified = any type):

1 = File

2 = Directory


Searching by UDP is subject to IP spoofing, and can thus be used to initiate a DoS attack. Clients should only accept incoming UDP searches in a trusted environment.

4.3.7RES

RES

Contexts: F, T, C, U

Search result, made up of fields syntactically and structurally similar to the INF ones. Clients must provide filename, TTH root, size and token, but are encouraged to supply additional fields if available. Passive results should be limited to 5 and active to 10.

FN

Full filename including path in share

SI

Size, in bytes

SL

Slots currently available

TO

Token

TR

Tiger tree hash root, encoded with base32.

TD

Tiger tree depth, index of the highest level of tree data available, root-only = 0, first level (2 leaves) = 1, second level = 2, etc…


4.3.8CTM

CTM protocol separator port separator “TO” token

Contexts: F, T

Connect to me. Used by active clients that want to connect to someone, or in response to RCM. Only TCP active clients may send this. TO is a string that identifies the incoming connection triggered by this command, and must be present in the INF command of the connecting client. Clients should not accept incoming connections with a token they did not send earlier. <proto> is an arbitrary string specifying the protocol to connect with; in the case of an ADC compliant connection attempt, this should be the string “ADC/1.0”. If <protocol> is supported, a response to a supported <protocol> RCM must copy the <token> and <proto> fields directly. If a protocol is not supported, a DSTA must be sent indicating this.

4.3.9RCM

RCM protocol separator “TO” token

Contexts: F, T

Reverse CTM. Used by passive clients to request a connection token from an active client.

4.3.10GPA

GPA data

Contexts: F

States: VERIFY

Get Password. The data parameter is at least 24 random bytes (base32 encoded), used to avoid replay attacks on the password.

4.3.11PAS

PAS password

Contexts: T

States: VERIFY

Password. The CID (binary), then the password, followed by the random data (binary), passed through the Tiger hash algorithm (not TTH) then base32. When validated, this transitions the server into NORMAL state.

4.3.12QUI

QUI sid

Contexts: F

States: IDENTIFY, VERIFY, NORMAL

The client identified by <sid> disconnected from the hub. If the SID belongs to the client receiving the QUI, it means that it should take action according to the reason (i.e. redirect or not reconnect in case of ban). The hub must not send data after the QUI to the client being disconnected.

The following flags may be present:

ID

SID of the initiator of the disconnect (for example the one that issued a kick).

TL

Time Left until reconnect is allowed, in seconds. -1 = forever.

MS

Message.

RD

Redirect server URL.

DI

Any client that has this flag in the QUI message should have its transfers terminated by other clients connected to it, as it is unwanted in the system.


4.3.13DSC

DSC victim_sid

Contexts: T

Disconnects user. The same flags as in the QUI command may be added, in which case the hub must copy them to the QUI sent to the victim.

4.3.14GET

GET type identifier start_pos bytes

Contexts: C

Requests that a certain file or binary data be transmitted. <start_pos> counts 0 as the first byte. <bytes> may be set to -1 to indicate that the sending client should fill it in with the number of bytes needed to complete the file from <start_pos>. <type> is a [a-zA-Z0-9]+ string that specifies the namespace for identifier and BASE requires that clients recognize the types “file”, “tthl” and “list”. Extensions may add to the identifier names as well as add new types.

“file” transfers transfer the file data in binary, starting at <start_pos> and sending <bytes> bytes. Identifier must be a TTH root value from the “TTH/” root.

“tthl” transfers send the largest set of leaves available) as a binary stream of leaf data, right-to-left, with no spacing in between them. <start_pos> must be set to 0 and <bytes> to -1 when requesting the data. <bytes> must contain the total binary size of the leaf stream in SND, and by dividing this length by the individual hash length, the number of leaves, and thus the leaf level can be deducted. The received leaves can then be used to reconstruct the entire tree, and the resulting root must match the root of the file (this verifies the integrity of the tree itself). Identifier must be a TTH root value from the “TTH/” root.

“list” transfers are used for partial file lists and have a directory as identifier. <start_pos> is always 0 and <bytes> contains the uncompressed length of the generated XML text in the corresponding SND. An optional flag “RE1” means that the client is requesting a recursive list and that the sending client should send the directory itself and all subdirectories as well. If this is too much, the sending client may choose to send only parts. The flag should be taken as a hint that the requesting client will be getting the subdirectories as well, so they might as well be sent in one go. Identifier must be a directory in the unnamed root, ending (and beginning) with ‘/’.

Note that GET can also be used by extensions for binary transfers between hub and client.

4.3.15GFI

GFI type identifier

Contexts: C

Get File Information. Requests that the other client returns a RES about the file as if it had responded to a SCH command. Type and identifier are the same as for GET.

4.3.16SND

SND type identifier start_pos bytes

Contexts: C

Transitions to DATA state. The sender will transmit until <bytes> bytes of binary data have been sent, and then will transition back to NORMAL state. The parameters essentially correspond to the GET parameters, but if <bytes> equals -1 it must be replaced by the number of bytes needed to complete the file starting at <start_pos>.

5Examples

5.1Client – Hub connection

Client

Hub

HSUP +BASE <other-features>



ISUP +BASE <other-features>

ISID <client-sid>

IINF HU1 HI1 …

BINF <my-sid> ID... PD…



IGPA …

HPAS …



BINF <all clients>

BINF <Client-SID> …

5.2Client – Client connection

Client

Server

CSUP +BASE <other-features>



CSUP +BASE <other-features>

CINF IDxxx

CINF IDxxx TO<token>



CGET …

CSND …

<data>



<disconnect>


6Standard Extensions <work-in-progress>

6.1REGX - Regular expressions in searches

This extension adds to the SCH command an additional operator RE that takes a Perl regular expression (http://perldoc.perl.org/perlre.html) with full Unicode support. Clients that support this must send “REGX” in their support string in the INF SU field.

6.2ZLIB - Compressed communication

There are two variants of zlib support, FULL and GET, and only one should be used on a each communications channel set up.

6.2.1ZLIB-FULL

If, during SUP negotiation, a peer sends “ZLIF” in its support string, it must accept two additional commands, ZON and ZOF. Upon reception of ZON the peer must start decompressing the incoming stream of data with zlib before interpreting it, and stop doing so after ZOF is received (in the compressed stream). The compressing end must partially flush the zlib buffer after each chunk of data to allow for decompression by the peer.

6.2.2ZLIB-GET

The alternative is to send “ZLIG” to indicate that zlib is supported for binary transfers using the GET command, but not otherwise. A flag “ZL1” is added to the to the SND command to indicate that the data will come compressed, and the client receiving requests it by adding the same flag to GET (the sending client may ignore a request for a compressed transfer, but may also use it even when not requested by the receiver). The <bytes> parameter of the GET and SND commands is to be interpreted as the number of uncompressed bytes to be transferred.

6.3UCMD - User commands

User commands are used to send hub-specific commands to the client which provide useful shortcuts for the user. These commands contain strings which must be sent back to the hub, and parameter substitutions in the strings. Each user command has a display name, a string to be sent to the hub, and one or more categories where it may appear. The strings passed to the hub must first be passed through a dictionary replacement that replaces all keywords in the string, and then through the equivalent of the C standard function “strftime”, with the current time.

6.3.1CMD

CMD name

Types: I

Name uniquely (per hub) identifies a particular user command. The name may contain ‘/’ to indicate a logical structure on the viewing client, where each ‘/’ introduces a new submenu level. Other than name, the command also has a number of flags that further detail what to do with it.

RM

1 = Remove command

CT

Context, the following flags summed:

1 = Hub command, client parameters only

2 = User list command, client and user parameters

4 = Search result command, client, user and file parameters

8 = File list command, client, user and file parameters

TT

Text to be sent to hub

CO

1 = Constrained, when sending this command on multiple users (for example in search results), constrain it to once per CID only

SP

1 = Insert separator instead of command name (name must still be present to uniquely identify the command)


Keywords are specified using “%[keyword]”. Unknown keywords must be replaced by the empty string. Additionally, all %-substitutions of the C function “strftime” must be supported.

The following tables specify the parameters that must be available.


Client parameters

myCID

Client CID

mySID

Client SID

myXX

One for each flag on that particular hub, for example myI4, myNI, etc.


User parameters

userCID

User CID

UserSID

SID of the user

userXX

One for each flag the user sent, for example userI4, userNI, etc.


File parameters

fileXX

One for each flag contained within a search result or file list entry (see RES)


Hub parameters

hubXX

One for each flag of the hub


6.4ADCS - Secure ADC <work-in-progress>

6.4.1Introduction

Secure ADC connections can be established using a TLS tunnel, both for hub and for client connections. Certificates can be used to authenticate both hub and user, for example by making the hub the root CA, and only allow clients signed by the hub to connect. Ephemeral keys should be use to ensure forward secrecy when possible.

6.4.2Client-Hub encryption

TLS client-hub connections can be initiated either by negotiating the feature “ADCS” on connection or by using the protocol adcs:// when initiating the connection. Hubs can choose to request a certificate for the user on login, and use this certificate to replace password-based login.

6.4.3Client-Client encryption

TLS client-client connections can be established either by negotiating the feature “ADCS” on connection or by specifying “ADCS/1.0” in the CTM protocol field. Clients supporting encrypted connections must indicate this in the INF SU field with “ADCS”