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