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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 220 - (hide annotations) (download)
Fri Sep 6 21:04:16 2002 UTC (10 years, 8 months ago) by rabbi
Original Path: trunk/Mix/mix.1
File size: 23012 byte(s)
Updated documentation for {IN,OUT}DUMMYP, and to reflect changes in
remailer defaults.

Mixmaster now has a sanity-check on the number of dummy messages
generated automatically.

Fixed typos in mix.1 and Install.

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

  ViewVC Help
Powered by ViewVC 1.1.5