1
0

Protocol.txt 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. ngIRCd - Next Generation IRC Server
  2. (c)2001-2003 by Alexander Barton,
  3. alex@barton.de, http://www.barton.de/
  4. ngIRCd is free software and published under the
  5. terms of the GNU General Public License.
  6. -- Protocol.txt --
  7. I. Compatibility
  8. ~~~~~~~~~~~~~~~~
  9. The ngIRCd implements the Internet Relay Chat (IRC) protocol version 2.10
  10. as defined in RFC ("request for comment") 1459 and 2810-2813. These (and
  11. probably further relevant RFCs) are listed in doc/RFC.txt.
  12. Unfortunately, even the "original" ircd doesn't follow these specifications
  13. in all details. But because the ngIRCd should be a fully compatible
  14. replacement for this server ("ircd") it tries to emulate these differences.
  15. If you don't like this behavior please ./configure the ngIRCd using the
  16. "--enable-strict-rfc" command line option. But keep in mind: not all IRC
  17. clients are compatible with a server configured that way, some can't even
  18. connect at all! Therefore this option usually isn't desired for "normal
  19. server operation".
  20. II. The IRC+ Protocol
  21. ~~~~~~~~~~~~~~~~~~~~~
  22. Starting with version 0.5.0, the ngIRCd extends the original IRC protocol
  23. as defined in RFC 2810-2813. This enhanced protocol is named "IRC+". It is
  24. backwards compatible to the "plain" IRC protocol and will only be used by
  25. the ngIRCd if it detects that the peer supports it as well.
  26. The "PASS" command is used to detect the protocol and peer versions see
  27. RFC 2813 (section 4.1.1) and below.
  28. II.1 Register new server link
  29. Command: PASS
  30. Parameters: <password> <version> <flags> [<options>]
  31. Used by: servers only (with these parameters)
  32. <password> is the password for this new server link as defined in the server
  33. configuration which is sent to the peer or received from it.
  34. <version> consists of two parts and is at least 4, at most 14 characters
  35. long: the first four bytes contain the IRC protocol version number, whereas
  36. the first two bytes represent the major version, the last two bytes the
  37. minor version (the string "0210" indicates version 2.10, e.g.).
  38. The following optional(!) 10 bytes contain an implementation-dependent
  39. version number. Servers supporting the IRC+ protocol as defined in this
  40. document provide the string "-IRC+" here.
  41. Example for <version>: "0210-IRC+".
  42. <flags> consists of two parts separated with the character "|" and is at
  43. most 100 bytes long. The first part contains the name of the implementation
  44. (ngIRCd sets this to "ngircd", the original ircd to "IRC", e.g.). The second
  45. part is implementation-dependent and should only be parsed if the peer
  46. supports the IRC+ protocol as well. In this case the following syntax is
  47. used: "<serverversion>[:<serverflags>]".
  48. <serverversion> is an ASCII representation of the clear-text server version
  49. number, <serverflags> indicates the supported IRC+ protocol extensions (and
  50. may be empty!).
  51. The following <serverflags> are defined at the moment:
  52. - C: The server supports the CHANINFO command.
  53. - L: INVITE- and BAN-lists should be synchronized between servers: if the
  54. peer understands this flag, it will send "MODE +I" and "MODE +b"
  55. commands after the server link has been established.
  56. - o: IRC operators are allowed to change channel- and channel-user-modes
  57. even if they aren't channel-operator of the affected channel.
  58. - Z: Compressed server links are supported by the server.
  59. Example for a complete <flags> string: "ngircd|0.7.5:CZ".
  60. The optional parameter <options> is used to propagate server options as
  61. defined in RFC 2813, section 4.1.1.
  62. II.2 Exchange channel-modes, topics, and persistent channels
  63. Command: CHANINFO
  64. Parameters: <channel> +<modes> <key> <maxusers> [<topic>]
  65. Used by: servers only
  66. CHANINFO is used by servers to inform each other about a channel: its
  67. modes, channel key, user limits and its topic. <topic> is optional.
  68. If the channel already exists on the server receiving the CHANINFO command,
  69. it only adopts the <modes> (or the <topic>) if there are no modes (or topic)
  70. already set. It there are already values set the server ignores the
  71. corresponding parameter.
  72. If the channel doesn't exists at all it will be created.
  73. The parameter <key> must be ignored if a channel has no key (the parameter
  74. <modes> doesn't list the "k" channel mode). In this case <key> should
  75. contain "*" because the parameter <key> is required by the CHANINFO syntax
  76. and therefore can't be omitted. The parameter <limit> must be ignored when
  77. a channel has no user limit (the parameter <modes> doesn't list the "l"
  78. channel mode). In this case <limit> should be "0".
  79. --
  80. $Id: Protocol.txt,v 1.12 2004/04/25 15:44:10 alex Exp $