path: root/doc/pingd.conf.pod

=pod

=head1 NAME

pingd.conf - configuration file for the Echolot ping daemon

=head1 DESCRIPTION

The file B<pingd.conf> sets configuration parameters for Echolot pingd(1).
It is a Perl script that gets eval()ed from within pingd. It has to set the
values in the $CONFIG hash.

=cut

=head1 OPTIONS

=head2 REQUIRED OPTIONS

=over

=item B<sitename>

A short name for your site/pinger. It is used in the statistics produced.

	Default: none
	Example: 'sitename' => 'testsite',

=item B<my_localpart>

The local part of the pinger's email address.

In C<pinger@remailer.example.com> the localpart is C<pinger>.

	Default: none
	Example: 'my_localpart' => 'pinger',

=item B<my_domain>

The domain part (FQDN) of the pinger's email address.

In C<pinger@remailer.example.com> the domain part is C<remailer.example.com>.

	Default: none
	Example: 'my_domain' => 'remailer.example.com',

=item B<operator_address>

The email address of the human operator that runs this pinger.

	Default: none
	Example: 'operator_address' => 'remop@example.org',

It is used in several templates.

=back



=head2 SYSTEM SPECIFIC OPTIONS

=over

=item B<recipient_delimiter>

The B<recipient_delimiter> parameter specifies the separator between user names
and address extensions (user+foo).

If it is an empty string Echolot does not make use of user defined mailboxes
but rather encodes the message type etc in a Comment/Realname part of an
address.

The use of recipient_delimiter is strongly recommended if your MTA setup
supports it.

	Default: 'recipient_delimiter' => '+',
	Example: 'recipient_delimiter' => '-',
	         'recipient_delimiter' => '',

Example addresses:

with + as a recipient delimiter:
 pinger+conf.1=1035540778=1dd23d97@example.org

without recipient delimiter:
 pinger@example.org (conf.2=1035541597=3baa2ae5)

=item B<dev_random>

Where to read random data from.

	Default: 'dev_random' => '/dev/random',
	Example: 'dev_random' => '/dev/urandom',

=item B<sendmail>

Path to the sendmail binary. It is expected to accept the C<-f> and C<-t>
parameters.

	Default: 'sendmail' => '/usr/sbin/sendmail',
	Example: 'sendmail' => '/usr/lib/sendmail',

=back



=head2 MAGIC NUMBERS

=over

=item B<hash_len> [integer]

Echolot uses email addresses like C<foo+some_data=MAC@domain>. MAC
is Message Authentication Code used to verify that the address
was actually generated by this pinger using a secret which is set
from random data the first time you run B<pingd>. Echolot uses MD5
as the MAC hash function.

B<hash_len> is the number of characters to include in the email address.

	Default: 'hash_len' => 8,
	Example: 'hash_len' => 4,

=back



=head2 NEW REMAILERS

=over

=item B<fetch_new> [bool]

Query new remailers for remailer-xxx replies by default.

	Default: 'fetch_new' => 1,
	Example: 'fetch_new' => 0,

=item B<ping_new> [bool]

Ping new remailers by default.

	Default: 'ping_new' => 1,
	Example: 'ping_new' => 0,

=item B<show_new> [bool]

Show new remailers in public stats by default.

	Default: 'show_new' => 1,
	Example: 'show_new' => 0,

=back



=head2 STATISTICS GENERATION

=over

=item B<separate_rlists> [bool]

Also build separate rlists with data from only DSA pings, only RSA pings and
only unencrypted pings.

	Default: 'separate_realists' => 0,
	Example: 'separate_rlists' => 1,

=item B<combined_list> [bool]

Build a combined list of all different stats too. While there is no
standard format it is nice to read for the human eye.

	Default: 'combined_list' => 0,
	Example: 'combined_list' => 1,

=item B<thesaurus> [bool]

Collect Thesaurus data and build Thesaurus Index.

	Default: 'thesaurus' => 1,
	Example: 'thesaurus' => 0,

=item B<stats_sort_by_latency>

In the statistics output remailers are sorted by reliability as the primary key.
The secondary key is usually nickname. If you prefer to sort by latency rather
than nick set this to 1 (-1 if you want to reverse the order).

	Default: 'stats_sort_by_latency' => 0,
	Example: 'stats_sort_by_latency' => 1,


=back



=head2 TIMERS AND COUNTERS

=over

=item B<processmail> [seconds]

How often to process incoming email.

	Default: 'processmail' => 60, # every minute
	Example: 'processmail' => 5*60, # every 5 minutes

=item B<buildstats> [seconds]

