/[pkg-mixmaster]/trunk/Mix/mixmaster.1

Diff of /trunk/Mix/mixmaster.1

Parent Directory | Revision Log | View Patch Patch

-revision 38 by rabbi,
Wed Dec 12 18:50:59 2001 UTC
+revision 545 by weaselp,
Mon Jul  7 11:18:20 2003 UTC
 Line 1
  .TH MIX 1 "Mixmaster Version 3.0 beta"
- .\" $Id: mix.1,v 1.2 2001/12/12 18:50:59 rabbi Exp $
+ .\" $Id: mix.1,v 1.31 2003/07/07 11:18:20 weaselp Exp $
  .SH NAME
  mix \- anonymous remailer software
  .SH SYNOPSIS
 Line 32 
 In the non-interactive mode, Mixmaster r
  standard input or from a file.  Destination address and input file can
  be specified in the command line.  If no address is given in the
  command line, the input file is expected to contain a message complete
- with mail headers.  Messages to be send under a pseudonym must contain
+ with mail headers.  Messages to be sent under a pseudonym must contain
  a
  .I Nym:
  header rather than
 Line 42 
 header rather than
  .B "\-h, \-\-help"
  Print a summary of command line options.
  .TP
+ .B "\-\-config=\fIfilename"
+ Read configuration from an alternate file.
+ .TP
  .B "\-t, \-\-to=\fIuser@host"
  Add the destination address(es) to the message header. The input file
  contains the message body without headers.
-Line 107 
 Send the message(s) from the pool.
+Line 110 
 Send the message(s) from the pool.
  Output informational messages.
  .TP
  .B "\-f\fR [\fIfile\fR]"
- Read a mail folder. This function requires ncurses support.
+ Read a mail folder or news article. This function requires ncurses support.
  .TP
  .B "\-fr\fR [\fIfile\fR]"
  Reply to a message.
-Line 141 
 Reply chain latency.
+Line 144 
 Reply chain latency.
  Reply chain for the pseudonym.
  .SS Remailer options:
  .TP
+ .B "\-\-config=\fIfilename"
+ Read configuration from an alternate file.
+ .TP
  .B \-R, \-\-read\-mail
  Read a remailer message from standard input and store it in the pool.
  .TP
+ .B \-I, \-\-store\-mail
+ Read a remailer message from standard input and store it in the pool
+ without decrypting it immediately. It will be processed the next time
+ Mixmaster processes the queue (called with \fP-M\fP or in daemon mode).
+ .TP
  .B \-P, \-\-pop-mail
  Read mail from the POP3 servers listed in
  .BR pop3.cfg .
-Line 155 
 internal files up\-to\-date.
+Line 166 
 internal files up\-to\-date.
  .TP
  .B \-D, \-\-daemon
  Detach from the console and process the pool, get mail and update the
- internal files in regular intervals.
+ internal files at regular intervals.
+ .TP
+ .B \-\-no-detach
+ Run as daemon but do not detach from the terminal (This option is
+ only useful together with \fB--daemon\fP).
  .TP
  .B -G, \-\-generate\-key
  Generate a new remailer key.
-Line 223 
 Default:
+Line 238 
 Default:
  .B DISTANCE
  When selecting random remailers, the chain will contain
  .I DISTANCE
- other remailers between two occurences of the
+ other remailers between two occurrences of the
  same remailer in the chain. Default:
  .BR 2 .
  .TP
-Line 240 
 as the final remailer. Default:
+Line 255 
 as the final remailer. Default:
  .BR 99 .
  .TP
  .B MAXLAT
- Only select remailers with a latency of maximally
+ Only select remailers with a latency of at most
  .IR MAXLAT .
  Default:
  .BR 36h .
  .TP
  .B PGPPUBRING
  Path to your public PGP key ring. Default:
- .BR ~/.pgp/pubring.pgp .
+ .BR ~/.pgp/pubring.pkr .
  (Windows default: PGP registry value.)
  .TP
  .B PGPSECRING
  Path to your secret PGP key ring. Default:
- .BR ~/.pgp/secring.pgp .
+ .BR ~/.pgp/secring.skr .
  (Windows default: PGP registry value.)
