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.
263 parameters: user mask, host mask, reason
264 propagation: broadcast
266 Propagates a G:line vote. Once votes from three different opers (based on
267 user@host mask) on three different servers have arrived, trigger the G:line.
268 Pending G:lines expire after some time, usually ten minutes. Triggered G:lines
269 expire after a configured time which may differ across servers.
271 Requests from server connections must be propagated, unless they are found to
272 be syntactically invalid (e.g. '!' in user mask). Therefore, disabling glines
273 must not affect propagation, and too wide glines, double votes and glines that
274 already exist locally must still be propagated.
276 Of course, servers are free to reject gline requests from their own operators.
283 parameters: user mask, host mask, reason
284 propagation: broadcast
286 Propagates a G:line removal vote. Once three votes have arrived (as with
287 G:lines), remove the G:line. Pending G:lines removals expire after some time,
290 Pending G:line removals do not interact with pending G:lines. Triggering a
291 G:line does not affect a pending G:line removal. Triggering a G:line removal
292 does not affect a pending G:line.
302 parameters: target user, channel, opt. channelTS
303 propagation: one-to-one
305 Invites a user to a channel.
307 If the channelTS is greater (newer) than the current TS of the channel, drop
310 Not sending the channelTS parameter is deprecated.
315 parameters: '0' (one ASCII zero)
316 propagation: broadcast
318 Parts the source user from all channels.
322 parameters: channelTS, channel, '+' (a plus sign)
323 propagation: broadcast
325 Joins the source user to the given channel. If the channel does not exist yet,
326 it is created with the given channelTS and no modes. If the channel already
327 exists and has a greater (newer) TS, wipe all simple modes and statuses and
328 change the TS, notifying local users of this but not servers (note that
329 ban-like modes remain intact; invites may or may not be cleared).
331 A JOIN is propagated with the new TS of the channel.
335 parameters: channel, target user, opt. reason
336 propagation: broadcast
338 Kicks the target user from the given channel.
340 Unless the channel's TS is 0, no check is done whether the source user has ops.
342 Not sending the reason parameter is questionable.
346 parameters: target user, path
347 propagation: broadcast
349 Removes the user from the network.
351 The format of the path parameter is some sort of description of the source of
352 the kill followed by a space and a parenthesized reason. To avoid overflow,
353 it is recommended not to add anything to the path.
359 parameters: duration, user mask, host mask, reason
361 Sets a K:line (ban on user@host).
366 parameters: target server mask, duration, user mask, host mask, reason
368 As form 1, deprecated.
373 propagation: broadcast
375 Requests an invite to a channel that is locked somehow (+ikl). Notifies all
376 operators of the channel. (In charybdis, on +g channels all members are
379 This is broadcast so that each server can store when KNOCK was used last on
384 parameters: hunted, server mask
386 Remote LINKS request. The server mask limits which servers are listed.
394 Sends a message to operators (with umode +l set). This is intended to be
395 used for strict subsets of the network.
400 parameters: target server mask, text
402 As form 1, deprecated.
407 parameters: account name
409 In a burst, states that the source user is logged in as the account.
413 parameters: server mask, hunted
415 Remote LUSERS request. Most servers ignore the server mask, treating it as '*'.
420 parameters: client, umode changes
421 propagation: broadcast
423 Propagates a user mode change. The client parameter must refer to the same user
426 Not all umodes are propagated to other servers.
430 parameters: channel, cmode changes, opt. cmode parameters...
432 Propagates a channel mode change.
434 This is deprecated because the channelTS is not included. If it is received,
435 it should be propagated as TMODE.
446 parameters: new nickname, new nickTS
447 propagation: broadcast
449 Propagates a nick change.
453 parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
455 Historic TS5 user introduction. The user is on the server indicated by the
456 server parameter; the source server is meaningless (local link).
462 source: services server
463 parameters: duration, nickname
465 If duration is greater than 0, makes the given nickname unavailable for that
468 If duration is 0, removes a nick delay entry for the given nickname.
470 There may or may not be a client with the given nickname; this does not affect
475 parameters: msgtarget, message
477 As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
478 and most error messages are suppressed.
480 Servers may not send '$$', '$#' and opers@server notices. Older servers may
481 not allow servers to send to specific statuses on a channel.
487 parameters: command name, parameters
489 Reports operspy usage.
494 propagation: broadcast
496 Sends a message to operators (with umode +z set).
500 parameters: comma separated channel list, message
502 Parts the source user from the given channels.
505 source: unregistered server
506 parameters: password, 'TS', TS version, SID
508 Sends the server link password, TS version and SID.
512 parameters: origin, opt. destination server
514 Sends a PING to the destination server, which will reply with a PONG. If the
515 destination server parameter is not present, the server receiving the message
518 The origin field is not used in the server protocol. It is sent as the name
519 (not UID/SID) of the source.
521 Remote PINGs are used for end-of-burst detection, therefore all servers must
526 parameters: origin, destination
528 Routes a PONG back to the destination that originally sent the PING.
532 parameters: msgtarget, message
534 Sends a normal message (PRIVMSG) to the given target.
538 propagation: one-to-one
540 propagation: all servers with -D users on the channel
541 (cmode +m/+n should be checked everywhere, bans should not be checked
543 - a status character ('@'/'+') followed by a channel name, to send to users
544 with that status or higher only.
546 propagation: all servers with -D users with appropriate status
547 - '=' followed by a channel name, to send to chanops only, for cmode +z.
548 capab: CHW and EOPMOD
549 propagation: all servers with -D chanops
550 - a user@server message, to send to users on a specific server. The exact
551 meaning of the part before the '@' is not prescribed, except that "opers"
552 allows IRC operators to send to all IRC operators on the server in an
554 propagation: one-to-one
555 - a message to all users on server names matching a mask ('$$' followed by mask)
556 propagation: broadcast
557 Only allowed to IRC operators.
558 - a message to all users with hostnames matching a mask ('$#' followed by mask).
559 Note that this is often implemented poorly.
560 propagation: broadcast
561 Only allowed to IRC operators.
563 In charybdis TS6, services may send to any channel and to statuses on any
569 encap target: single server
573 Remote PRIVS information request.
579 Propagates quitting of a client. No QUIT should be sent for a client that
580 has been removed as result of a KILL message.
587 parameters: real hostname
589 In a burst, propagates the real host of a dynamically-spoofed user.
595 parameters: opt. rehash type
597 Remote REHASH request. If the rehash type is omitted, it is equivalent to
598 a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
604 parameters: duration, mask, reason
606 Sets a RESV, making a nickname mask or exact channel unavailable.
611 parameters: target server mask, duration, mask, reason
613 As form 1, deprecated.
618 encap target: single server
619 source: services server
620 parameters: target user, new nickname, old nickTS, new nickTS
622 Forces a nickname change and propagates it.
624 The command is ignored if the nick TS of the user is not equal to the old
625 nickTS parameter. If the new nickname already exists (and is not the target
626 user), it is killed first.
634 parameters: source uid, '*', 'S', sasl mechanism name
636 Requests that a SASL agent (a service) initiate the authentication process.
637 The source uid is that of an unregistered client. This is why it is not sent
641 encap target: single server
643 parameters: source uid, target uid, mode, data
645 Part of a SASL authentication exchange. The mode is 'C' to send some data
646 (base64 encoded), or 'S' to end the exchange (data indicates type of
647 termination: 'A' for abort, 'F' for authentication failure, 'S' for
648 authentication success).
653 propagation: broadcast
654 parameters: target uid, TS
656 Resolve a nick collision by changing a nickname to the UID.
658 The server should verify that the UID belongs to a registered user, the user
659 does not already have their UID as their nick and the TS matches the user's
660 nickTS. If not, drop the message.
662 SAVE should be propagated as a regular NICK change to links without SAVE capab.
667 source: unregistered server
668 parameters: server name, hopcount, server description
670 Registers the connection as a server. PASS and CAPAB must have been sent
671 before, SVINFO should be sent afterwards.
673 If there is no such server configured or authentication failed, the connection
676 This is propagated as a SID message.
680 propagation: broadcast
681 parameters: server name, hopcount, server description
683 Introduces a new TS5 server, directly connected to the source of this command.
684 This is only used for jupes as TS5 servers may do little else than existing.
688 propagation: broadcast
689 parameters: server name, hopcount, sid, server description
691 Introduces a new server, directly connected to the source of this command.
695 propagation: broadcast
696 parameters: new nickname, new username, new visible hostname, new nickTS, new login name
698 Broadcasts a change of several user parameters at once.
700 Currently only sent after an SVSLOGIN.
704 propagation: broadcast
705 parameters: channelTS, simple modes, opt. mode parameters..., nicklist
707 Broadcasts a channel creation or bursts a channel.
709 The nicklist consists of users joining the channel, with status prefixes for
710 their status ('@+', '@', '+' or ''), for example:
711 '@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
712 so it is not possible to use this message to force users to join a channel.
714 The interpretation depends on the channelTS and the current TS of the channel.
715 If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
716 the incoming channelTS is greater (newer), ignore the incoming simple modes
717 and statuses and join and propagate just the users. If the incoming channelTS
718 is lower (older), wipe all modes and change the TS, notifying local users of
719 this but not servers (invites may be cleared). In the latter case, kick on
720 split riding may happen: if the key (+k) differs or the incoming simple modes
721 include +i, kick all local users, sending KICK messages to servers.
723 An SJOIN is propagated with the new TS and modes of the channel. The statuses
724 are propagated if and only if they were accepted.
726 SJOIN must be used to propagate channel creation and in netbursts. For regular
727 users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
734 parameters: snomask letter, text
736 Sends the text as a server notice from the source server to opers with the
740 parameters: target server, comment
742 Removes the target server and all servers and users behind it from the network.
744 If the target server is the receiving server or the local link this came from,
745 this is an announcement that the link is being closed.
747 Otherwise, if the target server is locally connected, the server should send
748 a WALLOPS announcing the SQUIT.
752 parameters: stats letter, hunted
754 Remote STATS request. Privileges are checked on the server executing the
760 source: services server
761 parameters: target user, new login name (optional)
763 If the new login name is not present or empty, mark the target user as not
764 logged in, otherwise mark the target user as logged in as the given account.
769 parameters: current TS version, minimum TS version, '0', current time
771 Verifies TS protocol compatibility and clock. If anything is not in order,
774 The current TS version is the highest version supported by the source server
775 and the minimum TS version is the lowest version supported.
777 The current time is sent as a TS in the usual way.
782 encap target: single server
783 source: services server
784 parameters: target, new nick, new username, new visible hostname, new login name
786 Sent after successful SASL authentication.
788 The target is a UID, typically an unregistered one.
790 Any of the "new" parameters can be '*' to leave the corresponding field
791 unchanged. The new login name can be '0' to log the user out.
793 If the UID is registered on the network, a SIGNON with the changes will be
794 broadcast, otherwise the changes will be stored, to be used when registration
800 propagation: broadcast
801 parameters: channel, topicTS, opt. topic setter, topic
803 Propagates a channel topic as part of a burst.
805 If the channel had no topic yet or the topicTS in the message is older than
806 the topicTS of the current topic on the channel and the topics differ, set
807 the topic with topicTS and topic setter, and propagate the message. Otherwise
808 ignore the message and do not propagate it.
810 If the topic setter is not present, use a server name instead.
820 parameters: channelTS, channel, cmode changes, opt. cmode parameters...
822 Propagates a channel mode change.
824 If the channelTS is greater (newer) than the current TS of the channel, drop
827 On input, only the limit on parameters per line restricts how many cmode
828 parameters can be present. Apart from this, arbitrary modes shall be
829 processed. Redundant modes may be dropped. For example, +n-n may be applied and
830 propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
833 The parameter for mode -k (removing a key) shall be ignored.
835 On output, at most ten cmode parameters should be sent; if there are more,
836 multiple TMODE messages should be sent.
840 propagation: broadcast
841 parameters: channel, topic
843 Propagates a channel topic change. The server may verify that the source has
846 The topicTS shall be set to the current time and the topic setter shall be
847 set indicating the source user. Note that this means that the topicTS of a
848 topic set with TOPIC is not necessarily consistent across the network.
855 Performs a trace to the target, sending 200 numerics from each server passing
856 the message on. The target server sends a description of the target followed
859 TRACE, STATS l and STATS L are the only commands using hunt_server that use the
860 hunted parameter for more than just determining which server the command
861 should be executed on.
864 parameters: target name, hunted
866 Executes a trace command on the target server. No 200 numerics are sent.
867 The target name is a name, not a UID, and should be on the target server.
871 propagation: broadcast
872 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
873 propagation: broadcast
875 Introduces a client. The client is on the source server of this command.
885 Removes a D:line (IP ban checked directly after accepting connection).
887 The mask must be an IP address or CIDR mask.
893 parameters: user mask, host mask
895 Removes a K:line (ban on user@host).
900 parameters: target server mask, user mask, host mask
902 As form 1, deprecated.
915 parameters: target server mask, mask
917 As form 1, deprecated.
925 Removes an X:line (ban on realname).
930 parameters: target server mask, mask
932 As form 1, deprecated.
938 Remote USERS request.
944 Remote VERSION request.
950 propagation: broadcast
952 In efnet TS6, sends a message to operators (with umode +z set). This is a
953 deprecated equivalent to OPERWALL.
955 In charybdis TS6, sends a message to local users with umode +w set (or possibly
956 another indication that WALLOPS messages should be sent), including non-opers.
961 propagation: broadcast
963 Sends a message to local users with umode +w set (or possibly another
964 indication that WALLOPS messages should be sent).
966 In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
971 parameters: hunted, target nick
973 Remote WHOIS request.
979 parameters: duration, mask, reason
981 Sets an X:line (ban on realname).
986 parameters: target server mask, duration, mask, reason
988 As form 1, deprecated.
990 Local only commands (charybdis 3.1):