ip_in_range 0.9 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ce982f6035c1c22265c9731cd82028849946f92bf79273f115bde5bc0ffc5c
-  data.tar.gz: 4d66098e9a222e4ce323d1218e628813b19832fad4dcc0ae6cc9b99a6529899b
+  metadata.gz: f78cc554313b637067339aa2d806c605b6b7c585281fda8b8cdea2cc8362b7cc
+  data.tar.gz: 69f993155150a984ff2adb49690d6e4da65bc5d550ce28c754a6a9142450da8c
 SHA512:
-  metadata.gz: 2266b3e824cdcd0fd587d7736d593fa1471c6eca426d805b357565f27d6a66bfa5c45c8d919f48975c7757ebc7513a8bf1d14720746a786b48949775167f6d48
-  data.tar.gz: d29d2cafbc63f87206b8485625c3c16dd72f859964337b7f21da5d87b2cef7a01e6ec28d1b0196183a32f34174f4b7eef23c949de8c8abe16ac019d4cf083c80
+  metadata.gz: 6181974367f0bed559cd03efad8795f06476e610f847d72fa8b9896f70d70d2c7937d5b6010d3c3e343ea966281b9cbbe1aa8d8cf7e44f937ce0d444c8f8da11
+  data.tar.gz: 5ec959d9ce03441472a4a9da6f67a61c8ecfdc6f3e7d452d88292fdf48a284b0f024c8e2f404bd5f906029de234b08f849af569b5e7949c6e7e6983b0d104055

data/README.md

@@ -0,0 +1,80 @@
+# IP_In_Range
+Test an IP-address against a IP-range
+## SYNOPSIS
+To test on address:  
+> **ip_in_range first_in_range last_in_range ip_to_check**  
+
+To verify Received-headers:  
+> **ip_in_range < [email] first_in_range last_in_range
+
+or  
+> **ip_in_range < [email] [range_list.txt]**  
+where range_list.txt contains a list of IP-ranges, one per line
+
+## Description
+You can pipe-in an email-message to filter and name a text-file as only
+program-argument to ip_in_range. This text-file contains a simple list of
+IP-ranges, one per line, like:   
+
+> 192.168.0.1 192.168.0.255  
+> Some Evil Exemplary Range: 192.168.2.100 192.168.2.168  
+> 192.200.12.20 192.200.12.100 I do no  like this  
+> (...)  
+
+Text outside the IP-addresses is ignored by ip_in_range and can be used to comment an entry.
+### Use with Procmail
+Procmail can delegate tasks to external programs, either to react to a matching
+filter or to test a condition which depends on the exit code of a program. Such
+call of a program in the condition of a Procmail-filter is initiated with the **?**
+flag.  The recipe which tests if the Received-headers of a mail contain any
+IP-address from a range that you want to filter:  
+
+> :0  
+> \* !FROM_DAEMON  
+> \* !FROM_MAILER  
+> \* !^X-Loop: my_mail@address  
+> \* 1^0 ? ip_in_range ~/.procmail/range_list.txt  
+> /home/[path to my mail-folder]/refused/ip_refused   
+
+This way, all mail which matches the filter will be written to a mail-folder “ip_refused” in the sub-directory “refused” of my mail-folder.  
+
+ip_in_range writes to STDOUT some informative log-message, i.e. the positiv
+result of a test. You can thus know, which IP-address from a mail had been
+found in which IP-range. To make these messages appear in the procmail
+log-file, you can alter the condition in the above recipe to:  
+
+> \* 1^0 ? ip_in_range ~/.procmail/range_list.txt >> [logfile]  
+
+See the Procmail manual for more detailed explications.
+
+### Remarks about the pertinence of this kind of filter
+If you can, you should make your Mail-Transfer-Agent (MTA) filter mail and only
+fetch the mail you want to read. If you do not know how to do this, then the filter
+described above can be an alternative. If you do not use software like
+Exim (sendmail), Postfix and the like be however aware of the limits of the
+Procmail-solutions.
+
+Even better are server-side filters that you would not have to activate anew
+each time that you consult your mail-account. 
+
+Also, the author of IP_In_Range does not advocate filters against whole
+IP-ranges as an efficient way to fight SPAM. 
+
+## Other Information
+### Development and source code
+IP_In_Range has been written in Ruby. As Ruby is an interpreted programming
+language, the executable file and all those that it may refer to at one point
+in time, are themselves the source-files of the current program-version. You
+can open them in any text-editor to scrutinize the source-code. If you have
+received the program as a Ruby-gem, you can also decompress a copy of the
+gem-file with  
+*tar -x*, then *tar -xzf*. 
+
+**License**  
+  IP_In_Range is distributed under the conditions of the WTF 2.0 or later version  
+  of the license. See http://www.wtfpl.net/about/ for details.
+
+**Author**  
+  IP_In_Range has been developed by  
+  Michael Uplawski <michael.uplawski@uplawski.eu>
+Ω

