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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

Name Value
svn:keywords Id

  ViewVC Help
Powered by ViewVC 1.1.5