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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.5