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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

Name Value
svn:keywords Id

  ViewVC Help
Powered by ViewVC 1.1.5