Contents of /trunk/Mix/README

Mixmaster version 3 -- anonymous remailer software -- (C) 1999 Anonymizer Inc.
------------------------------------------------------------------------------

PREVIEW VERSION  ---  WARNING: THIS SOFTWARE IS UNDER DEVELOPMENT!

This program consists of

* a remailer client:

  The remailer client supports sending anonymous mail using Cypherpunk
  and Mixmaster remailers, managing pseudonyms at Newnym nym servers
  and receiving mail anonymously from Cypherpunk remailers. It supports
  OpenPGP encryption (compatible with PGP 2, PGP 5 and GnuPG).

  The client can be used with a menu-based user interface and with
  command line options.

* a remailer:

  The remailer supports the Cypherpunk and Mixmaster message formats.
  It can be integrated with the mail delivery system of Unix-based
  computers or use the POP3 and SMTP protocols for mail transfer.
  Mixmaster includes an automated abuse-handling system.

Please report any problems to <mix-devel@melontraffickers.com>.

[Note: The final release of Mixmaster 3.0 will include the improved
Mixmaster protocol version 3.]


Installation:
------------

Libraries:

  Mixmaster uses the cryptographic library OpenSSL. If you want to use
  the menu-based user interface, you also need the ncurses library. If
  these libraries are not installed on your system, get them from
  ftp://mixmaster.anonymizer.com/ and extract them in the Src
  directory first.

  The Perl Compatable Regular Expressions library can be obtained from
  ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

  The zlib compression libraries can be obtained at

To install or upgrade Mixmaster, type `./Install'.

Mixmaster uses lists of currently operating remailers and information
about their reliability. You can get the current remailer lists from
http://anon.efga.org/ and http://mixmaster.shinn.net/ and via finger from
nym.alias.net:

  pubring.asc    Type 1 remailer keys
  pubring.mix    Type 2 remailer keys
  rlist.txt      List of reliable type 1 remailers
  mlist.txt      List of reliable type 2 remailers
  type2.list     List of known type 2 remailers (optional)

If you wish to participate in the Remailer Abuse Blocklist, you will need 
to obtain the blocklist file from http://www.paracrypt.com/remailerabuse/ 
and place it in your Mix directory. This may be automated with cron.

For support for multiple RAB services, edit the file Src/config.h manually,
and add additional block files to the existing line, such as:

#define DESTBLOCK "dest.blk rab.blk rab2.blk rab3.blk"

Note that only the first file should the the local block list, as it is the
only file mix will open for writing. Most users will not need to edit 
config.h.


Using the remailer client:
-------------------------

To use the menu-based user interface, simply run `mix'. To send an
anonymous or pseudonymous reply to a message from within your mail or
news reader, you can pipe it to `mix'.

The interactive mode supports sending mail, manages pseudonymous
accounts at nym servers and contains a simple mail reading function.
OpenPGP messages are encrypted and decrypted automatically. It can
also decrypt messages encrypted to ordinary non-anonymous OpenPGP keys
if you use the same passphrase for the nyms as for the OpenPGP key.

In the non-interactive mode, Mixmaster reads a message from a file or
from its standard input. The command line options are described in the
manual page (mix.1).


Mixmaster as a remailer:
-----------------------

The Mixmaster remailer can be installed on any account that can
receive mail. Non-remailer messages will be delivered as usual. If
you have root access, you may want to create a new user (e.g.,
`remailer') and install Mixmaster under that user id.

The Install script provides a simple way to set up the remailer. More
information about configuring Mixmaster can be found in the manual
page. Typically, incoming mail is piped to "mix -RM". In a UUCP
setting, it may be useful to use just "mix -R", and run "mix -S" once
all messages have arrived.

To upgrade from a Mixmaster 2.0.* remailer installation, make a
backup of your keys and configuration files before you run Install.


Installation problems:
---------------------

