| 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 |
|
|
| 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! |
| 33 |
|
Compatibility |
| 34 |
|
------------- |
| 35 |
|
|
| 36 |
< |
ircd-hybrid 8.2.1 |
| 37 |
< |
|
| 38 |
< |
HOPM is designed for ircd-hybrid. It is easily suitable for any other ircd with |
| 39 |
< |
little modification (connregex in hopm.conf). However, if an ircd does not send |
| 40 |
< |
IP's in a connection notice, HOPM will not be effective because the time it takes |
| 41 |
< |
to resolve a hostname would be a significant factor to HOPM's efficiency. |
| 36 |
> |
ircd-hybrid 8.2.x |
| 37 |
> |
ircd-ratbox 3.0.x |
| 38 |
> |
ircu 2.10.x |
| 39 |
> |
InspIRCd 2.0.x |
| 40 |
> |
UnrealIRCd 3.2.x |
| 41 |
> |
ngIRCd 22 |
| 42 |
> |
Bahamut 2.0.x |
| 43 |
> |
Charybdis 3.4.x |
| 44 |
> |
|
| 45 |
> |
HOPM is designed for ircd-hybrid based ircds. It is easily suitable for any |
| 46 |
> |
other ircd with little modification (connregex in hopm.conf). However, if an |
| 47 |
> |
ircd does not send IP addresses in a connection notice, HOPM will not work. |
| 48 |
|
|
| 49 |
|
|
| 50 |
|
Command Line Options |
| 51 |
|
-------------------- |
| 52 |
|
|
| 53 |
< |
-c <name> Config name. By default HOPM reads hopm.conf, "-c foo" |
| 54 |
< |
will cause HOPM to read foo.conf. The primary use for |
| 55 |
< |
this is to run multiple HOPMs from one directory. |
| 53 |
> |
-c <name> Config name. By default HOPM reads hopm.conf, "-c foo" |
| 54 |
> |
will cause HOPM to read foo.conf. The primary use for |
| 55 |
> |
this is to run multiple HOPMs from one directory. |
| 56 |
|
|
| 57 |
< |
-d Debug mode. HOPM will not fork, and will write logs to stderr. |
| 58 |
< |
Multiple -d increase debug level. |
| 57 |
> |
-d Debug mode. HOPM will not fork, and will write logs to stderr. |
| 58 |
> |
Multiple -d increase debug level. |
| 59 |
|
|
| 60 |
|
|
| 61 |
|
Operator Channel Commands |
| 62 |
|
------------------------- |
| 63 |
|
|
| 64 |
|
botnick check <host> [scanner] -- Manually scan host for insecure proxies and output all errors. |
| 65 |
< |
If scanner is not given, hopm will scan on all scanners. |
| 65 |
> |
If scanner is not given, HOPM will scan on all scanners. |
| 66 |
|
NOTE: this will NOT add a kline (or whatever) if it finds a |
| 67 |
|
proxy. |
| 68 |
|
|
| 69 |
|
botnick stats -- Output scan stats, uptime and client connection count. |
| 70 |
|
|
| 71 |
< |
botnick fdstat -- Output some into about file descriptors in use. |
| 71 |
> |
botnick fdstat -- Output some info about file descriptors in use. |
| 72 |
|
|
| 73 |
|
Also if several HOPMs are present in one channel they will all respond to !all, |
| 74 |
|
for example !all stats. |
| 77 |
|
Rehashing HOPM |
| 78 |
|
-------------- |
| 79 |
|
|
| 80 |
< |
A /kill to hopm will cause the process to restart, rehashing the configuration file |
| 80 |
> |
A /kill to HOPM will cause the process to restart, rehashing the configuration file |
| 81 |
|
and ending all queued scans. |
| 82 |
|
|
| 83 |
|
|
| 85 |
|
------- |
| 86 |
|
|
| 87 |
|
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 |
| 88 |
> |
which by default can be found at $HOME/hopm/var/hopm.log. There is also a |
| 89 |
|
config option to log all proxy scans initiated, which can be quite useful if |
| 90 |
|
you receive an abuse report related to portscanning. |
| 91 |
|
|
| 92 |
< |
These log files, especially the scan log, can grow quite large. It is |
| 93 |
< |
suggested that you arrange for these files to be rotated periodically. An |
| 94 |
< |
example shell script is provided in the contrib/logrotate directory. If you |
| 92 |
> |
These log files, especially the scan log, can grow quite large. It is |
| 93 |
> |
suggested that you arrange for these files to be rotated periodically. An |
| 94 |
> |
example shell script is provided in the contrib/logrotate directory. If you |
| 95 |
|
prefer to use the log rotation facilities of your operating system then you |
| 96 |
|
should send a USR1 signal to HOPM after moving its logfiles - this will cause |
| 97 |
|
HOPM to reopen those files. |
