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 IP addresses: IP addresses are converted to text in the usual way, including
25 '::' shortening in IPv6, with the exception that a zero is prepended to any
26 IP address that starts with a colon.
28 propagation: to which other servers the command is sent
30 For all commands with a hunted parameter, the propagation is determined by
31 that, and not otherwise specified.
33 For all commands with a target server mask parameter, the propagation is
34 determined by that, and not otherwise specified. The command is sent to all
35 servers with names matching the given mask (for example '*', '*.example.com',
36 'irc.example.com'). Those servers do not have to be directly connected.
37 Targets cannot be SIDs.
39 Propagation broadcast means the command is sent to all servers.
41 Propagation one-to-one means the command is only sent to the target or the
42 server the target is on.
44 Propagation none means the command is never sent to another server if it is
47 For some other commands, the propagation depends on the parameters and is
50 services server: server mentioned in a service{} block. There are no services
53 service: client with umode +S. This implies that it is on a services server.
56 The initiator sends the PASS, CAPAB and SERVER messages. Upon receiving the
57 SERVER, the listener will check the information, and if it is valid, it will
58 send its own PASS, CAPAB and SERVER messages, followed by SVINFO and the burst.
59 Upon receiving the SERVER, the initiator will send SVINFO and the burst. If
60 ziplinks are used, SVINFO is the first compressed message.
62 The burst consists of SID and SERVER messages for all known servers, BAN
63 messages for all propagated bans, UID or EUID messages for all known users
64 (possibly followed by ENCAP REALHOST, ENCAP LOGIN and/or AWAY) and SJOIN
65 messages for all known channels (possibly followed by BMASK and/or TB).
69 +D (deaf: does not receive channel messages)
70 +S (network service) (only settable on burst from a services server)
71 +a (appears as server administrator)
72 +i (invisible, see rfc1459)
73 +o (IRC operator, see rfc1459)
74 +w (wallops, see rfc1459) (always propagated for historical reasons)
76 +Q/+R/+g/+l/+s/+z (only locally effective)
77 +Z (ssl user) (only settable on burst)
78 possibly more added by modules
87 +e (ban exception) (capab: EX)
88 +I (invite exception) (capab: IE)
90 +k (key: password required to join, <= 23 ascii chars, no : or , or whitespace)
92 +l (limit: maximum number of members before further joins are disallowed)
95 +n (no external messages)
96 +p (private: does not appear in /whois to non-members, no /knock allowed)
97 +r (only registered users may join) (only if a services server exists) (capab: SERVICES)
99 +t (only chanops may change topic)
104 +f (forward: channel name <= 30 chars)
105 +j (join throttle: N:T with integer N and T)
107 +F (free target for +f)
109 +P (permanent: does not disappear when empty)
110 +Q (ignore forwards to this)
112 +g (allow any member to /invite)
113 +z (send messages blocked by +m to chanops)
117 parameters: target, any...
119 The command name should be three decimal ASCII digits.
121 Propagates a "numeric" command reply, such as from a remote WHOIS request.
123 If the first digit is 0 (indicating a reply about the local connection), it
124 should be changed to 1 before propagation or sending to a user.
126 Numerics to the local server may be sent to opers.
128 To avoid infinite loops, servers should not send any replies to numerics.
132 propagation: one-to-one
134 propagation: all servers with -D users on the channel
136 Numerics to channels are broken in some older servers.
142 Remote ADMIN request.
146 propagation: broadcast
147 parameters: opt. away reason
149 If the away reason is empty or not present, mark the user as not away.
150 Otherwise, mark the user as away.
152 Changing away reason from one non-empty string to another non-empty string
153 may not be propagated.
159 propagation: broadcast (restricted)
160 parameters: type, user mask, host mask, creation TS, duration, lifetime, oper, reason
162 Propagates a network wide ban.
164 The type is K for K:lines, R for resvs and X for X:lines; other types are
165 reserved. The user mask field is only used for K:lines; for resvs and X:lines
166 the field is ignored in input and sent as an asterisk.
168 The creation TS indicates when this ban was last modified. An incoming ban MUST
169 be ignored and not propagated if the creation TS is older than the creation TS
170 of the current ban. If the ban is identical, it SHOULD NOT be propagated to
171 avoid unnecessary network traffic. (Two changes to bans that set the TS to the
172 same value may cause desynchronization.)
174 The duration is 0 for an unban and relative to the creation TS for a ban.
175 When the duration has passed, the ban is no longer active but it may still
176 be necessary to remember it.
178 The lifetime is relative to the creation TS and indicates for how long this
179 ban needs to be remembered and propagated. This MUST be at least the duration.
180 Initially, it is usually set the same as the duration but when the ban is
181 modified later, it SHOULD be set such that the modified ban is remembered at
182 least as long as the original ban. This ensures that the original ban does not
183 revive via split servers. This requirement is only a SHOULD to allow for
184 implementations that only inject bans and do not remember any; implementations
185 that remember and propagate bans MUST set the lifetime appropriately.
187 The oper field indicates the oper that originally set the ban. If this message
188 is the initial propagation of a change, it SHOULD be sent as * (an asterisk).
190 The reason field indicates the reason for the ban. Any part after a | (vertical
191 bar) MUST NOT be shown to normal users. The rest of the field and the creation
192 TS and duration MAY be shown to normal users.
196 propagation: broadcast
197 parameters: channelTS, channel, type, space separated masks
199 If the channelTS in the message is greater (newer) than the current TS of
200 the channel, drop the message and do not propagate it.
202 Type is the mode letter of a ban-like mode. In efnet TS6 this is 'b', 'e' or
203 'I'. In charybdis TS6 additionally 'q' is possible.
205 Add all the masks to the given list of the channel.
207 All ban-like modes must be bursted using this command, not using MODE or TMODE.
210 source: unregistered server
212 parameters: space separated capability list
214 Sends capabilities of the server. This must include QS and ENCAP. It is also
215 strongly recommended to include EX, CHW, IE and KNOCK, and for charybdis TS6
216 also SAVE and EUID. For use with services, SERVICES and RSFNC are strongly
219 The capabilities may depend on the configuration for the server they are sent
225 propagation: broadcast
226 parameters: client, new hostname
228 Changes the visible hostname of a client.
230 Opers are notified unless the source is a server or a service.
234 parameters: server to connect to, port, hunted
236 Remote connect request. A server WALLOPS should be sent by the receiving
239 The port can be 0 for the default port.
245 parameters: duration, mask, reason
247 Sets a D:line (IP ban checked directly after accepting connection).
249 The mask must be an IP address or CIDR mask.
253 parameters: target server mask, subcommand, opt. parameters...
255 Sends a command to matching servers. Propagation is independent of
256 understanding the subcommand.
258 Subcommands are listed elsewhere with "encap only".
261 source: server or unregistered server
263 parameters: error message
265 Reports a (usually fatal) error with the connection.
267 Error messages may contain IP addresses and have a negative effect on server
272 encap target: single server
276 Remote ETRACE information request.
282 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, real hostname, account name, gecos
283 propagation: broadcast
285 Introduces a client. The client is on the source server of this command.
287 The IP address MUST be '0' (a zero) if the true address is not sent such as
288 because of a spoof. Otherwise, and if there is no dynamic spoof (i.e. the
289 visible and real hostname are equal), the IP address MAY be shown to normal
292 The account name is '*' if the user is not logged in with services.
296 EUID is similar to UID but includes the ENCAP REALHOST and ENCAP LOGIN
303 parameters: space separated capability list
305 Capability list of remote server.
311 parameters: user mask, host mask, reason
312 propagation: broadcast
314 Propagates a G:line vote. Once votes from three different opers (based on
315 user@host mask) on three different servers have arrived, trigger the G:line.
316 Pending G:lines expire after some time, usually ten minutes. Triggered G:lines
317 expire after a configured time which may differ across servers.
319 Requests from server connections must be propagated, unless they are found to
320 be syntactically invalid (e.g. '!' in user mask). Therefore, disabling glines
321 must not affect propagation, and too wide glines, double votes and glines that
322 already exist locally must still be propagated.
324 Of course, servers are free to reject gline requests from their own operators.
331 parameters: user mask, host mask, reason
332 propagation: broadcast
334 Propagates a G:line removal vote. Once three votes have arrived (as with
335 G:lines), remove the G:line. Pending G:lines removals expire after some time,
338 Pending G:line removals do not interact with pending G:lines. Triggering a
339 G:line does not affect a pending G:line removal. Triggering a G:line removal
340 does not affect a pending G:line.
350 parameters: target user, channel, opt. channelTS
351 propagation: one-to-one
353 Invites a user to a channel.
355 If the channelTS is greater (newer) than the current TS of the channel, drop
358 Not sending the channelTS parameter is deprecated.
363 parameters: '0' (one ASCII zero)
364 propagation: broadcast
366 Parts the source user from all channels.
370 parameters: channelTS, channel, '+' (a plus sign)
371 propagation: broadcast
373 Joins the source user to the given channel. If the channel does not exist yet,
374 it is created with the given channelTS and no modes. If the channel already
375 exists and has a greater (newer) TS, wipe all simple modes and statuses and
376 change the TS, notifying local users of this but not servers (note that
377 ban-like modes remain intact; invites may or may not be cleared).
379 A JOIN is propagated with the new TS of the channel.
384 propagation: broadcast (restricted)
385 parameters: target server mask, add or delete, server name, oper, reason
387 Adds or removes a jupe for a server. If the server is presently connected,
388 it MUST be SQUIT by the server's uplink when the jupe is applied.
390 The oper field indicates the oper that originally set the jupe. If this message
391 is the initial propagation of a removal, it SHOULD be sent as * (an asterisk).
393 The reason field indicates the reason for the jupe. It SHOULD be displayed
394 as the linking error message to the juped server if it tries to reconnect.
398 parameters: channel, target user, opt. reason
399 propagation: broadcast
401 Kicks the target user from the given channel.
403 Unless the channel's TS is 0, no check is done whether the source user has ops.
405 Not sending the reason parameter is questionable.
409 parameters: target user, path
410 propagation: broadcast
412 Removes the user from the network.
414 The format of the path parameter is some sort of description of the source of
415 the kill followed by a space and a parenthesized reason. To avoid overflow,
416 it is recommended not to add anything to the path.
422 parameters: duration, user mask, host mask, reason
424 Sets a K:line (ban on user@host).
429 parameters: target server mask, duration, user mask, host mask, reason
431 As form 1, deprecated.
437 propagation: broadcast
439 Requests an invite to a channel that is locked somehow (+ikl). Notifies all
440 operators of the channel. (In charybdis, on +g channels all members are
443 This is broadcast so that each server can store when KNOCK was used last on
448 parameters: hunted, server mask
450 Remote LINKS request. The server mask limits which servers are listed.
458 Sends a message to operators (with umode +l set). This is intended to be
459 used for strict subsets of the network.
464 parameters: target server mask, text
466 As form 1, deprecated.
471 parameters: account name
473 In a burst, states that the source user is logged in as the account.
477 parameters: server mask, hunted
479 Remote LUSERS request. Most servers ignore the server mask, treating it as '*'.
483 source: services server
484 parameters: channelTS, channel, mode letters
485 propagation: broadcast (restricted)
487 Propagates a channel mode lock change.
489 If the channelTS is greater (newer) than the current TS of the channel, drop
492 The final parameter is a list of mode letters that may not be changed by local
493 users. This applies to setting or unsetting simple modes, and changing or
494 removing mode parameters.
496 An MLOCK message with no modes disables the MLOCK, therefore the MLOCK message
497 always contains the literal MLOCK for simplicity.
502 parameters: client, umode changes
503 propagation: broadcast
505 Propagates a user mode change. The client parameter must refer to the same user
508 Not all umodes are propagated to other servers.
512 parameters: channel, cmode changes, opt. cmode parameters...
514 Propagates a channel mode change.
516 This is deprecated because the channelTS is not included. If it is received,
517 it should be propagated as TMODE.
528 parameters: new nickname, new nickTS
529 propagation: broadcast
531 Propagates a nick change.
535 parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
537 Historic TS5 user introduction. The user is on the server indicated by the
538 server parameter; the source server is meaningless (local link).
544 source: services server
545 parameters: duration, nickname
547 If duration is greater than 0, makes the given nickname unavailable for that
550 If duration is 0, removes a nick delay entry for the given nickname.
552 There may or may not be a client with the given nickname; this does not affect
557 parameters: msgtarget, message
559 As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
560 and most error messages are suppressed.
562 Servers may not send '$$', '$#' and opers@server notices. Older servers may
563 not allow servers to send to specific statuses on a channel.
569 parameters: command name, parameters
571 Reports operspy usage.
576 propagation: broadcast
578 Sends a message to operators (with umode +z set).
582 parameters: comma separated channel list, message
584 Parts the source user from the given channels.
587 source: unregistered server
588 parameters: password, 'TS', TS version, SID
590 Sends the server link password, TS version and SID.
594 parameters: origin, opt. destination server
596 Sends a PING to the destination server, which will reply with a PONG. If the
597 destination server parameter is not present, the server receiving the message
600 The origin field is not used in the server protocol. It is sent as the name
601 (not UID/SID) of the source.
603 Remote PINGs are used for end-of-burst detection, therefore all servers must
608 parameters: origin, destination
610 Routes a PONG back to the destination that originally sent the PING.
614 parameters: msgtarget, message
616 Sends a normal message (PRIVMSG) to the given target.
620 propagation: one-to-one
622 propagation: all servers with -D users on the channel
623 (cmode +m/+n should be checked everywhere, bans should not be checked
625 - a status character ('@'/'+') followed by a channel name, to send to users
626 with that status or higher only.
628 propagation: all servers with -D users with appropriate status
629 - '=' followed by a channel name, to send to chanops only, for cmode +z.
630 capab: CHW and EOPMOD
631 propagation: all servers with -D chanops
632 - a user@server message, to send to users on a specific server. The exact
633 meaning of the part before the '@' is not prescribed, except that "opers"
634 allows IRC operators to send to all IRC operators on the server in an
636 propagation: one-to-one
637 - a message to all users on server names matching a mask ('$$' followed by mask)
638 propagation: broadcast
639 Only allowed to IRC operators.
640 - a message to all users with hostnames matching a mask ('$#' followed by mask).
641 Note that this is often implemented poorly.
642 propagation: broadcast
643 Only allowed to IRC operators.
645 In charybdis TS6, services may send to any channel and to statuses on any
651 encap target: single server
655 Remote PRIVS information request.
661 Propagates quitting of a client. No QUIT should be sent for a client that
662 has been removed as result of a KILL message.
669 parameters: real hostname
671 In a burst, propagates the real host of a dynamically-spoofed user.
677 parameters: opt. rehash type
679 Remote REHASH request. If the rehash type is omitted, it is equivalent to
680 a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
686 parameters: duration, mask, reason
688 Sets a RESV, making a nickname mask or exact channel unavailable.
693 parameters: target server mask, duration, mask, reason
695 As form 1, deprecated.
700 encap target: single server
701 source: services server
702 parameters: target user, new nickname, new nickTS, old nickTS
704 Forces a nickname change and propagates it.
706 The command is ignored if the nick TS of the user is not equal to the old
707 nickTS parameter. If the new nickname already exists (and is not the target
708 user), it is killed first.
716 parameters: source uid, '*', 'S', sasl mechanism name
718 Requests that a SASL agent (a service) initiate the authentication process.
719 The source uid is that of an unregistered client. This is why it is not sent
723 encap target: single server
725 parameters: source uid, target uid, mode, data
727 Part of a SASL authentication exchange. The mode is 'C' to send some data
728 (base64 encoded), or 'D' to end the exchange (data indicates type of
729 termination: 'A' for abort, 'F' for authentication failure, 'S' for
730 authentication success).
735 propagation: broadcast
736 parameters: target uid, TS
738 Resolve a nick collision by changing a nickname to the UID.
740 The server should verify that the UID belongs to a registered user, the user
741 does not already have their UID as their nick and the TS matches the user's
742 nickTS. If not, drop the message.
744 SAVE should be propagated as a regular NICK change to links without SAVE capab.
749 source: unregistered server
750 parameters: server name, hopcount, server description
752 Registers the connection as a server. PASS and CAPAB must have been sent
753 before, SVINFO should be sent afterwards.
755 If there is no such server configured or authentication failed, the connection
758 This is propagated as a SID message.
762 propagation: broadcast
763 parameters: server name, hopcount, server description
765 Introduces a new TS5 server, directly connected to the source of this command.
766 This is only used for jupes as TS5 servers may do little else than existing.
770 propagation: broadcast
771 parameters: server name, hopcount, sid, server description
773 Introduces a new server, directly connected to the source of this command.
777 propagation: broadcast
778 parameters: new nickname, new username, new visible hostname, new nickTS, new login name
780 Broadcasts a change of several user parameters at once.
782 Currently only sent after an SVSLOGIN.
786 propagation: broadcast
787 parameters: channelTS, channel, simple modes, opt. mode parameters..., nicklist
789 Broadcasts a channel creation or bursts a channel.
791 The nicklist consists of users joining the channel, with status prefixes for
792 their status ('@+', '@', '+' or ''), for example:
793 '@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
794 so it is not possible to use this message to force users to join a channel.
796 The interpretation depends on the channelTS and the current TS of the channel.
797 If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
798 the incoming channelTS is greater (newer), ignore the incoming simple modes
799 and statuses and join and propagate just the users. If the incoming channelTS
800 is lower (older), wipe all modes and change the TS, notifying local users of
801 this but not servers (invites may be cleared). In the latter case, kick on
802 split riding may happen: if the key (+k) differs or the incoming simple modes
803 include +i, kick all local users, sending KICK messages to servers.
805 An SJOIN is propagated with the new TS and modes of the channel. The statuses
806 are propagated if and only if they were accepted.
808 SJOIN must be used to propagate channel creation and in netbursts. For regular
809 users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
816 parameters: snomask letter, text
818 Sends the text as a server notice from the source server to opers with the
822 parameters: target server, comment
824 Removes the target server and all servers and users behind it from the network.
826 If the target server is the receiving server or the local link this came from,
827 this is an announcement that the link is being closed.
829 Otherwise, if the target server is locally connected, the server should send
830 a WALLOPS announcing the SQUIT.
834 parameters: stats letter, hunted
836 Remote STATS request. Privileges are checked on the server executing the
842 source: services server
843 parameters: target user, new login name (optional)
845 If the new login name is not present or empty, mark the target user as not
846 logged in, otherwise mark the target user as logged in as the given account.
851 parameters: current TS version, minimum TS version, '0', current time
853 Verifies TS protocol compatibility and clock. If anything is not in order,
856 The current TS version is the highest version supported by the source server
857 and the minimum TS version is the lowest version supported.
859 The current time is sent as a TS in the usual way.
864 encap target: single server
865 source: services server
866 parameters: target, new nick, new username, new visible hostname, new login name
868 Sent after successful SASL authentication.
870 The target is a UID, typically an unregistered one.
872 Any of the "new" parameters can be '*' to leave the corresponding field
873 unchanged. The new login name can be '0' to log the user out.
875 If the UID is registered on the network, a SIGNON with the changes will be
876 broadcast, otherwise the changes will be stored, to be used when registration
882 propagation: broadcast
883 parameters: channel, topicTS, opt. topic setter, topic
885 Propagates a channel topic as part of a burst.
887 If the channel had no topic yet or the topicTS in the message is older than
888 the topicTS of the current topic on the channel and the topics differ, set
889 the topic with topicTS and topic setter, and propagate the message. Otherwise
890 ignore the message and do not propagate it.
892 If the topic setter is not present, use a server name instead.
902 parameters: channelTS, channel, cmode changes, opt. cmode parameters...
904 Propagates a channel mode change.
906 If the channelTS is greater (newer) than the current TS of the channel, drop
909 On input, only the limit on parameters per line restricts how many cmode
910 parameters can be present. Apart from this, arbitrary modes shall be
911 processed. Redundant modes may be dropped. For example, +n-n may be applied and
912 propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
915 The parameter for mode -k (removing a key) shall be ignored.
917 On output, at most ten cmode parameters should be sent; if there are more,
918 multiple TMODE messages should be sent.
922 propagation: broadcast
923 parameters: channel, topic
925 Propagates a channel topic change. The server may verify that the source has
928 The topicTS shall be set to the current time and the topic setter shall be
929 set indicating the source user. Note that this means that the topicTS of a
930 topic set with TOPIC is not necessarily consistent across the network.
937 Performs a trace to the target, sending 200 numerics from each server passing
938 the message on. The target server sends a description of the target followed
941 TRACE, STATS l and STATS L are the only commands using hunt_server that use the
942 hunted parameter for more than just determining which server the command
943 should be executed on.
946 parameters: target name, hunted
948 Executes a trace command on the target server. No 200 numerics are sent.
949 The target name is a name, not a UID, and should be on the target server.
953 propagation: broadcast
954 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
955 propagation: broadcast
957 Introduces a client. The client is on the source server of this command.
959 The IP address MUST be '0' (a zero) if the true address is not sent such as
960 because of a spoof. Otherwise, and if there is no dynamic spoof (ENCAP
961 REALHOST, charybdis TS6 only), the IP address MAY be shown to normal users.
971 Removes a D:line (IP ban checked directly after accepting connection).
973 The mask must be an IP address or CIDR mask.
979 parameters: user mask, host mask
981 Removes a K:line (ban on user@host).
986 parameters: target server mask, user mask, host mask
988 As form 1, deprecated.
1001 parameters: target server mask, mask
1003 As form 1, deprecated.
1011 Removes an X:line (ban on realname).
1016 parameters: target server mask, mask
1018 As form 1, deprecated.
1024 Remote USERS request.
1030 Remote VERSION request.
1036 propagation: broadcast
1038 In efnet TS6, sends a message to operators (with umode +z set). This is a
1039 deprecated equivalent to OPERWALL.
1041 In charybdis TS6, sends a message to local users with umode +w set (or possibly
1042 another indication that WALLOPS messages should be sent), including non-opers.
1047 propagation: broadcast
1049 Sends a message to local users with umode +w set (or possibly another
1050 indication that WALLOPS messages should be sent).
1052 In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
1057 parameters: hunted, target nick
1059 Remote WHOIS request.
1063 parameters: nickname, limit, hunted
1065 Remote WHOWAS request. Not implemented in all servers.
1067 Different from a local WHOWAS request, the limit is mandatory and servers should
1068 apply a maximum to it.
1074 parameters: duration, mask, reason
1076 Sets an X:line (ban on realname).
1081 parameters: target server mask, duration, mask, reason
1083 As form 1, deprecated.
1085 Local only commands (charybdis 3.1):