In case one of the libraries Mixmaster uses is installed incorrectly
on your system, place the library source code (available from
ftp://mixmaster.anonymizer.com) in the Src directory, remove the old
Makefile, run the Install script again and answer `y' when asked
whether to use the source code.

The ncurses library can use termcap and terminfo databases. The
Mixmaster Install script tries to find out whether terminfo is
available. If you get a "Can't open display" error when starting
the Mixmaster menu, run "./configure --enable-termcap; make lib/libncurses.a" 
in the ncurses directory.


Security notes:
--------------

The ciphers and the anonymizing mix-net protocol used in Mixmaster
correspond to the state of the art (see the Security Considerations
section of the Mixmaster Protocol specification for details). However,
no security proofs exist for any practical cryptosystem. It is
unlikely that their security will be broken, but there is no "perfect
security". Software can also contain implementation errors. The
complete Mixmaster source code is available for public review, so that
everyone can verify what the program does, and it is unlikely that
security related errors or secret back doors in the software would go
unnoticed.

No software is secure if run in an insecure environment. For that
reason you must make sure that there is no malicious software (such as
viruses) running on your computer. Deleted files and even passphrases
can in many cases be read from the hard disk if an adversary has
access to the computer. The use of disk encryption programs is
recommended to avoid this risk.

Anonymous messages are secure as long as at least one of the remailers
you use in a chain is honest. You can use up to 20 remailers in a
chain, but reliability and speed decrease with longer chains. Four is
a reasonable number of remailers to use. Many remailer operators sign
their keys. You should verify those signatures with OpenPGP to make
sure that you have the actual remailer keys.

Anonymous keys usually cannot be introduced to the OpenPGP web of
trust without giving up anonymity. For that reason, this client will
use any OpenPGP key found on the key ring, whether it is certified or
not. Your key ring must not contain any invalid keys when used with
this program.

If you want to use a pseudonym, the client will ask you for a
passphrase to protect the nym database. Your passphrase should be
long, and hard to guess. Anyone who gets hold of your nym database and
private keys and can determine the passphrase will be able to
compromise your pseudonymous identities. Note that some operating
systems may store your passphrase on your hard disk in clear.

While a good client passphrase can protect your keys if someone gets
hold of your files, the remailer passphrase offers only casual
protection for the remailer keys. If you install a remailer, the
remailer passphrase must be different from your private passphrases.


Copyright:
---------

Mixmaster may be redistributed and modified under certain conditions.
This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
ANY KIND, either express or implied. See the file COPYRIGHT for
details.

A license is required to use the IDEA(TM) algorithm for commercial
purposes; see the file idea.txt for details.

Mixmaster uses the compression library zlib by Jean-loup Gailly and Mark
Adler, the free ncurses library and the regex library by Philip Hazel.
This product includes cryptographic software written by Eric Young
(eay@cryptsoft.com). This product includes software developed by the
OpenSSL Project for use in the OpenSSL Toolkit (http://www.OpenSSL.org/).
For some platforms: This product includes software developed by the
University of California, Berkeley and its contributors.

All trademarks are the property of their respective owners.

$Id: README,v 1.1 2001/10/31 08:19:53 rabbi Exp $
1	rabbi	1	Mixmaster version 3 -- anonymous remailer software -- (C) 1999 Anonymizer Inc.
2			------------------------------------------------------------------------------
3
4			PREVIEW VERSION --- WARNING: THIS SOFTWARE IS UNDER DEVELOPMENT!
5
6			This program consists of
7
8			* a remailer client:
9
10			The remailer client supports sending anonymous mail using Cypherpunk
11			and Mixmaster remailers, managing pseudonyms at Newnym nym servers
12			and receiving mail anonymously from Cypherpunk remailers. It supports
13			OpenPGP encryption (compatible with PGP 2, PGP 5 and GnuPG).
14
15			The client can be used with a menu-based user interface and with
16			command line options.
17
18			* a remailer:
19
20			The remailer supports the Cypherpunk and Mixmaster message formats.
21			It can be integrated with the mail delivery system of Unix-based
22			computers or use the POP3 and SMTP protocols for mail transfer.
23			Mixmaster includes an automated abuse-handling system.
24
25			Please report any problems to <mix-devel@melontraffickers.com>.
26
27			[Note: The final release of Mixmaster 3.0 will include the improved
28			Mixmaster protocol version 3.]
29
30
31			Installation:
32			------------
33
34			Libraries:
35
36			Mixmaster uses the cryptographic library OpenSSL. If you want to use
37			the menu-based user interface, you also need the ncurses library. If
38			these libraries are not installed on your system, get them from
39			ftp://mixmaster.anonymizer.com/ and extract them in the Src
40			directory first.
41
42			The Perl Compatable Regular Expressions library can be obtained from
43			ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/
44
45			The zlib compression libraries can be obtained at
46
47			To install or upgrade Mixmaster, type `./Install'.
48
49			Mixmaster uses lists of currently operating remailers and information
50			about their reliability. You can get the current remailer lists from
51			http://anon.efga.org/ and http://mixmaster.shinn.net/ and via finger from
52			nym.alias.net:
53
54			pubring.asc Type 1 remailer keys
55			pubring.mix Type 2 remailer keys
56			rlist.txt List of reliable type 1 remailers
57			mlist.txt List of reliable type 2 remailers
58			type2.list List of known type 2 remailers (optional)
59
60			If you wish to participate in the Remailer Abuse Blocklist, you will need
61			to obtain the blocklist file from http://www.paracrypt.com/remailerabuse/
62			and place it in your Mix directory. This may be automated with cron.
63
64			For support for multiple RAB services, edit the file Src/config.h manually,
65			and add additional block files to the existing line, such as:
66
67			#define DESTBLOCK "dest.blk rab.blk rab2.blk rab3.blk"
68
69			Note that only the first file should the the local block list, as it is the
70			only file mix will open for writing. Most users will not need to edit
71			config.h.
72
73
74			Using the remailer client:
75			-------------------------
76
77			To use the menu-based user interface, simply run `mix'. To send an
78			anonymous or pseudonymous reply to a message from within your mail or
79			news reader, you can pipe it to `mix'.
80
81			The interactive mode supports sending mail, manages pseudonymous
82			accounts at nym servers and contains a simple mail reading function.
83			OpenPGP messages are encrypted and decrypted automatically. It can
84			also decrypt messages encrypted to ordinary non-anonymous OpenPGP keys
85			if you use the same passphrase for the nyms as for the OpenPGP key.
86
87			In the non-interactive mode, Mixmaster reads a message from a file or
88			from its standard input. The command line options are described in the
89			manual page (mix.1).
90
91
92			Mixmaster as a remailer:
93			-----------------------
94
95			The Mixmaster remailer can be installed on any account that can
96			receive mail. Non-remailer messages will be delivered as usual. If
97			you have root access, you may want to create a new user (e.g.,
98			`remailer') and install Mixmaster under that user id.
99
100			The Install script provides a simple way to set up the remailer. More
101			information about configuring Mixmaster can be found in the manual
102			page. Typically, incoming mail is piped to "mix -RM". In a UUCP
103			setting, it may be useful to use just "mix -R", and run "mix -S" once
104			all messages have arrived.
105
106			To upgrade from a Mixmaster 2.0.* remailer installation, make a
107			backup of your keys and configuration files before you run Install.
108
109
110			Installation problems:
111			---------------------
112
113			In case one of the libraries Mixmaster uses is installed incorrectly
114			on your system, place the library source code (available from
115			ftp://mixmaster.anonymizer.com) in the Src directory, remove the old
116			Makefile, run the Install script again and answer `y' when asked
117			whether to use the source code.
118
119			The ncurses library can use termcap and terminfo databases. The
120			Mixmaster Install script tries to find out whether terminfo is
121			available. If you get a "Can't open display" error when starting
122			the Mixmaster menu, run "./configure --enable-termcap; make lib/libncurses.a"
123			in the ncurses directory.
124
125
126			Security notes:
127			--------------
128
129			The ciphers and the anonymizing mix-net protocol used in Mixmaster
130			correspond to the state of the art (see the Security Considerations
131			section of the Mixmaster Protocol specification for details). However,
132			no security proofs exist for any practical cryptosystem. It is
133			unlikely that their security will be broken, but there is no "perfect
134			security". Software can also contain implementation errors. The
135			complete Mixmaster source code is available for public review, so that
136			everyone can verify what the program does, and it is unlikely that
137			security related errors or secret back doors in the software would go
138			unnoticed.
139
140			No software is secure if run in an insecure environment. For that
141			reason you must make sure that there is no malicious software (such as
142			viruses) running on your computer. Deleted files and even passphrases
143			can in many cases be read from the hard disk if an adversary has
144			access to the computer. The use of disk encryption programs is
145			recommended to avoid this risk.
146
147			Anonymous messages are secure as long as at least one of the remailers
148			you use in a chain is honest. You can use up to 20 remailers in a
149			chain, but reliability and speed decrease with longer chains. Four is
150			a reasonable number of remailers to use. Many remailer operators sign
151			their keys. You should verify those signatures with OpenPGP to make
152			sure that you have the actual remailer keys.
153
154			Anonymous keys usually cannot be introduced to the OpenPGP web of
155			trust without giving up anonymity. For that reason, this client will
156			use any OpenPGP key found on the key ring, whether it is certified or
157			not. Your key ring must not contain any invalid keys when used with
158			this program.
159
160			If you want to use a pseudonym, the client will ask you for a
161			passphrase to protect the nym database. Your passphrase should be
162			long, and hard to guess. Anyone who gets hold of your nym database and
163			private keys and can determine the passphrase will be able to
164			compromise your pseudonymous identities. Note that some operating
165			systems may store your passphrase on your hard disk in clear.
166
167			While a good client passphrase can protect your keys if someone gets
168			hold of your files, the remailer passphrase offers only casual
169			protection for the remailer keys. If you install a remailer, the
170			remailer passphrase must be different from your private passphrases.
171
172
173			Copyright:
174			---------
175
176			Mixmaster may be redistributed and modified under certain conditions.
177			This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
178			ANY KIND, either express or implied. See the file COPYRIGHT for
179			details.
180
181			A license is required to use the IDEA(TM) algorithm for commercial
182			purposes; see the file idea.txt for details.
183
184			Mixmaster uses the compression library zlib by Jean-loup Gailly and Mark
185			Adler, the free ncurses library and the regex library by Philip Hazel.
186			This product includes cryptographic software written by Eric Young
187			(eay@cryptsoft.com). This product includes software developed by the
188			OpenSSL Project for use in the OpenSSL Toolkit (http://www.OpenSSL.org/).
189			For some platforms: This product includes software developed by the
190			University of California, Berkeley and its contributors.
191
192			All trademarks are the property of their respective owners.
193
194			$Id: README,v 1.1 2001/10/31 08:19:53 rabbi Exp $