/*
 * README
 *
 * This is the README for the Network-Attached Secure Disks (NASD)
 * Prototype, release 1.3 (May 2000).
 */
/*
 * Copyright (c) of Carnegie Mellon University, 1996,1997,1998,1999.
 *
 * Permission to reproduce, use, and prepare derivative works of
 * this software for internal use is granted provided the copyright
 * and "No Warranty" statements are included with all reproductions
 * and derivative works. This software may also be redistributed
 * without charge provided that the copyright and "No Warranty"
 * statements are included in all redistributions.
 *
 * NO WARRANTY. THIS SOFTWARE IS FURNISHED ON AN "AS IS" BASIS.
 * CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER
 * EXPRESSED OR IMPLIED AS TO THE MATTER INCLUDING, BUT NOT LIMITED
 * TO: WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY
 * OF RESULTS OR RESULTS OBTAINED FROM USE OF THIS SOFTWARE. CARNEGIE
 * MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT
 * TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 */

==========
BUILD INSTRUCTIONS
==========

To build everything from source, type:

./itomf       (generates Makefiles)
make depend   (generates dependencies)
make          (builds everything in the default build)

To see options for itomf, run "./itomf -h". For example, to specify
that "make install" should place targets in /usr/local/nasd,
"./itomf -d /usr/local/nasd".

"make clean" will remove all generated targets. "make sterile" will
remove all generated targets as well as the Makefiles, returning the
tree to the original distribution state.

If itomf dies with the error "Your perl is too old; I need perl 5.",
that means it couldn't find a copy of Perl 5 in your path named either
"perl" or "perl5". If you have Perl 5 installed on your system, make
sure it's in your path. If you don't have Perl 5 installed on your
system, you'll need to install it. Several parts of the NASD build
process rely on it.

If you wish to use NASD over DCE RPC on Linux, you will need to
download and install FreeDCE for Linux. Instructions for doing this
are in the file linuxdce/README.

If you are building on FreeBSD, you must use GNU Make. The "make"
supplied with FreeBSD has problems with some of the Makefiles that
imake generates. If you do not have GNU Make on your system and you
have installed the optional FreeBSD ports package, you can build it by
doing the following (as root):

	cd /usr/ports/devel/gmake
	make install

If you did not install the ports package, you will have to obtain the
source to GNU Make and install it as "gmake". When building the
source, you should run "gmake depend" and "gmake".

==========
NOTES
==========

Due to concerns over U.S. Government export restrictions, we have
removed all encryption code from the NASD release. Therefore, all data
is sent in the clear over the network, and an adversary can
potentially read your disk traffic. The portions of the NASD security
code which implement integrity (as opposed to privacy) have been left
in place.

If you make changes to or fix bugs in the NASD distribution, you are
encouraged to submit them to the NASD development team by e-mailing
patches to <nasd-prototype-support@cs.cmu.edu>.

If you have questions or would like to receive announcements of new
releases, you can subscribe to the NASD Prototype mailing list by
sending mail to <nasd-prototype-request@cs.cmu.edu>. Submissions to
the list should be sent to <nasd-prototype@cs.cmu.edu>.

A remote execution system has been added to NASD.  See the
documentation in include/nasd_remote.h and the sample code (for caesar
"encryption") in drive/nasd_remote.c

==========
COPYRIGHT
==========

Except as otherwise noted, this package is covered by the license
which appears at the top of the README file.

This release includes SHA1 code from the SSLeay cryptography library
by Eric Young. The SSLeay code is covered by the following license:

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 * 
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 * 
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from 
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 * 
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

