/[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

trunk/Mix/mix.1 revision 547 by weaselp, Mon Jul 7 11:28:05 2003 UTC trunk/Mix/mixmaster.1 revision 852 by weasel, Thu May 13 13:59:28 2004 UTC
# Line 1  Line 1 
1  .TH MIX 1 "Mixmaster Version 3.0 beta"  .TH MIXMASTER 1 "Mixmaster Version 3.0 beta"
2  .\" $Id: mix.1,v 1.32 2003/07/07 11:28:05 weaselp Exp $  .\" $Id$
3  .SH NAME  .SH NAME
4  mix \- anonymous remailer software  mixmaster \- anonymous remailer software
5  .SH SYNOPSIS  .SH SYNOPSIS
6  .B mix  .B mixmaster
7  [\fB\-hpmdSvT\fR]  [\fB\-hpmdSvT\fR]
8  [\fB\-t \fIuser@host\fR]  [\fB\-t \fIuser@host\fR]
9  [\fB\-g \fInewsgroup\fR]  [\fB\-g \fInewsgroup\fR]
10  [\fB\-s \fIsubject\fR]  [\fB\-s \fIsubject\fR]
11  [\fB\-a \fIfilename\fR]  [\fB\-a \fIfilename\fR]
 [\fB\-n \fInym\fR]  
12  [\fB\-l \fImix1,mix2,mix3,...\fR]  [\fB\-l \fImix1,mix2,mix3,...\fR]
13  [\fB\-c \fInum\fR]  [\fB\-c \fInum\fR]
14  [\fIuser@host\fR]  [\fIuser@host\fR]
15  [\fIfilename\fR]  [\fIfilename\fR]
16  .PP  .PP
17  .B mix  .B mixmaster
18  [\fB\-f\fR[\fBrfg\fR] \fIfilename\fR]  [\fB\-f\fR[\fBrfg\fR] \fIfilename\fR]
19  .PP  .PP
20  .B mix \-\-nym\-config=\fIyournym \fR[\fBname=\fIPseudonym\fR]  .B mixmaster \fR[\fB\-RGKSP\fR]
 [\fBopt=\fInymserver options\fR] [\fB\-\-latency=\fIhours\fR]  
 [\fB\-\-reply\-chain=\fIrem1,rem2,...\fR]  
 .PP  
 .B mix \fR[\fB\-RGKSP\fR]  
21  .SH DESCRIPTION  .SH DESCRIPTION
22  Mixmaster is an anonymous remailer. Remailers provide protection  Mixmaster is an anonymous remailer. Remailers provide protection
23  against traffic analysis and allow sending mail anonymously or  against traffic analysis and allow sending mail anonymously or
# Line 32  In the non-interactive mode, Mixmaster r Line 27  In the non-interactive mode, Mixmaster r
27  standard input or from a file.  Destination address and input file can  standard input or from a file.  Destination address and input file can
28  be specified in the command line.  If no address is given in the  be specified in the command line.  If no address is given in the
29  command line, the input file is expected to contain a message complete  command line, the input file is expected to contain a message complete
30  with mail headers.  Messages to be sent under a pseudonym must contain  with mail headers.
 a  
 .I Nym:  
 header rather than  
 .IR From: .  
31  .SH OPTIONS  .SH OPTIONS
32  .TP  .TP
33  .B "\-h, \-\-help"  .B "\-h, \-\-help"
34  Print a summary of command line options.  Print a summary of command line options.
35  .TP  .TP
36    .B "\-V, \-\-version"
37    Print version information.
38    .TP
39    .B "\-\-about"
40    Print authorship and copyright information.
41    .TP
42  .B "\-\-config=\fIfilename"  .B "\-\-config=\fIfilename"
43  Read configuration from an alternate file.  Read configuration from an alternate file.
44  .TP  .TP
# Line 74  Attach Line 71  Attach
71  .I file  .I file
72  to the message.  to the message.
73  .TP  .TP
 .B "\-n, \-\-nym=\fIyournym"  
 Use the given pseudonym to send the message.  
 .TP  
74  .B \-\-encrypt  .B \-\-encrypt
75  Encrypt the message using the OpenPGP format.  Encrypt the message using the OpenPGP format.
76  .TP  .TP
# Line 121  Post a follow-up to a message. Line 115  Post a follow-up to a message.
115  .B "\-fg\fR [\fIfile\fR]"  .B "\-fg\fR [\fIfile\fR]"
116  Send a group reply to a message.  Send a group reply to a message.
117  .TP  .TP
118  .B "\-\-nym\-config=\fInym \fR[\fBname=\fIPseudonym\fR] [\fBopt=\fInymserver options\fR]"  .B "\-\-update-pinger-list"
119  Generate a pseudonym.  Download an updated all pingers list file.
   
 For example, to set up a pseudonym with two mail reply blocks and nym  
 server acknowledgment for successfully remailed messages:  
 .PP  
 mix --nym-config=yournym@nym.alias.net opt=+acksend --to=user@domain  
 --reply-chain=privacy,hr13,hyper --to=user@domain  
 --reply-chain=replay,squirrel,mix  
   
 To use a message pool:  
 .PP  
 mix --nym-config=yournym@nym.alias.net  
 --post-to=alt.anonymous.messages  
 --subject="secret message" --reply-chain=base  
 .TP  
 .B "\-\-latency=\fIhours"  
 Reply chain latency.  
120  .TP  .TP
121  .B "\-\-reply\-chain=\fIrem1,rem2,..."  .B "\-\-update-stats\fI[=source\fR]"
122  Reply chain for the pseudonym.  Download updated stats.
123  .SS Remailer options:  .SS Remailer options:
124  .TP  .TP
125  .B "\-\-config=\fIfilename"  .B "\-\-config=\fIfilename"
# Line 189  Remove the Mixmaster Service on Win32. Line 167  Remove the Mixmaster Service on Win32.
167  .TP  .TP
168  .B \-\-run\-svc  .B \-\-run\-svc
169  Run the Mixmaster Service on Win32.  Run the Mixmaster Service on Win32.
170    .TP
171    .B \-\-redirect
172    Read a Mixmaster packet from stdin and route it through a chain given with
173    \fB\-\-chain\fP.
174    Note that this may corrupt the packet if there is not enough space in the
175    headers (that is, if there are more than 20 hops total).  This function is
176    not normaly needed but may come in handy in certain cases.
177  .SH CONFIGURATION  .SH CONFIGURATION
178  Mixmaster reads its configuration from the file  Mixmaster reads its configuration from the file
179  .B mix.cfg  .B mix.cfg
# Line 206  script when setting up a remailer. Line 191  script when setting up a remailer.
191  .PP  .PP
192  All configuration variables can be overridden from the command line,  All configuration variables can be overridden from the command line,
193  e.g.  e.g.
194  .B mix -S --POOLSIZE=0 --RATE=100  .B mixmaster -S --POOLSIZE=0 --RATE=100
195  will send all messages currently in the message pool.  will send all messages currently in the message pool.
196  .SS Client configuration:  .SS Client configuration:
197  .TP  .TP
# Line 275  If Line 260  If
260  .B REMAIL  .B REMAIL
261  is set to  is set to
262  .BR n  .BR n
263  automatically flush the pool every time mixmaster is run. Default:  automatically flush the pool every time Mixmaster is run. Default:
264  .BR n .  .BR n .
265  .TP  .TP
266  .B SENDMAIL  .B SENDMAIL
# Line 315  used to send non-anonymous messages, Line 300  used to send non-anonymous messages,
300  is used instead.)  is used instead.)
301  Default:  Default:
302  .IR ANONADDR .  .IR ANONADDR .
303    .TP
304    .B ALLPINGERSURL
305    URL from which to download the
306    .IR ALLPINGERSFILE .
307    Default:
308    .BR http://www.noreply.org/allpingers/allpingers.txt .
309    .TP
310    .B WGET
311    Define the http protocol download tool. Default:
312    .BR wget .
313  .SS Remailer configuration:  .SS Remailer configuration:
314  .TP  .TP
315  .B NEWS  .B NEWS
# Line 470  be the same as the client passphrase. Line 465  be the same as the client passphrase.
465  .TP  .TP
466  .B EXTFLAGS  .B EXTFLAGS
467  Additional flags you want to set in the remailer's capabilities string.  Additional flags you want to set in the remailer's capabilities string.
468  Defaults to the empty string, which means none.  Defaults to the empty string, which means none.  Example:
469    .BR testing .
470    .TP
471    .B PRECEDENCE
472    Sets the header Precedence: to this value for all outgoing mail.
473    Defaults to the empty string, which means no such header is added.
474    Example:
475    .BR anon .
476    If you use this you might want to block user supplied precedence
477    headers in your header block file.
478  .PP  .PP
479  The following variables can be set to  The following variables can be set to
480  .B y  .B y
# Line 558  The following variables have numeric val Line 562  The following variables have numeric val
562  .B POOLSIZE  .B POOLSIZE
563  The size of the Mixmaster reordering pool. Larger sizes  The size of the Mixmaster reordering pool. Larger sizes
564  imply higher security and longer delays. Remailer default:  imply higher security and longer delays. Remailer default:
565  .BR 20 .  .BR 45 .
566  Client default:  Client default:
567  .BR 0 .  .BR 0 .
568  .TP  .TP
569  .B RATE  .B RATE
570  Percentage of messages from the pool to be sent. Remailer default:  Percentage of messages from the pool to be sent. Remailer default:
571  .BR 95 .  .BR 65 .
572  Client default:  Client default:
573  .BR 100 .  .BR 100 .
574  Lower values cause the pool to increase in size when  Lower values cause the pool to increase in size when
# Line 582  a dummy generation, and Line 586  a dummy generation, and
586  means that one in four will.  means that one in four will.
587  .B 0  .B 0
588  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
589  .BR 20 .  .BR 10 .
590  Client default:  Client default:
591  .BR 3 .  .BR 3 .
592  .TP  .TP
# Line 598  processing. Line 602  processing.
602  means four will be generated.  means four will be generated.
603  .B 0  .B 0
604  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
605  .BR 67 .  .BR 90 .
606  Client default:  Client default:
607  .BR 3 .  .BR 3 .
608  .TP  .TP
# Line 642  Default: Line 646  Default:
646  limits the number of allowed recipients in outgoing mail.  Anything that exceeds this  limits the number of allowed recipients in outgoing mail.  Anything that exceeds this
647  number is dropped silently.  Default:  number is dropped silently.  Default:
648  .BR 5 .  .BR 5 .
649    .TP
650    .B TEMP_FAIL
651    exit with this exit code when a timeskew problem is suspected.  Also see
652    .BR TIMESKEW_BACK
653    and
654    .BR TIMESKEW_FORWARD .
655    The default of
656    .B 75
657    should cause your MTA to requeue the message if you are running
658    mixmaster from a
659    .BR .forward
660    file.
661  .PP  .PP
662  The following are time variables. They can be given as days, hours, or  The following are time variables. They can be given as years (
663  minutes.  .BR y
664    ), months (
665    .BR b
666    ), days (
667    .BR d
668    ), hours (
669    .BR h
670    ), minutes (
671    .BR m
672    ), or seconds (
673    .BR s
674    ).
675  .TP  .TP
676  .B SENDPOOLTIME  .B SENDPOOLTIME
677  How often Mixmaster should check the pool for messages  How often Mixmaster should check the pool for messages
678  to be sent. Remailer default:  to be sent. Remailer default:
679  .BR 1h .  .BR 15m .
680  Client default:  Client default:
681  .BR 0h .  .BR 0h .
682  .TP  .TP
# Line 692  minimum: Line 719  minimum:
719  If set to  If set to
720  .BR 0 ,  .BR 0 ,
721  no log is kept.  no log is kept.
722    .TP
723    .B KEYLIFETIME
724    Mixmaster sets an expiration date on its remailer keys
725    .B KEYLIFETIME
726    after the key creation date. Default:
727    .BR 13b .
728    .TP
729    .B KEYGRACEPERIOD
730    Mixmaster will continue to decrypt messages encrypted to an expired key
731    for
732    .B KEYGRACEPERIOD
733    period of time after the expiration. This is done to ensure that messages
734    already injected into the network are allowed to exit. Do not change this
735    value unless you know what you are doing, or you will risk partitioning
736    attacks. Default:
737    .BR 7d .
738    .TP
739    .B KEYOVERLAPPERIOD
740    Mixmaster will generate and advertise a new key
741    .BR KEYOVERLAPPERIOD
742    period of time before the expiration of the key. Clients should always use
743    the most recently created valid key. Clients that deviate from this
744    recommended behavior risk partitioning attacks. Default:
745    .BR 7d .
746    .TP
747    .B TIMESKEW_BACK
748    Allow going back up to
749    .BR TIMESKEW_BACK
750    in time.  If the time moved further back mixmaster will assume
751    there is a problem with your clock and refuse to start as a remailer.
752    This is done by comparing the latest timestamp in
753    .BR time.log
754    with the current timestamp.  If set to
755    .BR 0
756    then this test is skipped.  If the system time is indeed correct, simply
757    remove
758    .BR time.log .
759    Default:
760    .BR 12h .
761    .TP
762    .B TIMESKEW_FORWARD
763    Similar to
764    .BR TIMESKEW_BACK
765    but allow jumping this far into the future.
766    Default:
767    .BR 2w .
768  .PP  .PP
769  The following strings must be specified at compile-time in  The following strings must be specified at compile-time in
770  .BR config.h .  .BR config.h .
# Line 892  keyword "apop" or "pass" to select an au Line 965  keyword "apop" or "pass" to select an au
965  .B dest.alw  .B dest.alw
966  List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).  List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
967  .TP  .TP
968    .B dest.alw.nonpublished
969    Similar to
970    .BR dest.alw ,
971    with the only difference that this list is not published in remailer-conf replies (\fBDESTALLOW2\fP).
972    .TP
973  .B dest.blk  .B dest.blk
974  List of blocked destination addresses.  List of blocked destination addresses.
975  Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).  Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
# Line 935  are supported. For example Line 1013  are supported. For example
1013  would allow user-defined names in the  would allow user-defined names in the
1014  .B From:  .B From:
1015  line, while replacing any given address with the remailer address.  line, while replacing any given address with the remailer address.
1016    .TP
1017    .B allpingers.txt
1018    Information on all known pingers (\fBALLPINGERSFILE\fP).
1019  .SS  .SS
1020  Mixmaster uses the following files internally:  Mixmaster uses the following files internally:
1021  .TP  .TP
1022  .B mixrand.bin  .B mixrand.bin
1023  Random seed file (\fBMIXRAND\fP).  Random seed file (\fBMIXRAND\fP).
1024  .TP  .TP
 .B secrets.mix  
 List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).  
 .TP  
 .B nymsec.pgp  
 Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).  
 .TP  
