Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SMTPRC(1)		     General Commands Manual		       SMTPRC(1)

NAME
     smtprc - SMTP Relay Checker

SYNOPSIS
     smtprc [OPTIONS] ...

DESCRIPTION
     smtprc  is  a  fully  configurable  multithreaded	open  mail  relay  scan-
     ner/checker. It can scan large networks for open relays and output the  re-
     sults  to a web page. It is intended for Systems Administrators to check IP
     blocks under their control.

OPTIONS
     -c config-file
	    The config file specified with this option contains a list	of  open
	    relay  checks  to be performed when scanning.  The file is comprised
	    of three columns, each of which is a different check to be performed
	    on the host being tested.  The first column will be  sent  with  the
	    HELO  command;  the  second  column will be sent with the MAIL FROM:
	    command; and the third column will be sent with the  RCPT  TO:  com-
	    mand.

	    example:

	    If the file contains the line.

	    x.x  diceman@dircon.co.uk	  diceman@dircon.co.uk

	    The following commands will be sent to the server.

	    HELO x.x

	    MAIL FROM:diceman@dircon.co.uk

	    RCPT TO:diceman@dircon.co.uk

	    The following macros can also be used.

	    --IP_ADDRESS-- Represents the IP address of the current server being
	    checked.

	    --HOSTNAME--  Represents the domain name of the current server being
	    checked.

	    --NAME-- Represents the name part of  the  email  address  specified
	    with the -b option

	    --DOMAIN-- Represents the domain part of the email address specified
	    with the -b option.

	    As long as the format of this file is adhered to then as many checks
	    as is required can be added to this file.

     -s ip-range
	    Specify  the  ip  range to scan. Smtprc has a powerful notation that
	    allows you to specify an IP address  range	using  lists/ranges  for
	    each  element.   Thus  you	can  scan  the	whole  class 'B' network
	    192.168/16 by  specifying  192.168.*.*   or  192.168.0-255.0-255  or
	    192.168.0-255.*   You  can	also  specify  multiple different ranges
	    sepreated by ',' For example 192.168.1.*,172.16.1.*  would scan both
	    ranges 192.168.1.0/24 and 172.16.1.0/24

     -i hostname-list
	    This option can be used instead of the -s option. The file specified
	    should contain a list of hostnames/IP addresses to	scan  sepereated
	    by newlines

     -w output-html-page
	    Use  this option to specify the name of a html file that the results
	    should be written to.

     -f output-text-file
	    Use this option to specify the name of a text file that the  results
	    should be written to.

     -o output-machine-readable-format-file
	    Use  this option to specify a file in which to save the scan results
	    in machine readable format.  Each scan will be  saved  on  a  single
	    line  with	values	seperated  by commas. The values will be: IP ad-
	    dress, Domain name, Rule no, STATUS, Banner, HELO reply, MAIL  FROM:
	    reply, RCPT TO: reply

     -b email-address
	    This  option  specifies  the email address that should be relayed to
	    while testing.

     -e <path to mailbox>
	    This option specifies the (mbox) mailbox relating to the  email  ad-
	    dress specied with the -b option.

     -u <path to mailbox>
	    This  option  specifies  the (maildir) mailbox relating to the email
	    address specied with the -b option.

     -y email-template-file
	    This option specifies the template to be used for  all  emails  sent
	    while testing.

     -j autoconfig-file
	    The  auto  config  file contains a list of configuration options for
	    running smtprc smtprc can then be run just by  specifying  the  auto
	    config file with this option. An auto config file can also be gener-
	    ated with the -k option.

     -k autoconfig-file
	    Use  this  option  to  generate an auto config file comprised of the
	    command line options currently being used.	smtprc can then  be  run
	    using the -j option.

     -p number-of-threads
	    Specify the number of threads to use when scanning (default 1000).

     -a     Display results of every scan (even those that passed all tests).

     -n     Try to resolve all ip addresses into hostnames.

     -m wait-for-mail-timeout
	    Specify  the  time	in  seconds to wait, after scanning, for relayed
	    mails to arrive.

     -l connection-timeout
	    Specify the connect timeout in seconds (default 30).

     -r read-timeout
	    Specify the read timeout in seconds (default 30).

     -v     Verbose output. Use twice for greater effect.

     -h     Display the help page.

FILES
     /usr/local/etc/smtprc/rcheck.conf
	    The relay check configuration file.  smtprc(1) for further details.

     /usr/local/etc/smtprc/email.tmpl
	    The email template file.  smtprc(1) for further details.

     /usr/local/etc/smtprc/auto.conf
	    The auto configuration file.  smtprc(1) for further details.

     /usr/share/doc/smtprc/README
	    The smtprc readme file. This file contains a detailed explanation of
	    all of smtprc's features.  smtprc(1) for further details.

EXAMPLES
     The following will scan the range 192.168.1.0/24 using 250  threads  trying
     to  relay to smtprc@lippy.warg.co.uk. It will also check the mbox mail file
     /var/mail/smtprc 1 minute after scanning to see if any mails have been  re-
     layed. It also display the results in html to /usr/local/apache/htdocs/smt-
     prc/html.	The  file  /use/local/etc/smtprc/email.tmpl  will be used as the
     template for emails that are sent through any servers that are scanned.

     This scan will also create the  file  /usr/local/etc/smtprc/auto.conf  con-
     taining all of the command line options just used.

     This  scan  is being run from lippy.warg.co.uk. Sendmail is running on this
     machine and accepting all mail for smtprc@lippy.warg.co.uk.

     smtprc   -s    192.168.1.*    -c	 /usr/local/etc/smtprc/rcheck.conf    -e
     /var/mail/smtprc -b smtprc@lippy.warg.co.uk -p 255 -w /usr/local/apache/ht-
     docs/smtprc.html  -k /usr/local/etc/smtprc/auto.conf -y /usr/local/etc/smt-
     prc/email.tmpl

     The next example will run smtprc taking all of the run  time  options  from
     the auto config file /usr/local/etc/smtprc/auto.conf

     smtprc -j /usr/local/etc/smtprc/auto.conf

BUGS
     Please report all bugs to diceman@dircon.co.uk.

SEE ALSO
     gsmtprc(1)

AUTHOR
     Spencer Hardy - diceman@dircon.co.uk

User Manuals			  DECEMBER 2004 		       SMTPRC(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=smtprc&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help