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

Contents of /trunk/Mix/mixmaster.1

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.5