/[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 545 by weaselp, Mon Jul 7 11:18:20 2003 UTC trunk/Mix/mixmaster.1 revision 967 by colin, Mon Jan 14 17:28:37 2008 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.31 2003/07/07 11:18:20 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  
120  .TP  .TP
121  .B "\-\-latency=\fIhours"  .B "\-\-update-stats\fI[=source\fR]"
122  Reply chain latency.  Download updated stats.
 .TP  
 .B "\-\-reply\-chain=\fIrem1,rem2,..."  
 Reply chain for the pseudonym.  
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    .B \-\-no\-ask\-passphrase
174    Do not ask for the remailer passphrase even if we don't have it compiled in,
175    don't have it in the config file, don't have it in the environment and we are
176    on a tty.
177    \fB\-\-chain\fP.
178    Note that this may corrupt the packet if there is not enough space in the
179    headers (that is, if there are more than 20 hops total).  This function is
180    not normally needed but may come in handy in certain cases.
181  .SH CONFIGURATION  .SH CONFIGURATION
182  Mixmaster reads its configuration from the file  Mixmaster reads its configuration from the file
183  .B mix.cfg  .B mix.cfg
# Line 206  script when setting up a remailer. Line 195  script when setting up a remailer.
195  .PP  .PP
196  All configuration variables can be overridden from the command line,  All configuration variables can be overridden from the command line,
197  e.g.  e.g.
198  .B mix -S --POOLSIZE=0 --RATE=100  .B mixmaster -S --POOLSIZE=0 --RATE=100
199  will send all messages currently in the message pool.  will send all messages currently in the message pool.
200  .SS Client configuration:  .SS Client configuration:
201  .TP  .TP
# Line 260  Only select remailers with a latency of Line 249  Only select remailers with a latency of
249  Default:  Default:
250  .BR 36h .  .BR 36h .
251  .TP  .TP
252    .B MINLAT
253    Only select remailers with a latency of at least
254    .IR MINLAT .
255    Default:
256    .BR 5m .
257    .TP
258  .B PGPPUBRING  .B PGPPUBRING
259  Path to your public PGP key ring. Default:  Path to your public PGP key ring. Default:
260  .BR ~/.pgp/pubring.pkr .  .BR ~/.pgp/pubring.pkr .
# Line 275  If Line 270  If
270  .B REMAIL  .B REMAIL
271  is set to  is set to
272  .BR n  .BR n
273  automatically flush the pool every time mixmaster is run. Default:  automatically flush the pool every time Mixmaster is run. Default:
274  .BR n .  .BR n .
275  .TP  .TP
276  .B SENDMAIL  .B SENDMAIL
# Line 315  used to send non-anonymous messages, Line 310  used to send non-anonymous messages,
310  is used instead.)  is used instead.)
311  Default:  Default:
312  .IR ANONADDR .  .IR ANONADDR .
313    .TP
314    .B ALLPINGERSURL
315    URL from which to download the
316    .IR ALLPINGERSFILE .
317    Default:
318    .BR http://www.noreply.org/allpingers/allpingers.txt .
319    .TP
320    .B WGET
321    Define the http protocol download tool. Default:
322    .BR wget .
323  .SS Remailer configuration:  .SS Remailer configuration:
324  .TP  .TP
325  .B NEWS  .B NEWS
# Line 467  which is now deprecated. Line 472  which is now deprecated.
472  This should  This should
473  .I not  .I not
474  be the same as the client passphrase.  be the same as the client passphrase.
475    .TP
476    .B EXTFLAGS
477    Additional flags you want to set in the remailer's capabilities string.
478    Defaults to the empty string, which means none.  Example:
479    .BR testing .
480    .TP
481    .B PRECEDENCE
482    Sets the header Precedence: to this value for all outgoing mail.
483    Defaults to the empty string, which means no such header is added.
484    Example:
485    .BR anon .
486    If you use this you might want to block user supplied precedence
487    headers in your header block file.
488  .PP  .PP
489  The following variables can be set to  The following variables can be set to
490  .B y  .B y
# Line 503  Accept Mixmaster messages. Default: Line 521  Accept Mixmaster messages. Default:
521  .B PGP  .B PGP
522  Accept OpenPGP-encrypted Cypherpunk remailer messages.  Accept OpenPGP-encrypted Cypherpunk remailer messages.
523  Default:  Default:
524  .BR y .  .BR n .
525  .TP  .TP
526  .B UNENCRYPTED  .B UNENCRYPTED
527  Accept unencrypted Cypherpunk remailer messages.  Accept unencrypted Cypherpunk remailer messages.
# Line 554  The following variables have numeric val Line 572  The following variables have numeric val
572  .B POOLSIZE  .B POOLSIZE
573  The size of the Mixmaster reordering pool. Larger sizes  The size of the Mixmaster reordering pool. Larger sizes
574  imply higher security and longer delays. Remailer default:  imply higher security and longer delays. Remailer default:
575  .BR 20 .  .BR 45 .
576  Client default:  Client default:
577  .BR 0 .  .BR 0 .
578  .TP  .TP
579  .B RATE  .B RATE
580  Percentage of messages from the pool to be sent. Remailer default:  Percentage of messages from the pool to be sent. Remailer default:
581  .BR 95 .  .BR 65 .
582  Client default:  Client default:
583  .BR 100 .  .BR 100 .
584  Lower values cause the pool to increase in size when  Lower values cause the pool to increase in size when
# Line 578  a dummy generation, and Line 596  a dummy generation, and
596  means that one in four will.  means that one in four will.
597  .B 0  .B 0
598  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
599  .BR 20 .  .BR 10 .
600  Client default:  Client default:
601  .BR 3 .  .BR 3 .
602  .TP  .TP
# Line 594  processing. Line 612  processing.
612  means four will be generated.  means four will be generated.
613  .B 0  .B 0
614  means no dummy messages. Remailer default:  means no dummy messages. Remailer default:
615  .BR 67 .  .BR 90 .
616  Client default:  Client default:
617  .BR 3 .  .BR 3 .
618  .TP  .TP
# Line 638  Default: Line 656  Default:
656  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
657  number is dropped silently.  Default:  number is dropped silently.  Default:
658  .BR 5 .  .BR 5 .
659    .TP
660    .B TEMP_FAIL
661    exit with this exit code when a timeskew problem is suspected.  Also see
662    .BR TIMESKEW_BACK
663    and
664    .BR TIMESKEW_FORWARD .
665    The default of
666    .B 75
667    should cause your MTA to requeue the message if you are running
668    mixmaster from a
669    .BR .forward
670    file.
671    .TP
672    .B STATSAUTOUPDATE
673    Set non-zero to enable Daemon stats download mode. Default:
674    .BR 0 .
675  .PP  .PP
676  The following are time variables. They can be given as days, hours, or  The following are time variables. They can be given as years (
677  minutes.  .BR y
678    ), months (
679    .BR b
680    ), days (
681    .BR d
682    ), hours (
683    .BR h
684    ), minutes (
685    .BR m
686    ), or seconds (
687    .BR s
688    ).
689  .TP  .TP
690  .B SENDPOOLTIME  .B SENDPOOLTIME
691  How often Mixmaster should check the pool for messages  How often Mixmaster should check the pool for messages
692  to be sent. Remailer default:  to be sent. Remailer default:
693  .BR 1h .  .BR 15m .
694  Client default:  Client default:
695  .BR 0h .  .BR 0h .
696  .TP  .TP
# Line 688  minimum: Line 733  minimum:
733  If set to  If set to
734  .BR 0 ,  .BR 0 ,
735  no log is kept.  no log is kept.
736    .TP
737    .B KEYLIFETIME
738    Mixmaster sets an expiration date on its remailer keys
739    .B KEYLIFETIME
740    after the key creation date. Default:
741    .BR 13b .
742    .TP
743    .B KEYGRACEPERIOD
744    Mixmaster will continue to decrypt messages encrypted to an expired key
745    for
746    .B KEYGRACEPERIOD
747    period of time after the expiration. This is done to ensure that messages
748    already injected into the network are allowed to exit. Do not change this
749    value unless you know what you are doing, or you will risk partitioning
750    attacks. Default:
751    .BR 7d .
752    .TP
753    .B KEYOVERLAPPERIOD
754    Mixmaster will generate and advertise a new key
755    .BR KEYOVERLAPPERIOD
756    period of time before the expiration of the key. Clients should always use
757    the most recently created valid key. Clients that deviate from this
758    recommended behavior risk partitioning attacks. Default:
759    .BR 7d .
760    .TP
761    .B TIMESKEW_BACK
762    Allow going back up to
763    .BR TIMESKEW_BACK
764    in time.  If the time moved further back mixmaster will assume
765    there is a problem with your clock and refuse to start as a remailer.
766    This is done by comparing the latest timestamp in
767    .BR time.log
768    with the current timestamp.  If set to
769    .BR 0
770    then this test is skipped.  If the system time is indeed correct, simply
771    remove
772    .BR time.log .
773    Default:
774    .BR 12h .
775    .TP
776    .B TIMESKEW_FORWARD
777    Similar to
778    .BR TIMESKEW_BACK
779    but allow jumping this far into the future.
780    Default:
781    .BR 2w .
782    .TP
783    .B STATSINTERVAL
784    Time interval between daemon downloads of stats files. Enabled by
785    .BR STATSAUTOUPDATE .
786    Default:
787    .BR 2h .
788  .PP  .PP
789  The following strings must be specified at compile-time in  The following strings must be specified at compile-time in
790  .BR config.h .  .BR config.h .
# Line 888  keyword "apop" or "pass" to select an au Line 985  keyword "apop" or "pass" to select an au
985  .B dest.alw  .B dest.alw
986  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).
987  .TP  .TP
988    .B dest.alw.nonpublished
989    Similar to
990    .BR dest.alw ,
991    with the only difference that this list is not published in remailer-conf replies (\fBDESTALLOW2\fP).
992    .TP
993  .B dest.blk  .B dest.blk
994  List of blocked destination addresses.  List of blocked destination addresses.
995  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 931  are supported. For example Line 1033  are supported. For example
1033  would allow user-defined names in the  would allow user-defined names in the
1034  .B From:  .B From:
1035  line, while replacing any given address with the remailer address.  line, while replacing any given address with the remailer address.
1036    .TP
1037    .B allpingers.txt
1038    Information on all known pingers (\fBALLPINGERSFILE\fP).
1039  .SS  .SS
1040  Mixmaster uses the following files internally:  Mixmaster uses the following files internally:
1041  .TP  .TP
1042  .B mixrand.bin  .B mixrand.bin
1043  Random seed file (\fBMIXRAND\fP).  Random seed file (\fBMIXRAND\fP).
1044  .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  
1045  .B secring.pgp  .B secring.pgp
1046  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).  Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
1047  .TP  .TP
# Line 956  The public type 1 remailer key (\fBPGPKE Line 1055  The public type 1 remailer key (\fBPGPKE
1055  The public type 2 remailer key (\fBKEYFILE\fP).  The public type 2 remailer key (\fBKEYFILE\fP).
1056  .TP  .TP
1057  .B id.log  .B id.log
1058  Log file of messages already processed (\fBKEYFILE\fP).  Log file of messages already processed (\fBIDLOG\fP).
1059  .TP  .TP
1060  .B stats.log  .B stats.log
1061  Log file for remailer statistics (\fBSTATS\fP).  Log file for remailer statistics (\fBSTATS\fP).
1062  .TP  .TP
1063    .B stats-src.txt
1064    File for name of most recent statistics source (\fBSTATSSRC\fP).
1065    .TP
1066  .B pgpmaxcount.log  .B pgpmaxcount.log
1067  Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).  Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
1068  .TP  .TP
# Line 973  Public Diffie-Hellman parameters used fo Line 1075  Public Diffie-Hellman parameters used fo
1075  .B dsaparam.mix  .B dsaparam.mix
1076  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).  Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
1077  .TP  .TP
1078  .B mix.pid  .B mixmaster.pid
1079  Pid file in daemon mode (\fBPIDFILE\fP).  Pid file in daemon mode (\fBPIDFILE\fP).
1080  .TP  .TP
1081  .BI pool/  .BI pool/
# Line 1005  The passphrase used to protect your nyms Line 1107  The passphrase used to protect your nyms
1107  .I MIXPASS  .I MIXPASS
1108  is not set, the client will ask for a passphrase.  is not set, the client will ask for a passphrase.
1109  .SH SEE ALSO  .SH SEE ALSO
1110    .BR mpgp (1),
1111  .BR pgp (1),  .BR pgp (1),
1112  .BR procmail (1),  .BR procmail (1),
1113  .BR sendmail (8).  .BR sendmail (8).
1114    .SH HISTORY
1115    Mixmaster is an implementation of a Chaumian mix-net system.
1116    Versions 1.0 through 2.0.3 of the
1117    .BR mixmaster
1118    remailer were originally written by Lance Cottrell. Mixmaster was first
1119    released in 1995. Ulf Moeller collaborated on version 2.0.4, and began an
1120    entire rewrite of
1121    .BR mixmaster
1122    in 1999. This rewrite was released in 2002 as version 2.9.0, with major
1123    contributions from Janis Jagars, Peter Palfrader, and Len Sassaman.
1124    Mixmaster 3.0 is based on the 2.9 codebase. Peter Palfrader and Len
1125    Sassaman are the principal maintainers. For more information on
1126    contributing authors, please see the file THANKS for details.
1127  .SH COPYRIGHT  .SH COPYRIGHT
1128  (C) 1999 Anonymizer Inc.  (C) 1999 - 2006 Anonymizer Inc. and others.
1129  Mixmaster may be redistributed and modified under certain conditions.  Mixmaster may be redistributed and modified under certain conditions.
1130  This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF  This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
1131  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.545  
changed lines
  Added in v.967

  ViewVC Help
Powered by ViewVC 1.1.5