- .SS Remailer configuration:
+ .TP
+ .B CLIENTAUTOFLUSH
+ If
+ .B REMAIL
+ is set to
+ .BR n
+ automatically flush the pool every time mixmaster is run. Default:
+ .BR n .
  .TP
  .B SENDMAIL
  Path to the
-Line 275 
 rather than by
+Line 297 
 rather than by
  .BR sendmail (1).
  .TP
  .B HELONAME
- Name used in the SMTP dialogue.
+ Host name used in the SMTP dialogue.
  Default: The
  .I ENVFROM
  host name or the current network name associated with the socket.
  .TP
+ .B SMTPUSERNAME
+ Some mail servers require authentication for sending mail. This is
+ the authenticated SMTP user name.
+ .B SMTPPASSWORD
+ Password for authenticated SMTP.
+ .TP
  .B ENVFROM
  Envelope from address used in the SMTP dialogue. (When the client is
  used to send non-anonymous messages,
-Line 287 
 used to send non-anonymous messages,
+Line 315 
 used to send non-anonymous messages,
  is used instead.)
  Default:
  .IR ANONADDR .
+ .SS Remailer configuration:
  .TP
  .B NEWS
  Path to the news posting program, or address of a
-Line 355 
 it specifies the path to a program. If i
+Line 384 
 it specifies the path to a program. If i
  .B @
  sign, the message is forwarded to the given address (with an
  .B X-Loop:
- header to prevent mail loops), otherwise the message is appended
+ header to prevent mail loops). If it ends with a
+ .B /
+ it is treated as a Maildir, otherwise the message is appended
  to the given file name or written to standard output if
- .B MAIL
+ .B MAILBOX
  is
  .BR stdout .
  Default:
-Line 398 
 errors. Default:
+Line 429 
 errors. Default:
  Mail folder for bounce messages. Default:
  .IR MAILBOX .
  .TP
+ .B MAILIN
+ If defined an additional mail folder where Mixmaster should read messages from
+ when processing its pool. If it ends with a
+ .B /
+ it is treated as a Maildir, otherwise a standard mbox format file
+ is expected. All messages are removed from the folder after reading.
+ .B MAILIN
+ is not set by default.
+ It is an incredibly bad idea to set this the same as \fBMAILBOX\fP.
+ .TP
  .B VERBOSE
  If
  .B VERBOSE
  is set to
  .BR 0 ,
  Mixmaster will log error
- messagess only. If it is set to
+ messages only. If it is set to
  .BR 1 ,
- error message and warnings are logged. If
+ error messages and warnings are logged. If
  .B VERBOSE
  is set to
  .BR 2 ,
-Line 416 
 If set to
+Line 457 
 If set to
  a log file entry is created whenever a message
  enters or leaves the pool.  Default:
  .BR 2 .
+ .TP
+ .B PASSPHRASE
+ A passphrase used to protect the remailer secret keys from
+ casual attackers. This setting overrides the compile-time
+ defined
+ .B COMPILEDPASS
+ which is now deprecated.
+ This should
+ .I not
+ be the same as the client passphrase.
  .PP
  The following variables can be set to
  .B y
-Line 424 
 or
+Line 475 
 or
  .TP
  .B REMAIL
  Enable remailer functionality. Default:
- .BR y .
+ .BR n .
  .TP
  .B MIDDLEMAN
  Act as an intermediate hop only, forward anonymized
- messages to an other remailer. This mode can be used
+ messages to another remailer. This mode can be used
  where complaints about anonymous messages must be
  avoided. (The variable
  .B FORWARDTO
  specifies the remailer
  chain to be used; default:
  .BR * .)
  Default:
  .BR n .
-Line 470 
 Default:
+Line 521 
 Default:
  Filter out binary attachments. Default:
  .BR n .
  .TP
+ .B LISTSUPPORTED
+ List known remailers and their keys in remailer-conf reply. Default:
+ .BR y .
+ .TP
  .B MID
  Use a hash of the message body as Message-ID, to avoid
  Usenet spam. Default:
-Line 488 
 file by sending the remailer a message c
+Line 543 
 file by sending the remailer a message c
  .BR destination-block .
  Default:
  .BR y .