data/bin/ip_in_range

@@ -2,38 +2,35 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   ©2021-2021, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *   ©2021-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 3 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   it under the terms of the WTFPL 2.0 or later, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
  *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 =end
+
 require_relative '../lib/ip_range'
 require_relative '../lib/email'
-require_relative '../lib/logging'
+require_relative '../lib/basic_logging'
 require_relative '../lib/file_checking'
 
-self.extend(Logging)
-log = init_logger(STDOUT)
+# log on class level
+extend BasicLogging
+set_target(STDOUT)
+set_level BasicLogging::INFO
 
 def usage
   prog = File.basename($0)
   usage = "\tUsage: " << prog << ' first_in_range last_in_range ip_to_check' 
   usage << "\n\tExample: " << prog << ' 192.168.1.100 192.168.1.255 192.168.10.100'
-  usage << "\n\t\t to verify Received-headers: cat mail | " << prog << " first_in_range last_in_range"
-  usage << "\n\t\t                         or: cat mail | " << prog << " <file>"
+  usage << "\n\tto verify Received-headers: cat mail | " << prog << " first_in_range last_in_range"
+  usage << "\n\t                        or: cat mail | " << prog << " <file>"
   usage << "\n\t\t where \"file\" contains a list of ip-ranges."
 end
 
@@ -51,61 +48,61 @@ elsif ARGV.length == 2
   if(!STDIN.tty?)
     mail = FMail.new(ARGF.read)
   else
-    log.error('No data to compare from STDIN – aborting!')
+    error('No data to compare from STDIN – aborting!')
     exit false
   end
   ips = mail.received.collect{|r| r.scan(IPR)}
   ips.flatten!
-  log.debug( 'ips: ' << ips.join(', '))
+  debug( 'ips: ' << ips.join(', '))
   ips.each do |ip|
     exit true if ip_range.in_range?(ip) 
   end
-  log.info('not in range')
+  info('not in range')
   exit false
   # 3) a text-file with ip-ranges, mail is piped in
 elsif ARGV.length == 1 
-  if(['-h', '--h'].none?{|h| h == ARGV[0]}) 
+  if(['-h', '--help'].none?{|h| h == ARGV[0]}) 
     list_file = ARGV[0]
     ARGV.clear
     if(!STDIN.tty?)
       mail = FMail.new(ARGF.read)
     else
-      log.error('No data waiting on STDIN – aborting!')
+      error('No data waiting on STDIN – aborting!')
       exit false
     end
     msg = File_Checking::file_check(list_file, [:file, :exist, :readable])
     if msg 
-      log.error( "File #{list_file} is unuseable: #{msg}. Aborting!" )
+      error( "File #{list_file} is unuseable: #{msg}. Aborting!" )
       exit false
     end
     ranges = File.readlines(list_file)
     ranges.each do |l| 
-      log.debug( "line is " << l)
+      debug( "line is " << l)
       if(!l.strip.empty? && !l.start_with?('#') )
         begin 
-          log.debug 'trying to extract an IP-range'
+          debug 'trying to extract an IP-range'
           range = l.scan(IPR).flatten
-          log.debug('testing range ' << range.to_s)
+          debug('testing range ' << range.to_s)
         rescue ArgumentError => msg
           er = 'Cannot interpret IP-range ' << l
           er << ': ' << msg
-          log.error(er)
+          error(er)
         rescue Exception => msg
-          log.error(msg)
+          error(msg)
         else 
-          log.debug( "range is " << range.to_s )
+          debug( "range is " << range.to_s )
           ip_range = IPRange.new(range) 
-          log.debug( "testing ip_range " << ip_range.vrange.to_s )
+          debug( "testing ip_range " << ip_range.vrange.to_s )
           ips = mail.received.collect{|r| r.scan(IPR)}
           ips.flatten!
-          log.debug( 'ips: ' << ips.join(', ') )
+          debug( 'ips: ' << ips.join(', ') )
           ips.each do |ip|
             isso = ip_range.in_range?(ip)
             msg = 'ip ' << ip << (isso ? ' is ' : ' is not ' ) << 'in range: ' << l
             if isso
-              log.info("\n" + msg)
+              info("\n" + msg)
             else
-              log.debug(msg)
+              debug(msg)
             end
             exit isso if isso
           end
@@ -117,7 +114,7 @@ elsif ARGV.length == 1
     puts usage
   end
 else
-  log.warn( "ERROR! Arguments missing" )
-  log.info( usage)
+  warn( "ERROR! Arguments missing" )
+  info( usage)
   exit false
 end