1025  .B secring.pgp  .B secring.pgp
1026  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
1027  .TP  .TP
# Line 960  The public type 1 remailer key (\fBPGPKE Line 1035  The public type 1 remailer key (\fBPGPKE
1035  The public type 2 remailer key (\fBKEYFILE\fP).  The public type 2 remailer key (\fBKEYFILE\fP).
1036  .TP  .TP
1037  .B id.log  .B id.log
1038  Log file of messages already processed (\fBKEYFILE\fP).  Log file of messages already processed (\fBIDLOG\fP).
1039  .TP  .TP
1040  .B stats.log  .B stats.log
1041  Log file for remailer statistics (\fBSTATS\fP).  Log file for remailer statistics (\fBSTATS\fP).
1042  .TP  .TP
1043    .B stats-src.txt
1044    File for name of most recent statistics source (\fBSTATSSRC\fP).
1045    .TP
1046  .B pgpmaxcount.log  .B pgpmaxcount.log
1047  Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).  Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
1048  .TP  .TP
# Line 977  Public Diffie-Hellman parameters used fo Line 1055  Public Diffie-Hellman parameters used fo
1055  .B dsaparam.mix  .B dsaparam.mix
1056  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
1057  .TP  .TP
1058  .B mix.pid  .B mixmaster.pid
1059  Pid file in daemon mode (\fBPIDFILE\fP).  Pid file in daemon mode (\fBPIDFILE\fP).
1060  .TP  .TP
1061  .BI pool/  .BI pool/
# Line 1009  The passphrase used to protect your nyms Line 1087  The passphrase used to protect your nyms
1087  .I MIXPASS  .I MIXPASS
1088  is not set, the client will ask for a passphrase.  is not set, the client will ask for a passphrase.
1089  .SH SEE ALSO  .SH SEE ALSO
1090    .BR mpgp (1),
1091  .BR pgp (1),  .BR pgp (1),
1092  .BR procmail (1),  .BR procmail (1),
1093  .BR sendmail (8).  .BR sendmail (8).
1094    .SH HISTORY
1095    Mixmaster is an implementation of a Chuamian mix-net system.
1096    Versions 1.0 through 2.0.3 of the
1097    .BR mixmaster
1098    remailer were originally written by Lance Cottrell. Mixmaster was first
1099    released in 1995. Ulf Moeller collaborated on version 2.0.4, and began an
1100    entire rewrite of
1101    .BR mixmaster
1102    in 1999. This rewrite was released in 2002 as version 2.9.0, with major
1103    contributions from Janis Jagars, Peter Palfrader, and Len Sassaman.
1104    Mixmaster 3.0 is based on the 2.9 codebase. Peter Palfrader and Len
1105    Sassaman are the principal maintainers. For more information on
1106    contributing authors, please see the file THANKS for details.
1107  .SH COPYRIGHT  .SH COPYRIGHT
1108  (C) 1999 Anonymizer Inc.  (C) 1999 - 2004 Anonymizer Inc. and others.
1109  Mixmaster may be redistributed and modified under certain conditions.  Mixmaster may be redistributed and modified under certain conditions.
1110  This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF  This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
1111  ANY KIND, either express or implied. See the file COPYRIGHT for  ANY KIND, either express or implied. See the file COPYRIGHT for
Legend:
Removed from v.547  
changed lines
  Added in v.852
  ViewVC Help
Powered by ViewVC 1.1.5