README

OpenSSL Example Programs 20020110
by Eric Rescorla
January 10, 2002 Edition

Copyright (C) 2001 RTFM, Inc.

INTRODUCTION
This is a set of example programs demonstrating how to perform
basic tasks with OpenSSL. There are five programs:

wclient	    -- a simple web client emulator
wserver	    -- a simple web server emulator
wclient2    -- a version of wclient with some extra options
	       including setting the cipher suite and 
	       session caching.
wserver2    -- a version of wserver2 with some extra options
	       including setting the cipher suite, client
	       authentication, rehandshake, and session caching.
sclient	    -- a simple client program that echos from the keyboard
	       to the server and vice versa. sclient is a simple
	       model of a terminal client such as Telnet.

See the file RUNNING for documentation on the command line
switches for these programs.

DOCUMENTATION
Although the programs are extensively commented they are not
completely self-explanatory. Rather, they are intended to be used as a
companion to a series of articles published in Linux Journal. The
first article was published in the September issue and is included
here as part1.pdf. The second article was published on the web
in early October and is included here as part2.pdf

This explains why we have both wclient and wclient2 (and wserver and
wserver2). The first editions appear in the first article and the
second ones in the second article. This structure also lets the
reader learn the basics without advanced features getting in the
way.

BUILDING
These programs are designed to build with GNU autoconf. 
With any luck you can build simply by doing

	./configure
	make

If the configure script can't find OpenSSL, it will exit with an
error. If your OpenSSL is in a nonstandard location, you will need to
give configure a hint with the '--with-openssl' or
'--with-openssl-{lib,include}' switches.

If you have some problem building this software, please send
a bug report to <ekr@rtfm.com>.


LICENSE
Copyright (C) 2000-2001 RTFM, Inc.
All Rights Reserved

This package is a series of demonstration programs written by
Eric Rescorla <ekr@rtfm.com> and licensed by RTFM, Inc.

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 above 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. Neither the name of RTFM, Inc. nor the name of Eric Rescorla may be
   used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE ERIC RESCORLA AND RTFM ``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 REGENTS 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.


SHAMELESS PLUG
Extremely detailed coverage of SSL/TLS can be found in 

	_SSL_and_TLS:_Designing_and_Building_Secure_Systems_
	Eric Rescorla
	Addison-Wesley, 2001
	ISBN 0-201-61598-3

The original versions of these programs appeared in that book.