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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 548 - (hide annotations) (download)
Mon Jul 7 11:32:45 2003 UTC (9 years, 10 months ago) by weaselp
Original Path: trunk/Mix/mix.1
File size: 24454 byte(s)
Config option PRECEDENCE allows setting the Precedence: header on all outgoing
mail.  (Hauke Lampe)
1 rabbi 1 .TH MIX 1 "Mixmaster Version 3.0 beta"
2 weaselp 548 .\" $Id: mix.1,v 1.33 2003/07/07 11:32:45 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 .TP
281     .B SENDMAIL
282     Path to the
283     .BR sendmail (1)
284     program. If set to
285     .BR outfile ,
286     Mixmaster will create text files named
287     .BI out * .txt
288     in the
289     .B pool
290     directory instead of sending mail.
291     Default:
292     .BR "/usr/lib/sendmail -t" .
293     .TP
294     .B SMTPRELAY
295     Name of SMTP relay. If set, mail will be delivered to the relay
296     rather than by
297     .BR sendmail (1).
298     .TP
299     .B HELONAME
300 ulfm 269 Host name used in the SMTP dialogue.
301 rabbi 1 Default: The
302     .I ENVFROM
303     host name or the current network name associated with the socket.
304     .TP
305 ulfm 269 .B SMTPUSERNAME
306     Some mail servers require authentication for sending mail. This is
307     the authenticated SMTP user name.
308     .B SMTPPASSWORD
309     Password for authenticated SMTP.
310     .TP
311 rabbi 1 .B ENVFROM
312     Envelope from address used in the SMTP dialogue. (When the client is
313     used to send non-anonymous messages,
314     .I ADDRESSS
315     is used instead.)
316     Default:
317     .IR ANONADDR .
318 weaselp 527 .SS Remailer configuration:
319 rabbi 1 .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 weaselp 547 .TP
471     .B EXTFLAGS
472     Additional flags you want to set in the remailer's capabilities string.
473 weaselp 548 Defaults to the empty string, which means none. Example:
474     .BR testing .
475     .TP
476     .B PRECEDENCE
477     Sets the header Precedence: to this value for all outgoing mail.
478     Defaults to the empty string, which means no such header is added.
479     Example:
480     .BR anon .
481     If you use this you might want to block user supplied precedence
482     headers in your header block file.
483 rabbi 1 .PP
484     The following variables can be set to
485     .B y
486     or
487     .BR n :
488     .TP
489     .B REMAIL
490     Enable remailer functionality. Default:
491 rabbi 220 .BR n .
492 rabbi 1 .TP
493     .B MIDDLEMAN
494     Act as an intermediate hop only, forward anonymized
495 weaselp 397 messages to another remailer. This mode can be used
496 rabbi 1 where complaints about anonymous messages must be
497     avoided. (The variable
498     .B FORWARDTO
499     specifies the remailer
500 weaselp 341 chain to be used; default:
501 rabbi 1 .BR * .)
502     Default:
503     .BR n .
504     .TP
505     .B AUTOREPLY
506     Send help files in response to non-remailer messages. Explicit
507     .B remailer-help
508     requests are always served.
509     Default:
510     .BR n .
511     .TP
512     .B MIX
513     Accept Mixmaster messages. Default:
514     .BR y .
515     .TP
516     .B PGP
517     Accept OpenPGP-encrypted Cypherpunk remailer messages.
518     Default:
519     .BR y .
520     .TP
521     .B UNENCRYPTED
522     Accept unencrypted Cypherpunk remailer messages.
523     Default:
524     .BR n .
525     .TP
526     .B REMIX
527     Re-encrypt Type I messages to other remailers in the Mixmaster format
528     .RB ( x
529     = only when requested by user explicitly).
530     Default:
531     .BR y .
532     .TP
533     .B BINFILTER
534     Filter out binary attachments. Default:
535     .BR n .
536     .TP
537 weaselp 168 .B LISTSUPPORTED
538     List known remailers and their keys in remailer-conf reply. Default:
539     .BR y .
540     .TP
541 rabbi 1 .B MID
542     Use a hash of the message body as Message-ID, to avoid
543     Usenet spam. Default:
544     .BR y .
545     If
546     .B MID
547     is set to a string
548     beginning with
549     .BR @ ,
550     that string is used as the domain part of the message ID.
551     .TP
552     .B AUTOBLOCK
553     Allow users to add their address to the
554     .B dest.blk
555     file by sending the remailer a message containing the line
556     .BR destination-block .
557     Default:
558     .BR y .
559 weaselp 392 .TP
560     .B STATSDETAILS
561     List statistics on intermediate vs. final delivery in remailer-stats.
562     Default:
563     .BR y .
564 rabbi 1 .PP
565     The following variables have numeric values:
566     .TP
567     .B POOLSIZE
568     The size of the Mixmaster reordering pool. Larger sizes
569 rabbi 220 imply higher security and longer delays. Remailer default:
570     .BR 20 .
571     Client default:
572 rabbi 1 .BR 0 .
573     .TP
574     .B RATE
575 weaselp 341 Percentage of messages from the pool to be sent. Remailer default:
576 rabbi 220 .BR 95 .
577 weaselp 341 Client default:
578 rabbi 1 .BR 100 .
579     Lower values cause the pool to increase in size when
580 rabbi 220 many messages are received at a time, reducing the effect
581 rabbi 1 of flooding attacks.
582     .TP
583 rabbi 220 .B INDUMMYP
584     Probability that Mixmaster will generate dummy messages upon
585 weaselp 341 receipt of incoming mail. Larger numbers mean more dummy
586     messages on average. For instance,
587 rabbi 220 .B 10
588 weaselp 341 means that on average one in nine incoming messages will trigger
589 rabbi 220 a dummy generation, and
590 weaselp 341 .B 20
591 rabbi 220 means that one in four will.
592     .B 0
593     means no dummy messages. Remailer default:
594     .BR 20 .
595 weaselp 341 Client default:
596 rabbi 220 .BR 3 .
597     .TP
598     .B OUTDUMMYP
599     Probability that Mixmaster will generate dummy messages at
600     .B SENDPOOL
601 weaselp 341 time. If the pool is processed frequently, this should be a lower value
602 rabbi 220 than if there are long intervals between pool processing. Examples:
603 weaselp 341 .B 50
604     means on average, one dummy message will be generated per pool
605 rabbi 220 processing.
606 weaselp 341 .B 80
607     means four will be generated.
608 rabbi 220 .B 0
609     means no dummy messages. Remailer default:
610     .BR 67 .
611     Client default:
612     .BR 3 .
613     .TP
614 rabbi 1 .B SIZELIMIT
615 weaselp 397 Maximum size for anonymous messages in kB.
616 rabbi 1 .B 0
617     means no limit.
618     Default:
619     .BR 0 .
620     .TP
621     .B POP3SIZELIMIT
622 weaselp 397 Maximum size for incoming messages in kB when using POP3.
623 rabbi 1 .B 0
624     means no limit.
625     Default:
626     .BR 0 .
627     Larger messages are deleted unread if
628     .B POP3DEL
629     is set to
630     .BR y ,
631     and left on the server otherwise.
632     .TP
633     .B INFLATEMAX
634 weaselp 397 Maximum size for
635 rabbi 1 .B Inflate:
636     padding in kB.
637     .B 0
638     means padding is not allowed.
639     Default:
640     .B 50
641     .BR kB .
642     .TP
643     .B MAXRANDHOPS
644 weaselp 397 Maximum chain length for message forwarding requested by
645 rabbi 1 .B Rand-Hop
646     directives.
647     Default:
648 weaselp 545 .BR 4 .
649     .TP
650     .B MAXRECIPIENTS
651     limits the number of allowed recipients in outgoing mail. Anything that exceeds this
652     number is dropped silently. Default:
653     .BR 5 .
654 rabbi 1 .PP
655     The following are time variables. They can be given as days, hours, or
656     minutes.
657     .TP
658     .B SENDPOOLTIME
659     How often Mixmaster should check the pool for messages
660 rabbi 220 to be sent. Remailer default:
661 rabbi 1 .BR 1h .
662 rabbi 220 Client default:
663 rabbi 378 .BR 0h .
664 rabbi 1 .TP
665     .B POP3TIME
666     How often Mixmaster should check the POP3 accounts
667     listed in
668     .B pop3.cfg
669     for new mail.
670     Default:
671     .BR 1h .
672     .TP
673 weaselp 183 .B MAILINTIME
674     How often Mixmaster should read mail from
675     .BR MAILIN
676 weaselp 341 and process mails fetched via POP3. Processing here means to
677 weaselp 183 answer remailer-xxx requests and decrypt messages to the Mixmaster
678     and place them in the pool. No other processing of the pool is
679     done. This action is always performed sending out messages from the pool (at
680     .BR SENDPOOLTIME
681     intervals) or receiving mail via POP3 (at
682     .BR POP3TIME
683 rabbi 220 intervals). Default:
684 weaselp 183 .BR 5m .
685     .TP
686 rabbi 1 .B PACKETEXP
687 weaselp 341 How long to store parts of incomplete multipart messages and other
688 rabbi 217 temporary pool files.
689 rabbi 1 Default:
690     .BR 7d .
691     .TP
692     .B IDEXP
693     Mixmaster keeps a log of packet IDs to prevent replay
694     attacks.
695     .B IDEXP
696     specifies after which period of time old
697     IDs are expired. Default:
698     .BR 7d ,
699     minimum:
700     .BR 5d .
701     If set to
702     .BR 0 ,
703     no log is kept.
704     .PP
705     The following strings must be specified at compile-time in
706     .BR config.h .
707 weaselp 397 It is not usually necessary to modify any of these:
708 rabbi 1 .TP
709     .B
710     DISCLAIMER
711     A default string to be inserted in the header of all anonymous
712     messages if no
713     .B disclaim.txt
714     file is available. If
715     .B DISCLAIMER
716     contains the substring
717     .BR "%s" ,
718     it will be substituted with the
719     .I COMPLAINTS
720     address.
721     .TP
722     .B FROMDISCLAIMER
723     A default string to be inserted at the top of the message body
724     if an anonymous message contains a user-supplied
725     .B From:
726     line and no
727     .B fromdscl.txt
728     file is available.
729     .TP
730 weaselp 166 .B MSGFOOTER
731     A default string to be inserted at the bottom of the message body
732 weaselp 397 of all anonymous messages if no
733 weaselp 166 .B footer.txt
734     file is available.
735     .TP
736 rabbi 1 .B BINDISCLAIMER
737     A string to replace the body of a binary attachment when
738     the remailer is configured to filter out binaries.
739     .TP
740     .B CHARSET
741     The character set used for MIME-encoded header lines.
742     .TP
743     .B DESTBLOCK
744 weaselp 341 A quoted list of files that contain blocked addresses.
745     Files must be separated by one space. Mixmaster will choose
746 weaselp 397 the first file for writing if
747 rabbi 1 .B AUTOBLOCK
748     is enabled.
749     .PP
750     The following variables can be set in the
751     .B Makefile
752     or in
753     .BR config.h :
754     .TP
755 rabbi 102 .B COMPILEDPASS
756 rabbi 1 A passphrase used to protect the remailer secret keys from
757     casual attackers. You can use
758     .B `make PASS="\fIyour passphrase\fB"'
759     to set a passphrase. This should
760     .I not
761 weaselp 341 be the same as the client passphrase. This option is now deprecated in
762 rabbi 102 favor of the configuration file option
763     .BR PASSPHRASE .
764 rabbi 1 .TP
765     .B SPOOL
766     Set
767     .B SPOOL
768     if you want to use a default directory other than
769     .B ~/Mix
770     or if Mixmaster is run in an environment where
771     .B $HOME
772     is not set, e.g. when invoked via
773     .BR .forward .
774     This value can be overridden by use of the environment variable
775     .BR $MIXPATH .
776     .TP
777     .B USE_SSLEAY
778     Use the SSLeay/OpenSSL cryptographic library. Currently this is the
779     only cryptographic library supported by Mixmaster.
780     .TP
781     .B USE_IDEA
782     Use the IDEA encryption algorithm. A license is required to use IDEA
783     for commercial purposes. See file
784     .B idea.txt
785     for details.
786     .TP
787     .B USE_PGP
788     Support the OpenPGP encryption format. Mixmaster does not call any
789     external encryption program.
790     .TP
791     .B USE_PCRE
792     Use the regular expression library.
793     .TP
794     .B USE_ZLIB
795     Use the
796     .B zlib
797     compression library.
798     .TP
799     .B USE_NCURSES
800     Use the
801     .B ncurses
802     library.
803     .TP
804     .B USE_SOCK
805     Use sockets to transfer mail by POP3 and SMTP.
806     .TP
807     .B USE_WINGUI
808     Use the
809     .B Win32
810     GUI.
811     .TP
812     .B HAVE_GETDOMAINNAME
813     The
814     .BR getdomainname (2)
815     function is available.
816     .SH FILES
817 rabbi 220 These filenames can be overridden by setting the corresponding configuration
818 weaselp 105 option (given in parentheses).
819 rabbi 1 .TP
820     .B mix.cfg
821     Mixmaster configuration file.
822     .TP
823     .B pubring.asc
824 weaselp 105 Type 1 remailer keys (\fBPGPREMPUBASC\fP).
825 rabbi 1 .TP
826     .B pubring.mix
827 weaselp 105 Type 2 remailer keys (\fBPUBRING\fP).
828 rabbi 1 .TP
829     .B rlist.txt
830 weaselp 105 List of reliable type 1 remailers (\fBTYPE1LIST\fP).
831 rabbi 1 .TP
832 weaselp 341 .B mlist.txt
833 weaselp 105 List of reliable type 2 remailers (\fBTYPE2REL\fP).
834 rabbi 1 .TP
835     .B type2.list
836 weaselp 105 List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
837 weaselp 397 .TP
838     .B starex.txt
839     List of remailers which should not be used in randomly generated
840     remailer chains (\fBSTAREX\fP).
841 rabbi 1 .SS Remailer files:
842     .TP
843     .B disclaim.txt
844     A string to be inserted in the header of all anonymous
845 weaselp 105 messages (\fBDISCLAIMFILE\fP).
846 rabbi 1 .TP
847     .B fromdscl.txt
848     A string to be inserted at the top of the message body
849     if an anonymous message contains a user-supplied
850     .B From:
851 weaselp 105 line (\fBFROMDSCLFILE\fP).
852 rabbi 1 .TP
853 weaselp 166 .TP
854     .B footer.txt
855     A string to be inserted at the bottom of the message body
856     of all anonymous messages (\fBMSGFOOTERFILE\fP).
857     .TP
858 rabbi 1 .B help.txt
859     Help file sent in response to
860     .B remailer-help
861 weaselp 105 requests (\fBHELPFILE\fP).
862 rabbi 1 .TP
863     .B adminkey.txt
864     The PGP key of the remailer operator sent in response to
865     .B remailer-adminkey
866 weaselp 105 requests (\fBADMKEYFILE\fP).
867 rabbi 1 .TP
868     .B abuse.txt
869     File sent in response to mail to the
870     .I COMPLAINTS
871     address if
872     .B AUTOREPLY
873 weaselp 105 is set (\fBABUSEFILE\fP).
874 rabbi 1 .TP
875     .B reply.txt
876     Help file sent in response to replies to anonymous messages if
877     .B AUTOREPLY
878 weaselp 105 is set (\fBREPLYFILE\fP).
879 rabbi 1 .TP
880     .B usage.txt
881     Help file sent in response to non-remailer message sent to
882     .I REMAILERADDR
883     if
884     .B AUTOREPLY
885     is set. If
886     .B usage.log
887     exists, recipients are logged and a reply is sent only once to avoid
888 weaselp 105 mail loops (\fBUSAGEFILE\fP).
889 rabbi 1 .TP
890     .B blocked.txt
891     Information sent in response to automatically processed blocking requests if
892     .B AUTOREPLY
893 weaselp 105 is set (\fBBLOCKFILE\fP).
894 rabbi 1 .TP
895     .B pop3.cfg
896     List of POP3 accounts with lines of the form
897     .I account@host.domain password
898     to get remailer messages from. The lines may optionally contain the
899 weaselp 105 keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
900 rabbi 1 .TP
901     .B dest.alw
902 weaselp 105 List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
903 rabbi 1 .TP
904     .B dest.blk
905     List of blocked destination addresses.
906 weaselp 105 Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
907 rabbi 1 .TP
908     .B rab.blk
909     Identical to
910     .BR dest.blk ,
911 weaselp 397 except Mixmaster will not write to this file.
912 rabbi 1 For use with external remailer abuse blocklists.
913     .TP
914     .B source.blk
915     List of blocked source addresses. If an incoming message originates
916 weaselp 397 from an address or IP in this list, it will be ignored. This
917 weaselp 105 feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
918 rabbi 1 .TP
919     .B header.blk
920     List of unwanted header fields. The file is used to delete unwanted
921     header lines (e.g. lines that indicate a false identity, or Usenet
922 weaselp 105 control messages), and do other header filtering (\fBHDRFILTER\fP).
923 weaselp 397
924 rabbi 1 A destination address or header line is left out if it contains a
925     search string or matches a regular expression specified in the block
926     file. Lines in the block file that begin and end with a slash
927     .RB ( /\fIregexp\fB/ )
928     are interpreted as regular expressions. Lines without
929     slashes are used for case-independent substring search.
930    
931     If a message contains a header line that matches a
932     .B /\fIregexp\fB/q
933     entry in
934     .BR header.blk ,
935     the entire message is deleted.
936    
937 rabbi 220 In addition, regular expressions can be substituted. Back-references
938 rabbi 1 are supported. For example
939    
940     /^From: *([^@]*) <.*>/From: $1/
941     /^From:.* \\(([^@]*)\)/From: $1/
942     /^From: *([^@]*).*$/From: $1 <\fInobody@remailer.domain\fR>/
943    
944     would allow user-defined names in the
945     .B From:
946     line, while replacing any given address with the remailer address.
947     .SS
948     Mixmaster uses the following files internally:
949     .TP
950     .B mixrand.bin
951 weaselp 105 Random seed file (\fBMIXRAND\fP).
952 rabbi 1 .TP
953     .B secrets.mix
954 weaselp 105 List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
955 rabbi 1 .TP
956     .B nymsec.pgp
957 weaselp 398 Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).
958 rabbi 1 .TP
959     .B secring.pgp
960 weaselp 105 Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
961 rabbi 1 .TP
962     .B secring.mix
963 weaselp 105 Remailer type 2 secret keys (\fBSECRING\fP).
964 rabbi 1 .TP
965     .B pgpkey.txt
966 weaselp 105 The public type 1 remailer key (\fBPGPKEY\fP).
967 rabbi 1 .TP
968     .B key.txt
969 ulfm 290 The public type 2 remailer key (\fBKEYFILE\fP).
970 rabbi 1 .TP
971     .B id.log
972 weaselp 105 Log file of messages already processed (\fBKEYFILE\fP).
973 rabbi 1 .TP
974     .B stats.log
975 weaselp 105 Log file for remailer statistics (\fBSTATS\fP).
976 rabbi 1 .TP
977 weaselp 477 .B pgpmaxcount.log
978     Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
979     .TP
980 rabbi 1 .B time.log
981 weaselp 105 Time for periodic remailer actions (\fBREGULAR\fP).
982 rabbi 1 .TP
983     .B dhparam.mix
984 weaselp 105 Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
985 rabbi 1 .TP
986     .B dsaparam.mix
987 weaselp 105 Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
988 rabbi 1 .TP
989 weaselp 348 .B mix.pid
990     Pid file in daemon mode (\fBPIDFILE\fP).
991     .TP
992 rabbi 283 .BI pool/
993     Message pool directory (\fBPOOL\fP).
994     .TP
995 rabbi 1 .BI pool/m *
996 rabbi 283 Message pool files.
997 rabbi 1 .TP
998     .BI pool/p *
999     Partial messages.
1000     .TP
1001     .BI pool/l *
1002     Latent messages.
1003     .TP
1004     .BI pool/s *
1005     Messages to be sent.
1006     .TP
1007     .BI pool/t *
1008     Temporary files.
1009     .SH ENVIRONMENT
1010     .TP
1011     .I MIXPATH
1012     The path to the Mixmaster directory. The default is
1013     .BR ~/Mix .
1014     .TP
1015     .I MIXPASS
1016     The passphrase used to protect your nyms and PGP keys.
1017     (The remailer uses a different passphrase.) If
1018     .I MIXPASS
1019     is not set, the client will ask for a passphrase.
1020     .SH SEE ALSO
1021     .BR pgp (1),
1022     .BR procmail (1),
1023     .BR sendmail (8).
1024     .SH COPYRIGHT
1025     (C) 1999 Anonymizer Inc.
1026     Mixmaster may be redistributed and modified under certain conditions.
1027     This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
1028     ANY KIND, either express or implied. See the file COPYRIGHT for
1029     details.

  ViewVC Help
Powered by ViewVC 1.1.5