/[pkg-mixmaster]/tags/mixmaster_3_0a4/Mix/mix.1
ViewVC logotype

Contents of /tags/mixmaster_3_0a4/Mix/mix.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 622 - (hide annotations) (download)
Fri Oct 24 13:38:29 2003 UTC (9 years, 6 months ago) by unknown
File size: 23871 byte(s)
This commit was manufactured by cvs2svn to create tag
'mixmaster_3_0a4'.
1 rabbi 1 .TH MIX 1 "Mixmaster Version 3.0 beta"
2 weaselp 498 .\" $Id: mix.1,v 1.29 2003/05/03 01:56:07 weaselp Exp $
3 rabbi 1 .SH NAME
4     mix \- anonymous remailer software
5     .SH SYNOPSIS
6     .B mix
7     [\fB\-hpmdSvT\fR]
8     [\fB\-t \fIuser@host\fR]
9     [\fB\-g \fInewsgroup\fR]
10     [\fB\-s \fIsubject\fR]
11     [\fB\-a \fIfilename\fR]
12     [\fB\-n \fInym\fR]
13     [\fB\-l \fImix1,mix2,mix3,...\fR]
14     [\fB\-c \fInum\fR]
15     [\fIuser@host\fR]
16     [\fIfilename\fR]
17     .PP
18     .B mix
19     [\fB\-f\fR[\fBrfg\fR] \fIfilename\fR]
20     .PP
21     .B mix \-\-nym\-config=\fIyournym \fR[\fBname=\fIPseudonym\fR]
22     [\fBopt=\fInymserver options\fR] [\fB\-\-latency=\fIhours\fR]
23     [\fB\-\-reply\-chain=\fIrem1,rem2,...\fR]
24     .PP
25     .B mix \fR[\fB\-RGKSP\fR]
26     .SH DESCRIPTION
27     Mixmaster is an anonymous remailer. Remailers provide protection
28     against traffic analysis and allow sending mail anonymously or
29     pseudonymously.
30     .PP
31     In the non-interactive mode, Mixmaster reads a message from its
32     standard input or from a file. Destination address and input file can
33     be specified in the command line. If no address is given in the
34     command line, the input file is expected to contain a message complete
35 weaselp 397 with mail headers. Messages to be sent under a pseudonym must contain
36 rabbi 1 a
37     .I Nym:
38     header rather than
39     .IR From: .
40     .SH OPTIONS
41     .TP
42     .B "\-h, \-\-help"
43     Print a summary of command line options.
44     .TP
45 rabbi 283 .B "\-\-config=\fIfilename"
46     Read configuration from an alternate file.
47     .TP
48 rabbi 1 .B "\-t, \-\-to=\fIuser@host"
49     Add the destination address(es) to the message header. The input file
50     contains the message body without headers.
51     .TP
52     .B "\-g, \-\-post-to=\fInewsgroup"
53     Add the newsgroup(s) to the message header. The input file
54     contains the message body without headers.
55     .TP
56     .B
57     \-p, \-\-post
58     Post the message to Usenet.
59     .TP
60     .B
61     \-m, \-\-mail
62     Send the message as electronic mail. (This is the default.)
63     .TP
64     .B "\-s, \-\-subject=\fIsubject"
65     Add the
66     .I subject
67     to the message header.
68     .TP
69     .B "\-\-header=\fI'Header: text'
70     Add the header line to the message header.
71     .TP
72     .B "\-a, \-\-attachment=\fIfilename"
73     Attach
74     .I file
75     to the message.
76     .TP
77     .B "\-n, \-\-nym=\fIyournym"
78     Use the given pseudonym to send the message.
79     .TP
80     .B \-\-encrypt
81     Encrypt the message using the OpenPGP format.
82     .TP
83     .B \-\-sign
84     Sign the message using the OpenPGP format.
85     .TP
86     .B "\-l, \-\-chain=\fImix1,mix2,mix3,..."
87     Use this remailer chain to send the message. Alternatively, the input
88     message may contain a pseudo-header
89     .BR Chain: .
90     If no chain is specified, Mixmaster will use a chain of four random
91     remailers.
92     .TP
93     .B "\-T, \-\-type\-list"
94     Display the contents of the
95     .BR type2.list
96     file.
97     .TP
98     .B "\-c, \-\-copies=\fInum"
99     Send
100     .I num
101     copies of the message to increase reliability.
102     .TP
103     .B \-d, \-\-dummy
104     Generate a dummy message as protection against traffic analysis.
105     .TP
106     .B \-S, \-\-send
107     Send the message(s) from the pool.
108     .TP
109     .B \-v, \-\-verbose
110     Output informational messages.
111     .TP
112     .B "\-f\fR [\fIfile\fR]"
113 ulfm 289 Read a mail folder or news article. This function requires ncurses support.
114 rabbi 1 .TP
115     .B "\-fr\fR [\fIfile\fR]"
116     Reply to a message.
117     .TP
118     .B "\-ff\fR [\fIfile\fR]"
119     Post a follow-up to a message.
120     .TP
121     .B "\-fg\fR [\fIfile\fR]"
122     Send a group reply to a message.
123     .TP
124     .B "\-\-nym\-config=\fInym \fR[\fBname=\fIPseudonym\fR] [\fBopt=\fInymserver options\fR]"
125     Generate a pseudonym.
126    
127     For example, to set up a pseudonym with two mail reply blocks and nym
128     server acknowledgment for successfully remailed messages:
129     .PP
130     mix --nym-config=yournym@nym.alias.net opt=+acksend --to=user@domain
131     --reply-chain=privacy,hr13,hyper --to=user@domain
132     --reply-chain=replay,squirrel,mix
133    
134     To use a message pool:
135     .PP
136     mix --nym-config=yournym@nym.alias.net
137     --post-to=alt.anonymous.messages
138     --subject="secret message" --reply-chain=base
139     .TP
140     .B "\-\-latency=\fIhours"
141     Reply chain latency.
142     .TP
143     .B "\-\-reply\-chain=\fIrem1,rem2,..."
144     Reply chain for the pseudonym.
145     .SS Remailer options:
146     .TP
147 rabbi 283 .B "\-\-config=\fIfilename"
148     Read configuration from an alternate file.
149     .TP
150 rabbi 1 .B \-R, \-\-read\-mail
151     Read a remailer message from standard input and store it in the pool.
152     .TP
153 weaselp 150 .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 rabbi 1 .B \-P, \-\-pop-mail
159     Read mail from the POP3 servers listed in
160     .BR pop3.cfg .
161     .TP
162     .B \-M, \-\-remailer
163     Check if it is time to perform the regular remailer actions:
164     Send messages from the pool, get mail from POP3 servers and keep the
165     internal files up\-to\-date.
166     .TP
167     .B \-D, \-\-daemon
168     Detach from the console and process the pool, get mail and update the
169 weaselp 397 internal files at regular intervals.
170 rabbi 1 .TP
171 weaselp 177 .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 rabbi 1 .B -G, \-\-generate\-key
176     Generate a new remailer key.
177     .TP
178     .B \-K, \-\-update\-keys
179     Generate remailer keys if necessary.
180     .TP
181     .B \-S, \-\-send
182     Force sending the message(s) from the pool.
183 rabbi 38 .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 rabbi 1 .SH CONFIGURATION
193     Mixmaster reads its configuration from the file
194     .B mix.cfg
195     in its working directory. The configuration file consists of lines of
196     the type
197     .PP
198     .I VARIABLE values
199     .PP
200     and of comments, which begin with a
201     .B #
202     character. The variables have reasonable default values, but it is
203     useful to create a configuration file using the
204     .B Install
205     script when setting up a remailer.
206     .PP
207     All configuration variables can be overridden from the command line,
208     e.g.
209     .B mix -S --POOLSIZE=0 --RATE=100
210     will send all messages currently in the message pool.
211     .SS Client configuration:
212     .TP
213     .B ADDRESS
214     Your address for sending non-anonymous messages.
215     .TP
216     .B NAME
217     Your real name (used for sending non-anonymous messages).
218     .TP
219     .B MAILtoNEWS
220     Address of a mail-to-news gateway. Default:
221     .BR mail2news@nym.alias.net .
222     .TP
223     .B CHAIN
224     Default chain for anonymous messages to be sent.
225     .B CHAIN
226     is a comma-separated list of remailer names or addresses.
227     A
228     .B *
229     represents a random reliable remailer. Default:
230     .BR *,*,*,* .
231     .TP
232     .B NUMCOPIES
233     Number of redundant copies of an anonymous message to be
234     sent, unless specified otherwise on the command line.
235     Default:
236     .BR 1 .
237     .TP
238     .B DISTANCE
239     When selecting random remailers, the chain will contain
240     .I DISTANCE
241 rabbi 220 other remailers between two occurrences of the
242 rabbi 1 same remailer in the chain. Default:
243     .BR 2 .
244     .TP
245     .B MINREL
246     Only select remailers with a reliability of at least
247     .IR MINREL %.
248     Default:
249     .BR 98 .
250     .TP
251     .B RELFINAL
252     Only select a remailer with a reliability of at least
253     .IR RELFINAL %
254     as the final remailer. Default:
255     .BR 99 .
256     .TP
257     .B MAXLAT
258 weaselp 397 Only select remailers with a latency of at most
259 rabbi 1 .IR MAXLAT .
260     Default:
261     .BR 36h .
262     .TP
263     .B PGPPUBRING
264     Path to your public PGP key ring. Default:
265 rabbi 151 .BR ~/.pgp/pubring.pkr .
266 rabbi 1 (Windows default: PGP registry value.)
267     .TP
268     .B PGPSECRING
269     Path to your secret PGP key ring. Default:
270 rabbi 151 .BR ~/.pgp/secring.skr .
271 rabbi 1 (Windows default: PGP registry value.)
272 weaselp 498 .TP
273     .B CLIENTAUTOFLUSH
274     If
275     .B REMAIL
276     is set to
277     .BR n
278     automatically flush the pool every time mixmaster is run. Default:
279     .BR n .
280 rabbi 1 .SS Remailer configuration:
281     .TP
282     .B SENDMAIL
283     Path to the
284     .BR sendmail (1)
285     program. If set to
286     .BR outfile ,
287     Mixmaster will create text files named
288     .BI out * .txt
289     in the
290     .B pool
291     directory instead of sending mail.
292     Default:
293     .BR "/usr/lib/sendmail -t" .
294     .TP
295     .B SMTPRELAY
296     Name of SMTP relay. If set, mail will be delivered to the relay
297     rather than by
298     .BR sendmail (1).
299     .TP
300     .B HELONAME
301 ulfm 269 Host name used in the SMTP dialogue.
302 rabbi 1 Default: The
303     .I ENVFROM
304     host name or the current network name associated with the socket.
305     .TP
306 ulfm 269 .B SMTPUSERNAME
307     Some mail servers require authentication for sending mail. This is
308     the authenticated SMTP user name.
309     .B SMTPPASSWORD
310     Password for authenticated SMTP.
311     .TP
312 rabbi 1 .B ENVFROM
313     Envelope from address used in the SMTP dialogue. (When the client is
314     used to send non-anonymous messages,
315     .I ADDRESSS
316     is used instead.)
317     Default:
318     .IR ANONADDR .
319     .TP
320     .B NEWS
321     Path to the news posting program, or address of a
322     mail-to-news gateway. Default: no news posting.
323     (When using a news posting program,
324     .I ORGANIZATION
325     contains
326     an Organization line for anonymous messages. Default:
327     .BR "Anonymous Posting Service" .)
328     .TP
329     .B SENDANONMAIL
330     Path to a program for sending anonymous mail. Default:
331     .IR SENDMAIL .
332     .B SENDANONMAIL
333     can be used to invoke an external mail filter for anonymized messages.
334     .TP
335     .B SHORTNAME
336     A short name for the remailer to be used in lists. Defaults to the host name.
337     .TP
338     .B REMAILERADDR
339     The remailer mail address.
340     .TP
341     .B ANONADDR
342     An address to be inserted in the
343     .B From:
344     line of anonymous messages. Default:
345     .IR REMAILERADDR .
346     .TP
347     .B REMAILERNAME
348     A name to be inserted in the
349     .B From:
350     line of remailer status
351     messages. Default:
352     .BR "Anonymous Remailer" .
353     .TP
354     .B ANONNAME
355     A name to be inserted in the
356     .B From:
357     line of anonymous messages.
358     Default:
359     .BR "Anonymous" .
360     .TP
361     .B COMPLAINTS
362     An address for complaints to be sent to. Default:
363     .IR REMAILERADDR .
364     .TP
365     .B ERRLOG
366     Name of a file to log error messages, or
367     .B stdout
368     or
369     .BR stderr .
370     Default:
371     .BR stderr .
372     (When run from a tty, Mixmaster will always print a copy of error
373     messages to
374     .BR stderr .)
375     .TP
376     .B MAILBOX
377     A generic mail folder for non-remailer messages that are not stored in
378     any of the following folders.
379     If
380     .B MAILBOX
381     begins with a
382     .BR | ,
383     it specifies the path to a program. If it contains an
384     .B @
385     sign, the message is forwarded to the given address (with an
386     .B X-Loop:
387 weaselp 153 header to prevent mail loops). If it ends with a
388     .B /
389 rabbi 220 it is treated as a Maildir, otherwise the message is appended
390 rabbi 1 to the given file name or written to standard output if
391 weaselp 110 .B MAILBOX
392 rabbi 1 is
393     .BR stdout .
394     Default:
395     .BR mbox .
396     .TP
397     .B MAILABUSE
398     Mail folder for messages sent to the
399     .I COMPLAINTS
400     address.
401     Default:
402     .IR MAILBOX .
403     .TP
404     .B MAILBLOCK
405     Mail folder for messages sent to the remailer address with a
406     .B DESTINATION-BLOCK
407     line.
408     Default:
409     .IR MAILBOX .
410     .TP
411     .B MAILUSAGE
412     Mail folder for messages sent to the remailer address that do not
413     contain any valid remailer commands. Default:
414     .BR /dev/null .
415     .TP
416     .B MAILANON
417     Mail folder for replies sent to the
418     .I ANONADDR
419     address.
420     Default:
421     .BR /dev/null .
422     .TP
423     .B MAILERROR
424     Mail folder for messages that cannot be decrypted or contain other
425     errors. Default:
426     .BR /dev/null .
427     .TP
428     .B MAILBOUNCE
429     Mail folder for bounce messages. Default:
430     .IR MAILBOX .
431     .TP
432 weaselp 337 .B MAILIN
433     If defined an additional mail folder where Mixmaster should read messages from
434     when processing its pool. If it ends with a
435     .B /
436     it is treated as a Maildir, otherwise a standard mbox format file
437     is expected. All messages are removed from the folder after reading.
438     .B MAILIN
439     is not set by default.
440 weaselp 397 It is an incredibly bad idea to set this the same as \fBMAILBOX\fP.
441 weaselp 337 .TP
442 rabbi 1 .B VERBOSE
443     If
444     .B VERBOSE
445     is set to
446     .BR 0 ,
447     Mixmaster will log error
448 rabbi 53 messages only. If it is set to
449 rabbi 1 .BR 1 ,
450 weaselp 397 error messages and warnings are logged. If
451 rabbi 1 .B VERBOSE
452     is set to
453     .BR 2 ,
454     successful operation is logged as well.
455     If set to
456     .BR 3 ,
457     a log file entry is created whenever a message
458     enters or leaves the pool. Default:
459     .BR 2 .
460 rabbi 102 .TP
461     .B PASSPHRASE
462     A passphrase used to protect the remailer secret keys from
463     casual attackers. This setting overrides the compile-time
464     defined
465     .B COMPILEDPASS
466     which is now deprecated.
467     This should
468     .I not
469     be the same as the client passphrase.
470 rabbi 1 .PP
471     The following variables can be set to
472     .B y
473     or
474     .BR n :
475     .TP
476     .B REMAIL
477     Enable remailer functionality. Default:
478 rabbi 220 .BR n .
479 rabbi 1 .TP
480     .B MIDDLEMAN
481     Act as an intermediate hop only, forward anonymized
482 weaselp 397 messages to another remailer. This mode can be used
483 rabbi 1 where complaints about anonymous messages must be
484     avoided. (The variable
485     .B FORWARDTO
486     specifies the remailer
487 weaselp 341 chain to be used; default:
488 rabbi 1 .BR * .)
489     Default:
490     .BR n .
491     .TP
492     .B AUTOREPLY
493     Send help files in response to non-remailer messages. Explicit
494     .B remailer-help
495     requests are always served.
496     Default:
497     .BR n .
498     .TP
499     .B MIX
500     Accept Mixmaster messages. Default:
501     .BR y .
502     .TP
503     .B PGP
504     Accept OpenPGP-encrypted Cypherpunk remailer messages.
505     Default:
506     .BR y .
507     .TP
508     .B UNENCRYPTED
509     Accept unencrypted Cypherpunk remailer messages.
510     Default:
511     .BR n .
512     .TP
513     .B REMIX
514     Re-encrypt Type I messages to other remailers in the Mixmaster format
515     .RB ( x
516     = only when requested by user explicitly).
517     Default:
518     .BR y .
519     .TP
520     .B BINFILTER
521     Filter out binary attachments. Default:
522     .BR n .
523     .TP
524 weaselp 168 .B LISTSUPPORTED
525     List known remailers and their keys in remailer-conf reply. Default:
526     .BR y .
527     .TP
528 rabbi 1 .B MID
529     Use a hash of the message body as Message-ID, to avoid
530     Usenet spam. Default:
531     .BR y .
532     If
533     .B MID
534     is set to a string
535     beginning with
536     .BR @ ,
537     that string is used as the domain part of the message ID.
538     .TP
539     .B AUTOBLOCK
540     Allow users to add their address to the
541     .B dest.blk
542     file by sending the remailer a message containing the line
543     .BR destination-block .
544     Default:
545     .BR y .
546 weaselp 392 .TP
547     .B STATSDETAILS
548     List statistics on intermediate vs. final delivery in remailer-stats.
549     Default:
550     .BR y .
551 rabbi 1 .PP
552     The following variables have numeric values:
553     .TP
554     .B POOLSIZE
555     The size of the Mixmaster reordering pool. Larger sizes
556 rabbi 220 imply higher security and longer delays. Remailer default:
557     .BR 20 .
558     Client default:
559 rabbi 1 .BR 0 .
560     .TP
561     .B RATE
562 weaselp 341 Percentage of messages from the pool to be sent. Remailer default:
563 rabbi 220 .BR 95 .
564 weaselp 341 Client default:
565 rabbi 1 .BR 100 .
566     Lower values cause the pool to increase in size when
567 rabbi 220 many messages are received at a time, reducing the effect
568 rabbi 1 of flooding attacks.
569     .TP
570 rabbi 220 .B INDUMMYP
571     Probability that Mixmaster will generate dummy messages upon
572 weaselp 341 receipt of incoming mail. Larger numbers mean more dummy
573     messages on average. For instance,
574 rabbi 220 .B 10
575 weaselp 341 means that on average one in nine incoming messages will trigger
576 rabbi 220 a dummy generation, and
577 weaselp 341 .B 20
578 rabbi 220 means that one in four will.
579     .B 0
580     means no dummy messages. Remailer default:
581     .BR 20 .
582 weaselp 341 Client default:
583 rabbi 220 .BR 3 .
584     .TP
585     .B OUTDUMMYP
586     Probability that Mixmaster will generate dummy messages at
587     .B SENDPOOL
588 weaselp 341 time. If the pool is processed frequently, this should be a lower value
589 rabbi 220 than if there are long intervals between pool processing. Examples:
590 weaselp 341 .B 50
591     means on average, one dummy message will be generated per pool
592 rabbi 220 processing.
593 weaselp 341 .B 80
594     means four will be generated.
595 rabbi 220 .B 0
596     means no dummy messages. Remailer default:
597     .BR 67 .
598     Client default:
599     .BR 3 .
600     .TP
601 rabbi 1 .B SIZELIMIT
602 weaselp 397 Maximum size for anonymous messages in kB.
603 rabbi 1 .B 0
604     means no limit.
605     Default:
606     .BR 0 .
607     .TP
608     .B POP3SIZELIMIT
609 weaselp 397 Maximum size for incoming messages in kB when using POP3.
610 rabbi 1 .B 0
611     means no limit.
612     Default:
613     .BR 0 .
614     Larger messages are deleted unread if
615     .B POP3DEL
616     is set to
617     .BR y ,
618     and left on the server otherwise.
619     .TP
620     .B INFLATEMAX
621 weaselp 397 Maximum size for
622 rabbi 1 .B Inflate:
623     padding in kB.
624     .B 0
625     means padding is not allowed.
626     Default:
627     .B 50
628     .BR kB .
629     .TP
630     .B MAXRANDHOPS
631 weaselp 397 Maximum chain length for message forwarding requested by
632 rabbi 1 .B Rand-Hop
633     directives.
634     Default:
635     .BR 20 .
636     .PP
637     The following are time variables. They can be given as days, hours, or
638     minutes.
639     .TP
640     .B SENDPOOLTIME
641     How often Mixmaster should check the pool for messages
642 rabbi 220 to be sent. Remailer default:
643 rabbi 1 .BR 1h .
644 rabbi 220 Client default:
645 rabbi 378 .BR 0h .
646 rabbi 1 .TP
647     .B POP3TIME
648     How often Mixmaster should check the POP3 accounts
649     listed in
650     .B pop3.cfg
651     for new mail.
652     Default:
653     .BR 1h .
654     .TP
655 weaselp 183 .B MAILINTIME
656     How often Mixmaster should read mail from
657     .BR MAILIN
658 weaselp 341 and process mails fetched via POP3. Processing here means to
659 weaselp 183 answer remailer-xxx requests and decrypt messages to the Mixmaster
660     and place them in the pool. No other processing of the pool is
661     done. This action is always performed sending out messages from the pool (at
662     .BR SENDPOOLTIME
663     intervals) or receiving mail via POP3 (at
664     .BR POP3TIME
665 rabbi 220 intervals). Default:
666 weaselp 183 .BR 5m .
667     .TP
668 rabbi 1 .B PACKETEXP
669 weaselp 341 How long to store parts of incomplete multipart messages and other
670 rabbi 217 temporary pool files.
671 rabbi 1 Default:
672     .BR 7d .
673     .TP
674     .B IDEXP
675     Mixmaster keeps a log of packet IDs to prevent replay
676     attacks.
677     .B IDEXP
678     specifies after which period of time old
679     IDs are expired. Default:
680     .BR 7d ,
681     minimum:
682     .BR 5d .
683     If set to
684     .BR 0 ,
685     no log is kept.
686     .PP
687     The following strings must be specified at compile-time in
688     .BR config.h .
689 weaselp 397 It is not usually necessary to modify any of these:
690 rabbi 1 .TP
691     .B
692     DISCLAIMER
693     A default string to be inserted in the header of all anonymous
694     messages if no
695     .B disclaim.txt
696     file is available. If
697     .B DISCLAIMER
698     contains the substring
699     .BR "%s" ,
700     it will be substituted with the
701     .I COMPLAINTS
702     address.
703     .TP
704     .B FROMDISCLAIMER
705     A default string to be inserted at the top of the message body
706     if an anonymous message contains a user-supplied
707     .B From:
708     line and no
709     .B fromdscl.txt
710     file is available.
711     .TP
712 weaselp 166 .B MSGFOOTER
713     A default string to be inserted at the bottom of the message body
714 weaselp 397 of all anonymous messages if no
715 weaselp 166 .B footer.txt
716     file is available.
717     .TP
718 rabbi 1 .B BINDISCLAIMER
719     A string to replace the body of a binary attachment when
720     the remailer is configured to filter out binaries.
721     .TP
722     .B CHARSET
723     The character set used for MIME-encoded header lines.
724     .TP
725     .B DESTBLOCK
726 weaselp 341 A quoted list of files that contain blocked addresses.
727     Files must be separated by one space. Mixmaster will choose
728 weaselp 397 the first file for writing if
729 rabbi 1 .B AUTOBLOCK
730     is enabled.
731     .PP
732     The following variables can be set in the
733     .B Makefile
734     or in
735     .BR config.h :
736     .TP
737 rabbi 102 .B COMPILEDPASS
738 rabbi 1 A passphrase used to protect the remailer secret keys from
739     casual attackers. You can use
740     .B `make PASS="\fIyour passphrase\fB"'
741     to set a passphrase. This should
742     .I not
743 weaselp 341 be the same as the client passphrase. This option is now deprecated in
744 rabbi 102 favor of the configuration file option
745     .BR PASSPHRASE .
746 rabbi 1 .TP
747     .B SPOOL
748     Set
749     .B SPOOL
750     if you want to use a default directory other than
751     .B ~/Mix
752     or if Mixmaster is run in an environment where
753     .B $HOME
754     is not set, e.g. when invoked via
755     .BR .forward .
756     This value can be overridden by use of the environment variable
757     .BR $MIXPATH .
758     .TP
759     .B USE_SSLEAY
760     Use the SSLeay/OpenSSL cryptographic library. Currently this is the
761     only cryptographic library supported by Mixmaster.
762     .TP
763     .B USE_IDEA
764     Use the IDEA encryption algorithm. A license is required to use IDEA
765     for commercial purposes. See file
766     .B idea.txt
767     for details.
768     .TP
769     .B USE_PGP
770     Support the OpenPGP encryption format. Mixmaster does not call any
771     external encryption program.
772     .TP
773     .B USE_PCRE
774     Use the regular expression library.
775     .TP
776     .B USE_ZLIB
777     Use the
778     .B zlib
779     compression library.
780     .TP
781     .B USE_NCURSES
782     Use the
783     .B ncurses
784     library.
785     .TP
786     .B USE_SOCK
787     Use sockets to transfer mail by POP3 and SMTP.
788     .TP
789     .B USE_WINGUI
790     Use the
791     .B Win32
792     GUI.
793     .TP
794     .B HAVE_GETDOMAINNAME
795     The
796     .BR getdomainname (2)
797     function is available.
798     .SH FILES
799 rabbi 220 These filenames can be overridden by setting the corresponding configuration
800 weaselp 105 option (given in parentheses).
801 rabbi 1 .TP
802     .B mix.cfg
803     Mixmaster configuration file.
804     .TP
805     .B pubring.asc
806 weaselp 105 Type 1 remailer keys (\fBPGPREMPUBASC\fP).
807 rabbi 1 .TP
808     .B pubring.mix
809 weaselp 105 Type 2 remailer keys (\fBPUBRING\fP).
810 rabbi 1 .TP
811     .B rlist.txt
812 weaselp 105 List of reliable type 1 remailers (\fBTYPE1LIST\fP).
813 rabbi 1 .TP
814 weaselp 341 .B mlist.txt
815 weaselp 105 List of reliable type 2 remailers (\fBTYPE2REL\fP).
816 rabbi 1 .TP
817     .B type2.list
818 weaselp 105 List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
819 weaselp 397 .TP
820     .B starex.txt
821     List of remailers which should not be used in randomly generated
822     remailer chains (\fBSTAREX\fP).
823 rabbi 1 .SS Remailer files:
824     .TP
825     .B disclaim.txt
826     A string to be inserted in the header of all anonymous
827 weaselp 105 messages (\fBDISCLAIMFILE\fP).
828 rabbi 1 .TP
829     .B fromdscl.txt
830     A string to be inserted at the top of the message body
831     if an anonymous message contains a user-supplied
832     .B From:
833 weaselp 105 line (\fBFROMDSCLFILE\fP).
834 rabbi 1 .TP
835 weaselp 166 .TP
836     .B footer.txt
837     A string to be inserted at the bottom of the message body
838     of all anonymous messages (\fBMSGFOOTERFILE\fP).
839     .TP
840 rabbi 1 .B help.txt
841     Help file sent in response to
842     .B remailer-help
843 weaselp 105 requests (\fBHELPFILE\fP).
844 rabbi 1 .TP
845     .B adminkey.txt
846     The PGP key of the remailer operator sent in response to
847     .B remailer-adminkey
848 weaselp 105 requests (\fBADMKEYFILE\fP).
849 rabbi 1 .TP
850     .B abuse.txt
851     File sent in response to mail to the
852     .I COMPLAINTS
853     address if
854     .B AUTOREPLY
855 weaselp 105 is set (\fBABUSEFILE\fP).
856 rabbi 1 .TP
857     .B reply.txt
858     Help file sent in response to replies to anonymous messages if
859     .B AUTOREPLY
860 weaselp 105 is set (\fBREPLYFILE\fP).
861 rabbi 1 .TP
862     .B usage.txt
863     Help file sent in response to non-remailer message sent to
864     .I REMAILERADDR
865     if
866     .B AUTOREPLY
867     is set. If
868     .B usage.log
869     exists, recipients are logged and a reply is sent only once to avoid
870 weaselp 105 mail loops (\fBUSAGEFILE\fP).
871 rabbi 1 .TP
872     .B blocked.txt
873     Information sent in response to automatically processed blocking requests if
874     .B AUTOREPLY
875 weaselp 105 is set (\fBBLOCKFILE\fP).
876 rabbi 1 .TP
877     .B pop3.cfg
878     List of POP3 accounts with lines of the form
879     .I account@host.domain password
880     to get remailer messages from. The lines may optionally contain the
881 weaselp 105 keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
882 rabbi 1 .TP
883     .B dest.alw
884 weaselp 105 List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
885 rabbi 1 .TP
886     .B dest.blk
887     List of blocked destination addresses.
888 weaselp 105 Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
889 rabbi 1 .TP
890     .B rab.blk
891     Identical to
892     .BR dest.blk ,
893 weaselp 397 except Mixmaster will not write to this file.
894 rabbi 1 For use with external remailer abuse blocklists.
895     .TP
896     .B source.blk
897     List of blocked source addresses. If an incoming message originates
898 weaselp 397 from an address or IP in this list, it will be ignored. This
899 weaselp 105 feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
900 rabbi 1 .TP
901     .B header.blk
902     List of unwanted header fields. The file is used to delete unwanted
903     header lines (e.g. lines that indicate a false identity, or Usenet
904 weaselp 105 control messages), and do other header filtering (\fBHDRFILTER\fP).
905 weaselp 397
906 rabbi 1 A destination address or header line is left out if it contains a
907     search string or matches a regular expression specified in the block
908     file. Lines in the block file that begin and end with a slash
909     .RB ( /\fIregexp\fB/ )
910     are interpreted as regular expressions. Lines without
911     slashes are used for case-independent substring search.
912    
913     If a message contains a header line that matches a
914     .B /\fIregexp\fB/q
915     entry in
916     .BR header.blk ,
917     the entire message is deleted.
918    
919 rabbi 220 In addition, regular expressions can be substituted. Back-references
920 rabbi 1 are supported. For example
921    
922     /^From: *([^@]*) <.*>/From: $1/
923     /^From:.* \\(([^@]*)\)/From: $1/
924     /^From: *([^@]*).*$/From: $1 <\fInobody@remailer.domain\fR>/
925    
926     would allow user-defined names in the
927     .B From:
928     line, while replacing any given address with the remailer address.
929     .SS
930     Mixmaster uses the following files internally:
931     .TP
932     .B mixrand.bin
933 weaselp 105 Random seed file (\fBMIXRAND\fP).
934 rabbi 1 .TP
935     .B secrets.mix
936 weaselp 105 List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
937 rabbi 1 .TP
938     .B nymsec.pgp
939 weaselp 398 Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).
940 rabbi 1 .TP
941     .B secring.pgp
942 weaselp 105 Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
943 rabbi 1 .TP
944     .B secring.mix
945 weaselp 105 Remailer type 2 secret keys (\fBSECRING\fP).
946 rabbi 1 .TP
947     .B pgpkey.txt
948 weaselp 105 The public type 1 remailer key (\fBPGPKEY\fP).
949 rabbi 1 .TP
950     .B key.txt
951 ulfm 290 The public type 2 remailer key (\fBKEYFILE\fP).
952 rabbi 1 .TP
953     .B id.log
954 weaselp 105 Log file of messages already processed (\fBKEYFILE\fP).
955 rabbi 1 .TP
956     .B stats.log
957 weaselp 105 Log file for remailer statistics (\fBSTATS\fP).
958 rabbi 1 .TP
959 weaselp 477 .B pgpmaxcount.log
960     Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
961     .TP
962 rabbi 1 .B time.log
963 weaselp 105 Time for periodic remailer actions (\fBREGULAR\fP).
964 rabbi 1 .TP
965     .B dhparam.mix
966 weaselp 105 Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
967 rabbi 1 .TP
968     .B dsaparam.mix
969 weaselp 105 Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
970 rabbi 1 .TP
971 weaselp 348 .B mix.pid
972     Pid file in daemon mode (\fBPIDFILE\fP).
973     .TP
974 rabbi 283 .BI pool/
975     Message pool directory (\fBPOOL\fP).
976     .TP
977 rabbi 1 .BI pool/m *
978 rabbi 283 Message pool files.
979 rabbi 1 .TP
980     .BI pool/p *
981     Partial messages.
982     .TP
983     .BI pool/l *
984     Latent messages.
985     .TP
986     .BI pool/s *
987     Messages to be sent.
988     .TP
989     .BI pool/t *
990     Temporary files.
991     .SH ENVIRONMENT
992     .TP
993     .I MIXPATH
994     The path to the Mixmaster directory. The default is
995     .BR ~/Mix .
996     .TP
997     .I MIXPASS
998     The passphrase used to protect your nyms and PGP keys.
999     (The remailer uses a different passphrase.) If
1000     .I MIXPASS
1001     is not set, the client will ask for a passphrase.
1002     .SH SEE ALSO
1003     .BR pgp (1),
1004     .BR procmail (1),
1005     .BR sendmail (8).
1006     .SH COPYRIGHT
1007     (C) 1999 Anonymizer Inc.
1008     Mixmaster may be redistributed and modified under certain conditions.
1009     This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
1010     ANY KIND, either express or implied. See the file COPYRIGHT for
1011     details.

  ViewVC Help
Powered by ViewVC 1.1.5