ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/svn/hopm/trunk/README

Comparing hopm/trunk/README (file contents):
Revision 5134 by michael, Thu Dec 25 18:50:02 2014 UTC vs.
Revision 5361 by michael, Sun Jan 11 19:41:34 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
37	<
38	<	HOPM is designed for ircd-hybrid based ircds.  It is easily suitable for any
36	>	HOPM is designed for ircd-hybrid based ircds. It is easily suitable for any
37		other ircd with little modification (connregex in hopm.conf). However, if an
38		ircd does not send IP addresses in a connection notice, HOPM will not be
39		effective because the time it takes to resolve a hostname would be a
#	Line 45 | Line 43 | significant factor to HOPM's efficiency.
43		Command Line Options
44		--------------------
45
46	<	-c <name>       Config name.  By default HOPM reads hopm.conf, "-c foo"
47	<	will cause HOPM to read foo.conf.  The primary use for
48	<	this is to run multiple HOPMs from one directory.
46	>	-c <name>       Config name. By default HOPM reads hopm.conf, "-c foo"
47	>	will cause HOPM to read foo.conf. The primary use for
48	>	this is to run multiple HOPMs from one directory.
49
50	<	-d              Debug mode.  HOPM will not fork, and will write logs to stderr.
51	<	Multiple -d increase debug level.
50	>	-d              Debug mode. HOPM will not fork, and will write logs to stderr.
51	>	Multiple -d increase debug level.
52
53
54		Operator Channel Commands
55		-------------------------
56
57		botnick check <host> [scanner]  -- Manually scan host for insecure proxies and output all errors.
58	<	If scanner is not given, hopm will scan on all scanners.
58	>	If scanner is not given, HOPM will scan on all scanners.
59		NOTE: this will NOT add a kline (or whatever) if it finds a
60		proxy.
61
#	Line 72 | Line 70 | for example !all stats.
70		Rehashing HOPM
71		--------------
72
73	<	A /kill to hopm will cause the process to restart, rehashing the configuration file
73	>	A /kill to HOPM will cause the process to restart, rehashing the configuration file
74		and ending all queued scans.
75
76
#	Line 80 | Line 78 | Logging
78		-------
79
80		Once started, HOPM logs all significant events to a file called "hopm.log"
81	<	which by default can be found at $HOME/hopm/var/hopm.log.  There is also a
81	>	which by default can be found at $HOME/hopm/var/hopm.log. There is also a
82		config option to log all proxy scans initiated, which can be quite useful if
83		you receive an abuse report related to portscanning.
84
85	<	These log files, especially the scan log, can grow quite large.  It is
86	<	suggested that you arrange for these files to be rotated periodically.  An
87	<	example shell script is provided in the contrib/logrotate directory.  If you
85	>	These log files, especially the scan log, can grow quite large. It is
86	>	suggested that you arrange for these files to be rotated periodically. An
87	>	example shell script is provided in the contrib/logrotate directory. If you
88		prefer to use the log rotation facilities of your operating system then you
89		should send a USR1 signal to HOPM after moving its logfiles - this will cause
90		HOPM to reopen those files.

Comparing hopm/trunk/README (property svn:eol-style):
Revision 5134 by michael, Thu Dec 25 18:50:02 2014 UTC vs.
Revision 5361 by michael, Sun Jan 11 19:41:34 2015 UTC

#	Line 0 | Line 1
1	+	native

Diff Legend

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