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

Diff of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1 by rabbi, Wed Oct 31 08:19:51 2001 UTC revision 341 by weaselp, Wed Oct 9 21:45:07 2002 UTC
# Line 1  Line 1 
1  .TH MIX 1 "Mixmaster Version 3.0 beta"  .TH MIX 1 "Mixmaster Version 3.0 beta"
2  .\" $Id: mix.1,v 1.1 2001/10/31 08:19:53 rabbi Exp $  .\" $Id: mix.1,v 1.22 2002/10/09 21:45:07 weaselp Exp $
3  .SH NAME  .SH NAME
4  mix \- anonymous remailer software  mix \- anonymous remailer software
5  .SH SYNOPSIS  .SH SYNOPSIS
# Line 42  header rather than Line 42  header rather than
42  .B "\-h, \-\-help"  .B "\-h, \-\-help"
43  Print a summary of command line options.  Print a summary of command line options.
44  .TP  .TP
45    .B "\-\-config=\fIfilename"
46    Read configuration from an alternate file.
47    .TP
48  .B "\-t, \-\-to=\fIuser@host"  .B "\-t, \-\-to=\fIuser@host"
49  Add the destination address(es) to the message header. The input file  Add the destination address(es) to the message header. The input file
50  contains the message body without headers.  contains the message body without headers.
# Line 107  Send the message(s) from the pool. Line 110  Send the message(s) from the pool.
110  Output informational messages.  Output informational messages.
111  .TP  .TP
112  .B "\-f\fR [\fIfile\fR]"  .B "\-f\fR [\fIfile\fR]"
113  Read a mail folder. This function requires ncurses support.  Read a mail folder or news article. This function requires ncurses support.
114  .TP  .TP
115  .B "\-fr\fR [\fIfile\fR]"  .B "\-fr\fR [\fIfile\fR]"
116  Reply to a message.  Reply to a message.
# Line 141  Reply chain latency. Line 144  Reply chain latency.
144  Reply chain for the pseudonym.  Reply chain for the pseudonym.
145  .SS Remailer options:  .SS Remailer options:
146  .TP  .TP
147    .B "\-\-config=\fIfilename"
148    Read configuration from an alternate file.
149    .TP
150  .B \-R, \-\-read\-mail  .B \-R, \-\-read\-mail
151  Read a remailer message from standard input and store it in the pool.  Read a remailer message from standard input and store it in the pool.
152  .TP  .TP
153    .B \-I, \-\-store\-mail
154    Read a remailer message from standard input and store it in the pool
155    without decrypting it immediately. It will be processed the next time
156    Mixmaster processes the queue (called with \fP-M\fP or in daemon mode).
157    .TP
158  .B \-P, \-\-pop-mail  .B \-P, \-\-pop-mail
159  Read mail from the POP3 servers listed in  Read mail from the POP3 servers listed in
160  .BR pop3.cfg .  .BR pop3.cfg .
# Line 157  internal files up\-to\-date. Line 168  internal files up\-to\-date.
168  Detach from the console and process the pool, get mail and update the  Detach from the console and process the pool, get mail and update the
169  internal files in regular intervals.  internal files in regular intervals.
170  .TP  .TP
171    .B \-\-no-detach
172    Run as daemon but do not detach from the terminal (This option is
173    only useful together with \fB--daemon\fP).
174    .TP
175  .B -G, \-\-generate\-key  .B -G, \-\-generate\-key
176  Generate a new remailer key.  Generate a new remailer key.
177  .TP  .TP
# Line 165  Generate remailer keys if necessary. Line 180  Generate remailer keys if necessary.
180  .TP  .TP
181  .B \-S, \-\-send  .B \-S, \-\-send
182  Force sending the message(s) from the pool.  Force sending the message(s) from the pool.
183    .TP
184    .B \-\-install\-svc
185    Install the Mixmaster Service on Win32.
186    .TP
187    .B \-\-remove\-svc
188    Remove the Mixmaster Service on Win32.
189    .TP
190    .B \-\-run\-svc
191    Run the Mixmaster Service on Win32.
192  .SH CONFIGURATION  .SH CONFIGURATION
193  Mixmaster reads its configuration from the file  Mixmaster reads its configuration from the file
194  .B mix.cfg  .B mix.cfg
# Line 214  Default: Line 238  Default:
238  .B DISTANCE  .B DISTANCE
239  When selecting random remailers, the chain will contain  When selecting random remailers, the chain will contain
240  .I DISTANCE  .I DISTANCE
241  other remailers between two occurences of the  other remailers between two occurrences of the
242  same remailer in the chain. Default:  same remailer in the chain. Default:
243  .BR 2 .  .BR 2 .
244  .TP  .TP
# Line 238  Default: Line 262  Default:
262  .TP  .TP
263  .B PGPPUBRING  .B PGPPUBRING
264  Path to your public PGP key ring. Default:  Path to your public PGP key ring. Default:
265  .BR ~/.pgp/pubring.pgp .  .BR ~/.pgp/pubring.pkr .
266  (Windows default: PGP registry value.)  (Windows default: PGP registry value.)
267  .TP  .TP
268  .B PGPSECRING  .B PGPSECRING
269  Path to your secret PGP key ring. Default:  Path to your secret PGP key ring. Default:
270  .BR ~/.pgp/secring.pgp .  .BR ~/.pgp/secring.skr .
271  (Windows default: PGP registry value.)  (Windows default: PGP registry value.)
272  .SS Remailer configuration:  .SS Remailer configuration:
273  .TP  .TP
# Line 266  rather than by Line 290  rather than by
290  .BR sendmail (1).  .BR sendmail (1).
291  .TP  .TP
292  .B HELONAME  .B HELONAME
293  Name used in the SMTP dialogue.  Host name used in the SMTP dialogue.
294  Default: The  Default: The
295  .I ENVFROM  .I ENVFROM
296  host name or the current network name associated with the socket.  host name or the current network name associated with the socket.
297  .TP  .TP
298    .B SMTPUSERNAME
299    Some mail servers require authentication for sending mail. This is
300    the authenticated SMTP user name.
301    .B SMTPPASSWORD
302    Password for authenticated SMTP.
303    .TP
304  .B ENVFROM  .B ENVFROM
305  Envelope from address used in the SMTP dialogue. (When the client is  Envelope from address used in the SMTP dialogue. (When the client is
306  used to send non-anonymous messages,  used to send non-anonymous messages,
# Line 346  it specifies the path to a program. If i Line 376  it specifies the path to a program. If i
376  .B @  .B @
377  sign, the message is forwarded to the given address (with an  sign, the message is forwarded to the given address (with an
378  .B X-Loop:  .B X-Loop:
379  header to prevent mail loops), otherwise the message is appended  header to prevent mail loops). If it ends with a
380    .B /
381    it is treated as a Maildir, otherwise the message is appended
382  to the given file name or written to standard output if  to the given file name or written to standard output if
383  .B MAIL  .B MAILBOX
384  is  is
385  .BR stdout .  .BR stdout .
386  Default:  Default:
# Line 389  errors. Default: Line 421  errors. Default:
421  Mail folder for bounce messages. Default:  Mail folder for bounce messages. Default:
422  .IR MAILBOX .  .IR MAILBOX .
423  .TP  .TP
424    .B MAILIN
425    If defined an additional mail folder where Mixmaster should read messages from
426    when processing its pool. If it ends with a
427    .B /
428    it is treated as a Maildir, otherwise a standard mbox format file
429    is expected. All messages are removed from the folder after reading.
430    .B MAILIN
431    is not set by default.
432    It is an incredible bad idea to set this the same as \fBMAILBOX\fP.
433    .TP
434  .B VERBOSE  .B VERBOSE
435  If  If
436  .B VERBOSE  .B VERBOSE
437  is set to  is set to
438  .BR 0 ,  .BR 0 ,
439  Mixmaster will log error  Mixmaster will log error
440  messagess only. If it is set to  messages only. If it is set to
441  .BR 1 ,  .BR 1 ,
442  error message and warnings are logged. If  error message and warnings are logged. If
443  .B VERBOSE  .B VERBOSE
# Line 407  If set to Line 449  If set to
449  a log file entry is created whenever a message  a log file entry is created whenever a message
450  enters or leaves the pool.  Default:  enters or leaves the pool.  Default:
451  .BR 2 .  .BR 2 .
452    .TP
453    .B PASSPHRASE
454    A passphrase used to protect the remailer secret keys from
455    casual attackers. This setting overrides the compile-time
456    defined
457    .B COMPILEDPASS
458    which is now deprecated.
459    This should
460    .I not
461    be the same as the client passphrase.
462  .PP  .PP
463  The following variables can be set to  The following variables can be set to
464  .B y  .B y
# Line 415  or Line 467  or
467  .TP  .TP
468  .B REMAIL  .B REMAIL
469  Enable remailer functionality. Default:  Enable remailer functionality. Default:
470  .BR y .  .BR n .
471  .TP  .TP
472  .B MIDDLEMAN  .B MIDDLEMAN
473  Act as an intermediate hop only, forward anonymized  Act as an intermediate hop only, forward anonymized
# Line 424  where complaints about anonymous message Line 476  where complaints about anonymous message
476  avoided. (The variable  avoided. (The variable
477  .B FORWARDTO  .B FORWARDTO
478  specifies the remailer  specifies the remailer
479  chain to be used; default:  chain to be used; default:
480  .BR * .)  .BR * .)
481  Default:  Default:
482  .BR n .  .BR n .
# Line 461  Default: Line 513  Default:
513  Filter out binary attachments. Default:  Filter out binary attachments. Default:
514  .BR n .  .BR n .
515  .TP  .TP
516    .B LISTSUPPORTED
517    List known remailers and their keys in remailer-conf reply. Default:
518    .BR y .
519    .TP
520  .B MID  .B MID
521  Use a hash of the message body as Message-ID, to avoid  Use a hash of the message body as Message-ID, to avoid
522  Usenet spam. Default:  Usenet spam. Default:
# Line 484  The following variables have numeric val Line 540  The following variables have numeric val
540  .TP  .TP
541  .B POOLSIZE  .B POOLSIZE
542  The size of the Mixmaster reordering pool. Larger sizes  The size of the Mixmaster reordering pool. Larger sizes
543  imply higher security and longer delays. Default:  imply higher security and longer delays. Remailer default:
544    .BR 20 .
545    Client default:
546  .BR 0 .  .BR 0 .
547  .TP  .TP
548  .B RATE  .B RATE
549  Percentage of messages from the pool to be sent. Default:  Percentage of messages from the pool to be sent. Remailer default:
550    .BR 95 .
551    Client default:
552  .BR 100 .  .BR 100 .
553  Lower values cause the pool to increase in size when  Lower values cause the pool to increase in size when
554  many messages are recieved at a time, reducing the effect  many messages are received at a time, reducing the effect
555  of flooding attacks.  of flooding attacks.
556  .TP  .TP
557    .B INDUMMYP
558    Probability that Mixmaster will generate dummy messages upon
559    receipt of incoming mail. Larger numbers mean more dummy
560    messages on average. For instance,
561    .B 10
562    means that on average one in nine incoming messages will trigger
563    a dummy generation, and
564    .B 20
565    means that one in four will.
566    .B 0
567    means no dummy messages. Remailer default:
568    .BR 20 .
569    Client default:
570    .BR 3 .
571    .TP
572    .B OUTDUMMYP
573    Probability that Mixmaster will generate dummy messages at
574    .B SENDPOOL
575    time. If the pool is processed frequently, this should be a lower value
576    than if there are long intervals between pool processing. Examples:
577    .B 50
578    means on average, one dummy message will be generated per pool
579    processing.
580    .B 80
581    means four will be generated.
582    .B 0
583    means no dummy messages. Remailer default:
584    .BR 67 .
585    Client default:
586    .BR 3 .
587    .TP
588  .B SIZELIMIT  .B SIZELIMIT
589  Maximal size for anonymous messages in kB.  Maximal size for anonymous messages in kB.
590  .B 0  .B 0
# Line 535  minutes. Line 626  minutes.
626  .TP  .TP
627  .B SENDPOOLTIME  .B SENDPOOLTIME
628  How often Mixmaster should check the pool for messages  How often Mixmaster should check the pool for messages
629  to be sent. Default:  to be sent. Remailer default:
630  .BR 1h .  .BR 1h .
631    Client default:
632    .BR 6h .
633  .TP  .TP
634  .B POP3TIME  .B POP3TIME
635  How often Mixmaster should check the POP3 accounts  How often Mixmaster should check the POP3 accounts
# Line 546  for new mail. Line 639  for new mail.
639  Default:  Default:
640  .BR 1h .  .BR 1h .
641  .TP  .TP
642    .B MAILINTIME
643    How often Mixmaster should read mail from
644    .BR MAILIN
645    and process mails fetched via POP3. Processing here means to
646    answer remailer-xxx requests and decrypt messages to the Mixmaster
647    and place them in the pool. No other processing of the pool is
648    done. This action is always performed sending out messages from the pool (at
649    .BR SENDPOOLTIME
650    intervals) or receiving mail via POP3 (at
651    .BR POP3TIME
652    intervals). Default:
653    .BR 5m .
654    .TP
655  .B PACKETEXP  .B PACKETEXP
656  How long to store parts of incomplete multipart messages.  How long to store parts of incomplete multipart messages and other
657    temporary pool files.
658  Default:  Default:
659  .BR 7d .  .BR 7d .
660  .TP  .TP
# Line 589  line and no Line 696  line and no
696  .B fromdscl.txt  .B fromdscl.txt
697  file is available.  file is available.
698  .TP  .TP
699    .B MSGFOOTER
700    A default string to be inserted at the bottom of the message body
701    of all anonymous messages and no
702    .B footer.txt
703    file is available.
704    .TP
705  .B BINDISCLAIMER  .B BINDISCLAIMER
706  A string to replace the body of a binary attachment when  A string to replace the body of a binary attachment when
707  the remailer is configured to filter out binaries.  the remailer is configured to filter out binaries.
# Line 597  the remailer is configured to filter out Line 710  the remailer is configured to filter out
710  The character set used for MIME-encoded header lines.  The character set used for MIME-encoded header lines.
711  .TP  .TP
712  .B DESTBLOCK  .B DESTBLOCK
713  A quoted list of files that contain blocked addresses.  A quoted list of files that contain blocked addresses.
714  Files must be separated by one space. Mixmaster will choose  Files must be separated by one space. Mixmaster will choose
715  the first file for writing  the first file for writing
716  .B AUTOBLOCK  .B AUTOBLOCK
717  is enabled.  is enabled.
718  .PP  .PP
# Line 608  The following variables can be set in th Line 721  The following variables can be set in th
721  or in  or in
722  .BR config.h :  .BR config.h :
723  .TP  .TP
724  .B PASSPHRASE  .B COMPILEDPASS
725  A passphrase used to protect the remailer secret keys from  A passphrase used to protect the remailer secret keys from
726  casual attackers. You can use  casual attackers. You can use
727  .B `make PASS="\fIyour passphrase\fB"'  .B `make PASS="\fIyour passphrase\fB"'
728  to set a passphrase. This should  to set a passphrase. This should
729  .I not  .I not
730  be the same as the client passphrase.  be the same as the client passphrase. This option is now deprecated in
731    favor of the configuration file option
732    .BR PASSPHRASE .
733  .TP  .TP
734  .B SPOOL  .B SPOOL
735  Set  Set
# Line 668  The Line 783  The
783  .BR getdomainname (2)  .BR getdomainname (2)
784  function is available.  function is available.
785  .SH FILES  .SH FILES
786    These filenames can be overridden by setting the corresponding configuration
787    option (given in parentheses).
788  .TP  .TP
789  .B mix.cfg  .B mix.cfg
790  Mixmaster configuration file.  Mixmaster configuration file.
791  .TP  .TP
792  .B pubring.asc  .B pubring.asc
793  Type 1 remailer keys.  Type 1 remailer keys (\fBPGPREMPUBASC\fP).
794  .TP  .TP
795  .B pubring.mix  .B pubring.mix
796  Type 2 remailer keys.  Type 2 remailer keys (\fBPUBRING\fP).
797  .TP  .TP
798  .B rlist.txt  .B rlist.txt
799  List of reliable type 1 remailers.  List of reliable type 1 remailers (\fBTYPE1LIST\fP).
800  .TP  .TP
801  .B mlist.txt  .B mlist.txt
802  List of reliable type 2 remailers.  List of reliable type 2 remailers (\fBTYPE2REL\fP).
803  .TP  .TP
804  .B type2.list  .B type2.list
805  List of known type 2 remailers (optional).  List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
806  .SS Remailer files:  .SS Remailer files:
807  .TP  .TP
808  .B disclaim.txt  .B disclaim.txt
809  A string to be inserted in the header of all anonymous  A string to be inserted in the header of all anonymous
810  messages.  messages (\fBDISCLAIMFILE\fP).
811  .TP  .TP
812  .B fromdscl.txt  .B fromdscl.txt
813  A string to be inserted at the top of the message body  A string to be inserted at the top of the message body
814  if an anonymous message contains a user-supplied  if an anonymous message contains a user-supplied
815  .B From:  .B From:
816  line.  line (\fBFROMDSCLFILE\fP).
817    .TP
818    .TP
819    .B footer.txt
820    A string to be inserted at the bottom of the message body
821    of all anonymous messages (\fBMSGFOOTERFILE\fP).
822  .TP  .TP
823  .B help.txt  .B help.txt
824  Help file sent in response to  Help file sent in response to
825  .B remailer-help  .B remailer-help
826  requests.  requests (\fBHELPFILE\fP).
827  .TP  .TP
828  .B adminkey.txt  .B adminkey.txt
829  The PGP key of the remailer operator sent in response to  The PGP key of the remailer operator sent in response to
830  .B remailer-adminkey  .B remailer-adminkey
831  requests.  requests (\fBADMKEYFILE\fP).
832  .TP  .TP
833  .B abuse.txt  .B abuse.txt
834  File sent in response to mail to the  File sent in response to mail to the
835  .I COMPLAINTS  .I COMPLAINTS
836  address if  address if
837  .B AUTOREPLY  .B AUTOREPLY
838  is set.  is set (\fBABUSEFILE\fP).
839  .TP  .TP
840  .B reply.txt  .B reply.txt
841  Help file sent in response to replies to anonymous messages if  Help file sent in response to replies to anonymous messages if
842  .B AUTOREPLY  .B AUTOREPLY
843  is set.  is set (\fBREPLYFILE\fP).
844  .TP  .TP
845  .B usage.txt  .B usage.txt
846  Help file sent in response to non-remailer message sent to  Help file sent in response to non-remailer message sent to
# Line 728  if Line 850  if
850  is set. If  is set. If
851  .B usage.log  .B usage.log
852  exists, recipients are logged and a reply is sent only once to avoid  exists, recipients are logged and a reply is sent only once to avoid
853  mail loops.  mail loops (\fBUSAGEFILE\fP).
854  .TP  .TP
855  .B blocked.txt  .B blocked.txt
856  Information sent in response to automatically processed blocking requests if  Information sent in response to automatically processed blocking requests if
857  .B AUTOREPLY  .B AUTOREPLY
858  is set.  is set (\fBBLOCKFILE\fP).
859  .TP  .TP
860  .B pop3.cfg  .B pop3.cfg
861  List of POP3 accounts with lines of the form  List of POP3 accounts with lines of the form
862  .I account@host.domain password  .I account@host.domain password
863  to get remailer messages from. The lines may optionally contain the  to get remailer messages from. The lines may optionally contain the
864  keyword "apop" or "pass" to select an authentication method.  keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
865  .TP  .TP
866  .B dest.alw  .B dest.alw
867  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).
868  .TP  .TP
869  .B dest.blk  .B dest.blk
870  List of blocked destination addresses.  List of blocked destination addresses.
871  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).
872  .TP  .TP
873  .B rab.blk  .B rab.blk
874  Identical to  Identical to
# Line 757  For use with external remailer abuse blo Line 879  For use with external remailer abuse blo
879  .B source.blk  .B source.blk
880  List of blocked source addresses.  If an incoming message originates  List of blocked source addresses.  If an incoming message originates
881  from an address or IP in this in this list, it will be ignored. This  from an address or IP in this in this list, it will be ignored. This
882  feature can be used to avoid spam and other abusive mail.  feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
883  .TP  .TP
884  .B header.blk  .B header.blk
885  List of unwanted header fields. The file is used to delete unwanted  List of unwanted header fields. The file is used to delete unwanted
886  header lines (e.g. lines that indicate a false identity, or Usenet  header lines (e.g. lines that indicate a false identity, or Usenet
887  control messages), and do other header filtering.  control messages), and do other header filtering (\fBHDRFILTER\fP).
888  .PP  .PP
889  A destination address or header line is left out if it contains a  A destination address or header line is left out if it contains a
890  search string or matches a regular expression specified in the block  search string or matches a regular expression specified in the block
# Line 777  entry in Line 899  entry in
899  .BR header.blk ,  .BR header.blk ,
900  the entire message is deleted.  the entire message is deleted.
901    
902  In addition, regular expressions can be substituted. Backreferences  In addition, regular expressions can be substituted. Back-references
903  are supported. For example  are supported. For example
904    
905   /^From: *([^@]*) <.*>/From: $1/   /^From: *([^@]*) <.*>/From: $1/
# Line 791  line, while replacing any given address Line 913  line, while replacing any given address
913  Mixmaster uses the following files internally:  Mixmaster uses the following files internally:
914  .TP  .TP
915  .B mixrand.bin  .B mixrand.bin
916  Random seed file.  Random seed file (\fBMIXRAND\fP).
917  .TP  .TP
918  .B secrets.mix  .B secrets.mix
919  List of your nyms with configuration data (encrypted).  List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
920  .TP  .TP
921  .B nymsec.pgp  .B nymsec.pgp
922  Your nyms' secret PGP keys (encrypted).  Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).
923  .TP  .TP
924  .B secring.pgp  .B secring.pgp
925  Remailer type 1 secret keys.  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
926  .TP  .TP
927  .B secring.mix  .B secring.mix
928  Remailer type 2 secret keys.  Remailer type 2 secret keys (\fBSECRING\fP).
929  .TP  .TP
930  .B pgpkey.txt  .B pgpkey.txt
931  The public type 1 remailer key.  The public type 1 remailer key (\fBPGPKEY\fP).
932  .TP  .TP
933  .B key.txt  .B key.txt
934  The public type 2 remailer key.  The public type 2 remailer key (\fBKEYFILE\fP).
935  .TP  .TP
936  .B id.log  .B id.log
937  Log file of messages already processed.  Log file of messages already processed (\fBKEYFILE\fP).
938  .TP  .TP
939  .B stats.log  .B stats.log
940  Log file for remailer statistics.  Log file for remailer statistics (\fBSTATS\fP).
941  .TP  .TP
942  .B time.log  .B time.log
943  Time for periodic remailer actions.  Time for periodic remailer actions (\fBREGULAR\fP).
944  .TP  .TP
945  .B dhparam.mix  .B dhparam.mix
946  Public Diffie-Hellman parameters used for El-Gamal key generation.  Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
947  .TP  .TP
948  .B dsaparam.mix  .B dsaparam.mix
949  Public DSA parameters used for DSA key generation.  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
950    .TP
951    .BI pool/
952    Message pool directory (\fBPOOL\fP).
953  .TP  .TP
954  .BI pool/m *  .BI pool/m *
955  Message pool.  Message pool files.
956  .TP  .TP
957  .BI pool/p *  .BI pool/p *
958  Partial messages.  Partial messages.
Legend:
Removed from v.1  
changed lines
  Added in v.341
  ViewVC Help
Powered by ViewVC 1.1.5