## Undernet P10 Protocol and Interface Specification

(As of ircu 2.10.11)

## Undernet Coder-com, `coder-com@undernet.org`

$Id: p10.html,v 1.6 2002-02-14 00:20:40 ghostwolf Exp $

This document aims to be a practical guide for implementing and maintaining the protocol, not just a reference manual.

This document is "work in progress" and being continually updated :)

1. Introduction

2. General concepts and background

> 2.1 Concepts.
> 2.2 Token Table.

## 3. Registration and syncronisation

- 3.1 Server registration and authentication.
- 3.2 Network database resyncronisation.
- 3.3 Summary.

## 4. Continous operation

- 4.1 Channel state operations.
- 4.2 Client state operations.
- 4.3 Channel/Client Messaging.
- 4.4 Setting G-Lines.
- 4.5 ...

## 4. Programmers reference: Function headers

- 4.1 ms_nick
- 4.2 m_burst
- 4.3 ..etc

## 5. Programmers reference: Client/Server Structures

## 6. FAQ

## 7. Acknowledgements and disclaimer

## 8. Update History

> - TODO List

1. Introduction

[Back]

2. General concepts and background

2.1 Concepts

The undernet P10 protocol uses a scheme of "Numerics" to uniquenly identify a client or server within the network. Each server has its own unique numeric (0 -> 4095) and each client has its own numeric within that server (0->262,143).

The numerics are encoded into a Base64 stream to maintain human readable data flow and reduce the size of the messages. The Base64 character set used in ircu is included below, this defines all valid characters allowed in a Base64 numeric with "A" representing 0 and "]" representing 63.

>     ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789[]

Server numerics consist of 2 characters, with the minimum, 0, being represented by "AA", and the maximum, 4095, being represented by "]]". Client numerics are 3 characters long, with the minimum, 0, being represented by "AAA", and the maximum, 262,143, being represented by "]]]". The unique identifier of a client on the network consists of a combination of both the server and client numeric in the format SSCCC.

As an example, consider a server "irc.undernet.org" which has a numeric of 2, translating to "AC" in Base64. On this server exists a client, whom has been allocated the numeric 63 (which translates to "AA]" in Base64). Therefore, the unique identifier of this client on the network is "ACAA]". From this, we can determine which server the message came from, aswell as the client who sent it.

These numerics are used to prefix every message issued on the stream except for the initial "PASS" or "SERVER" message, which are not prefixed. Therefore, every message that can be recieved from a server will consist of the format:

>     [NUMERIC PREFIX] [TOKEN] [DATA]

For Example:

>     A[A5j P ABAAA :Foo.

2.2 Token Table

The following table lists all the acceptable messages, along with their relevant "Token", which is used in the server<>server protocol. The aim of tokenisation is to reduce the bandwidth used during network communication by reducing the length of common message identifiers.

Message | Token
PRIVMSG | P
WHO | H
WHOIS | W
WHOWAS | X
USER | USER
NICK | N
SERVER | S
LIST | LIST
TOPIC | T
INVITE | I
VERSION | V
QUIT | Q
SQUIT | SQ
KILL | D
INFO | F
LINKS | LI
STATS | R
HELP | HELP
ERROR | Y
AWAY | A
CONNECT | CO
MAP | MAP
PING | G
PONG | Z
OPER | OPER
PASS | PA
WALLOPS | WA
DESYNCH | DS
TIME | TI
SETTIME | SE
RPING | RI
RPONG | RO
NAMES | E
ADMIN | AD
TRACE | TR
NOTICE | O
WALLCHOPS | WC
CPRIVMSG | CP
CNOTICE | CN
JOIN | J
PART | L
LUSERS | LU
MOTD | MO
MODE | M
KICK | K
USERHOST | USERHOST
USERIP | USERIP
ISON | ISON
SQUERY | SQUERY
SERVLIST | SERVLIST
SERVSET | SERVSET
REHASH | REHASH
RESTART | RESTART
CLOSE | CLOSE
DIE | DIE
HASH | HASH
DNS | DNS
SILENCE | U
GLINE | GL
BURST | B
CREATE | C
DESTRUCT | DE
END_OF_BURST | EB
END_OF_BURST_ACK | EA
PROTO | PROTO
JUPE | JU
OPMODE | OM
CLEARMODE | CM
ACCOUNT | AC

[Back]

3. Registration and syncronisation

3.1 Server registration and authentication

After a TCP connection has been established, the server initally introduces itself via a "PASS" message as follows:

>     PASS :[PASSWORD]

"PASSWORD" is simply compared with the password present in the destination servers config file, and is used to confirm credentials after the "SERVER" message has been recieved, as follows:

>     SERVER [SERVERNAME] [HOPCOUNT] [START TIME] [LINK TIME] [PROTOCOL] [NUMERIC/MAXCONN] :[DESCRIPTION]

For Example:

>     1      2                3 4         5         6   7     8
>     SERVER irc.undernet.org 1 933022556 947908144 J10 AA]]] :[127.0.0.1] A Undernet Server.