How often to build mlist etc.

	Default: 'buildstats' => 5*60, # every 5 minutes
	Example: 'buildstats' => 60*60, # hourly

=item B<buildkeys> [seconds]

How often to build keyrings.

	Default: 'buildkeys' => 8*60*60, # every 8 hours
	Example: 'buildkeys' => 24*60*60, # daily

=item B<buildthesaurus> [seconds]

How often to update thesaurus index page.

	Default: 'buildthesaurus' => 60*60, # hourly
	Example: 'buildthesaurus' => 24*60*60, # daily

=item B<commitprospectives> [seconds]

How often to check for prospective new remailer addresses and
commit them to the list of remailers.

	Default: 'commitprospectives' => 8*60*60, # every 8 hours
	Example: 'commitprospectives' => 24*60*60, # daily

=item B<expire> [seconds]

How often to expire old keys, pings and remailers

	Default: 'expire' => 24*60*60, # daily
	Example: 'expire' => 8*60*60, # every 8 hours

=item B<getkeyconf_interval> [seconds]

=item B<getkeyconf_every_nth_time> [integer]

How often to query remailers for new keys and configuration data
(remailer-xxx). Some requests are sent every B<getkeyconf_interval>
seconds. The same request to the same remailer is sent only every 
B<getkeyconf_every_nth_time> time.

	Default: 'getkeyconf_interval'       => 5*60,    # send out requests every 5 minutes
	         'getkeyconf_every_nth_time' => 24*60/5, # send out the same request to the same remailer once a day
	Example: 'getkeyconf_interval'       => 10*60,
	         'getkeyconf_every_nth_time' => 2*24*60/10, # new request every other day

=item B<check_resurrection> [seconds]

How often to check assumed dead remailers for resurrection.

	Default: 'check_resurrection' => 7*24*60*60, # weekly
	Example: 'check_resurrection' => 14*24*60*60, # every other week

=item B<pinger_interval> [seconds]

=item B<ping_every_nth_time> [integer]

How often to send pings. Pings are sent every B<pinger_interval> seconds. The
same remailer is pinged every B<ping_every_nth_time> time pings are sent (This
means the same remailer is pinged every B<pinger_interval> *
B<ping_every_nth_time> seconds).  It is done this way in order to avoid
spikes.

	Default: 'pinger_interval'     => 5*60, # send out pings every 5 minutes
	         'ping_every_nth_time' => 48,   # send out pings to the same remailer every 48 calls, i.e. every 4 hours
	Example: 'pinger_interval'     => 60,    # send out pings every minute
	         'ping_every_nth_time' => 60,    # send out pings to the same remailer every 60 calls, i.e. every hour

=item B<addresses_default_ttl> [integer]

How many times to request remailer-xxx from a remailer (done every
B<getkeyconf> seconds, daily per default) without a reply before it is assumed
dead.

	Default: 'addresses_default_ttl' => 5, # getkeyconf seconds (days if getkeyconf is 24*60*60, the default)
	Example: 'addresses_default_ttl' => 7,

=item B<check_resurrection_ttl> [integer]

How many times to request remailer-xxx from an assumed dead remailer (done every
B<check_resurrection> seconds, weekly per default) without a reply before it is
really considered dead.

	Default: 'check_resurrection_ttl' => 8, # check_resurrection seconds (weeks if check_resurrection is 7*24*60*60, the default)
	Example: 'check_resurrection_ttl' => 4,

=item B<prospective_addresses_ttl> [seconds]

How long to keep information about a prospective address in the database.
Addresses that are not committed to the list of remailer addresses are
expired after this time.

	Default: 'prospective_addresses_ttl' => 5*24*60*60, # 5 days
	Example: 'prospective_addresses_ttl' =>14*24*60*60, # 2 weeks

=item B<reliable_auto_add_min> [integer]

How many different remailers need to list an address in Reliable's remailer-conf
reply to get it committed to the list of remailer addresses.

	Default: 'reliable_auto_add_min' => 3,
	Example: 'reliable_auto_add_min' => 5,

=item B<expire_keys> [seconds]

After how long to expire received keys if they were not updated by remailer-key replies.

	Default: 'expire_keys' => 5*24*60*60, # 5 days
	Example: 'expire_keys' => 7*24*60*60, # 1 week

=item B<expire_confs> [seconds]

After how long to expire received remailer-conf replies.

	Default: 'expire_confs' => 5*24*60*60, # 5 days
	Example: 'expire_confs' => 7*24*60*60, # 1 week

=item B<expire_pings> [seconds]

After how long to expire pings. 12 is the value of choice
because that is the time frame the statistics show. You should
not make this smaller than 12 days.

	Default: 'expire_pings' => 12*24*60*60, # 12 days

