ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/hopm/trunk/README
(Generate patch)

Comparing hopm/trunk/README (file contents):
Revision 5135 by michael, Thu Dec 25 18:51:51 2014 UTC vs.
Revision 5655 by michael, Sun Mar 8 14:21:04 2015 UTC

# Line 2 | Line 2 | Introduction
2   ------------
3  
4   HOPM (Hybrid Open Proxy Monitor) is an open proxy monitoring bot designed for
5 < Hybrid based ircds.  The bot is designed to monitor an individual server (all
5 > Hybrid based ircds. The bot is designed to monitor an individual server (all
6   servers on the network have to run their own bot) with a local operator {}
7 < block and monitor connections.  When a client connects to the server, HOPM will
8 < scan the connection for insecure proxies.  Insecure proxies are determined by
7 > block and monitor connections. When a client connects to the server, HOPM will
8 > scan the connection for insecure proxies. Insecure proxies are determined by
9   attempting to connect the proxy back to another host (usually the IRC server in
10   question).
11  
12 < HOPM is written ground-up in C language, concept derived from wgmon.  It
12 > HOPM is written ground-up in C language, concept derived from wgmon. It
13   improves on wgmon with HTTP support, faster scanning (it can scan clients
14   simultaneously), better layout (scalability), and dnsbl support.
15  
# Line 20 | Line 20 | Requirements
20   o An IRCd which presents connection notices in a format which HOPM
21    recognises (see below).
22  
23 < o A host with full connectivity for all the ports you wish to scan.  i.e. is
23 > o A host with full connectivity for all the ports you wish to scan. i.e. is
24    NOT transparently proxied -- many domestic internet connections have port 80
25    transparently proxied and this produces completely unpredictable results,
26    sometimes as severe as 100% of clients being K:lined!
# Line 33 | Line 33 | o Permission from your users to portscan
33   Compatibility
34   -------------
35  
36 < ircd-hybrid 8.2.1
36 > ircd-hybrid 8.2.x
37 > ircd-ratbox 3.0.x
38 > InspIRCd 2.0.x
39 > UnrealIRCd 3.2.x
40 > ngIRCd 22
41 > Bahamut 2.0.x
42 > Charybdis 3.4.x
43  
44 < HOPM is designed for ircd-hybrid based ircds.  It is easily suitable for any
44 > HOPM is designed for ircd-hybrid based ircds. It is easily suitable for any
45   other ircd with little modification (connregex in hopm.conf). However, if an
46   ircd does not send IP addresses in a connection notice, HOPM will not be
47   effective because the time it takes to resolve a hostname would be a
# Line 45 | Line 51 | significant factor to HOPM's efficiency.
51   Command Line Options
52   --------------------
53  
54 < -c <name>       Config name.  By default HOPM reads hopm.conf, "-c foo"
55 <                will cause HOPM to read foo.conf.  The primary use for
56 <                this is to run multiple HOPMs from one directory.
54 > -c <name>       Config name. By default HOPM reads hopm.conf, "-c foo"
55 >                will cause HOPM to read foo.conf. The primary use for
56 >                this is to run multiple HOPMs from one directory.
57  
58 < -d              Debug mode.  HOPM will not fork, and will write logs to stderr.
59 <                Multiple -d increase debug level.
58 > -d              Debug mode. HOPM will not fork, and will write logs to stderr.
59 >                Multiple -d increase debug level.
60  
61  
62   Operator Channel Commands
63   -------------------------
64  
65   botnick check <host> [scanner]  -- Manually scan host for insecure proxies and output all errors.
66 <                                   If scanner is not given, hopm will scan on all scanners.
66 >                                   If scanner is not given, HOPM will scan on all scanners.
67                                     NOTE: this will NOT add a kline (or whatever) if it finds a
68                                     proxy.
69  
# Line 72 | Line 78 | for example !all stats.
78   Rehashing HOPM
79   --------------
80  
81 < A /kill to hopm will cause the process to restart, rehashing the configuration file
81 > A /kill to HOPM will cause the process to restart, rehashing the configuration file
82   and ending all queued scans.
83  
84  
# Line 80 | Line 86 | Logging
86   -------
87  
88   Once started, HOPM logs all significant events to a file called "hopm.log"
89 < which by default can be found at $HOME/hopm/var/hopm.log.  There is also a
89 > which by default can be found at $HOME/hopm/var/hopm.log. There is also a
90   config option to log all proxy scans initiated, which can be quite useful if
91   you receive an abuse report related to portscanning.
92  
93 < These log files, especially the scan log, can grow quite large.  It is
94 < suggested that you arrange for these files to be rotated periodically.  An
95 < example shell script is provided in the contrib/logrotate directory.  If you
93 > These log files, especially the scan log, can grow quite large. It is
94 > suggested that you arrange for these files to be rotated periodically. An
95 > example shell script is provided in the contrib/logrotate directory. If you
96   prefer to use the log rotation facilities of your operating system then you
97   should send a USR1 signal to HOPM after moving its logfiles - this will cause
98   HOPM to reopen those files.

Diff Legend

– Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)