[ViewVC] Annotation of: svn/hopm/trunk/README

Introduction
============

HOPM (Hybrid Open Proxy Monitor) is an open-proxy monitoring bot designed to
monitor an individual server (all servers on the network have to run their own
bot if the IRCD does not support `farconnect` user mode) with a local
operator {} block and monitor connections. When a client connects to a server,
HOPM will scan the connection for insecure proxies. Insecure proxies are
determined by attempting to connect the proxy back to another host (usually the
IRC server in question).

HOPM is written ground-up in C language and it is an improved fork of BOPM
(blitzed open proxy monitor), which is a concept derived from wgmon. It
improves on wgmon with HTTP support, faster scanning (it can scan clients
simultaneously), better layout (scalability) and DNSBL support.


Requirements
============

* An IRCD, which presents connection notices in a format, which HOPM recognizes;

* A host with full connectivity for all the ports you wish to scan. i.e. is NOT
transparently proxied -- many domestic Internet connections have port 80
transparently proxied and this produces completely unpredictable results,
sometimes as severe as 100% of clients being K:lined;

* A UNIX OS with GNU make, a C99 compiler, etc.;

* Permission from your users to portscan them for open proxies.


Compatibility
=============

* ircd-hybrid 8.2.x
* ircd-ratbox 3.0.x
* ircu 2.10.x
* InspIRCd 2.0.x
* UnrealIRCd 3.2.x, 4.0.0
* ngIRCd 22
* Bahamut 2.0.x
* Charybdis 3.4.x

HOPM is easily suitable for any other IRCD with little modification (`connregex`
in hopm.conf). However, if an IRCD does not send IP addresses in a connection
notice, HOPM will not work.


Command-line options
====================

`-c <name>`     Configuration filename. By default, HOPM reads hopm.conf,
                `-c foo` will cause HOPM to read foo.conf. The primary use for
                this is to run multiple HOPM from one directory.

`-d`            Debug mode. HOPM will not fork and will write logs to stderr.
                Multiple -d increase debug level.


Operator channel commands
=========================

`<bot> check <host> [scanner]`  Manually scans host for insecure proxies and
                                outputs all errors. If scanner is not given,
                                HOPM will scan on all scanners.NOTE: this will
                                NOT add a kline if it finds a proxy.

`<bot> stats`                   Outputs scan stats, uptime and connection count.

`<bot> fdstat`                  Outputs info about file descriptors in use.

Also, if several HOPM are present in one channel, they will all respond to !all,
for example `!all stats`.


Rehashing HOPM
==============

A /quote KILL on HOPM will cause the process to restart, rehashing the
configuration file and ending all queued scans.


Logging
=======

Once started, HOPM logs all significant events to a file called `hopm.log`,
which by default can be found at `$HOME/hopm/var/hopm.log`. There is also a
configuration option, `scanlog`, to log all proxy scans initiated, which can be
quite useful if you receive an abuse report related to portscanning.

These log files, especially the scan.log, can grow quite large. It is suggested
that you arrange for these files to be rotated periodically. You should send a
`USR1` signal to HOPM after moving its logfiles -- this will cause HOPM to
reopen those files.


Contact information
===================

* Bug reports: bugs@ircd-hybrid.org
* IRC: #ircd-coders on irc.ircd-hybrid.org
* GitHub: https://github.com/ircd-hybrid/hopm

Anonymous SVN access is also available:
  Devel: `svn co svn://svn.ircd-hybrid.org/svnroot/hopm/trunk`
  Stable branch (1.1.x): `svn co svn://svn.ircd-hybrid.org/svnroot/hopm/branches/1.1.x`