=item B<expire_thesaurus> [seconds]

After how long to expire files in the thesaurus directory.

	Default: 'expire_thesaurus' => 21*24*60*60, # 2 weeks
	Example: 'expire_thesaurus' => 7*24*60*60, # 1 week

=item B<metadata_backup> [seconds]

How often to make backups of metadata and rotate them. If gzip is set, backups
are compressed.

	Default: 'metadata_backup' => 8*60*60, # 8 hours
	Example: 'metadata_backup' => 24*60*60, # daily

=item B<metadata_backup_count> [integer]

How many backups of metadata to keep.

	Default: 'metadata_backup_count' => 32, # keep the last 32 backups
	Example: 'metadata_backup_count' => 4, # keep 4 rotations

=back


=head2 DIRECTORIES AND FILES

=over

=item B<homedir>

The base directory of the Echolot installation. All other filenames and
directory names are local to this directory. B<pingd> changes into this
directory upon startup.

	Default: The directory in which pingd is.
	Example: 'homedir' => '/home/pinger/echolot',

=item B<mailin>

The Maildir directory or Mbox which is searched for new messages.

	Default: 'mailin' => 'mail',
	Example: 'mailin' => '/var/mail/echolot',

=item B<mailerrordir>

The Maildir directory where messages are put that could not be parsed.

	Default: 'mailerrordir' => 'mail-errors',

=item B<resultdir>

The directory where statistics and keyrings are put.

	Default: 'resultdir' => 'results',

=item B<thesaurusdir>

The directory where Thesaurus data is put.

	Default: 'thesaurusdir' => 'results/thesaurus',

=item B<thesaurusindexfile>

The Thesaurus index file.

	Default: 'thesaurusindexfile' => 'results/thesaurus/index',

=item B<private_resultdir>

The directory where private stats and keyrings are put (Remailers that have
show set to false are shown here too).

	Default: 'private_resultdir' => 'results',

=item B<indexfilebasename>

The file to write the index.html to (relative to the result directory).

	Default: 'indexfilebasename' => 'echolot',
	Example: 'indexfilebasename' => 'index',

=item B<gnupghome>

The directory which is used as temporal GnuPG home for all keyring and
encryption/decryption actions.

	Default: 'gnupghome' => 'gnupghome',

=item B<gnupg>

Name of the GnuPG executable. If it is not in your PATH make sure to
include path information.

If B<gnupg> is an empty string, the C<GnuPG::Interface> default (usually B<gpg>)
is used.

	Default: 'gnupg' => '',
	Example: 'gnupg' => '/home/pinger/bin/myGnuPG',

=item B<gzip>

Name of the gzip executable. If it is not in your PATH make sure to
include path information.

	Default: 'gzip' => 'gzip',

=item B<mixhome>

The directory which is used as temporal Mixmaster home for all keyring and
encryption/decryption actions.

	Default: 'mixhome' => 'mixhome',
	Example: 'mixhome' => '/home/pinger/Mix',

=item B<mixmaster>

Name of the mixmaster executable. If it is not in your PATH make sure to
include path information.

	Default: 'mixmaster' => 'mix',
	Example: 'mixmaster' => '/home/pinger/Mix/mix',

=item B<tmpdir>

General purpose temp directory. Make sure it is not shared with other
applications.

	Default: 'tmpdir' => 'tmp',

=item B<commands_file>

A file where commands to the daemon process are stored. The client
puts commands (like add a new remailer) in it and then sends a HUP
to the daemon process which reads and empties the file.

	Default: 'commands_file' => 'commands.txt',

=item B<pidfile>

The daemon's PID file. The daemon's Process ID is stored in this file.
As long as it exists pingd refuses to start up in daemon mode.

	Default: 'pidfile' => 'pingd.pid',

=item B<broken1>

File listing broken type I remailer chains. If it does not exist, the part is
skipped in generated stats. Otherwise its content is copied in verbatim.

	Default: 'broken1' => 'broken1.txt',
	Example content:
		(havenco cmeclax)
		(frog3 nycrem)

=item B<broken2>

File listing broken type II remailer chains. If it does not exist, the part is
skipped in generated stats. Otherwise its content is copied in verbatim.

	Default: 'broken2' => 'broken2.txt',
	Example content:
		(freedom lcs)
		(* xganon)

=item B<sameop>

File listing remailers that have the same operator or share a machine or other
important infrastructure.  If it does not exist, the part is skipped in
generated stats. Otherwise its content is copied in verbatim.

	Default: 'sameop' => 'sameop.txt',
	Example content:
		(xganon2 xganon)
		(cracker redneck)

