From: michael Date: Mon, 22 Dec 2014 13:54:58 +0000 (+0000) Subject: - Update INSTALL & README X-Git-Tag: 1.0.0beta1~78 X-Git-Url: http://git.serene-ircd.net/?a=commitdiff_plain;h=02893ab4325c73335eae9407e08ae01394486ae1;p=hopm.git - Update INSTALL & README git-svn-id: svn://svn.ircd-hybrid.org/svnroot/hopm/trunk@5060 82007160-df01-0410-b94d-b575c5fd34c7 --- diff --git a/INSTALL b/INSTALL index 98f4f53..086e21b 100644 --- a/INSTALL +++ b/INSTALL @@ -6,18 +6,18 @@ Make 1. ./configure 2. make 3. make install - 4. cd $HOME/bopm - 5. edit $HOME/bopm/etc/bopm.conf to suit - 6. $HOME/bopm/bin/bopm + 4. cd $HOME/hopm + 5. edit $HOME/hopm/etc/hopm.conf to suit + 6. $HOME/hopm/bin/hopm In detail: ./configure has a few options which you might need: - --prefix Sets the root of BOPM's install. By default this - is $HOME/bopm, with binaries going in - $HOME/bopm/bin, config in $HOME/bopm/etc and logs - in $HOME/bopm/var. + --prefix Sets the root of HOPM's install. By default this + is $HOME/hopm, with binaries going in + $HOME/hopm/bin, config in $HOME/hopm/etc and logs + in $HOME/hopm/var. --bindir Specify the place to install binaries. By default this is $PREFIX/bin. (see --prefix, above) @@ -33,25 +33,25 @@ Make configure at some point. If you think you need to change these then we assume you've read the code and know why. - Compilation of BOPM requires GNU Make (usually 'gmake' on BSD systems). + Compilation of HOPM requires GNU Make (usually 'gmake' on BSD systems). Configuration ------------- - Edit bopm.conf as needed. Most options are self explanatory and + Edit hopm.conf as needed. Most options are self explanatory and contain a short description. Please take note of the target_string, this is new in version 2 onward and may be different for your ircd. Because we now check that we really have - connected back onto IRC, BOPM needs to be told what your ircd says during + connected back onto IRC, HOPM needs to be told what your ircd says during the first part of a connection. If you're not sure, the best thing to do is telnet to your ircd from your shell, e.g.: - [andy@fullers bopm]$ telnet porkscratchings.someserver.org 6667 + [andy@fullers hopm]$ telnet porkscratchings.someserver.org 6667 Trying 207.8.219.202... Connected to porkscratchings.someserver.org. Escape character is '^]'. - :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Looking up your hostname... + :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Looking up your hostname :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Checking Ident :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Got Ident response :porkscratchings.pa.us.someserver.org NOTICE AUTH :*** Found your hostname @@ -81,18 +81,18 @@ Configuration Execution --------- - You can run BOPM from any directory, the path to its config file is + You can run HOPM from any directory, the path to its config file is compiled into it. The bot will fork and connect to the IRC server immediately. Any errors and debug information can be found in - $PREFIX/var/bopm.log. + $PREFIX/var/hopm.log. - You can tell BOPM to use a different config file with the -c argument, + You can tell HOPM to use a different config file with the -c argument, this works the same way that wgmon's -c argument does, just give the name of the config file not including the ".conf". This also affects the log - and PID files i.e. ./bopm -c myserver will read from myserver.conf, log to + and PID files i.e. ./hopm -c myserver will read from myserver.conf, log to myserver.log and write PID to myserver.pid. If you do not use -c, the - files bopm.conf, bopm.log and bopm.pid will be used by default. This can - be altered in options.h. This is useful for running multiple BOPM on + files hopm.conf, hopm.log and hopm.pid will be used by default. This can + be altered in options.h. This is useful for running multiple HOPM on the same host. Further debugging can be enabled by using one or more -d switches. One or diff --git a/README b/README index 26a6163..71024b9 100644 --- a/README +++ b/README @@ -1,15 +1,15 @@ Introduction ------------ -BOPM (Blitzed Open Proxy Monitor) is an open proxy monitoring bot designed for -Bahamut and Hybrid based ircds. The bot is designed to monitor an individual -server (all servers on the network have to run their own bot) with a local o: -line and monitor connections. When a client connects to the server, BOPM will +HOPM (Hybrid Open Proxy Monitor) is an open proxy monitoring bot designed for +Hybrid based ircds. The bot is designed to monitor an individual server (all +servers on the network have to run their own bot) with a local operator {} +block and monitor connections. When a client connects to the 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). -BOPM is written ground-up in C language, concept derived from wgmon. It +HOPM is written ground-up in C language, concept derived from wgmon. It improves on wgmon with HTTP support, faster scanning (it can scan clients simultaneously), better layout (scalability), and dnsbl support. @@ -17,7 +17,7 @@ simultaneously), better layout (scalability), and dnsbl support. Requirements ------------ -o An IRCd which presents connection notices in a format which BOPM +o An IRCd which presents connection notices in a format which HOPM recognises (see below). o A host with full connectivity for all the ports you wish to scan. i.e. is @@ -25,8 +25,7 @@ o A host with full connectivity for all the ports you wish to scan. i.e. is transparently proxied and this produces completely unpredictable results, sometimes as severe as 100% of clients being K:lined! -o A unix OS with GNU Make, an ANSI C compiler, etc.. BOPM probably does - compile and work on win32 under cygwin, but we won't support it. +o A unix OS with GNU Make, a C99 compiler, etc.. o Permission from your users to portscan them for open proxies. @@ -34,36 +33,22 @@ o Permission from your users to portscan them for open proxies. Compatibility ------------- -Bahamut (tested with 1.4.28 -> 1.4.34) -Hybrid (tested with 2.8/hybrid-5.3p8, ircd-hybrid-6.3 and ircd-hybrid-7) -Unreal (tested with 3.1.2 and 3.2) -Dancer (tested with 1.0.31) -Ultimate IRCD (tested with UltimateIRCd(Tsunami)-3.0(00).a22) - please -note, earlier versions of Ultimate IRCD are *not* supported +ircd-hybrid 8.2.1 -BOPM is designed for the Bahamut and Hybrid IRCds. It is easily -suitable for any other ircd with little modification (connregex in bopm.conf). -However, if an ircd does not send IP's in a connection notice (bahamut sends -[IP]), BOPM will not be effective because the time it takes to resolve a -hostname would be a significant factor to BOPM's efficiency. - -If you want to use BOPM but you don't think your ircd supports it then please -contact us. As long as source is available for your ircd then we can almost -certainly make BOPM work with it. - -Any questions regarding compatibility should be sent to the developers. If -feasible we might be able to add compatibility to multiple ircd types to the -project in the future. +HOPM is designed for ircd-hybrid. It is easily suitable for any other ircd with +little modification (connregex in hopm.conf). However, if an ircd does not send +IP's in a connection notice, HOPM will not be effective because the time it takes +to resolve a hostname would be a significant factor to HOPM's efficiency. Command Line Options -------------------- --c Config name. By default BOPM reads bopm.conf, "-c foo" - will cause BOPM to read foo.conf. The primary use for - this is to run multiple BOPMs from one directory. +-c Config name. By default HOPM reads hopm.conf, "-c foo" + will cause HOPM to read foo.conf. The primary use for + this is to run multiple HOPMs from one directory. --d Debug mode. BOPM will not fork, and will write logs to stderr. +-d Debug mode. HOPM will not fork, and will write logs to stderr. Multiple -d increase debug level. @@ -71,30 +56,30 @@ Operator Channel Commands ------------------------- botnick check [scanner] -- Manually scan host for insecure proxies and output all errors. - If scanner is not given, bopm will scan on all scanners. + If scanner is not given, hopm will scan on all scanners. NOTE: this will NOT add a kline (or whatever) if it finds a - proxy. This is a change from 2.x. + proxy. botnick stats -- Output scan stats, uptime and client connection count. botnick fdstat -- Output some into about file descriptors in use. -Also if several BOPMs are present in one channel they will all respond to !all, +Also if several HOPMs are present in one channel they will all respond to !all, for example !all stats (fixed in BOPM 3.1.0). -Rehashing BOPM +Rehashing HOPM -------------- -A /kill to bopm will cause the process to restart, rehashing the configuration file +A /kill to hopm will cause the process to restart, rehashing the configuration file and ending all queued scans. Logging ------- -Once started, BOPM logs all significant events to a file called "bopm.log" -which by default can be found at $HOME/bopm/var/bopm.log. There is also a +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 config option to log all proxy scans initiated, which can be quite useful if you receive an abuse report related to portscanning. @@ -102,70 +87,17 @@ These log files, especially the scan log, can grow quite large. It is suggested that you arrange for these files to be rotated periodically. An example shell script is provided in the contrib/logrotate directory. If you prefer to use the log rotation facilities of your operating system then you -should send a USR1 signal to BOPM after moving its logfiles - this will cause -BOPM to reopen those files. +should send a USR1 signal to HOPM after moving its logfiles - this will cause +HOPM to reopen those files. Support ------- -BOPM has a mailing list for general discussion and announcements. CVS -commit emails are also sent there and that is also the place to mail your -patches (unless they are massive, in which case just post a URL). You can -subscribe to this list from: - - http://lists.blitzed.org/listinfo/bopm - -Also check if your question is answered on the BOPM FAQ: - - http://blitzed.org/bopm/faq.phtml - -No IRC support currently exists for BOPM. If you would like to run such a -support channel, please let us know so that we can list it here. - - -Compatibility Notes -------------------- - -o Unreal Ircd - - For *older* versions of Unreal to work, patches to fix the HCN connect - notices (found at http://www.blitzed.org/files/) must be applied. - - Unreal 3.1.3 seems to require opers to be global if they are to see - connection notices. - -- prince@avalon.zirc.org - - Later versions of Unreal require different user modes to be set on BOPM for - it to see connection notices. You will need to use - - mode = "+sc"; - - in your bopm.conf. Also later versions of Unreal no longer require patching - as described above. - -- prince@avalon.zirc.org - -o IRCu - - IRCu does not present a banner to clients when they connect, so - target_string, target_ip and target_port must use some other service besides - ircd. For those with root access to their servers, the following inetd.conf - example is an easy fix for this: - - # BOPM proxy check string - 16667 stream tcp nowait nobody /bin/echo echo Open Proxy Check - - target_string can then be set to "Open Proxy Check", and target_ip/target_port - set to your IP and port 16667. - - If you don't want to do the above, you could use any other service on - your machine that presents a banner. We would recommend against using - port 25 because it is common for providers to transparently proxy port - 25. - - Also, to see connect notices, your bopm should set itself umode "+s +16384". - There is a config file item for setting umodes. - + * Bug Reports: + - bugs@ircd-hybrid.org + * IRC contact: + - #ircd-coders on irc.ircd-hybrid.org Credits -------