Revision:	6985
Committed:	Fri Dec 25 20:15:06 2015 UTC (10 years, 6 months ago) by michael
File size:	3768 byte(s)
Log Message:	- Update reference.conf: add 'connregex' for Unreal 4.0.0; update README file
#	User	Rev	Content
1	michael	5052	Introduction
2	michael	6564	============
3	michael	5052
4	michael	6564	HOPM (Hybrid Open Proxy Monitor) is an open-proxy monitoring bot designed to
5	michael	6521	monitor an individual server (all servers on the network have to run their own
6	michael	6564	bot if the IRCD does not support `farconnect` user mode) with a local
7	michael	6521	operator {} block and monitor connections. When a client connects to a server,
8			HOPM will scan the connection for insecure proxies. Insecure proxies are
9			determined by attempting to connect the proxy back to another host (usually the
10			IRC server in question).
11	michael	5052
12	michael	6521	HOPM is written ground-up in C language and it is an improved fork of BOPM
13	michael	6564	(blitzed open proxy monitor), which is a concept derived from wgmon. It
14	michael	5052	improves on wgmon with HTTP support, faster scanning (it can scan clients
15	michael	6564	simultaneously), better layout (scalability) and DNSBL support.
16	michael	5052
17
18			Requirements
19	michael	6564	============
20	michael	5052
21	michael	6564	* An IRCD, which presents connection notices in a format, which HOPM recognizes;
22	michael	5052
23	michael	6564	* A host with full connectivity for all the ports you wish to scan. i.e. is NOT
24			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;
27	michael	5052
28	michael	6564	* A UNIX OS with GNU make, a C99 compiler, etc.;
29	michael	5052
30	michael	6564	* Permission from your users to portscan them for open proxies.
31	michael	5052
32
33			Compatibility
34	michael	6564	=============
35	michael	5052
36	michael	6564	* ircd-hybrid 8.2.x
37			* ircd-ratbox 3.0.x
38			* ircu 2.10.x
39			* InspIRCd 2.0.x
40	michael	6985	* UnrealIRCd 3.2.x, 4.0.0
41	michael	6564	* ngIRCd 22
42			* Bahamut 2.0.x
43			* Charybdis 3.4.x
44	michael	5655
45	michael	6564	HOPM is easily suitable for any other IRCD with little modification (`connregex`
46	michael	6521	in hopm.conf). However, if an IRCD does not send IP addresses in a connection
47			notice, HOPM will not work.
48	michael	5052
49
50	michael	6564	Command-line options
51			====================
52	michael	5052
53	michael	6564	`-c <name>` Configuration filename. By default, HOPM reads hopm.conf,
54			`-c foo` will cause HOPM to read foo.conf. The primary use for
55			this is to run multiple HOPM from one directory.
56	michael	5052
57	michael	6564	`-d` Debug mode. HOPM will not fork and will write logs to stderr.
58	michael	5361	Multiple -d increase debug level.
59	michael	5052
60
61	michael	6564	Operator channel commands
62			=========================
63	michael	5052
64	michael	6564	`<bot> check <host> [scanner]` Manually scans host for insecure proxies and
65			outputs all errors. If scanner is not given,
66			HOPM will scan on all scanners.NOTE: this will
67			NOT add a kline if it finds a proxy.
68	michael	5052
69	michael	6564	`<bot> stats` Outputs scan stats, uptime and connection count.
70	michael	5052
71	michael	6564	`<bot> fdstat` Outputs info about file descriptors in use.
72	michael	5052
73	michael	6564	Also, if several HOPM are present in one channel, they will all respond to !all,
74			for example `!all stats`.
75	michael	5052
76
77	michael	5104	Rehashing HOPM
78	michael	6564	==============
79	michael	5052
80	michael	6564	A /quote KILL on HOPM will cause the process to restart, rehashing the
81	michael	6521	configuration file and ending all queued scans.
82	michael	5052
83
84			Logging
85	michael	6564	=======
86	michael	5052
87	michael	6564	Once started, HOPM logs all significant events to a file called `hopm.log`,
88			which by default can be found at `$HOME/hopm/var/hopm.log`. There is also a
89			configuration option, `scanlog`, to log all proxy scans initiated, which can be
90			quite useful if you receive an abuse report related to portscanning.
91	michael	5052
92	michael	6564	These log files, especially the scan.log, can grow quite large. It is suggested
93			that you arrange for these files to be rotated periodically. You should send a
94			`USR1` signal to HOPM after moving its logfiles -- this will cause HOPM to
95			reopen those files.
96	michael	5052
97
98	michael	6564	Contact information
99			===================
100	michael	5052
101	michael	6564	* Bug reports: bugs@ircd-hybrid.org
102			* IRC: #ircd-coders on irc.ircd-hybrid.org
103			* GitHub: https://github.com/ircd-hybrid/hopm
104
105			Anonymous SVN access is also available:
106			Devel: `svn co svn://svn.ircd-hybrid.org/svnroot/hopm/trunk`
107			Stable branch (1.1.x): `svn co svn://svn.ircd-hybrid.org/svnroot/hopm/branches/1.1.x`