+ .TP
+ .B STATSDETAILS
+ List statistics on intermediate vs. final delivery in remailer-stats.
+ Default:
+ .BR y .
  .PP
  The following variables have numeric values:
  .TP
  .B POOLSIZE
  The size of the Mixmaster reordering pool. Larger sizes
- imply higher security and longer delays. Default:
+ imply higher security and longer delays. Remailer default:
+ .BR 20 .
+ Client default:
  .BR 0 .
  .TP
  .B RATE
- Percentage of messages from the pool to be sent. Default:
+ Percentage of messages from the pool to be sent. Remailer default:
+ .BR 95 .
+ Client default:
  .BR 100 .
  Lower values cause the pool to increase in size when
- many messages are recieved at a time, reducing the effect
+ many messages are received at a time, reducing the effect
  of flooding attacks.
  .TP
+ .B INDUMMYP
+ Probability that Mixmaster will generate dummy messages upon
+ receipt of incoming mail. Larger numbers mean more dummy
+ messages on average. For instance,
+ .B 10
+ means that on average one in nine incoming messages will trigger
+ a dummy generation, and
+ .B 20
+ means that one in four will.
+ .B 0
+ means no dummy messages. Remailer default:
+ .BR 20 .
+ Client default:
+ .BR 3 .
+ .TP
+ .B OUTDUMMYP
+ Probability that Mixmaster will generate dummy messages at
+ .B SENDPOOL
+ time. If the pool is processed frequently, this should be a lower value
+ than if there are long intervals between pool processing. Examples:
+ .B 50
+ means on average, one dummy message will be generated per pool
+ processing.
+ .B 80
+ means four will be generated.
+ .B 0
+ means no dummy messages. Remailer default:
+ .BR 67 .
+ Client default:
+ .BR 3 .
+ .TP
  .B SIZELIMIT
- Maximal size for anonymous messages in kB.
+ Maximum size for anonymous messages in kB.
  .B 0
  means no limit.
  Default:
  .BR 0 .
  .TP
  .B POP3SIZELIMIT
- Maximal size for incoming messages in kB when using POP3.
+ Maximum size for incoming messages in kB when using POP3.
  .B 0
  means no limit.
  Default:
-Line 523 
 is set to
+Line 618 
 is set to
  and left on the server otherwise.
  .TP
  .B INFLATEMAX
- Maximal size for
+ Maximum size for
  .B Inflate:
  padding in kB.
  .B 0
-Line 533 
 Default:
+Line 628 
 Default:
  .BR kB .
  .TP
  .B MAXRANDHOPS
- Maximal chain length for message forwarding requested by
+ Maximum chain length for message forwarding requested by
  .B Rand-Hop
  directives.
  Default:
- .BR 20 .
+ .BR 4 .
+ .TP
+ .B MAXRECIPIENTS
+ limits the number of allowed recipients in outgoing mail.  Anything that exceeds this
+ number is dropped silently.  Default:
+ .BR 5 .
  .PP
  The following are time variables. They can be given as days, hours, or
  minutes.
  .TP
  .B SENDPOOLTIME
  How often Mixmaster should check the pool for messages
- to be sent. Default:
+ to be sent. Remailer default:
  .BR 1h .
+ Client default:
+ .BR 0h .
  .TP
  .B POP3TIME
  How often Mixmaster should check the POP3 accounts
-Line 555 
 for new mail.
+Line 657 
 for new mail.
  Default:
  .BR 1h .
  .TP
+ .B MAILINTIME
+ How often Mixmaster should read mail from
+ .BR MAILIN
+ and process mails fetched via POP3. Processing here means to
+ answer remailer-xxx requests and decrypt messages to the Mixmaster
+ and place them in the pool. No other processing of the pool is
+ done. This action is always performed sending out messages from the pool (at
+ .BR SENDPOOLTIME
+ intervals) or receiving mail via POP3 (at
+ .BR POP3TIME
+ intervals). Default:
+ .BR 5m .
+ .TP
  .B PACKETEXP
- How long to store parts of incomplete multipart messages.
+ How long to store parts of incomplete multipart messages and other
+ temporary pool files.
  Default:
  .BR 7d .
  .TP
-Line 575 
 no log is kept.
