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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 849 - (show annotations) (download)
Thu May 13 06:44:00 2004 UTC (9 years ago) by weasel
File size: 26198 byte(s)
Support nonpublished destination allow
1 .TH MIXMASTER 1 "Mixmaster Version 3.0 beta"
2 .\" $Id$
3 .SH NAME
4 mixmaster \- anonymous remailer software
5 .SH SYNOPSIS
6 .B mixmaster
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\-l \fImix1,mix2,mix3,...\fR]
13 [\fB\-c \fInum\fR]
14 [\fIuser@host\fR]
15 [\fIfilename\fR]
16 .PP
17 .B mixmaster
18 [\fB\-f\fR[\fBrfg\fR] \fIfilename\fR]
19 .PP
20 .B mixmaster \fR[\fB\-RGKSP\fR]
21 .SH DESCRIPTION
22 Mixmaster is an anonymous remailer. Remailers provide protection
23 against traffic analysis and allow sending mail anonymously or
24 pseudonymously.
25 .PP
26 In the non-interactive mode, Mixmaster reads a message from its
27 standard input or from a file. Destination address and input file can
28 be specified in the command line. If no address is given in the
29 command line, the input file is expected to contain a message complete
30 with mail headers.
31 .SH OPTIONS
32 .TP
33 .B "\-h, \-\-help"
34 Print a summary of command line options.
35 .TP
36 .B "\-V, \-\-version"
37 Print version information.
38 .TP
39 .B "\-\-about"
40 Print authorship and copyright information.
41 .TP
42 .B "\-\-config=\fIfilename"
43 Read configuration from an alternate file.
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 \-\-encrypt
75 Encrypt the message using the OpenPGP format.
76 .TP
77 .B \-\-sign
78 Sign the message using the OpenPGP format.
79 .TP
80 .B "\-l, \-\-chain=\fImix1,mix2,mix3,..."
81 Use this remailer chain to send the message. Alternatively, the input
82 message may contain a pseudo-header
83 .BR Chain: .
84 If no chain is specified, Mixmaster will use a chain of four random
85 remailers.
86 .TP
87 .B "\-T, \-\-type\-list"
88 Display the contents of the
89 .BR type2.list
90 file.
91 .TP
92 .B "\-c, \-\-copies=\fInum"
93 Send
94 .I num
95 copies of the message to increase reliability.
96 .TP
97 .B \-d, \-\-dummy
98 Generate a dummy message as protection against traffic analysis.
99 .TP
100 .B \-S, \-\-send
101 Send the message(s) from the pool.
102 .TP
103 .B \-v, \-\-verbose
104 Output informational messages.
105 .TP
106 .B "\-f\fR [\fIfile\fR]"
107 Read a mail folder or news article. This function requires ncurses support.
108 .TP
109 .B "\-fr\fR [\fIfile\fR]"
110 Reply to a message.
111 .TP
112 .B "\-ff\fR [\fIfile\fR]"
113 Post a follow-up to a message.
114 .TP
115 .B "\-fg\fR [\fIfile\fR]"
116 Send a group reply to a message.
117 .SS Remailer options:
118 .TP
119 .B "\-\-config=\fIfilename"
120 Read configuration from an alternate file.
121 .TP
122 .B \-R, \-\-read\-mail
123 Read a remailer message from standard input and store it in the pool.
124 .TP
125 .B \-I, \-\-store\-mail
126 Read a remailer message from standard input and store it in the pool
127 without decrypting it immediately. It will be processed the next time
128 Mixmaster processes the queue (called with \fP-M\fP or in daemon mode).
129 .TP
130 .B \-P, \-\-pop-mail
131 Read mail from the POP3 servers listed in
132 .BR pop3.cfg .
133 .TP
134 .B \-M, \-\-remailer
135 Check if it is time to perform the regular remailer actions:
136 Send messages from the pool, get mail from POP3 servers and keep the
137 internal files up\-to\-date.
138 .TP
139 .B \-D, \-\-daemon
140 Detach from the console and process the pool, get mail and update the
141 internal files at regular intervals.
142 .TP
143 .B \-\-no-detach
144 Run as daemon but do not detach from the terminal (This option is
145 only useful together with \fB--daemon\fP).
146 .TP
147 .B -G, \-\-generate\-key
148 Generate a new remailer key.
149 .TP
150 .B \-K, \-\-update\-keys
151 Generate remailer keys if necessary.
152 .TP
153 .B \-S, \-\-send
154 Force sending the message(s) from the pool.
155 .TP
156 .B \-\-install\-svc
157 Install the Mixmaster Service on Win32.
158 .TP
159 .B \-\-remove\-svc
160 Remove the Mixmaster Service on Win32.
161 .TP
162 .B \-\-run\-svc
163 Run the Mixmaster Service on Win32.
164 .TP
165 .B \-\-redirect
166 Read a Mixmaster packet from stdin and route it through a chain given with
167 \fB\-\-chain\fP.
168 Note that this may corrupt the packet if there is not enough space in the
169 headers (that is, if there are more than 20 hops total). This function is
170 not normaly needed but may come in handy in certain cases.
171 .SH CONFIGURATION
172 Mixmaster reads its configuration from the file
173 .B mix.cfg
174 in its working directory. The configuration file consists of lines of
175 the type
176 .PP
177 .I VARIABLE values
178 .PP
179 and of comments, which begin with a
180 .B #
181 character. The variables have reasonable default values, but it is
182 useful to create a configuration file using the
183 .B Install
184 script when setting up a remailer.
185 .PP
186 All configuration variables can be overridden from the command line,
187 e.g.
188 .B mixmaster -S --POOLSIZE=0 --RATE=100
189 will send all messages currently in the message pool.
190 .SS Client configuration:
191 .TP
192 .B ADDRESS
193 Your address for sending non-anonymous messages.
194 .TP
195 .B NAME
196 Your real name (used for sending non-anonymous messages).
197 .TP
198 .B MAILtoNEWS
199 Address of a mail-to-news gateway. Default:
200 .BR mail2news@nym.alias.net .
201 .TP
202 .B CHAIN
203 Default chain for anonymous messages to be sent.
204 .B CHAIN
205 is a comma-separated list of remailer names or addresses.
206 A
207 .B *
208 represents a random reliable remailer. Default:
209 .BR *,*,*,* .
210 .TP
211 .B NUMCOPIES
212 Number of redundant copies of an anonymous message to be
213 sent, unless specified otherwise on the command line.
214 Default:
215 .BR 1 .
216 .TP
217 .B DISTANCE
218 When selecting random remailers, the chain will contain
219 .I DISTANCE
220 other remailers between two occurrences of the
221 same remailer in the chain. Default:
222 .BR 2 .
223 .TP
224 .B MINREL
225 Only select remailers with a reliability of at least
226 .IR MINREL %.
227 Default:
228 .BR 98 .
229 .TP
230 .B RELFINAL
231 Only select a remailer with a reliability of at least
232 .IR RELFINAL %
233 as the final remailer. Default:
234 .BR 99 .
235 .TP
236 .B MAXLAT
237 Only select remailers with a latency of at most
238 .IR MAXLAT .
239 Default:
240 .BR 36h .
241 .TP
242 .B PGPPUBRING
243 Path to your public PGP key ring. Default:
244 .BR ~/.pgp/pubring.pkr .
245 (Windows default: PGP registry value.)
246 .TP
247 .B PGPSECRING
248 Path to your secret PGP key ring. Default:
249 .BR ~/.pgp/secring.skr .
250 (Windows default: PGP registry value.)
251 .TP
252 .B CLIENTAUTOFLUSH
253 If
254 .B REMAIL
255 is set to
256 .BR n
257 automatically flush the pool every time Mixmaster is run. Default:
258 .BR n .
259 .TP
260 .B SENDMAIL
261 Path to the
262 .BR sendmail (1)
263 program. If set to
264 .BR outfile ,
265 Mixmaster will create text files named
266 .BI out * .txt
267 in the
268 .B pool
269 directory instead of sending mail.
270 Default:
271 .BR "/usr/lib/sendmail -t" .
272 .TP
273 .B SMTPRELAY
274 Name of SMTP relay. If set, mail will be delivered to the relay
275 rather than by
276 .BR sendmail (1).
277 .TP
278 .B HELONAME
279 Host name used in the SMTP dialogue.
280 Default: The
281 .I ENVFROM
282 host name or the current network name associated with the socket.
283 .TP
284 .B SMTPUSERNAME
285 Some mail servers require authentication for sending mail. This is
286 the authenticated SMTP user name.
287 .B SMTPPASSWORD
288 Password for authenticated SMTP.
289 .TP
290 .B ENVFROM
291 Envelope from address used in the SMTP dialogue. (When the client is
292 used to send non-anonymous messages,
293 .I ADDRESSS
294 is used instead.)
295 Default:
296 .IR ANONADDR .
297 .SS Remailer configuration:
298 .TP
299 .B NEWS
300 Path to the news posting program, or address of a
301 mail-to-news gateway. Default: no news posting.
302 (When using a news posting program,
303 .I ORGANIZATION
304 contains
305 an Organization line for anonymous messages. Default:
306 .BR "Anonymous Posting Service" .)
307 .TP
308 .B SENDANONMAIL
309 Path to a program for sending anonymous mail. Default:
310 .IR SENDMAIL .
311 .B SENDANONMAIL
312 can be used to invoke an external mail filter for anonymized messages.
313 .TP
314 .B SHORTNAME
315 A short name for the remailer to be used in lists. Defaults to the host name.
316 .TP
317 .B REMAILERADDR
318 The remailer mail address.
319 .TP
320 .B ANONADDR
321 An address to be inserted in the
322 .B From:
323 line of anonymous messages. Default:
324 .IR REMAILERADDR .
325 .TP
326 .B REMAILERNAME
327 A name to be inserted in the
328 .B From:
329 line of remailer status
330 messages. Default:
331 .BR "Anonymous Remailer" .
332 .TP
333 .B ANONNAME
334 A name to be inserted in the
335 .B From:
336 line of anonymous messages.
337 Default:
338 .BR "Anonymous" .
339 .TP
340 .B COMPLAINTS
341 An address for complaints to be sent to. Default:
342 .IR REMAILERADDR .
343 .TP
344 .B ERRLOG
345 Name of a file to log error messages, or
346 .B stdout
347 or
348 .BR stderr .
349 Default:
350 .BR stderr .
351 (When run from a tty, Mixmaster will always print a copy of error
352 messages to
353 .BR stderr .)
354 .TP
355 .B MAILBOX
356 A generic mail folder for non-remailer messages that are not stored in
357 any of the following folders.
358 If
359 .B MAILBOX
360 begins with a
361 .BR | ,
362 it specifies the path to a program. If it contains an
363 .B @
364 sign, the message is forwarded to the given address (with an
365 .B X-Loop:
366 header to prevent mail loops). If it ends with a
367 .B /
368 it is treated as a Maildir, otherwise the message is appended
369 to the given file name or written to standard output if
370 .B MAILBOX
371 is
372 .BR stdout .
373 Default:
374 .BR mbox .
375 .TP
376 .B MAILABUSE
377 Mail folder for messages sent to the
378 .I COMPLAINTS
379 address.
380 Default:
381 .IR MAILBOX .
382 .TP
383 .B MAILBLOCK
384 Mail folder for messages sent to the remailer address with a
385 .B DESTINATION-BLOCK
386 line.
387 Default:
388 .IR MAILBOX .
389 .TP
390 .B MAILUSAGE
391 Mail folder for messages sent to the remailer address that do not
392 contain any valid remailer commands. Default:
393 .BR /dev/null .
394 .TP
395 .B MAILANON
396 Mail folder for replies sent to the
397 .I ANONADDR
398 address.
399 Default:
400 .BR /dev/null .
401 .TP
402 .B MAILERROR
403 Mail folder for messages that cannot be decrypted or contain other
404 errors. Default:
405 .BR /dev/null .
406 .TP
407 .B MAILBOUNCE
408 Mail folder for bounce messages. Default:
409 .IR MAILBOX .
410 .TP
411 .B MAILIN
412 If defined an additional mail folder where Mixmaster should read messages from
413 when processing its pool. If it ends with a
414 .B /
415 it is treated as a Maildir, otherwise a standard mbox format file
416 is expected. All messages are removed from the folder after reading.
417 .B MAILIN
418 is not set by default.
419 It is an incredibly bad idea to set this the same as \fBMAILBOX\fP.
420 .TP
421 .B VERBOSE
422 If
423 .B VERBOSE
424 is set to
425 .BR 0 ,
426 Mixmaster will log error
427 messages only. If it is set to
428 .BR 1 ,
429 error messages and warnings are logged. If
430 .B VERBOSE
431 is set to
432 .BR 2 ,
433 successful operation is logged as well.
434 If set to
435 .BR 3 ,
436 a log file entry is created whenever a message
437 enters or leaves the pool. Default:
438 .BR 2 .
439 .TP
440 .B PASSPHRASE
441 A passphrase used to protect the remailer secret keys from
442 casual attackers. This setting overrides the compile-time
443 defined
444 .B COMPILEDPASS
445 which is now deprecated.
446 This should
447 .I not
448 be the same as the client passphrase.
449 .TP
450 .B EXTFLAGS
451 Additional flags you want to set in the remailer's capabilities string.
452 Defaults to the empty string, which means none. Example:
453 .BR testing .
454 .TP
455 .B PRECEDENCE
456 Sets the header Precedence: to this value for all outgoing mail.
457 Defaults to the empty string, which means no such header is added.
458 Example:
459 .BR anon .
460 If you use this you might want to block user supplied precedence
461 headers in your header block file.
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 another 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 45 .
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 65 .
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 10 .
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 90 .
590 Client default:
591 .BR 3 .
592 .TP
593 .B SIZELIMIT
594 Maximum size for anonymous messages in kB.
595 .B 0
596 means no limit.
597 Default:
598 .BR 0 .
599 .TP
600 .B POP3SIZELIMIT
601 Maximum 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 Maximum 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 Maximum chain length for message forwarding requested by
624 .B Rand-Hop
625 directives.
626 Default:
627 .BR 4 .
628 .TP
629 .B MAXRECIPIENTS
630 limits the number of allowed recipients in outgoing mail. Anything that exceeds this
631 number is dropped silently. Default:
632 .BR 5 .
633 .TP
634 .B TEMP_FAIL
635 exit with this exit code when a timeskew problem is suspected. Also see
636 .BR TIMESKEW_BACK
637 and
638 .BR TIMESKEW_FORWARD .
639 The default of
640 .B 75
641 should cause your MTA to requeue the message if you are running
642 mixmaster from a
643 .BR .forward
644 file.
645 .PP
646 The following are time variables. They can be given as years (
647 .BR y
648 ), months (
649 .BR b
650 ), days (
651 .BR d
652 ), hours (
653 .BR h
654 ), minutes (
655 .BR m
656 ), or seconds (
657 .BR s
658 ).
659 .TP
660 .B SENDPOOLTIME
661 How often Mixmaster should check the pool for messages
662 to be sent. Remailer default:
663 .BR 15m .
664 Client default:
665 .BR 0h .
666 .TP
667 .B POP3TIME
668 How often Mixmaster should check the POP3 accounts
669 listed in
670 .B pop3.cfg
671 for new mail.
672 Default:
673 .BR 1h .
674 .TP
675 .B MAILINTIME
676 How often Mixmaster should read mail from
677 .BR MAILIN
678 and process mails fetched via POP3. Processing here means to
679 answer remailer-xxx requests and decrypt messages to the Mixmaster
680 and place them in the pool. No other processing of the pool is
681 done. This action is always performed sending out messages from the pool (at
682 .BR SENDPOOLTIME
683 intervals) or receiving mail via POP3 (at
684 .BR POP3TIME
685 intervals). Default:
686 .BR 5m .
687 .TP
688 .B PACKETEXP
689 How long to store parts of incomplete multipart messages and other
690 temporary pool files.
691 Default:
692 .BR 7d .
693 .TP
694 .B IDEXP
695 Mixmaster keeps a log of packet IDs to prevent replay
696 attacks.
697 .B IDEXP
698 specifies after which period of time old
699 IDs are expired. Default:
700 .BR 7d ,
701 minimum:
702 .BR 5d .
703 If set to
704 .BR 0 ,
705 no log is kept.
706 .TP
707 .B KEYLIFETIME
708 Mixmaster sets an expiration date on its remailer keys
709 .B KEYLIFETIME
710 after the key creation date. Default:
711 .BR 13b .
712 .TP
713 .B KEYGRACEPERIOD
714 Mixmaster will continue to decrypt messages encrypted to an expired key
715 for
716 .B KEYGRACEPERIOD
717 period of time after the expiration. This is done to ensure that messages
718 already injected into the network are allowed to exit. Do not change this
719 value unless you know what you are doing, or you will risk partitioning
720 attacks. Default:
721 .BR 7d .
722 .TP
723 .B KEYOVERLAPPERIOD
724 Mixmaster will generate and advertise a new key
725 .BR KEYOVERLAPPERIOD
726 period of time before the expiration of the key. Clients should always use
727 the most recently created valid key. Clients that deviate from this
728 recommended behavior risk partitioning attacks. Default:
729 .BR 7d .
730 .TP
731 .B TIMESKEW_BACK
732 Allow going back up to
733 .BR TIMESKEW_BACK
734 in time. If the time moved further back mixmaster will assume
735 there is a problem with your clock and refuse to start as a remailer.
736 This is done by comparing the latest timestamp in
737 .BR time.log
738 with the current timestamp. If set to
739 .BR 0
740 then this test is skipped. If the system time is indeed correct, simply
741 remove
742 .BR time.log .
743 Default:
744 .BR 12h .
745 .TP
746 .B TIMESKEW_FORWARD
747 Similar to
748 .BR TIMESKEW_BACK
749 but allow jumping this far into the future.
750 Default:
751 .BR 2w .
752 .PP
753 The following strings must be specified at compile-time in
754 .BR config.h .
755 It is not usually necessary to modify any of these:
756 .TP
757 .B
758 DISCLAIMER
759 A default string to be inserted in the header of all anonymous
760 messages if no
761 .B disclaim.txt
762 file is available. If
763 .B DISCLAIMER
764 contains the substring
765 .BR "%s" ,
766 it will be substituted with the
767 .I COMPLAINTS
768 address.
769 .TP
770 .B FROMDISCLAIMER
771 A default string to be inserted at the top of the message body
772 if an anonymous message contains a user-supplied
773 .B From:
774 line and no
775 .B fromdscl.txt
776 file is available.
777 .TP
778 .B MSGFOOTER
779 A default string to be inserted at the bottom of the message body
780 of all anonymous messages if no
781 .B footer.txt
782 file is available.
783 .TP
784 .B BINDISCLAIMER
785 A string to replace the body of a binary attachment when
786 the remailer is configured to filter out binaries.
787 .TP
788 .B CHARSET
789 The character set used for MIME-encoded header lines.
790 .TP
791 .B DESTBLOCK
792 A quoted list of files that contain blocked addresses.
793 Files must be separated by one space. Mixmaster will choose
794 the first file for writing if
795 .B AUTOBLOCK
796 is enabled.
797 .PP
798 The following variables can be set in the
799 .B Makefile
800 or in
801 .BR config.h :
802 .TP
803 .B COMPILEDPASS
804 A passphrase used to protect the remailer secret keys from
805 casual attackers. You can use
806 .B `make PASS="\fIyour passphrase\fB"'
807 to set a passphrase. This should
808 .I not
809 be the same as the client passphrase. This option is now deprecated in
810 favor of the configuration file option
811 .BR PASSPHRASE .
812 .TP
813 .B SPOOL
814 Set
815 .B SPOOL
816 if you want to use a default directory other than
817 .B ~/Mix
818 or if Mixmaster is run in an environment where
819 .B $HOME
820 is not set, e.g. when invoked via
821 .BR .forward .
822 This value can be overridden by use of the environment variable
823 .BR $MIXPATH .
824 .TP
825 .B USE_SSLEAY
826 Use the SSLeay/OpenSSL cryptographic library. Currently this is the
827 only cryptographic library supported by Mixmaster.
828 .TP
829 .B USE_IDEA
830 Use the IDEA encryption algorithm. A license is required to use IDEA
831 for commercial purposes. See file
832 .B idea.txt
833 for details.
834 .TP
835 .B USE_PGP
836 Support the OpenPGP encryption format. Mixmaster does not call any
837 external encryption program.
838 .TP
839 .B USE_PCRE
840 Use the regular expression library.
841 .TP
842 .B USE_ZLIB
843 Use the
844 .B zlib
845 compression library.
846 .TP
847 .B USE_NCURSES
848 Use the
849 .B ncurses
850 library.
851 .TP
852 .B USE_SOCK
853 Use sockets to transfer mail by POP3 and SMTP.
854 .TP
855 .B USE_WINGUI
856 Use the
857 .B Win32
858 GUI.
859 .TP
860 .B HAVE_GETDOMAINNAME
861 The
862 .BR getdomainname (2)
863 function is available.
864 .SH FILES
865 These filenames can be overridden by setting the corresponding configuration
866 option (given in parentheses).
867 .TP
868 .B mix.cfg
869 Mixmaster configuration file.
870 .TP
871 .B pubring.asc
872 Type 1 remailer keys (\fBPGPREMPUBASC\fP).
873 .TP
874 .B pubring.mix
875 Type 2 remailer keys (\fBPUBRING\fP).
876 .TP
877 .B rlist.txt
878 List of reliable type 1 remailers (\fBTYPE1LIST\fP).
879 .TP
880 .B mlist.txt
881 List of reliable type 2 remailers (\fBTYPE2REL\fP).
882 .TP
883 .B type2.list
884 List of known type 2 remailers (optional) (\fBTYPE2LIST\fP).
885 .TP
886 .B starex.txt
887 List of remailers which should not be used in randomly generated
888 remailer chains (\fBSTAREX\fP).
889 .SS Remailer files:
890 .TP
891 .B disclaim.txt
892 A string to be inserted in the header of all anonymous
893 messages (\fBDISCLAIMFILE\fP).
894 .TP
895 .B fromdscl.txt
896 A string to be inserted at the top of the message body
897 if an anonymous message contains a user-supplied
898 .B From:
899 line (\fBFROMDSCLFILE\fP).
900 .TP
901 .TP
902 .B footer.txt
903 A string to be inserted at the bottom of the message body
904 of all anonymous messages (\fBMSGFOOTERFILE\fP).
905 .TP
906 .B help.txt
907 Help file sent in response to
908 .B remailer-help
909 requests (\fBHELPFILE\fP).
910 .TP
911 .B adminkey.txt
912 The PGP key of the remailer operator sent in response to
913 .B remailer-adminkey
914 requests (\fBADMKEYFILE\fP).
915 .TP
916 .B abuse.txt
917 File sent in response to mail to the
918 .I COMPLAINTS
919 address if
920 .B AUTOREPLY
921 is set (\fBABUSEFILE\fP).
922 .TP
923 .B reply.txt
924 Help file sent in response to replies to anonymous messages if
925 .B AUTOREPLY
926 is set (\fBREPLYFILE\fP).
927 .TP
928 .B usage.txt
929 Help file sent in response to non-remailer message sent to
930 .I REMAILERADDR
931 if
932 .B AUTOREPLY
933 is set. If
934 .B usage.log
935 exists, recipients are logged and a reply is sent only once to avoid
936 mail loops (\fBUSAGEFILE\fP).
937 .TP
938 .B blocked.txt
939 Information sent in response to automatically processed blocking requests if
940 .B AUTOREPLY
941 is set (\fBBLOCKFILE\fP).
942 .TP
943 .B pop3.cfg
944 List of POP3 accounts with lines of the form
945 .I account@host.domain password
946 to get remailer messages from. The lines may optionally contain the
947 keyword "apop" or "pass" to select an authentication method (\fBPOP3CONF\fP).
948 .TP
949 .B dest.alw
950 List of addresses to which Mixmaster will deliver, even in middleman mode (\fBDESTALLOW\fP).
951 .TP
952 .B dest.alw.nonpublished
953 Similar to
954 .BR dest.alw ,
955 with the only difference that this list is not published in remailer-conf replies (\fBDESTALLOW2\fP).
956 .TP
957 .B dest.blk
958 List of blocked destination addresses.
959 Mixmaster does not send mail to the blocked addresses listed in this file (\fBDESTBLOCK\fP).
960 .TP
961 .B rab.blk
962 Identical to
963 .BR dest.blk ,
964 except Mixmaster will not write to this file.
965 For use with external remailer abuse blocklists.
966 .TP
967 .B source.blk
968 List of blocked source addresses. If an incoming message originates
969 from an address or IP in this list, it will be ignored. This
970 feature can be used to avoid spam and other abusive mail (\fBSOURCEBLOCK\fP).
971 .TP
972 .B header.blk
973 List of unwanted header fields. The file is used to delete unwanted
974 header lines (e.g. lines that indicate a false identity, or Usenet
975 control messages), and do other header filtering (\fBHDRFILTER\fP).
976
977 A destination address or header line is left out if it contains a
978 search string or matches a regular expression specified in the block
979 file. Lines in the block file that begin and end with a slash
980 .RB ( /\fIregexp\fB/ )
981 are interpreted as regular expressions. Lines without
982 slashes are used for case-independent substring search.
983
984 If a message contains a header line that matches a
985 .B /\fIregexp\fB/q
986 entry in
987 .BR header.blk ,
988 the entire message is deleted.
989
990 In addition, regular expressions can be substituted. Back-references
991 are supported. For example
992
993 /^From: *([^@]*) <.*>/From: $1/
994 /^From:.* \\(([^@]*)\)/From: $1/
995 /^From: *([^@]*).*$/From: $1 <\fInobody@remailer.domain\fR>/
996
997 would allow user-defined names in the
998 .B From:
999 line, while replacing any given address with the remailer address.
1000 .SS
1001 Mixmaster uses the following files internally:
1002 .TP
1003 .B mixrand.bin
1004 Random seed file (\fBMIXRAND\fP).
1005 .TP
1006 .B secring.pgp
1007 Remailer type 1 secret keys (\fBPGPREMSECRING\fP).
1008 .TP
1009 .B secring.mix
1010 Remailer type 2 secret keys (\fBSECRING\fP).
1011 .TP
1012 .B pgpkey.txt
1013 The public type 1 remailer key (\fBPGPKEY\fP).
1014 .TP
1015 .B key.txt
1016 The public type 2 remailer key (\fBKEYFILE\fP).
1017 .TP
1018 .B id.log
1019 Log file of messages already processed (\fBIDLOG\fP).
1020 .TP
1021 .B stats.log
1022 Log file for remailer statistics (\fBSTATS\fP).
1023 .TP
1024 .B pgpmaxcount.log
1025 Log file for PGP Max-Count statistics (\fBPGPMAXCOUNT\fP).
1026 .TP
1027 .B time.log
1028 Time for periodic remailer actions (\fBREGULAR\fP).
1029 .TP
1030 .B dhparam.mix
1031 Public Diffie-Hellman parameters used for El-Gamal key generation (\fBDHPARAMS\fP).
1032 .TP
1033 .B dsaparam.mix
1034 Public DSA parameters used for DSA key generation (\fBDSAPARAMS\fP).
1035 .TP
1036 .B mixmaster.pid
1037 Pid file in daemon mode (\fBPIDFILE\fP).
1038 .TP
1039 .BI pool/
1040 Message pool directory (\fBPOOL\fP).
1041 .TP
1042 .BI pool/m *
1043 Message pool files.
1044 .TP
1045 .BI pool/p *
1046 Partial messages.
1047 .TP
1048 .BI pool/l *
1049 Latent messages.
1050 .TP
1051 .BI pool/s *
1052 Messages to be sent.
1053 .TP
1054 .BI pool/t *
1055 Temporary files.
1056 .SH ENVIRONMENT
1057 .TP
1058 .I MIXPATH
1059 The path to the Mixmaster directory. The default is
1060 .BR ~/Mix .
1061 .TP
1062 .I MIXPASS
1063 The passphrase used to protect your nyms and PGP keys.
1064 (The remailer uses a different passphrase.) If
1065 .I MIXPASS
1066 is not set, the client will ask for a passphrase.
1067 .SH SEE ALSO
1068 .BR mpgp (1),
1069 .BR pgp (1),
1070 .BR procmail (1),
1071 .BR sendmail (8).
1072 .SH HISTORY
1073 Mixmaster is an implementation of a Chuamian mix-net system.
1074 Versions 1.0 through 2.0.3 of the
1075 .BR mixmaster
1076 remailer were originally written by Lance Cottrell. Mixmaster was first
1077 released in 1995. Ulf Moeller collaborated on version 2.0.4, and began an
1078 entire rewrite of
1079 .BR mixmaster
1080 in 1999. This rewrite was released in 2002 as version 2.9.0, with major
1081 contributions from Janis Jagars, Peter Palfrader, and Len Sassaman.
1082 Mixmaster 3.0 is based on the 2.9 codebase. Peter Palfrader and Len
1083 Sassaman are the principal maintainers. For more information on
1084 contributing authors, please see the file THANKS for details.
1085 .SH COPYRIGHT
1086 (C) 1999 - 2004 Anonymizer Inc. and others.
1087 Mixmaster may be redistributed and modified under certain conditions.
1088 This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
1089 ANY KIND, either express or implied. See the file COPYRIGHT for
1090 details.

Properties

Name Value
svn:keywords Id

  ViewVC Help
Powered by ViewVC 1.1.5