Notes:

1. The SERVER message, indicating this connection wishes to introduce a new server to the network.
2. The name of the server you are introducing, a valid server name consists of [..defn..].
3. The hop count of the server you are introducing, this is always 1 when you are introducing yourself.
4. The epoch timestamp specifying when the ircd was started.
5. The epoch timestamp specifying the time the server initiated the link to the network.
6. The Protocol identifier of this server.

1. This token informs the network which protocol it is compliant with, eg: If it is a P10 compliant server, then the token will be "P10".
2. If the server being introduced has not yet successfully synced its database with the network (Completed its net.burst - see 3.2), then the Protocol token should be prefixed with a J, instead of a P (Eg: J10) to indicate it is currently still joining the network.
3. The protocol token should always be JXX when the server is introducing itself.

7. The numeric, and maximum connections identifier for this server.

1. This token is formatted exactly the same as a client numeric is formatted. The first 2 characters identify the server's numeric, whilst in this situation, the final 3 characters define the maximum number of clients that this server can hold (and more importantly, the maximum number of numerics it will generate). This is always one less than a power of two, because the server uses this as a bitmask. A server can give out a higher numeric than this, however it will be "anded" with this number to find it's entry slot. The reason for this is so a server which is near the maximum number of clients can give out more numerics than it's using to prevent a new client getting a numeric that was used only seconds ago and maybe get messages destined to the old user.
2. The example "AA]]]" shows that this is a server with numeric 0, which will generate client numerics up to 262,143.

8. This final parameter simply consists of a textual description of the server prefixed by a colon. This is displayed in a clients WHOIS line, aswell as in the LINKS reply. By convention, if this is a leaf server it contains the servers IP in square brackets at the beginning of the string,

3.2 Network Database resyncronisation

After the connection has been established and verified, the next step is to syncronise the database of client/server/channel information between the two servers.

> 3.2.1 - SERVER Messages

> Server details are transmitted via "SERVER" messages similar to the initial introduction message, with the following format:

> > `[OWNING SERVER PREFIX] S [SERVERNAME] [HOPCOUNT] [START TIME] [LINK TIME] [PROTOCOL] [NUMERIC/MAXCONN] 0 :[DESCRIPTION]`

> The syntax of this message is almost identical to the originally recieved server message, with the only exception being that the message is numeric prefixed, to indicate which server sent this message (and also therefore, which hub this new server is linked too). There is also a fixed "0" present before the Description field, this is a placeholder for future use and currently unused. [Isomer: Question, what IS this reserved for?]

> 3.2.2 - NICK Messages

> Client information is transmitted via "NICK" messages, of the following format:

> >     [NUMERIC PREFIX] N [NICK] [HOPCOUNT] [TIMESTAMP] [USERNAME] [HOST] <+modes> [BASE64 IP] [NUMERIC] :[USERINFO]

> For Example:

> > `1 2 3 4 5 6 7 8 9 10 11`
> > `AF N Client1 1 947957573 User userhost.net +oiwg DAqAoB AFAAA :Generic Client.`

