1 |
/* doc/kline.txt - Overview of the remote kline system |
2 |
* |
3 |
* Copyright (C) 2005-2012 Hybrid Development Team |
4 |
* |
5 |
* $Id$ |
6 |
*/ |
7 |
|
8 |
|
9 |
Introduction |
10 |
------------ |
11 |
|
12 |
Since ircd-hybrid-7, opers are allowed to add and remove K-Lines on multiple |
13 |
servers, an extension and replacement of the old ircd-hybrid-6 method of sharing |
14 |
all K-Lines between servers. |
15 |
|
16 |
In this implementation, it is extended to be routable among servers which |
17 |
understand the "KLN" capability. This allows us to continue to "talk" |
18 |
to non remote kline capable servers without breaking anything. |
19 |
|
20 |
|
21 |
Usage |
22 |
----- |
23 |
|
24 |
The old K-Line method has not been changed. To place a K-Line it is still: |
25 |
|
26 |
/quote kline <nick|user@host> :reason |
27 |
/quote kline [tkline_duration] <nick|user@host> :reason |
28 |
|
29 |
Scenario 1 |
30 |
---------- |
31 |
|
32 |
Oper wishes to K-Line user@host on server irc.xyz.net |
33 |
|
34 |
/quote kline <nick|user@host> on irc.xyz.net :reason |
35 |
/quote kline [duration] <nick|user@host> on irc.xyz.net :reason |
36 |
|
37 |
Scenario 2 |
38 |
---------- |
39 |
|
40 |
Oper wishes to K-Line user@host on all servers named *.uk |
41 |
|
42 |
/quote kline <nick|user@host> on *.uk :reason |
43 |
/quote kline [duration] <nick|user@host> on *.uk :reason |
44 |
|
45 |
Scenario 3 |
46 |
---------- |
47 |
|
48 |
Oper wishes to place a network wide K-Line on user@host |
49 |
|
50 |
/quote kline <nick|user@host> on * :reason |
51 |
/quote kline [duration] <nick|user@host> on * :reason |
52 |
|
53 |
|
54 |
Authorization |
55 |
------------- |
56 |
|
57 |
For the K-Line to be accepted by the remote server, the server must have |
58 |
explicitly allowed K-Lines from that user. This is done via a shared {}; |
59 |
block in ircd.conf. |
60 |
|
61 |
The shared block contains two settings, a user@host mask of the oper |
62 |
who is allowed to K-Line, and a servername. |
63 |
|
64 |
- If both of these options are present, K-Lines will only be allowed |
65 |
from that specific user@host on that specific server. |
66 |
- If only the servername is present, all K-Lines from opers on that |
67 |
server will be accepted. |
68 |
- If only the user@host is present, all K-Lines from that user@host on |
69 |
any server will be accepted. |
70 |
- If neither are present, the shared block is invalid. |
71 |
|
72 |
shared { |
73 |
/* The name of the server we allow K-Lines from */ |
74 |
name = "this.server.net"; |
75 |
|
76 |
/* the user@host allowed to K-Line */ |
77 |
user = "user@host.com"; |
78 |
}; |
79 |
|
80 |
Server to Server Protocol |
81 |
------------------------- |
82 |
|
83 |
As mentioned above, each server capable of remote K-Lines passes |
84 |
the capability KLN along. No server will send a KLINE to a server |
85 |
without a KLN capability. |
86 |
|
87 |
Server to server messages are formatted like this: |
88 |
|
89 |
":oper KLINE target.server duration user host :reason" |
90 |
|
91 |
Note the difference between hybrid-6 GLINE which explicitly passed |
92 |
the oper user@host and server along. This was originally done to handle |
93 |
possible desync conditions, but is now shelved in favor of saving |
94 |
some bandwidth. |
95 |
|
96 |
oper: the nick of the oper performing the K-Line |
97 |
target.server: the server(s) this K-Line is destined for |
98 |
duration: the duration if a TK-Line, 0 if permanent. |
99 |
user: the 'user' portion of the K-Line |
100 |
host: the 'host' portion of the K-Line |
101 |
reason: the reason for the K-Line. |