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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 269 - (hide annotations) (download)
Wed Sep 25 23:02:44 2002 UTC (10 years, 7 months ago) by ulfm
Original Path: trunk/Mix/mix.1
File size: 23186 byte(s)
AUTH LOGIN support for SMTP.
1 rabbi 1 .TH MIX 1 "Mixmaster Version 3.0 beta"
2 ulfm 269 .\" $Id: mix.1,v 1.17 2002/09/25 23:02:44 ulfm 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 ulfm 269 Host name used in the SMTP dialogue.
288 rabbi 1 Default: The
289     .I ENVFROM
290     host name or the current network name associated with the socket.
291     .TP
292 ulfm 269 .B SMTPUSERNAME
293     Some mail servers require authentication for sending mail. This is
294     the authenticated SMTP user name.
295     .B SMTPPASSWORD
296     Password for authenticated SMTP.
297     .TP
298 rabbi 1 .B ENVFROM
299     Envelope from address used in the SMTP dialogue. (When the client is
300     used to send non-anonymous messages,
301     .I ADDRESSS
302     is used instead.)
303     Default:
304     .IR ANONADDR .
305     .TP
306     .B NEWS
307     Path to the news posting program, or address of a
308     mail-to-news gateway. Default: no news posting.
309     (When using a news posting program,
310     .I ORGANIZATION
311     contains
312     an Organization line for anonymous messages. Default:
313     .BR "Anonymous Posting Service" .)
314     .TP
315     .B SENDANONMAIL
316     Path to a program for sending anonymous mail. Default:
317     .IR SENDMAIL .
318     .B SENDANONMAIL
319     can be used to invoke an external mail filter for anonymized messages.
320     .TP
321     .B SHORTNAME
322     A short name for the remailer to be used in lists. Defaults to the host name.
323     .TP
324     .B REMAILERADDR
325     The remailer mail address.
326     .TP
327     .B ANONADDR
328     An address to be inserted in the
329     .B From:
330     line of anonymous messages. Default:
331     .IR REMAILERADDR .
332     .TP
333     .B REMAILERNAME
334     A name to be inserted in the
335     .B From:
336     line of remailer status
337     messages. Default:
338     .BR "Anonymous Remailer" .
339     .TP
340     .B ANONNAME
341     A name to be inserted in the
342     .B From:
343     line of anonymous messages.
344     Default:
345     .BR "Anonymous" .
346     .TP
347     .B COMPLAINTS
348     An address for complaints to be sent to. Default:
349     .IR REMAILERADDR .
350     .TP
351     .B ERRLOG
352     Name of a file to log error messages, or
353     .B stdout
354     or
355     .BR stderr .
356     Default:
357     .BR stderr .
358     (When run from a tty, Mixmaster will always print a copy of error
359     messages to
360     .BR stderr .)
361     .TP
362     .B MAILBOX
363     A generic mail folder for non-remailer messages that are not stored in
364     any of the following folders.
365     If
366     .B MAILBOX
367     begins with a
368     .BR | ,
369     it specifies the path to a program. If it contains an
370     .B @
371     sign, the message is forwarded to the given address (with an
372     .B X-Loop:
373 weaselp 153 header to prevent mail loops). If it ends with a
374     .B /
375 rabbi 220 it is treated as a Maildir, otherwise the message is appended
376 rabbi 1 to the given file name or written to standard output if
377 weaselp 110 .B MAILBOX
378 rabbi 1 is
379     .BR stdout .
380     Default:
381     .BR mbox .
382     .TP
383 weaselp 163 .B MAILIN
384     If defined an additional mail folder where Mixmaster should read messages from
385     when processing its pool. If it ends with a
386     .B /
387 rabbi 220 it is treated as a Maildir, otherwise a standard mbox format file
388 weaselp 163 is expected. All messages are removed from the folder after reading.
389     .B MAILIN
390     is not set by default.
391     It is an incredible bad idea to set this the same as \fBMAILBOX\fP.
392     .TP
393 rabbi 1 .B MAILABUSE
394     Mail folder for messages sent to the
395     .I COMPLAINTS
396     address.
397     Default:
398     .IR MAILBOX .
399     .TP
400     .B MAILBLOCK
401     Mail folder for messages sent to the remailer address with a
402     .B DESTINATION-BLOCK
403     line.
404     Default:
405     .IR MAILBOX .
406     .TP
407     .B MAILUSAGE
408     Mail folder for messages sent to the remailer address that do not
409     contain any valid remailer commands. Default:
410     .BR /dev/null .
411     .TP
412     .B MAILANON
413     Mail folder for replies sent to the
414     .I ANONADDR
415     address.
416     Default:
417     .BR /dev/null .
418     .TP
419     .B MAILERROR
420     Mail folder for messages that cannot be decrypted or contain other
421     errors. Default:
422     .BR /dev/null .
423     .TP
424     .B MAILBOUNCE
425     Mail folder for bounce messages. Default:
426     .IR MAILBOX .
427     .TP
428     .B VERBOSE
429     If
430     .B VERBOSE
431     is set to
432     .BR 0 ,
433     Mixmaster will log error
434 rabbi 53 messages only. If it is set to
435 rabbi 1 .BR 1 ,
436     error message and warnings are logged. If
437     .B VERBOSE
438     is set to
439     .BR 2 ,
440     successful operation is logged as well.
441     If set to
442     .BR 3 ,
443     a log file entry is created whenever a message
444     enters or leaves the pool. Default:
445     .BR 2 .
446 rabbi 102 .TP
447     .B PASSPHRASE
448     A passphrase used to protect the remailer secret keys from
449     casual attackers. This setting overrides the compile-time
450     defined
451     .B COMPILEDPASS
452     which is now deprecated.
453     This should
454     .I not
455     be the same as the client passphrase.
456 rabbi 1 .PP
457     The following variables can be set to
458     .B y
459     or
460     .BR n :
461     .TP
462     .B REMAIL
463     Enable remailer functionality. Default:
464 rabbi 220 .BR n .
465 rabbi 1 .TP
466     .B MIDDLEMAN
467     Act as an intermediate hop only, forward anonymized
468     messages to an other remailer. This mode can be used
469     where complaints about anonymous messages must be
470     avoided. (The variable
471     .B FORWARDTO
472     specifies the remailer
473     chain to be used; default:
474     .BR * .)
475     Default:
476     .BR n .
477     .TP
478     .B AUTOREPLY
479     Send help files in response to non-remailer messages. Explicit
480     .B remailer-help
481     requests are always served.
482     Default:
483     .BR n .
484     .TP
485     .B MIX
486     Accept Mixmaster messages. Default:
487     .BR y .
488     .TP
489     .B PGP
490     Accept OpenPGP-encrypted Cypherpunk remailer messages.
491     Default:
492     .BR y .
493     .TP
494     .B UNENCRYPTED
495     Accept unencrypted Cypherpunk remailer messages.
496     Default:
497     .BR n .
498     .TP
499     .B REMIX
500     Re-encrypt Type I messages to other remailers in the Mixmaster format
501     .RB ( x
502     = only when requested by user explicitly).
503     Default:
504     .BR y .
505     .TP
506     .B BINFILTER
507     Filter out binary attachments. Default:
508     .BR n .
509     .TP
510 weaselp 168 .B LISTSUPPORTED
511     List known remailers and their keys in remailer-conf reply. Default:
512     .BR y .
513     .TP
514 rabbi 1 .B MID
515     Use a hash of the message body as Message-ID, to avoid
516     Usenet spam. Default:
517     .BR y .
518     If
519     .B MID
520     is set to a string
521     beginning with
522     .BR @ ,
523     that string is used as the domain part of the message ID.
524     .TP
525     .B AUTOBLOCK
526     Allow users to add their address to the
527     .B dest.blk
528     file by sending the remailer a message containing the line
529     .BR destination-block .
530     Default:
531     .BR y .
532     .PP
533     The following variables have numeric values:
534     .TP
535     .B POOLSIZE
536     The size of the Mixmaster reordering pool. Larger sizes
537 rabbi 220 imply higher security and longer delays. Remailer default:
538     .BR 20 .
539     Client default:
540 rabbi 1 .BR 0 .
541     .TP
542     .B RATE
543 rabbi 220 Percentage of messages from the pool to be sent. Remailer default:
544     .BR 95 .
545     Client default:
546 rabbi 1 .BR 100 .
547     Lower values cause the pool to increase in size when
548 rabbi 220 many messages are received at a time, reducing the effect
549 rabbi 1 of flooding attacks.
550     .TP
551 rabbi 220 .B INDUMMYP
552     Probability that Mixmaster will generate dummy messages upon
553     receipt of incoming mail. Larger numbers mean more dummy
554     messages on average. For instance,
555     .B 10
556     means that on average one in nine incoming messages will trigger
557     a dummy generation, and
558     .B 20
559     means that one in four will.
560     .B 0
561     means no dummy messages. Remailer default:
562     .BR 20 .
563     Client default:
564     .BR 3 .
565     .TP
566     .B OUTDUMMYP
567     Probability that Mixmaster will generate dummy messages at
568     .B SENDPOOL
569     time. If the pool is processed frequently, this should be a lower value
570     than if there are long intervals between pool processing. Examples:
571     .B 50
572     means on average, one dummy message will be generated per pool
573     processing.
574     .B 80
575     means four will be generated.
576     .B 0
577     means no dummy messages. Remailer default:
578     .BR 67 .
579     Client default:
580     .BR 3 .
581     .TP
582 rabbi 1 .B SIZELIMIT
583     Maximal size for anonymous messages in kB.
584     .B 0
585     means no limit.
586     Default:
587     .BR 0 .
588     .TP
589     .B POP3SIZELIMIT
590     Maximal size for incoming messages in kB when using POP3.
591     .B 0
592     means no limit.
593     Default:
594     .BR 0 .
595     Larger messages are deleted unread if
596     .B POP3DEL
597     is set to
598     .BR y ,
599     and left on the server otherwise.
600     .TP
601     .B INFLATEMAX
602     Maximal size for
603     .B Inflate:
604     padding in kB.
605     .B 0
606     means padding is not allowed.
607     Default:
608     .B 50
609     .BR kB .
610     .TP
611     .B MAXRANDHOPS
612     Maximal chain length for message forwarding requested by
613     .B Rand-Hop
614     directives.
615     Default:
616     .BR 20 .
617     .PP
618     The following are time variables. They can be given as days, hours, or
619     minutes.
620     .TP
621     .B SENDPOOLTIME
622     How often Mixmaster should check the pool for messages
623 rabbi 220 to be sent. Remailer default:
624 rabbi 1 .BR 1h .
625 rabbi 220 Client default:
626     .BR 6h .
627 rabbi 1 .TP
628     .B POP3TIME
629     How often Mixmaster should check the POP3 accounts
630     listed in
631     .B pop3.cfg
632     for new mail.
633     Default:
634     .BR 1h .
635     .TP
636 weaselp 183 .B MAILINTIME
637     How often Mixmaster should read mail from
638     .BR MAILIN
639     and process mails fetched via POP3. Processing here means to
640     answer remailer-xxx requests and decrypt messages to the Mixmaster
641     and place them in the pool. No other processing of the pool is
642     done. This action is always performed sending out messages from the pool (at
643     .BR SENDPOOLTIME
644     intervals) or receiving mail via POP3 (at
645     .BR POP3TIME
646 rabbi 220 intervals). Default:
647 weaselp 183 .BR 5m .
648     .TP
649 rabbi 1 .B PACKETEXP
650 rabbi 217 How long to store parts of incomplete multipart messages and other
651     temporary pool files.
652 rabbi 1 Default:
653     .BR 7d .
654     .TP
655     .B IDEXP
656     Mixmaster keeps a log of packet IDs to prevent replay
657     attacks.
658     .B IDEXP
659     specifies after which period of time old
660     IDs are expired. Default:
661     .BR 7d ,
662     minimum:
663     .BR 5d .
664     If set to
665     .BR 0 ,
666     no log is kept.
667     .PP
668     The following strings must be specified at compile-time in
669     .BR config.h .
670     Usually it is not necessary to modify any of these:
671     .TP
672     .B
673     DISCLAIMER
674     A default string to be inserted in the header of all anonymous
675     messages if no
676     .B disclaim.txt
677     file is available. If
678     .B DISCLAIMER
679     contains the substring
680     .BR "%s" ,
681     it will be substituted with the
682     .I COMPLAINTS
683     address.
684     .TP
685     .B FROMDISCLAIMER
686     A default string to be inserted at the top of the message body
687     if an anonymous message contains a user-supplied
688     .B From:
689     line and no
690     .B fromdscl.txt
691     file is available.
692     .TP
693 weaselp 166 .B MSGFOOTER
694     A default string to be inserted at the bottom of the message body
695     of all anonymous messages and no
696     .B footer.txt
697     file is available.
698     .TP
699 rabbi 1 .B BINDISCLAIMER
700     A string to replace the body of a binary attachment when
701     the remailer is configured to filter out binaries.
702     .TP
703     .B CHARSET
704     The character set used for MIME-encoded header lines.
705     .TP
706     .B DESTBLOCK
707     A quoted list of files that contain blocked addresses.
708     Files must be separated by one space. Mixmaster will choose
709     the first file for writing
710     .B AUTOBLOCK
711     is enabled.
712     .PP
713     The following variables can be set in the
714     .B Makefile
715     or in
716     .BR config.h :
717     .TP
718 rabbi 102 .B COMPILEDPASS
719 rabbi 1 A passphrase used to protect the remailer secret keys from
720     casual attackers. You can use
721     .B `make PASS="\fIyour passphrase\fB"'
722     to set a passphrase. This should
723     .I not
724 rabbi 102 be the same as the client passphrase. This option is now deprecated in
725     favor of the configuration file option
726     .BR PASSPHRASE .
727 rabbi 1 .TP
728     .B SPOOL
729     Set
730     .B SPOOL
731     if you want to use a default directory other than
732     .B ~/Mix
733     or if Mixmaster is run in an environment where
734     .B $HOME
735     is not set, e.g. when invoked via
736     .BR .forward .
737     This value can be overridden by use of the environment variable
738     .BR $MIXPATH .
739     .TP
740     .B USE_SSLEAY
741     Use the SSLeay/OpenSSL cryptographic library. Currently this is the
742     only cryptographic library supported by Mixmaster.
743     .TP
744     .B USE_IDEA
745     Use the IDEA encryption algorithm. A license is required to use IDEA
746     for commercial purposes. See file
747     .B idea.txt
748     for details.
749     .TP
750     .B USE_PGP
751     Support the OpenPGP encryption format. Mixmaster does not call any
752     external encryption program.
753     .TP
754     .B USE_PCRE
755     Use the regular expression library.
756     .TP
757     .B USE_ZLIB
758     Use the
759     .B zlib
760     compression library.
761     .TP
762     .B USE_NCURSES
763     Use the
764     .B ncurses
765     library.
766     .TP
767     .B USE_SOCK
768     Use sockets to transfer mail by POP3 and SMTP.
769     .TP
770     .B USE_WINGUI
771     Use the
772     .B Win32
773     GUI.
774     .TP
775     .B HAVE_GETDOMAINNAME
776     The
777     .BR getdomainname (2)
778     function is available.
779     .SH FILES
780 rabbi 220 These filenames can be overridden by setting the corresponding configuration
781 weaselp 105 option (given in parentheses).
782 rabbi 1 .TP
783     .B mix.cfg
784     Mixmaster configuration file.
785     .TP
786     .B pubring.asc
787 weaselp 105 Type 1 remailer keys (\fBPGPREMPUBASC\fP).
788 rabbi 1 .TP
789     .B pubring.mix
790 weaselp 105 Type 2 remailer keys (\fBPUBRING\fP).
791 rabbi 1 .TP
792     .B rlist.txt
793 weaselp 105 List of reliable type 1 remailers (\fBTYPE1LIST\fP).
794 rabbi 1 .TP
795     .B mlist.txt
796 weaselp 105 List of reliable type 2 remailers (\fBTYPE2REL\fP).
797 rabbi 1 .TP
798     .B type2.list
799 weaselp 105 List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
800 rabbi 1 .SS Remailer files:
801     .TP
802     .B disclaim.txt
803     A string to be inserted in the header of all anonymous
804 weaselp 105 messages (\fBDISCLAIMFILE\fP).
805 rabbi 1 .TP
806     .B fromdscl.txt
807     A string to be inserted at the top of the message body
808     if an anonymous message contains a user-supplied
809     .B From:
810 weaselp 105 line (\fBFROMDSCLFILE\fP).
811 rabbi 1 .TP
812 weaselp 166 .TP
813     .B footer.txt
814     A string to be inserted at the bottom of the message body
815     of all anonymous messages (\fBMSGFOOTERFILE\fP).
816     .TP
817 rabbi 1 .B help.txt
818     Help file sent in response to
819     .B remailer-help
820 weaselp 105 requests (\fBHELPFILE\fP).
821 rabbi 1 .TP
822     .B adminkey.txt
823     The PGP key of the remailer operator sent in response to
824     .B remailer-adminkey
825 weaselp 105 requests (\fBADMKEYFILE\fP).
826 rabbi 1 .TP
827     .B abuse.txt
828     File sent in response to mail to the
829     .I COMPLAINTS
830     address if
831     .B AUTOREPLY
832 weaselp 105 is set (\fBABUSEFILE\fP).
833 rabbi 1 .TP
834     .B reply.txt
835     Help file sent in response to replies to anonymous messages if
836     .B AUTOREPLY
837 weaselp 105 is set (\fBREPLYFILE\fP).
838 rabbi 1 .TP
839     .B usage.txt
840     Help file sent in response to non-remailer message sent to
841     .I REMAILERADDR
842     if
843     .B AUTOREPLY
844     is set. If
845     .B usage.log
846     exists, recipients are logged and a reply is sent only once to avoid
847 weaselp 105 mail loops (\fBUSAGEFILE\fP).
848 rabbi 1 .TP
849     .B blocked.txt
850     Information sent in response to automatically processed blocking requests if
851     .B AUTOREPLY
852 weaselp 105 is set (\fBBLOCKFILE\fP).
853 rabbi 1 .TP
854     .B pop3.cfg
855     List of POP3 accounts with lines of the form
856     .I account@host.domain password
857     to get remailer messages from. The lines may optionally contain the
858 weaselp 105 keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
859 rabbi 1 .TP
860     .B dest.alw
861 weaselp 105 List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
862 rabbi 1 .TP
863     .B dest.blk
864     List of blocked destination addresses.
865 weaselp 105 Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
866 rabbi 1 .TP
867     .B rab.blk
868     Identical to
869     .BR dest.blk ,
870     except that Mixmaster will not write to this file.
871     For use with external remailer abuse blocklists.
872     .TP
873     .B source.blk
874     List of blocked source addresses. If an incoming message originates
875     from an address or IP in this in this list, it will be ignored. This
876 weaselp 105 feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
877 rabbi 1 .TP
878     .B header.blk
879     List of unwanted header fields. The file is used to delete unwanted
880     header lines (e.g. lines that indicate a false identity, or Usenet
881 weaselp 105 control messages), and do other header filtering (\fBHDRFILTER\fP).
882 rabbi 1 .PP
883     A destination address or header line is left out if it contains a
884     search string or matches a regular expression specified in the block
885     file. Lines in the block file that begin and end with a slash
886     .RB ( /\fIregexp\fB/ )
887     are interpreted as regular expressions. Lines without
888     slashes are used for case-independent substring search.
889    
890     If a message contains a header line that matches a
891     .B /\fIregexp\fB/q
892     entry in
893     .BR header.blk ,
894     the entire message is deleted.
895    
896 rabbi 220 In addition, regular expressions can be substituted. Back-references
897 rabbi 1 are supported. For example
898    
899     /^From: *([^@]*) <.*>/From: $1/
900     /^From:.* \\(([^@]*)\)/From: $1/
901     /^From: *([^@]*).*$/From: $1 <\fInobody@remailer.domain\fR>/
902    
903     would allow user-defined names in the
904     .B From:
905     line, while replacing any given address with the remailer address.
906     .SS
907     Mixmaster uses the following files internally:
908     .TP
909     .B mixrand.bin
910 weaselp 105 Random seed file (\fBMIXRAND\fP).
911 rabbi 1 .TP
912     .B secrets.mix
913 weaselp 105 List of your nyms with configuration data (encrypted) (\fBNYMDB\fP).
914 rabbi 1 .TP
915     .B nymsec.pgp
916 weaselp 105 Your nyms' secret PGP keys (encrypted) (\fBNYMSECRING\fP).
917 rabbi 1 .TP
918     .B secring.pgp
919 weaselp 105 Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
920 rabbi 1 .TP
921     .B secring.mix
922 weaselp 105 Remailer type 2 secret keys (\fBSECRING\fP).
923 rabbi 1 .TP
924     .B pgpkey.txt
925 weaselp 105 The public type 1 remailer key (\fBPGPKEY\fP).
926 rabbi 1 .TP
927     .B key.txt
928 weaselp 105 The public type 2 remailer key (\fB\fP).
929 rabbi 1 .TP
930     .B id.log
931 weaselp 105 Log file of messages already processed (\fBKEYFILE\fP).
932 rabbi 1 .TP
933     .B stats.log
934 weaselp 105 Log file for remailer statistics (\fBSTATS\fP).
935 rabbi 1 .TP
936     .B time.log
937 weaselp 105 Time for periodic remailer actions (\fBREGULAR\fP).
938 rabbi 1 .TP
939     .B dhparam.mix
940 weaselp 105 Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
941 rabbi 1 .TP
942     .B dsaparam.mix
943 weaselp 105 Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
944 rabbi 1 .TP
945     .BI pool/m *
946     Message pool.
947     .TP
948     .BI pool/p *
949     Partial messages.
950     .TP
951     .BI pool/l *
952     Latent messages.
953     .TP
954     .BI pool/s *
955     Messages to be sent.
956     .TP
957     .BI pool/t *
958     Temporary files.
959     .SH ENVIRONMENT
960     .TP
961     .I MIXPATH
962     The path to the Mixmaster directory. The default is
963     .BR ~/Mix .
964     .TP
965     .I MIXPASS
966     The passphrase used to protect your nyms and PGP keys.
967     (The remailer uses a different passphrase.) If
968     .I MIXPASS
969     is not set, the client will ask for a passphrase.
970     .SH SEE ALSO
971     .BR pgp (1),
972     .BR procmail (1),
973     .BR sendmail (8).
974     .SH COPYRIGHT
975     (C) 1999 Anonymizer Inc.
976     Mixmaster may be redistributed and modified under certain conditions.
977     This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
978     ANY KIND, either express or implied. See the file COPYRIGHT for
979     details.

  ViewVC Help
Powered by ViewVC 1.1.5