> Notes:
> 1. The numeric of the server sending this message. (And hence, owning this client).
> 2. The "NICK" token.
> 3. The nickname of this client, currently max 9 chars.
> 4. The "Hopcount" of this client, Ie: how many servers away it is on.
> 5. The epoch timestamp indicating when the user was created.
> 6. The "User" part of the user@host mask.
> 7. the "Host" part of the user@host mask.
> 8. [Optional]: User modes. If present, this is always +<user modes for this client>. Note that the special +r usermode is followed by the client's account name; see the documentation for ACCOUNT.
> 9. The real IP address of this client, a Base64 encoded 32bit int.
> 10. This client's numeric, in SSCCC format.
> 11. Free format user info line.

> 3.2.3 - BURST Messages

> Channel details and membership information is synchronised in one (or more) BURST messages for each channel that exists, formatted as follows:

> >     [NUMERIC PREFIX] B [CHANNEL] [CREATION TIMESTAMP] <+MODES> <ARG1> <ARG2> [MEMBER LIST] <:%BANS>

> For Example:

> >     1  2 3          4         5      6   7  8                                         9
> >     AZ B #coder-com 949217470 +tinkl key 56 AAAAA,AAAAB,AAAAC,ABAAA,ABAAB,ABAAC,ACAAA :%*!*@*.net

> Notes:

1. The numeric of the server sending this message.
2. The "BURST" token.
3. The name of the channel to which this data belongs. Currently #Channel and +Channel names can be sent in a BURST message, &Channels are not because by definition they are local to the server.
4. The epoch timestamp indicating when the channel was created.
5. [Optional]: Channel Modes.

1. The channel may have a number of modes set, aswell as relevant mode arguments in the following 2 parameters.

6. [Optional]: Channel Key, this parameter is present if the channel modes contain a "k" mode.
7. [Optional]: Channel Limit, this parameter is present if the channel modes contain a "l" mode.
8. A comma seperated list of client numerics, with the following specific formatting rules to indicate +o, +v and +ov channel members.

1. Numerics can have the following symbols appended on them; ":ov", ":v" or ":o". These indicate that this numeric is either Opped (:o), Voiced (:v) or both (:ov). This state applies to the numeric it is attached too, and all subsequent numerics until another state is encountered. For Example:
2. AAABA:ov, AAABB:o,AAABC,AAABD,AAABE:v,AAABZ
Here, AAABA is both opped, and voiced, AAABB, AAABC and AAABD are opped leaving AAABE and AAABZ voiced.
3. The first numeric of the member list will always contain a state symbol.

9. A space seperated list of bans present in the channel. The start of the ban stream is indicated by a ":%", everything following the ":%" is the ban list.
For Example:
:%*!*@*.foobar.net another!ban@*.com *!*fred@a.host.co.uk
Would add the following bans to the channel:

*!*@*.foobar.net
another!ban@*.com
*!*fred@a.host.co.uk

> If the length of a BURST message exceeds the maximum lenght of a line (512 characters) then the remaining channel members/bans are sent in subsequent BURST lines. The subsequent burst lines are only used to add additional members to the channel, and if neccessary, channel bans. There will be no "Mode" parameters present. A sample additional burst line would be:

> >     AZ BURST #coder-com 949217470 ACAAB:o,ACAAD :%*!*another@*.ban.com

> Which adds two more opped members and a ban to the channel.

> 3.2.4 - JUPE Messages

> Any currently unexpired JUPEs are transmitted via "JUPE" messages with the following format:

> > `[NUMERIC PREFIX] JU * (+|-)[SERVER NAME] [LIFETIME] [LAST MOD] :[REASON]`

> For example:

> > `1 2 3 4 5 6 7`
> > `AZ JU * +juped.undernet.org 000003593 955419707 :Juped Server`

> Notes:

1. The numeric of the server sending this message.
2. The "JUPE" token.
3. The target that should apply this JUPE (always "*" during bursts).
4. The name of the server to JUPE, prefixed with a "+" if the JUPE is active, or with a "-" if it is not.
5. The remaining absolute lifetime of the JUPE, expressed in seconds.
6. The last time the JUPE was modified.
7. The reason the JUPE was applied.

