]> arthur.barton.de Git - ngircd-alex.git/blob - doc/Protocol.txt
- Dokumentation des vom ngIRCd verwendeten Protokolls begonnen.
[ngircd-alex.git] / doc / Protocol.txt
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001,2002 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                   ngIRCd ist freie Software und steht unter
8                        der GNU General Public License.
9
10                               -- Protocol.txt --
11
12
13 I. Kompatibilitaet
14 ~~~~~~~~~~~~~~~~~~
15
16 Der ngIRCd haelt sich an das IRC-Protokoll Version 2.10, wie es in den RFCs
17 1459 und 2810-2813 beschrieben ist. Diese (und ggf. weitere fuer den ngIRCd
18 relevante) RFCs sind in RFC.txt aufgefuehrt.
19
20 Leider verhaelt sich aber schon der "Originalserver" nicht immer genau so,
21 wie es in den RFCs beschrieben ist. Da der ngIRCd aber ein Ersatz fuer
22 eben diesen Server sein soll, werden diese Abweichungen in der Regel vom
23 ngIRCd emuliert um die Kompatibilitaet zu wahren.
24
25 Sollte dieses Verhalten nicht erwuenscht sein, so kann mit der configure-
26 Option "--enable-strict-rfc" der ngIRCd so compiliert werden, dass er sich
27 strikt an die entsprechenden RFCs haelt.
28
29 ACHTUNG: an einem so compilierten Server koennen sich andere Server und
30 Clients, die sich nicht genau an das Protokoll halten, u.U. nicht mehr
31 anmelden oder alle Funktionen nutzen! In der Regel ist diese Option daher
32 nicht erwuenscht.
33
34
35 II. Erweiterungen des IRC-Protokolls
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38 Erkennt der ngIRCd, dass ein connectierter Server ebenfalls ein ngIRCd ist,
39 so werden -- so es die Version auf der Gegenseite unterstuetzt (s.u.) --
40 Erweiterungen zum IRC-Protokoll 2.10 verwendet. Diese Erweiterungen werden
41 dabei nicht von Versionsnummern abhaengig verwendet, sondern anhand von
42 Falgs, die die beiden ngIRCd-Server austauschen, aktiviert.
43
44 Die Protokoll- und Server-Erkennung wird mit dem "PASS"-Befehl durchgefuehrt
45 (vgl. RFC 2813, Sektion 4.1.1):
46
47
48 II.1 neuen Server-Link registrieren
49
50      Befehl: PASS
51   Parameter: <password> <version> <flags> [<options>]
52        Fuer: mit dieser Syntax nur Server
53
54 <password> enthaelt das Passwort fur den neu aufzubauenden Server-Link, wie er
55 in der Konfigurationsdatei definiert wurde.
56
57 <version> setzt sich aus zwei Teilen zusammen und ist mindestens 4, maximal
58 14 Zeichen lang: die ersten vier Bytes enthalten die Versionsnummer des IRC-
59 Protokolls, wobei die ersten zwei Bytes die Major-, die letzten beiden die
60 Minor-Revision angeben. "0210" steht also fuer Protokollversion 2.10.
61 Die folgenden (optionalen!) 10 Bytes enthalten eine implementationsabhaengige
62 Versionsnummer, der ngIRCd liefert hier immer "-ngIRCd" (Zur Identifikation
63 des ngIRCd sollte dieser String jedoch NICHT verwendet werden, s.u.).
64
65 <flags> setzt sich ebenfalls aus zwei Bestandteilen zusammen und ist maximal
66 100 Bytes lang. Getrennt werden die beiden Teile mit dem Zeichen "|". Der
67 erste Teil enthaelt den Namen der Implementation, der ngIRCd liefert hier z.B.
68 "ngIRCd", der Originalserver "IRC". Anhand dieser "ID" kann zwischen Server-
69 Implementationen unterschieden werden.
70 Der zweite Teil (nach dem "|") ist implementationsabhaengig und wird vom ngIRCd
71 nur ausgewertet, wenn die Gegenseite ebenfalls ein ngIRCd ist. In diesem Fall
72 wird folgende Syntax erwartet: "<serverversion>[:<serverflags>]".
73 <version> ist hier eine ASCII-Darstellung der Versionsnummer, <flags> zeigt die
74 vom Server unterstuetzten Erweiterungen an (und kann die leere Menge sein).
75
76 Mit dem optionalen Parameter <options> werden Server-Optionen bekannt gemacht,
77 wie sie in RFC 2813, Sektion 4.1.1 definiert sind.
78
79 Folgende <serverflags> werden zur Zeit vom ngIRCd verwendet:
80
81 - o: IRC-Operatoren duerfen auch dann Channel- und Channel-User-Modes aendern,
82      wenn sie kein Channel-Operator im betroffenen Channel sind.
83
84
85 -- 
86 $Id: Protocol.txt,v 1.1 2002/09/02 21:04:27 alex Exp $