[thirdparty/openssl.git] / README


 OpenTLS 0.9.1c 22-Dec-1998

 Copyright (c) 1998 The OpenTLS Project
 Copyright (c) 1995-1998 Eric Young
 All rights reserved.

 The OpenTLS Project is a collaborative effort to develop a robust,
 commercial-grade, fully featured, and Open Source toolkit implementing the
 Transport Layer Security (TLS v1) and Secure Sockets Layer (SSL v2/v3)
 protocols with full-strength cryptography world-wide. The project is managed
 by a worldwide community of volunteers that use the Internet to communicate,
 plan, and develop the OpenTLS tookit and its related documentation. 

 OpenTLS is based on the excellent SSLeay library developed from Eric A. Young
 and Tim J. Hudson.  The OpenTLS toolkit is licensed under a BSD-style licence,
 which basically means that you are free to get and use it for commercial and
 non-commercial purposes. 

 The package includes:

 libssl.a:
     Implementation of SSLv2, SSLv3, TLSv1 and the required code to support
     both SSLv2, SSLv3 and TLSv1 in the one server.

 libcrypto.a:
     General encryption and X.509 stuff needed by TLS/SSL but not actually
     logically part of it. It includes routines for the following:

     Ciphers
        libdes - EAY's libdes DES encryption package which has been floating
                 around the net for a few years.  It includes 15
                 'modes/variations' of DES (1, 2 and 3 key versions of ecb,
                 cbc, cfb and ofb; pcbc and a more general form of cfb and
                 ofb) including desx in cbc mode, a fast crypt(3), and
                 routines to read passwords from the keyboard.
        RC4 encryption,
        RC2 encryption      - 4 different modes, ecb, cbc, cfb and ofb.
        Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb.
        IDEA encryption     - 4 different modes, ecb, cbc, cfb and ofb.

     Digests
        MD5 and MD2 message digest algorithms, fast implementations,
        SHA (SHA-0) and SHA-1 message digest algorithms,
        MDC2 message digest. A DES based hash that is polular on smart cards.

     Public Key
        RSA encryption/decryption/generation.  
            There is no limit on the number of bits.
        DSA encryption/decryption/generation.   
            There is no limit on the number of bits.
        Diffie-Hellman key-exchange/key generation.  
            There is no limit on the number of bits.

     X.509v3 certificates
        X509 encoding/decoding into/from binary ASN1 and a PEM
             based ascii-binary encoding which supports encryption with a
             private key.  Program to generate RSA and DSA certificate
             requests and to generate RSA and DSA certificates.

     Systems
        The normal digital envelope routines and base64 encoding.  Higher
        level access to ciphers and digests by name.  New ciphers can be
        loaded at run time.  The BIO io system which is a simple non-blocking
        IO abstraction.  Current methods supported are file descriptors,
        sockets, socket accept, socket connect, memory buffer, buffering, SSL
        client/server, file pointer, encryption, digest, non-blocking testing
        and null.

     Data structures
        A dynamically growing hashing system
        A simple stack.
        A Configuration loader that uses a format similar to MS .ini files.

 Programs in this package include:

     enc     - a general encryption program that can encrypt/decrypt using
               one of 17 different cipher/mode combinations.  The
               input/output can also be converted to/from base64
               ascii encoding.
     dgst    - a generate message digesting program that will generate
               message digests for any of md2, md5, sha (sha-0 or sha-1)
               or mdc2.
     asn1parse - parse and display the structure of an asn1 encoded
               binary file.
     rsa     - Manipulate RSA private keys.
     dsa     - Manipulate DSA private keys.
     dh      - Manipulate Diffie-Hellman parameter files.
     dsaparam- Manipulate and generate DSA parameter files.
     crl     - Manipulate certificate revocation lists.
     crt2pkcs7- Generate a pkcs7 object containing a crl and a certificate.
     x509    - Manipulate x509 certificates, self-sign certificates.
     req     - Manipulate PKCS#10 certificate requests and also
               generate certificate requests.
     genrsa  - Generates an arbitrary sized RSA private key.
     gendh   - Generates a set of Diffie-Hellman parameters, the prime
               will be a strong prime.
     ca      - Create certificates from PKCS#10 certificate requests.
               This program also maintains a database of certificates
               issued.
     verify  - Check x509 certificate signatures.
     speed   - Benchmark SSLeay's ciphers.
     s_server- A test SSL server.
     s_client- A test SSL client.
     s_time  - Benchmark SSL performance of SSL server programs.
     errstr  - Convert from SSLeay hex error codes to a readable form.
        
To install this package, read the INSTALL file.
For the Microsoft world, read INSTALL.W32 file.

For people in the USA, it is possible to compile SSLeay to use RSA Inc.'s
public key library, RSAref.  From my understanding, it is claimed by RSA Inc.
to be illegal to use my public key routines inside the USA.  Read
doc/rsaref.doc on how to build with RSAref.