3.3 Summary

The following table summarises the sequence of events that occur when a server connects to another server. S1 is our server, and S2 is a HUB on the target network.

S1: Sends Password.
S1: Sends initial SERVER message.

S2 Confirms S1 has the correct credentials, and if so, proceeds. If not, S1 is squit with a relevant reason.

S2: Sends Password.
S2: Sends initial SERVER message.

S1 Confirms S2 has the correct credentials, and if so, proceeds. If not, S2 is squit with a relevant reason.

The follow occur asynchronously, however they have been shown seperately below for simplicity.

S1: Sends all the servers it is aware of as a stream of SERVER messages.
S1: Sends all the clients it is aware of as a stream of NICK messages.
S1: Sends the database of channel states on the network, as a stream of BURST messages.
S1: Sends all the jupes it is aware of as a stream of JUPE messages.
S1: Sends a END_OF_BURST token (EB) to indicate it has finished sending.

S2: Sends all the servers it is aware of as a stream of SERVER messages.
S2: Sends all the clients it is aware of as a stream of NICK messages.
S2: Sends the database of channel states on the network, as a stream of BURST messages.
S2: Sends all the jupes it is aware of as a stream of JUPE messages.
S2: Sends a END_OF_BURST token (EB) to indicate it has finished sending.

S2: Sends an EOB_ACK token (EA) to indicate it has succesfully recieved the END_OF_BURST from S1
S1: Sends an EOB_ACK token (EA) to indicate it has succesfully recieved the END_OF_BURST from S2

Example Session:

    [WRITE]: PASS :54321
    [WRITE]: SERVER irc.undernet.org 1 947957852 947957852 J10 AB]]] :Undernet Client Server.
    [WRITE]: AB N MrFoo 1 947957852 ~me myhost.foobar.net +diksw DAqAoB ABAAA :Mr Foo (foo@bar.com).
    [WRITE]: AB B #mychannel 946101324 ABAAA:o
    [WRITE]: AB EB
    [ READ]: PASS :54321
    [ READ]: SERVER server1.undernet.org 1 947901540 947958150 J10 AFAD] :A Generic Server.
    [ READ]: AF S server2.undernet.org 2 0 947957585 P10 AZAD] 0 :[192.168.10.3] A Generic Server.
    [ READ]: AZ S server3.undernet.org 3 0 947957607 P10 AIAD] 0 :[192.168.10.5] A Generic Server.
    [ READ]: AF N Client1 1 947957573 Ident userhost.net +oiwg DAqAoB AFAAA :Generic Client.
    [ READ]: AZ N Client2 2 947957719 Ident userhost.net +iwg DAqAoB AZAAA :Generic Client.
    [ READ]: AI N Client3 3 947957742 Ident userhost.net +iwg DAqAoB AIAAA :Generic Client.
    [ READ]: AI N Client4 3 947958121 Ident userhost.net +iwg DAqAoB AIAAB :Generic Client.
    [ READ]: AF B #foobar 947957734 +tink akey AIAAB,AIAAA:v,AZAAA:o :%*!*another@*.ban.com *!*foo@bar.net
    [ READ]: AF B #coder-com 947957727 AIAAB,AZAAA:o
    [ READ]: AF B #another 946101321 AFAAA
    [ READ]: AF JU * +juped.undernet.org 3600 947958100 :Broken, please fix
    [ READ]: AF EB
    [WRITE]: AB EA
    [ READ]: AF EA

[Back]

4. Continuous Operation

This chapter provides details of the messages that can be sent after successfully linking to a network, and synchronising the channel/user database.

4.1 Channel state operations

There are a number of messages that can modify the state of a channel, these are:

4.1.1 - MODE

The MODE message can modify channel modes and bans, and also give or take operator/voice status from channel members.

`[NUMERIC PREFIX] M [CHANNEL] (+|-)[MODESTRING] <MODESTRING PARAMETERS>`

For Example:

`1 2 3 4 5`
`AZAAA M #coder-com +stinlko 500 TestKey BAC`

Notes:

1. The numeric of the user issuing this MODE command. It can be assumed this user is opped on the target channel.
2. The "MODE" token.
3. The target channel.
4. The "Mode string".

1. This consists of up to 6 '+' or '-' (add or remove) prefixed channel modes. (If no '+' or '-' are specified, a '+' is assumed unless a '-' has been encountered previously in the mode string). For example, '+s+t+n-l-io' is a valid mode string, as is '+stnmov'.
2. Valid Mode modes are:

Token | Function | Parameters
p | Sets/Unsets 'Private' Flag. | None.
s | Sets/Unsets 'Secret' Flag. | None.
m | Sets/Unsets 'Moderated' Flag. | None.
n | Sets/Unsets 'External Messages' Flag. | None.
t | Sets/Unsets 'Topic Limit' Flag. | None.
i | Sets/Unsets 'Invite only' Flag. | None.
l | Sets/Unsets 'Channel Limit' Flag. | The channel limit.
k | Sets/Unsets 'Channel Key' Flag. | The channel keyword (Password).
o | Ops and Deops users. | Numeric of user to be opped.
v | Voice | Numeric of user to be voiced.
b | Ban | Ban string.

1. The "Mode string Parameters".

1. This is a matching list of parameters to the modes supplied in the "Modestring".
For Example:
If the Modestring is "+stnlo", a typical parameter string would be "500 AZAA". The first 3 modes, 's', 't' and 'n' do not require parameters, so non are present. The following two, 'l' and 'o' both require parameters, so they are 500 and AZAAA respectively (This sets the channel limit to 500 users, and ops the numeric AZAAA).

N.B: The "MODE" message is also used to modify a client's user modes, not just channel modes. See section 4.2 for details.

4.1.2 - OPMODE

The OPMODE message is identical in syntax to the MODE message, however it will only ever have an operator as the source. It is likely that the source of this mode will not have ops in the target channel, but it should succeed never the less.

4.1.3 - JOIN

4.1.4 - PART

4.1.5 - KICK

4.1.6 - TOPIC

4.1.7 - CLEARMODE

`AZAAA CM #coder-com ovpsmikbl`

4.2 Client state operations

> 4.2.1 - NICK

> > `AZAAA N Nick2 955423230`

> 4.2.2 - MODE

> > `AZAAA M Nick2 :+odi`

> 4.2.3 - ACCOUNT

> > `AX AC AZAAA oper`

> The ACCOUNT message provides a way for servers, such as the channel service server, to set the account name information that is associated with a client. Once set, it cannot be unset or changed, and will be propagated in NICK during net bursts using the special user mode +r followed by the account name.

4.3 Channel/Client Messaging.

> 4.3.1 - PRIVMSG

> 4.3.2 - NOTICE

> 4.3.3 - CNOTICE

> 4.3.4 - CPRIVMSG

[Back]

5. Programmers reference: Client/Server Structures

This section provides information on the standard Client/Server structures, for easy reference during development.

[..Link to autogenerated struct.html..]

[Back]

7. FAQ

Frequently asked questions.

- Q. How..
- A. ...

[Back]

8. Update History

[2000-01-20]: Initial draft, structure, background info.
[2000-02-13]: Added initial BURST documentation.
[2000-02-14]: Continued BURST documentation / Begin NICK and SERVER documentation.
[2000-02-26]: Continued chapter 5, few example fixes, added token table from msg.h. -Gte.
[2000-03-02]: Added NICK spec. -Gte.
[2000-03-18]: Added JUPE spec. -Kev
[2000-04-10]: Added information about OPMODE and CLEARMODE tokens. -Kev
[2000-04-11]: Started work on chapter 4. -Gte
[2000-06-01]: Changed some info about the max number of clients -Isomer
[2002-01-11]: Wrote a specification for ACCOUNT and noted that a usermode in a NICK message may have an argument. -Kev

8.1 TODO

- Finish Chapter 5.
- Go through examples, and ensure they are all correct.
- Add common function headers, with argv listings.
- Add description of further server to server messages, with special cases and outcomes.
- Add FAQ Section.

[Back]