+Line 691 
 no log is kept.
  .PP
  The following strings must be specified at compile-time in
  .BR config.h .
- Usually it is not necessary to modify any of these:
+ It is not usually necessary to modify any of these:
  .TP
  .B
  DISCLAIMER
-Line 598 
 line and no
+Line 714 
 line and no
  .B fromdscl.txt
  file is available.
  .TP
+ .B MSGFOOTER
+ A default string to be inserted at the bottom of the message body
+ of all anonymous messages if no
+ .B footer.txt
+ file is available.
+ .TP
  .B BINDISCLAIMER
  A string to replace the body of a binary attachment when
  the remailer is configured to filter out binaries.
-Line 606 
 the remailer is configured to filter out
+Line 728 
 the remailer is configured to filter out
  The character set used for MIME-encoded header lines.
  .TP
  .B DESTBLOCK
  A quoted list of files that contain blocked addresses.
  Files must be separated by one space. Mixmaster will choose
- the first file for writing
+ the first file for writing if
  .B AUTOBLOCK
  is enabled.
  .PP
-Line 617 
 The following variables can be set in th
+Line 739 
 The following variables can be set in th
  or in
  .BR config.h :
  .TP
- .B PASSPHRASE
+ .B COMPILEDPASS
  A passphrase used to protect the remailer secret keys from
  casual attackers. You can use
  .B `make PASS="\fIyour passphrase\fB"'
  to set a passphrase. This should
  .I not
- be the same as the client passphrase.
+ be the same as the client passphrase. This option is now deprecated in
+ favor of the configuration file option
+ .BR PASSPHRASE .
  .TP
  .B SPOOL
  Set
-Line 677 
 The
+Line 801 
 The
  .BR getdomainname (2)
  function is available.
  .SH FILES
+ These filenames can be overridden by setting the corresponding configuration
+ option (given in parentheses).
  .TP
  .B mix.cfg
  Mixmaster configuration file.
  .TP
  .B pubring.asc
- Type 1 remailer keys.
+ Type 1 remailer keys (\fBPGPREMPUBASC\fP).
  .TP
  .B pubring.mix
- Type 2 remailer keys.
+ Type 2 remailer keys (\fBPUBRING\fP).
  .TP
  .B rlist.txt
- List of reliable type 1 remailers.
+ List of reliable type 1 remailers (\fBTYPE1LIST\fP).
  .TP
  .B mlist.txt
- List of reliable type 2 remailers.
+ List of reliable type 2 remailers (\fBTYPE2REL\fP).
  .TP
  .B type2.list
- List of known type 2 remailers (optional).
+ List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
+ .TP
+ .B starex.txt
+ List of remailers which should not be used in randomly generated
+ remailer chains (\fBSTAREX\fP).
  .SS Remailer files:
  .TP
  .B disclaim.txt
  A string to be inserted in the header of all anonymous
- messages.
+ messages (\fBDISCLAIMFILE\fP).
  .TP
  .B fromdscl.txt
  A string to be inserted at the top of the message body
  if an anonymous message contains a user-supplied
  .B From:
- line.
+ line (\fBFROMDSCLFILE\fP).
+ .TP
+ .TP
+ .B footer.txt
+ A string to be inserted at the bottom of the message body
+ of all anonymous messages (\fBMSGFOOTERFILE\fP).
  .TP
  .B help.txt
  Help file sent in response to
  .B remailer-help
- requests.
+ requests (\fBHELPFILE\fP).
  .TP
  .B adminkey.txt
  The PGP key of the remailer operator sent in response to
  .B remailer-adminkey
- requests.
+ requests (\fBADMKEYFILE\fP).
  .TP
  .B abuse.txt
  File sent in response to mail to the
  .I COMPLAINTS
  address if
  .B AUTOREPLY
- is set.
+ is set (\fBABUSEFILE\fP).
  .TP
  .B reply.txt
  Help file sent in response to replies to anonymous messages if
  .B AUTOREPLY
- is set.
+ is set (\fBREPLYFILE\fP).
  .TP
  .B usage.txt
  Help file sent in response to non-remailer message sent to
-Line 737 
 if
+Line 872 
 if
  is set. If
  .B usage.log
  exists, recipients are logged and a reply is sent only once to avoid
- mail loops.
+ mail loops (\fBUSAGEFILE\fP).
  .TP
  .B blocked.txt
  Information sent in response to automatically processed blocking requests if
  .B AUTOREPLY
- is set.
+ is set (\fBBLOCKFILE\fP).
  .TP
  .B pop3.cfg
  List of POP3 accounts with lines of the form
  .I account@host.domain password
  to get remailer messages from. The lines may optionally contain the
- keyword "apop" or "pass" to select an authentication method.
+ keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
  .TP
  .B dest.alw
- List of addresses to which Mixmaster will deliver, even in middleman mode.
+ List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
  .TP
  .B dest.blk
  List of blocked destination addresses.
- Mixmaster does not send mail to the blocked addresses listed in this file.
+ Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
  .TP
  .B rab.blk
  Identical to
  .BR dest.blk ,
- except that Mixmaster will not write to this file.
+ except Mixmaster will not write to this file.
  For use with external remailer abuse blocklists.
  .TP
  .B source.blk
  List of blocked source addresses.  If an incoming message originates
- from an address or IP in this in this list, it will be ignored. This
+ from an address or IP in this list, it will be ignored. This
- feature can be used to avoid spam and other abusive mail.
+ feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
  .TP
  .B header.blk
  List of unwanted header fields. The file is used to delete unwanted
  header lines (e.g. lines that indicate a false identity, or Usenet
- control messages), and do other header filtering.
+ control messages), and do other header filtering (\fBHDRFILTER\fP).
- .PP
  A destination address or header line is left out if it contains a
  search string or matches a regular expression specified in the block
  file. Lines in the block file that begin and end with a slash
-Line 786 
 entry in
+Line 921 
 entry in
  .BR header.blk ,
  the entire message is deleted.
- In addition, regular expressions can be substituted. Backreferences
+ In addition, regular expressions can be substituted. Back-references
  are supported. For example
   /^From: *([^@]*) <.*>/From: $1/
-Line 800 
 line, while replacing any given address
+Line 935 
 line, while replacing any given address
  Mixmaster uses the following files internally:
  .TP
  .B mixrand.bin
- Random seed file.
+ Random seed file (\fBMIXRAND\fP).
  .TP
  .B secrets.mix
- List of your nyms with configuration data (encrypted).
+ List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
  .TP
  .B nymsec.pgp
- Your nyms' secret PGP keys (encrypted).
+ Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).
  .TP
  .B secring.pgp
- Remailer type 1 secret keys.
+ Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
  .TP
  .B secring.mix
- Remailer type 2 secret keys.
+ Remailer type 2 secret keys (\fBSECRING\fP).
  .TP
  .B pgpkey.txt
- The public type 1 remailer key.
+ The public type 1 remailer key (\fBPGPKEY\fP).
  .TP
  .B key.txt
- The public type 2 remailer key.
+ The public type 2 remailer key (\fBKEYFILE\fP).
  .TP
  .B id.log
- Log file of messages already processed.
+ Log file of messages already processed (\fBKEYFILE\fP).
  .TP
  .B stats.log
- Log file for remailer statistics.
+ Log file for remailer statistics (\fBSTATS\fP).
+ .TP
+ .B pgpmaxcount.log
+ Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
  .TP
  .B time.log
- Time for periodic remailer actions.
+ Time for periodic remailer actions (\fBREGULAR\fP).
  .TP
  .B dhparam.mix
- Public Diffie-Hellman parameters used for El-Gamal key generation.
+ Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
  .TP
  .B dsaparam.mix
- Public DSA parameters used for DSA key generation.
+ Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
+ .TP
+ .B mix.pid
+ Pid file in daemon mode (\fBPIDFILE\fP).
+ .TP
+ .BI pool/
+ Message pool directory (\fBPOOL\fP).
  .TP
  .BI pool/m *
- Message pool.
+ Message pool files.
  .TP
  .BI pool/p *
  Partial messages.

 Legend:



Removed from v.38
 


changed lines


 
Added in v.545
 Legend:



Removed from v.38
 


changed lines


 
Added in v.545
-Removed from v.38
+Added in v.545

	ViewVC Help
Powered by ViewVC 1.1.5