1 TS6 protocol description
2 Written by Jilles Tjoelker
4 General format: much like rfc1459
5 Maximum parameters for a command: 15 (this does not include the prefix
8 SID: a server's unique ID. It is configured in each server and consists of
9 a digit and two alphanumerics. Sending SIDs with lowercase letters is
12 UID: a client's unique ID. It consists of the server's SID and six
13 alphanumerics (so it is nine characters long). The first of the alphanumerics
14 should be a letter, numbers are legal but reserved for future use.
16 hunted: a parameter type used for various remote requests. From local users,
17 nicknames and server names are accepted, possibly with wildcards; from servers,
18 UIDs/SIDs (sending names or even wildcards is deprecated). This is done with
19 the function hunt_server(). Any rate limiting should be done locally.
21 duration: a parameter type used for ban durations. It is a duration in seconds.
22 A value of 0 means a permanent ban.
24 propagation: to which other servers the command is sent
26 For all commands with a hunted parameter, the propagation is determined by
27 that, and not otherwise specified.
29 For all commands with a target server mask parameter, the propagation is
30 determined by that, and not otherwise specified. The command is sent to all
31 servers with names matching the given mask (for example '*', '*.example.com',
32 'irc.example.com'). Those servers do not have to be directly connected.
33 Targets cannot be SIDs.
35 Propagation broadcast means the command is sent to all servers.
37 Propagation one-to-one means the command is only sent to the target or the
38 server the target is on.
40 Propagation none means the command is never sent to another server if it is
43 For some other commands, the propagation depends on the parameters and is
46 services server: server mentioned in a service{} block. There are no services
49 service: client with umode +S. This implies that it is on a services server.
52 The initiator sends the PASS, CAPAB and SERVER messages. Upon receiving the
53 SERVER, the listener will check the information, and if it is valid, it will
54 send its own PASS, CAPAB and SERVER messages, followed by SVINFO and the burst.
55 Upon receiving the SERVER, the initiator will send SVINFO and the burst. If
56 ziplinks are used, SVINFO is the first compressed message.
58 The burst consists of SID and SERVER messages for all known servers, UID or
59 EUID messages for all known users (possibly followed by ENCAP REALHOST, ENCAP
60 LOGIN and/or AWAY) and SJOIN messages for all known channels (possibly followed
65 +D (deaf: does not receive channel messages)
66 +S (network service) (only settable on burst from a services server)
67 +a (appears as server administrator)
68 +i (invisible, see rfc1459)
69 +o (IRC operator, see rfc1459)
70 +w (wallops, see rfc1459) (always propagated for historical reasons)
72 +Q/+R/+g/+l/+s/+z (only locally effective)
73 +Z (ssl user) (only settable on burst)
74 possibly more added by modules
86 +k (key: password required to join, <= 23 ascii chars, no : or , or whitespace)
88 +l (limit: maximum number of members before further joins are disallowed)
91 +n (no external messages)
92 +p (private: does not appear in /whois to non-members, no /knock allowed)
93 +r (only registered users may join) (only if a services server exists)
95 +t (only chanops may change topic)
100 +f (forward: channel name <= 30 chars)
101 +j (join throttle: N:T with integer N and T)
103 +F (free target for +f)
105 +P (permanent: does not disappear when empty)
106 +Q (ignore forwards to this)
108 +g (allow any member to /invite)
109 +z (send messages blocked by +m to chanops)
113 parameters: target, any...
115 The command name should be three decimal ASCII digits.
117 Propagates a "numeric" command reply, such as from a remote WHOIS request.
119 If the first digit is 0 (indicating a reply about the local connection), it
120 should be changed to 1 before propagation or sending to a user.
122 Numerics to the local server may be sent to opers.
124 To avoid infinite loops, servers should not send any replies to numerics.
128 propagation: one-to-one
130 propagation: all servers with -D users on the channel
132 Numerics to channels are broken in some older servers.
138 Remote ADMIN request.
142 propagation: broadcast
143 parameters: opt. away reason
145 If the away reason is empty or not present, mark the user as not away.
146 Otherwise, mark the user as away.
148 Changing away reason from one non-empty string to another non-empty string
149 may not be propagated.
153 propagation: broadcast
154 parameters: channelTS, channel, type, space separated masks
156 If the channelTS in the message is greater (newer) than the current TS of
157 the channel, drop the message and do not propagate it.
159 Type is the mode letter of a ban-like mode. In efnet TS6 this is 'b', 'e' or
160 'I'. In charybdis TS6 additionally 'q' is possible.
162 Add all the masks to the given list of the channel.
164 All ban-like modes must be bursted using this command, not using MODE or TMODE.
167 source: unregistered server
169 parameters: space separated capability list
171 Sends capabilities of the server. This must include QS and ENCAP. It is also
172 strongly recommended to include EX, CHW, IE and KNOCK, and for charybdis TS6
173 also SAVE and EUID. For use with services, SERVICES and RSFNC are strongly
176 The capabilities may depend on the configuration for the server they are sent
182 propagation: broadcast
183 parameters: client, new hostname
185 Changes the visible hostname of a client.
187 Opers are notified unless the source is a server or a service.
191 parameters: server to connect to, port, hunted
193 Remote connect request. A server WALLOPS should be sent by the receiving
196 The port can be 0 for the default port.
202 parameters: duration, mask, reason
204 Sets a D:line (IP ban checked directly after accepting connection).
206 The mask must be an IP address or CIDR mask.
210 parameters: target server mask, subcommand, opt. parameters...
212 Sends a command to matching servers. Propagation is independent of
213 understanding the subcommand.
215 Subcommands are listed elsewhere with "encap only".
218 source: server or unregistered server
220 parameters: error message
222 Reports a (usually fatal) error with the connection.
224 Error messages may contain IP addresses and have a negative effect on server
229 encap target: single server
233 Remote ETRACE information request.
239 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, real hostname, account name, gecos
240 propagation: broadcast
242 Introduces a client. The client is on the source server of this command.
244 The account name is '0' if the user is not logged in with services.
248 EUID is similar to UID but includes the ENCAP REALHOST and ENCAP LOGIN
255 parameters: space separated capability list
257 Capability list of remote server.
267 parameters: target user, channel, opt. channelTS
268 propagation: one-to-one
270 Invites a user to a channel.
272 If the channelTS is greater (newer) than the current TS of the channel, drop
275 Not sending the channelTS parameter is deprecated.
280 parameters: '0' (one ASCII zero)
281 propagation: broadcast
283 Parts the source user from all channels.
287 parameters: channelTS, channel, '+' (a plus sign)
288 propagation: broadcast
290 Joins the source user to the given channel. If the channel does not exist yet,
291 it is created with the given channelTS and no modes. If the channel already
292 exists and has a greater (newer) TS, wipe all simple modes and statuses and
293 change the TS, notifying local users of this but not servers (note that
294 ban-like modes remain intact; invites may or may not be cleared).
296 A JOIN is propagated with the new TS of the channel.
300 parameters: channel, target user, opt. reason
301 propagation: broadcast
303 Kicks the target user from the given channel.
305 Unless the channel's TS is 0, no check is done whether the source user has ops.
307 Not sending the reason parameter is questionable.
311 parameters: target user, path
312 propagation: broadcast
314 Removes the user from the network.
316 The format of the path parameter is some sort of description of the source of
317 the kill followed by a space and a parenthesized reason. To avoid overflow,
318 it is recommended not to add anything to the path.
324 parameters: duration, user mask, host mask, reason
326 Sets a K:line (ban on user@host).
331 parameters: target server mask, duration, user mask, host mask, reason
333 As form 1, deprecated.
338 propagation: broadcast
340 Requests an invite to a channel that is locked somehow (+ikl). Notifies all
341 operators of the channel. (In charybdis, on +g channels all members are
344 This is broadcast so that each server can store when KNOCK was used last on
349 parameters: hunted, server mask
351 Remote LINKS request. The server mask limits which servers are listed.
359 Sends a message to operators (with umode +l set). This is intended to be
360 used for strict subsets of the network.
365 parameters: target server mask, text
367 As form 1, deprecated.
372 parameters: account name
374 In a burst, states that the source user is logged in as the account.
378 parameters: server mask, hunted
380 Remote LUSERS request. Most servers ignore the server mask, treating it as '*'.
385 parameters: client, umode changes
386 propagation: broadcast
388 Propagates a user mode change. The client parameter must refer to the same user
391 Not all umodes are propagated to other servers.
395 parameters: channel, cmode changes, opt. cmode parameters...
397 Propagates a channel mode change.
399 This is deprecated because the channelTS is not included. If it is received,
400 it should be propagated as TMODE.
411 parameters: new nickname, new nickTS
412 propagation: broadcast
414 Propagates a nick change.
418 parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
420 Historic TS5 user introduction. The user is on the server indicated by the
421 server parameter; the source server is meaningless (local link).
427 source: services server
428 parameters: duration, nickname
430 If duration is greater than 0, makes the given nickname unavailable for that
433 If duration is 0, removes a nick delay entry for the given nickname.
435 There may or may not be a client with the given nickname; this does not affect
440 parameters: msgtarget, message
442 As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
443 and most error messages are suppressed.
449 parameters: command name, parameters
451 Reports operspy usage.
456 propagation: broadcast
458 Sends a message to operators (with umode +z set).
462 parameters: comma separated channel list, message
464 Parts the source user from the given channels.
467 source: unregistered server
468 parameters: password, 'TS', TS version, SID
470 Sends the server link password, TS version and SID.
474 parameters: origin, opt. destination server
476 Sends a PING to the destination server, which will reply with a PONG. If the
477 destination server parameter is not present, the server receiving the message
480 The origin field is not used in the server protocol. It is sent as the name
481 (not UID/SID) of the source.
483 Remote PINGs are used for end-of-burst detection, therefore all servers must
488 parameters: origin, destination
490 Routes a PONG back to the destination that originally sent the PING.
494 parameters: msgtarget, message
496 Sends a normal message (PRIVMSG) to the given target.
500 propagation: one-to-one
502 propagation: all servers with -D users on the channel
503 (cmode +m/+n should be checked everywhere, bans should not be checked
505 - a status character ('@'/'+') followed by a channel name, to send to users
506 with that status or higher only.
507 propagation: all servers with -D users with appropriate status
508 - a user@server message, to send to users on a specific server. The exact
509 meaning of the part before the '@' is not prescribed, except that "opers"
510 allows IRC operators to send to all IRC operators on the server in an
512 propagation: one-to-one
513 - a message to all users on server names matching a mask ('$$' followed by mask)
514 propagation: broadcast
515 - a message to all users with hostnames matching a mask ('$#' followed by mask).
516 Note that this is often implemented poorly.
517 propagation: broadcast
522 encap target: single server
526 Remote PRIVS information request.
532 Propagates quitting of a client. No QUIT should be sent for a client that
533 has been removed as result of a KILL message.
540 parameters: real hostname
542 In a burst, propagates the real host of a dynamically-spoofed user.
548 parameters: opt. rehash type
550 Remote REHASH request. If the rehash type is omitted, it is equivalent to
551 a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
557 parameters: duration, mask, reason
559 Sets a RESV, making a nickname mask or exact channel unavailable.
564 parameters: target server mask, duration, mask, reason
566 As form 1, deprecated.
571 encap target: single server
572 source: services server
573 parameters: target user, new nickname, old nickTS, new nickTS
575 Forces a nickname change and propagates it.
577 The command is ignored if the nick TS of the user is not equal to the old
578 nickTS parameter. If the new nickname already exists (and is not the target
579 user), it is killed first.
587 parameters: source uid, '*', 'S', sasl mechanism name
589 Requests that a SASL agent (a service) initiate the authentication process.
590 The source uid is that of an unregistered client. This is why it is not sent
594 encap target: single server
596 parameters: source uid, target uid, mode, data
598 Part of a SASL authentication exchange. The mode is 'C' to send some data
599 (base64 encoded), or 'S' to end the exchange (data indicates type of
600 termination: 'A' for abort, 'F' for authentication failure, 'S' for
601 authentication success).
606 propagation: broadcast
607 parameters: target uid, TS
609 Resolve a nick collision by changing a nickname to the UID.
611 The server should verify that the UID belongs to a registered user, the user
612 does not already have their UID as their nick and the TS matches the user's
613 nickTS. If not, drop the message.
615 SAVE should be propagated as a regular NICK change to links without SAVE capab.
620 source: unregistered server
621 parameters: server name, hopcount, server description
623 Registers the connection as a server. PASS and CAPAB must have been sent
624 before, SVINFO should be sent afterwards.
626 If there is no such server configured or authentication failed, the connection
629 This is propagated as a SID message.
633 propagation: broadcast
634 parameters: server name, hopcount, server description
636 Introduces a new TS5 server, directly connected to the source of this command.
637 This is only used for jupes as TS5 servers may do little else than existing.
641 propagation: broadcast
642 parameters: server name, hopcount, sid, server description
644 Introduces a new server, directly connected to the source of this command.
648 propagation: broadcast
649 parameters: new nickname, new username, new visible hostname, new nickTS, new login name
651 Broadcasts a change of several user parameters at once.
653 Currently only sent after an SVSLOGIN.
657 propagation: broadcast
658 parameters: channelTS, simple modes, opt. mode parameters..., nicklist
660 Broadcasts a channel creation or bursts a channel.
662 The nicklist consists of users joining the channel, with status prefixes for
663 their status ('@+', '@', '+' or ''), for example:
664 '@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
665 so it is not possible to use this message to force users to join a channel.
667 The interpretation depends on the channelTS and the current TS of the channel.
668 If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
669 the incoming channelTS is greater (newer), ignore the incoming simple modes
670 and statuses and join and propagate just the users. If the incoming channelTS
671 is lower (older), wipe all modes and change the TS, notifying local users of
672 this but not servers (invites may be cleared). In the latter case, kick on
673 split riding may happen: if the key (+k) differs or the incoming simple modes
674 include +i, kick all local users, sending KICK messages to servers.
676 An SJOIN is propagated with the new TS and modes of the channel. The statuses
677 are propagated if and only if they were accepted.
679 SJOIN must be used to propagate channel creation and in netbursts. For regular
680 users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
687 parameters: snomask letter, text
689 Sends the text as a server notice from the source server to opers with the
693 parameters: target server, comment
695 Removes the target server and all servers and users behind it from the network.
697 If the target server is the receiving server or the local link this came from,
698 this is an announcement that the link is being closed.
700 Otherwise, if the target server is locally connected, the server should send
701 a WALLOPS announcing the SQUIT.
705 parameters: stats letter, hunted
707 Remote STATS request. Privileges are checked on the server executing the
713 source: services server
714 parameters: target user, new login name (optional)
716 If the new login name is not present or empty, mark the target user as not
717 logged in, otherwise mark the target user as logged in as the given account.
722 parameters: current TS version, minimum TS version, '0', current time
724 Verifies TS protocol compatibility and clock. If anything is not in order,
727 The current TS version is the highest version supported by the source server
728 and the minimum TS version is the lowest version supported.
730 The current time is sent as a TS in the usual way.
735 encap target: single server
736 source: services server
737 parameters: target, new nick, new username, new visible hostname, new login name
739 Sent after successful SASL authentication.
741 The target is a UID, typically an unregistered one.
743 Any of the "new" parameters can be '*' to leave the corresponding field
744 unchanged. The new login name can be '0' to log the user out.
746 If the UID is registered on the network, a SIGNON with the changes will be
747 broadcast, otherwise the changes will be stored, to be used when registration
752 propagation: broadcast
763 parameters: channelTS, channel, cmode changes, opt. cmode parameters...
765 Propagates a channel mode change.
767 If the channelTS is greater (newer) than the current TS of the channel, drop
770 On input, only the limit on parameters per line restricts how many cmode
771 parameters can be present. Apart from this, arbitrary modes shall be
772 processed. Redundant modes may be dropped. For example, +n-n may be applied and
773 propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
776 The parameter for mode -k (removing a key) shall be ignored.
778 On output, at most ten cmode parameters should be sent; if there are more,
779 multiple TMODE messages should be sent.
783 propagation: broadcast
785 Propagates a channel topic change. The server may verify that the source has
793 Performs a trace to the target, sending 200 numerics from each server passing
794 the message on. The target server sends a description of the target followed
797 TRACE, STATS l and STATS L are the only commands using hunt_server that use the
798 hunted parameter for more than just determining which server the command
799 should be executed on.
802 parameters: target name, hunted
804 Executes a trace command on the target server. No 200 numerics are sent.
805 The target name is a name, not a UID, and should be on the target server.
809 propagation: broadcast
810 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
811 propagation: broadcast
813 Introduces a client. The client is on the source server of this command.
823 Removes a D:line (IP ban checked directly after accepting connection).
825 The mask must be an IP address or CIDR mask.
831 parameters: user mask, host mask
833 Removes a K:line (ban on user@host).
838 parameters: target server mask, user mask, host mask
840 As form 1, deprecated.
853 parameters: target server mask, mask
855 As form 1, deprecated.
863 Removes an X:line (ban on realname).
868 parameters: target server mask, mask
870 As form 1, deprecated.
876 Remote USERS request.
882 Remote VERSION request.
888 propagation: broadcast
890 In efnet TS6, sends a message to operators (with umode +z set). This is a
891 deprecated equivalent to OPERWALL.
893 In charybdis TS6, sends a message to local users with umode +w set (or possibly
894 another indication that WALLOPS messages should be sent), including non-opers.
899 propagation: broadcast
901 Sends a message to local users with umode +w set (or possibly another
902 indication that WALLOPS messages should be sent).
904 In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
909 parameters: hunted, target nick
911 Remote WHOIS request.
917 parameters: duration, mask, reason
919 Sets an X:line (ban on realname).
924 parameters: target server mask, duration, mask, reason
926 As form 1, deprecated.
928 Local only commands (charybdis 3.1):