=back


=head2 LOGGING

=over

=item B<logfile>

File to write logs to.  This file is reopened on SIGHUP.

	Default: 'logfile' => 'pingd.log',
	Example: 'logfile' => '/var/log/echolot/pingd.log',

=item B<loglevel>

Minimum severity of messages to include in log file. Possible values are
B<debug>, B<info>, B<notice>, B<warning>, B<error>, B<critical>, B<alert>, and
B<emergency>.

	Default: 'loglevel' => 'info',
	Example: 'loglevel' => 'debug',

=back


=head2 MISCELLANEOUS

=over

=item B<write_meta_files> [bool]

Whether to write meta files for each created file. These files include
meta information for http servers and http clients like the date when
a specific page expires.

	Default: 'write_meta_files' => 1,

=item B<meta_extension>

The extension that such metafiles (see above) should have.

	Default: 'meta_extension' => '.meta',

=back

=head2 PINGING TYPES

=over

=item B<do_pings>

B<do_pings> determines which ping types are sent.
It is a hash that has the following keys:

=over

=item B<cpunk-dsa>

Send out CPunk pings to CPunk remailers with their DSA key.

=item B<cpunk-rsa>

Send out CPunk pings to CPunk remailers with their RSA key.

=item B<cpunk-clear>

Send out unencrypted pings to CPunk remailers that don't have pgponly
in their capsstring.

=item B<mix>

Pings mixmaster remailers.

=back

	Default: 'do_pings' => {
	   'cpunk-dsa' => 1,
	   'cpunk-rsa' => 1,
	   'cpunk-clear' => 1,
	   'mix' => 1
	  },

=back

=head2 TEMPLATES

=over

=item B<templates>

The template files are used to generate the HTML version of all Echolot output.
It is a hash of hashes which each have following keys:
B<thesaurusindexfile>,
B<mlist>,
B<mlist2>,
B<rlist>,
B<rlist-rsa>,
B<rlist-dsa>,
B<rlist-clear>,
B<rlist2>,
B<rlist2-rsa>,
B<rlist2-dsa>,
B<rlist2-clear>, and
B<clist>.

The outer hash keys are for language selection.

	Default: 'templates' => {
	    'default' => {
		    'thesaurusindexfile' => 'templates/thesaurusindex.html',
		    'mlist'              => 'templates/mlist.html',
		    'mlist2'             => 'templates/mlist2.html',
		    'rlist'              => 'templates/rlist.html',
		    'rlist-rsa'          => 'templates/rlist-rsa.html',
		    'rlist-dsa'          => 'templates/rlist-dsa.html',
		    'rlist-clear'        => 'templates/rlist-clear.html',
		    'rlist2'             => 'templates/rlist2.html',
		    'rlist2-rsa'         => 'templates/rlist2-rsa.html',
		    'rlist2-dsa'         => 'templates/rlist2-dsa.html',
		    'rlist2-clear'       => 'templates/rlist2-clear.html',
		    'clist'              => 'templates/clist.html',
	    },
	    'de' => { 
		   'thesaurusindexfile' => 'templates/thesaurusindex.de.html',
		   ....
	    },
	    'pl' => { 
		   'thesaurusindexfile' => 'templates/thesaurusindex.pl.html',
		   ....
	    }
	  };

=item B<echolot_css>

Location of the CSS file. This is copied to resultdir/echolot.css.

	Default: 'echolot_css'               => 'templates/echolot.css',

=back



=head2 STRINGS

=over

=item B<remailerxxxtext>

The text to send along with remailer-xxx queries.
The template variables address and operator_address are substituted for their
real values.

	Default: 'remailerxxxtext' => "Hello,\n".
	    "\n".
	    "This message requests remailer configuration data. The pinging software thinks\n".
	    "<TMPL_VAR NAME=\"address\"> is a remailer. Either it has been told so by the\n".
	    "maintainer of the pinger or it found the address in a remailer-conf or\n".
	    "remailer-key reply of some other remailer.\n".
	    "\n".
	    "If this is _not_ a remailer, you can tell this pinger that and it will stop\n".
	    "sending you those requests immediately (otherwise it will try a few more times).\n".
	    "Just reply and make sure the following is the first line of your message:\n".
	    "   not a remailer\n".
	    "\n".
	    "If you want to talk to a human please mail <TMPL_VAR NAME=\"operator_address\">.\n",

=back

=head1 AUTHOR

Peter Palfrader E<lt>peter@palfrader.orgE<gt>

=head1 BUGS

Please report them at E<lt>URL:http://savannah.gnu.org/bugs/?group=echolotE<gt>

=cut