Read the documentation in the doc directory.  It is quite rough, but it lists
the functions, you will probably have to look at the code to work out how to
used them.  I will be working on documentation.  Look at the example programs.
Commit	Line	Data
d02b48c6	1
651d0aff RE	2	OpenTLS 0.9.1c 22-Dec-1998
	3
	4	Copyright (c) 1998 The OpenTLS Project
	5	Copyright (c) 1995-1998 Eric Young
	6	All rights reserved.
	7
	8	The OpenTLS Project is a collaborative effort to develop a robust,
	9	commercial-grade, fully featured, and Open Source toolkit implementing the
	10	Transport Layer Security (TLS v1) and Secure Sockets Layer (SSL v2/v3)
	11	protocols with full-strength cryptography world-wide. The project is managed
	12	by a worldwide community of volunteers that use the Internet to communicate,
	13	plan, and develop the OpenTLS tookit and its related documentation.
	14
	15	OpenTLS is based on the excellent SSLeay library developed from Eric A. Young
	16	and Tim J. Hudson. The OpenTLS toolkit is licensed under a BSD-style licence,
	17	which basically means that you are free to get and use it for commercial and
	18	non-commercial purposes.
	19
	20	The package includes:
	21
	22	libssl.a:
	23	Implementation of SSLv2, SSLv3, TLSv1 and the required code to support
	24	both SSLv2, SSLv3 and TLSv1 in the one server.
	25
	26	libcrypto.a:
	27	General encryption and X.509 stuff needed by TLS/SSL but not actually
	28	logically part of it. It includes routines for the following:
	29
	30	Ciphers
	31	libdes - EAY's libdes DES encryption package which has been floating
	32	around the net for a few years. It includes 15
	33	'modes/variations' of DES (1, 2 and 3 key versions of ecb,
	34	cbc, cfb and ofb; pcbc and a more general form of cfb and
	35	ofb) including desx in cbc mode, a fast crypt(3), and
	36	routines to read passwords from the keyboard.
	37	RC4 encryption,
	38	RC2 encryption - 4 different modes, ecb, cbc, cfb and ofb.
	39	Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb.
	40	IDEA encryption - 4 different modes, ecb, cbc, cfb and ofb.
	41
	42	Digests
	43	MD5 and MD2 message digest algorithms, fast implementations,
	44	SHA (SHA-0) and SHA-1 message digest algorithms,
	45	MDC2 message digest. A DES based hash that is polular on smart cards.
	46
	47	Public Key
	48	RSA encryption/decryption/generation.
	49	There is no limit on the number of bits.
	50	DSA encryption/decryption/generation.
	51	There is no limit on the number of bits.
	52	Diffie-Hellman key-exchange/key generation.
	53	There is no limit on the number of bits.
	54
	55	X.509v3 certificates
	56	X509 encoding/decoding into/from binary ASN1 and a PEM
	57	based ascii-binary encoding which supports encryption with a
	58	private key. Program to generate RSA and DSA certificate
	59	requests and to generate RSA and DSA certificates.
	60
	61	Systems
	62	The normal digital envelope routines and base64 encoding. Higher
	63	level access to ciphers and digests by name. New ciphers can be
	64	loaded at run time. The BIO io system which is a simple non-blocking
	65	IO abstraction. Current methods supported are file descriptors,
66	sockets, socket accept, socket connect, memory buffer, buffering, SSL
67	client/server, file pointer, encryption, digest, non-blocking testing
68	and null.
69
70	Data structures
71	A dynamically growing hashing system
72	A simple stack.
73	A Configuration loader that uses a format similar to MS .ini files.
74
75	Programs in this package include:
76
77	enc - a general encryption program that can encrypt/decrypt using
78	one of 17 different cipher/mode combinations. The
79	input/output can also be converted to/from base64
80	ascii encoding.
81	dgst - a generate message digesting program that will generate
82	message digests for any of md2, md5, sha (sha-0 or sha-1)
83	or mdc2.
84	asn1parse - parse and display the structure of an asn1 encoded
85	binary file.
86	rsa - Manipulate RSA private keys.
87	dsa - Manipulate DSA private keys.
88	dh - Manipulate Diffie-Hellman parameter files.
89	dsaparam- Manipulate and generate DSA parameter files.
90	crl - Manipulate certificate revocation lists.
91	crt2pkcs7- Generate a pkcs7 object containing a crl and a certificate.
92	x509 - Manipulate x509 certificates, self-sign certificates.
93	req - Manipulate PKCS#10 certificate requests and also
94	generate certificate requests.
95	genrsa - Generates an arbitrary sized RSA private key.
96	gendh - Generates a set of Diffie-Hellman parameters, the prime
97	will be a strong prime.
98	ca - Create certificates from PKCS#10 certificate requests.
99	This program also maintains a database of certificates
100	issued.
101	verify - Check x509 certificate signatures.
102	speed - Benchmark SSLeay's ciphers.
103	s_server- A test SSL server.
104	s_client- A test SSL client.
105	s_time - Benchmark SSL performance of SSL server programs.
106	errstr - Convert from SSLeay hex error codes to a readable form.
107
d02b48c6	108	To install this package, read the INSTALL file.
651d0aff RE	109	For the Microsoft world, read INSTALL.W32 file.
	110
	111	For people in the USA, it is possible to compile SSLeay to use RSA Inc.'s
	112	public key library, RSAref. From my understanding, it is claimed by RSA Inc.
	113	to be illegal to use my public key routines inside the USA. Read
	114	doc/rsaref.doc on how to build with RSAref.
	115
	116	Read the documentation in the doc directory. It is quite rough, but it lists
	117	the functions, you will probably have to look at the code to work out how to
	118	used them. I will be working on documentation. Look at the example programs.
d02b48c6	119