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.
286 parameters: target user, channel, opt. channelTS
287 propagation: one-to-one
289 Invites a user to a channel.
291 If the channelTS is greater (newer) than the current TS of the channel, drop
294 Not sending the channelTS parameter is deprecated.
299 parameters: '0' (one ASCII zero)
300 propagation: broadcast
302 Parts the source user from all channels.
306 parameters: channelTS, channel, '+' (a plus sign)
307 propagation: broadcast
309 Joins the source user to the given channel. If the channel does not exist yet,
310 it is created with the given channelTS and no modes. If the channel already
311 exists and has a greater (newer) TS, wipe all simple modes and statuses and
312 change the TS, notifying local users of this but not servers (note that
313 ban-like modes remain intact; invites may or may not be cleared).
315 A JOIN is propagated with the new TS of the channel.
319 parameters: channel, target user, opt. reason
320 propagation: broadcast
322 Kicks the target user from the given channel.
324 Unless the channel's TS is 0, no check is done whether the source user has ops.
326 Not sending the reason parameter is questionable.
330 parameters: target user, path
331 propagation: broadcast
333 Removes the user from the network.
335 The format of the path parameter is some sort of description of the source of
336 the kill followed by a space and a parenthesized reason. To avoid overflow,
337 it is recommended not to add anything to the path.
343 parameters: duration, user mask, host mask, reason
345 Sets a K:line (ban on user@host).
350 parameters: target server mask, duration, user mask, host mask, reason
352 As form 1, deprecated.
357 propagation: broadcast
359 Requests an invite to a channel that is locked somehow (+ikl). Notifies all
360 operators of the channel. (In charybdis, on +g channels all members are
363 This is broadcast so that each server can store when KNOCK was used last on
368 parameters: hunted, server mask
370 Remote LINKS request. The server mask limits which servers are listed.
378 Sends a message to operators (with umode +l set). This is intended to be
379 used for strict subsets of the network.
384 parameters: target server mask, text
386 As form 1, deprecated.
391 parameters: account name
393 In a burst, states that the source user is logged in as the account.
397 parameters: server mask, hunted
399 Remote LUSERS request. Most servers ignore the server mask, treating it as '*'.
404 parameters: client, umode changes
405 propagation: broadcast
407 Propagates a user mode change. The client parameter must refer to the same user
410 Not all umodes are propagated to other servers.
414 parameters: channel, cmode changes, opt. cmode parameters...
416 Propagates a channel mode change.
418 This is deprecated because the channelTS is not included. If it is received,
419 it should be propagated as TMODE.
430 parameters: new nickname, new nickTS
431 propagation: broadcast
433 Propagates a nick change.
437 parameters: nickname, hopcount, nickTS, umodes, username, hostname, server, gecos
439 Historic TS5 user introduction. The user is on the server indicated by the
440 server parameter; the source server is meaningless (local link).
446 source: services server
447 parameters: duration, nickname
449 If duration is greater than 0, makes the given nickname unavailable for that
452 If duration is 0, removes a nick delay entry for the given nickname.
454 There may or may not be a client with the given nickname; this does not affect
459 parameters: msgtarget, message
461 As PRIVMSG, except NOTICE messages are sent out, server sources are permitted
462 and most error messages are suppressed.
464 Servers may not send '$$', '$#' and opers@server notices. Older servers may
465 not allow servers to send to specific statuses on a channel.
471 parameters: command name, parameters
473 Reports operspy usage.
478 propagation: broadcast
480 Sends a message to operators (with umode +z set).
484 parameters: comma separated channel list, message
486 Parts the source user from the given channels.
489 source: unregistered server
490 parameters: password, 'TS', TS version, SID
492 Sends the server link password, TS version and SID.
496 parameters: origin, opt. destination server
498 Sends a PING to the destination server, which will reply with a PONG. If the
499 destination server parameter is not present, the server receiving the message
502 The origin field is not used in the server protocol. It is sent as the name
503 (not UID/SID) of the source.
505 Remote PINGs are used for end-of-burst detection, therefore all servers must
510 parameters: origin, destination
512 Routes a PONG back to the destination that originally sent the PING.
516 parameters: msgtarget, message
518 Sends a normal message (PRIVMSG) to the given target.
522 propagation: one-to-one
524 propagation: all servers with -D users on the channel
525 (cmode +m/+n should be checked everywhere, bans should not be checked
527 - a status character ('@'/'+') followed by a channel name, to send to users
528 with that status or higher only.
529 propagation: all servers with -D users with appropriate status
530 - a user@server message, to send to users on a specific server. The exact
531 meaning of the part before the '@' is not prescribed, except that "opers"
532 allows IRC operators to send to all IRC operators on the server in an
534 propagation: one-to-one
535 - a message to all users on server names matching a mask ('$$' followed by mask)
536 propagation: broadcast
537 Only allowed to IRC operators.
538 - a message to all users with hostnames matching a mask ('$#' followed by mask).
539 Note that this is often implemented poorly.
540 propagation: broadcast
541 Only allowed to IRC operators.
543 In charybdis TS6, services may send to any channel and to statuses on any
549 encap target: single server
553 Remote PRIVS information request.
559 Propagates quitting of a client. No QUIT should be sent for a client that
560 has been removed as result of a KILL message.
567 parameters: real hostname
569 In a burst, propagates the real host of a dynamically-spoofed user.
575 parameters: opt. rehash type
577 Remote REHASH request. If the rehash type is omitted, it is equivalent to
578 a regular /rehash, otherwise it is equivalent to /rehash <rehash type>.
584 parameters: duration, mask, reason
586 Sets a RESV, making a nickname mask or exact channel unavailable.
591 parameters: target server mask, duration, mask, reason
593 As form 1, deprecated.
598 encap target: single server
599 source: services server
600 parameters: target user, new nickname, old nickTS, new nickTS
602 Forces a nickname change and propagates it.
604 The command is ignored if the nick TS of the user is not equal to the old
605 nickTS parameter. If the new nickname already exists (and is not the target
606 user), it is killed first.
614 parameters: source uid, '*', 'S', sasl mechanism name
616 Requests that a SASL agent (a service) initiate the authentication process.
617 The source uid is that of an unregistered client. This is why it is not sent
621 encap target: single server
623 parameters: source uid, target uid, mode, data
625 Part of a SASL authentication exchange. The mode is 'C' to send some data
626 (base64 encoded), or 'S' to end the exchange (data indicates type of
627 termination: 'A' for abort, 'F' for authentication failure, 'S' for
628 authentication success).
633 propagation: broadcast
634 parameters: target uid, TS
636 Resolve a nick collision by changing a nickname to the UID.
638 The server should verify that the UID belongs to a registered user, the user
639 does not already have their UID as their nick and the TS matches the user's
640 nickTS. If not, drop the message.
642 SAVE should be propagated as a regular NICK change to links without SAVE capab.
647 source: unregistered server
648 parameters: server name, hopcount, server description
650 Registers the connection as a server. PASS and CAPAB must have been sent
651 before, SVINFO should be sent afterwards.
653 If there is no such server configured or authentication failed, the connection
656 This is propagated as a SID message.
660 propagation: broadcast
661 parameters: server name, hopcount, server description
663 Introduces a new TS5 server, directly connected to the source of this command.
664 This is only used for jupes as TS5 servers may do little else than existing.
668 propagation: broadcast
669 parameters: server name, hopcount, sid, server description
671 Introduces a new server, directly connected to the source of this command.
675 propagation: broadcast
676 parameters: new nickname, new username, new visible hostname, new nickTS, new login name
678 Broadcasts a change of several user parameters at once.
680 Currently only sent after an SVSLOGIN.
684 propagation: broadcast
685 parameters: channelTS, simple modes, opt. mode parameters..., nicklist
687 Broadcasts a channel creation or bursts a channel.
689 The nicklist consists of users joining the channel, with status prefixes for
690 their status ('@+', '@', '+' or ''), for example:
691 '@+1JJAAAAAB +2JJAAAA4C 1JJAAAADS'. All users must be behind the source server
692 so it is not possible to use this message to force users to join a channel.
694 The interpretation depends on the channelTS and the current TS of the channel.
695 If either is 0, set the channel's TS to 0 and accept all modes. Otherwise, if
696 the incoming channelTS is greater (newer), ignore the incoming simple modes
697 and statuses and join and propagate just the users. If the incoming channelTS
698 is lower (older), wipe all modes and change the TS, notifying local users of
699 this but not servers (invites may be cleared). In the latter case, kick on
700 split riding may happen: if the key (+k) differs or the incoming simple modes
701 include +i, kick all local users, sending KICK messages to servers.
703 An SJOIN is propagated with the new TS and modes of the channel. The statuses
704 are propagated if and only if they were accepted.
706 SJOIN must be used to propagate channel creation and in netbursts. For regular
707 users joining channels, JOIN must be used. Pseudoservers may use SJOIN to join
714 parameters: snomask letter, text
716 Sends the text as a server notice from the source server to opers with the
720 parameters: target server, comment
722 Removes the target server and all servers and users behind it from the network.
724 If the target server is the receiving server or the local link this came from,
725 this is an announcement that the link is being closed.
727 Otherwise, if the target server is locally connected, the server should send
728 a WALLOPS announcing the SQUIT.
732 parameters: stats letter, hunted
734 Remote STATS request. Privileges are checked on the server executing the
740 source: services server
741 parameters: target user, new login name (optional)
743 If the new login name is not present or empty, mark the target user as not
744 logged in, otherwise mark the target user as logged in as the given account.
749 parameters: current TS version, minimum TS version, '0', current time
751 Verifies TS protocol compatibility and clock. If anything is not in order,
754 The current TS version is the highest version supported by the source server
755 and the minimum TS version is the lowest version supported.
757 The current time is sent as a TS in the usual way.
762 encap target: single server
763 source: services server
764 parameters: target, new nick, new username, new visible hostname, new login name
766 Sent after successful SASL authentication.
768 The target is a UID, typically an unregistered one.
770 Any of the "new" parameters can be '*' to leave the corresponding field
771 unchanged. The new login name can be '0' to log the user out.
773 If the UID is registered on the network, a SIGNON with the changes will be
774 broadcast, otherwise the changes will be stored, to be used when registration
779 propagation: broadcast
790 parameters: channelTS, channel, cmode changes, opt. cmode parameters...
792 Propagates a channel mode change.
794 If the channelTS is greater (newer) than the current TS of the channel, drop
797 On input, only the limit on parameters per line restricts how many cmode
798 parameters can be present. Apart from this, arbitrary modes shall be
799 processed. Redundant modes may be dropped. For example, +n-n may be applied and
800 propagated as +n-n, -n or (if the channel was already -n) nothing, but not as
803 The parameter for mode -k (removing a key) shall be ignored.
805 On output, at most ten cmode parameters should be sent; if there are more,
806 multiple TMODE messages should be sent.
810 propagation: broadcast
812 Propagates a channel topic change. The server may verify that the source has
820 Performs a trace to the target, sending 200 numerics from each server passing
821 the message on. The target server sends a description of the target followed
824 TRACE, STATS l and STATS L are the only commands using hunt_server that use the
825 hunted parameter for more than just determining which server the command
826 should be executed on.
829 parameters: target name, hunted
831 Executes a trace command on the target server. No 200 numerics are sent.
832 The target name is a name, not a UID, and should be on the target server.
836 propagation: broadcast
837 parameters: nickname, hopcount, nickTS, umodes, username, visible hostname, IP address, UID, gecos
838 propagation: broadcast
840 Introduces a client. The client is on the source server of this command.
850 Removes a D:line (IP ban checked directly after accepting connection).
852 The mask must be an IP address or CIDR mask.
858 parameters: user mask, host mask
860 Removes a K:line (ban on user@host).
865 parameters: target server mask, user mask, host mask
867 As form 1, deprecated.
880 parameters: target server mask, mask
882 As form 1, deprecated.
890 Removes an X:line (ban on realname).
895 parameters: target server mask, mask
897 As form 1, deprecated.
903 Remote USERS request.
909 Remote VERSION request.
915 propagation: broadcast
917 In efnet TS6, sends a message to operators (with umode +z set). This is a
918 deprecated equivalent to OPERWALL.
920 In charybdis TS6, sends a message to local users with umode +w set (or possibly
921 another indication that WALLOPS messages should be sent), including non-opers.
926 propagation: broadcast
928 Sends a message to local users with umode +w set (or possibly another
929 indication that WALLOPS messages should be sent).
931 In efnet TS6 this may include non-opers, in charybdis TS6 this may only be
936 parameters: hunted, target nick
938 Remote WHOIS request.
944 parameters: duration, mask, reason
946 Sets an X:line (ban on realname).
951 parameters: target server mask, duration, mask, reason
953 As form 1, deprecated.
955 Local only commands (charybdis 3.1):