# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.

# =========================================================================== 
# BACKGROUND
# =========================================================================== 

Many of the tools made available to store and retrieve files using Cloud
Storage services such as Amazon S3 assume that the content will be stored
"as is".  There are many scenarios where it would be better to first
encrypt the content before storing into the Cloud (and automatically
decrypt it upon retrieve).  

The goal of this software is to provide this necessary function, namely
to provide front-end encryption and decryption capabilities to augment
existing tools that can already store and retrieve files in the Cloud.

# =========================================================================== 
# FUNCTIONALITY
# =========================================================================== 

This tool supports the following modes of operation:

   * encryption
   * compression
   * splitting

in addition to any commands that can be passed through to the back-end
functionality (e.g., list, remove, etc.)  For "put" operations, 
compression is done before encryption and splitting is done last (if
needed). The reverse process is used for "get" operations. 

The cryptographic operations performed by this tool are enabled by 
OpenSSL (or the Solaris Cryptographic Framework on Solaris 10 or
OpenSolaris).  By default, OpenSSL is used as it enables the greatest
level of portability.  To use the Solaris cryptographic operations,
use the "-p solaris" command line option.  Note that on platforms using
the UltraSPARC T2 (Niagara 2) processor, these cryptographic operations
can be hardware accelerated.

All of the command line options as well as common use cases are available
from the tool's usage message available using the "-h" command line option
to the s3-crypto.ksh command.  Note that in addition, the Cloud Safety Box,
csb, command is also provided to enable a simple, easy to use interface at
the expense of some measure of flexibility.  If you want more control than
what csb provides, simply use the s3-crypto.ksh script directly. 

# =========================================================================== 
# INSTALLATION
# =========================================================================== 

See the INSTALL file.

# =========================================================================== 
# MORE INFORMATION
# =========================================================================== 

See the project home page at:

   http://kenai.com/projects/s3-crypto/pages/Home