TLS/SSL and crypto library https://www.openssl.org

Richard Levitte 4579924b7e Cleanse memory using the new OPENSSL_cleanse() function. 22 years ago
MacOS 738554331b Constification needed. 22 years ago
VMS bff1567623 Since we're currently assuming VMS can deal with dynamic engines, 22 years ago
apps 4579924b7e Cleanse memory using the new OPENSSL_cleanse() function. 22 years ago
bugs cf1b7d9664 Make all configuration macros available for application by making 24 years ago
certs bc2dfde4b3 Oops: It's RegTP, not RegPT ... 24 years ago
crypto 4579924b7e Cleanse memory using the new OPENSSL_cleanse() function. 22 years ago
demos 8d6e60486f Fix to build better with DJGPP. 22 years ago
doc 32d21c1ef6 Better workaround to the "=head1 NAME OPTIONS" pod2latex problem: 22 years ago
engines 4579924b7e Cleanse memory using the new OPENSSL_cleanse() function. 22 years ago
include 457c8a3965 Add include dir 26 years ago
ms 0bf23d9b20 WinCE patches 22 years ago
os2 cd4c36adb8 Add support for shared libraries with OS/2. 22 years ago
perl a0ecb9b8fc Remove the perl/ subdirectory. It hasn't been worked on for ages, is 23 years ago
shlib 2469361c0f Add missing '"' 22 years ago
ssl 4579924b7e Cleanse memory using the new OPENSSL_cleanse() function. 22 years ago
test fcc764639d make update 22 years ago
times b98ebe0fa5 I forgot this file that Assar provided as well... 24 years ago
tools 56b5f687e4 And if the path has a space, we definitely need to protect $openssl. 22 years ago
util df29cc8f77 Add OPENSSL_cleanse() to help cleanse memory and avoid certain compiler 22 years ago
.cvsignore 7fa2a81d34 Ignore openssl.pc. This way, there's no risk that I'll add it again :-). 22 years ago
CHANGES df29cc8f77 Add OPENSSL_cleanse() to help cleanse memory and avoid certain compiler 22 years ago
CHANGES.SSLeay 9acc2aa6d1 *** empty log message *** 26 years ago
Configure ec7164133d I forgot that @ in strings must be escaped in Perl 22 years ago
FAQ d4e573f305 Add a FAQ on how to check the authenticity of the openSSL distribution. 22 years ago
INSTALL 96c930dd2f More information to the important issue of seeding the PRNG 22 years ago
INSTALL.DJGPP 451dc18f10 Add support for DJGPP. 22 years ago
INSTALL.MacOS 2bfb2398e3 Typos (Chris Pepper <pepper@mail.reppep.com>) 23 years ago
INSTALL.OS2 cd4c36adb8 Add support for shared libraries with OS/2. 22 years ago
INSTALL.VMS 3b80e3aa9e ispell 23 years ago
INSTALL.W32 0bf23d9b20 WinCE patches 22 years ago
INSTALL.WCE 629b58b7fb Make it possible to build for more than one CPU. 22 years ago
LICENSE 304d90425f fix ssl3_pending 22 years ago
Makefile.org 6f17f16fd5 Changes to make shared library building and use work better with Cygwin 22 years ago
Makefile.shared bfa96bc20e Add the INHIBIT_SYMLINKS flag variable to help Cygwin. 22 years ago
NEWS 9801fb61d0 Add news items for 0.9.6h and expand on the 0.9.7 news as well. 22 years ago
PROBLEMS e74e9c48de Don't try testing with parallell make, that will just fail. 22 years ago
README 819a040f44 more detailed instructions for export from US 22 years ago
README.ASN1 9d6b1ce644 24 years ago
README.ENGINE 2c8ad4f1af oops, there were other cases of "ENGINE_ID" to change too. 22 years ago
STATUS 364ff369d1 Mention a current showstopper 22 years ago
TABLE fcc764639d make update 22 years ago
config b9c23cca01 Add Tandem OSS target. 22 years ago
e_os.h 0bf23d9b20 WinCE patches 22 years ago
e_os2.h 0bf23d9b20 WinCE patches 22 years ago
install.com 1fbcfbe693 There is no RSAREF any more, so do not ty to install it. 22 years ago
makevms.com b6d0defb98 Remove all referenses to RSAref, since that's been gone for more than 22 years ago
openssl.doxy eb90a483ad Add functions to add certs to stacks, used for CA file/path stuff in servers. 26 years ago
openssl.spec 0caec9e8f8 Modify the main trunk version to 0.9.8-dev. 23 years ago

README


OpenSSL 0.9.8-dev XX xxx XXXX

Copyright (c) 1998-2002 The OpenSSL Project
Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
All rights reserved.

DESCRIPTION
-----------

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

OpenSSL is based on the excellent SSLeay library developed from Eric A. Young
and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
OpenSSL license plus the SSLeay license) situation, which basically means
that you are free to get and use it for commercial and non-commercial
purposes as long as you fulfill the conditions of both licenses.

OVERVIEW
--------

The OpenSSL toolkit includes:

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

libcrypto.a:
General encryption and X.509 v1/v3 stuff needed by SSL/TLS 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 popular 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.

openssl:
A command line tool that can be used for:
Creation of RSA, DH and DSA key parameters
Creation of X.509 certificates, CSRs and CRLs
Calculation of Message Digests
Encryption and Decryption with Ciphers
SSL/TLS Client and Server Tests
Handling of S/MIME signed or encrypted mail


PATENTS
-------

Various companies hold various patents for various algorithms in various
locations around the world. _YOU_ are responsible for ensuring that your use
of any algorithms is legal by checking if there are any patents in your
country. The file contains some of the patents that we know about or are
rumored to exist. This is not a definitive list.

RSA Security holds software patents on the RC5 algorithm. If you
intend to use this cipher, you must contact RSA Security for
licensing conditions. Their web page is http://www.rsasecurity.com/.

RC4 is a trademark of RSA Security, so use of this label should perhaps
only be used with RSA Security's permission.

The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy,
Japan, the Netherlands, Spain, Sweden, Switzerland, UK and the USA. They
should be contacted if that algorithm is to be used; their web page is
http://www.ascom.ch/.

INSTALLATION
------------

To install this package under a Unix derivative, read the INSTALL file. For
a Win32 platform, read the INSTALL.W32 file. For OpenVMS systems, read
INSTALL.VMS.

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 use them. Look at the example programs.

PROBLEMS
--------

For some platforms, there are some known problems that may affect the user
or application author. We try to collect those in doc/PROBLEMS, with current
thoughts on how they should be solved in a future of OpenSSL.

SUPPORT
-------

If you have any problems with OpenSSL then please take the following steps
first:

- Download the current snapshot from ftp://ftp.openssl.org/snapshot/
to see if the problem has already been addressed
- Remove ASM versions of libraries
- Remove compiler optimisation flags

If you wish to report a bug then please include the following information in
any bug report:

- On Unix systems:
Self-test report generated by 'make report'
- On other systems:
OpenSSL version: output of 'openssl version -a'
OS Name, Version, Hardware platform
Compiler Details (name, version)
- Application Details (name, version)
- Problem Description (steps that will reproduce the problem, if known)
- Stack Traceback (if the application dumps core)

Report the bug to the OpenSSL project via the Request Tracker
(http://www.openssl.org/rt2.html) by mail to:

openssl-bugs@openssl.org

Note that mail to openssl-bugs@openssl.org is recorded in the publicly
readable request tracker database and is forwarded to a public
mailing list. Confidential mail may be sent to openssl-security@openssl.org
(PGP key available from the key servers).

HOW TO CONTRIBUTE TO OpenSSL
----------------------------

Development is coordinated on the openssl-dev mailing list (see
http://www.openssl.org for information on subscribing). If you
would like to submit a patch, send it to openssl-dev@openssl.org with
the string "[PATCH]" in the subject. Please be sure to include a
textual explanation of what your patch does.

Note: For legal reasons, contributions from the US can be accepted only
if a TSA notification and a copy of the patch is sent to crypt@bis.doc.gov;
see http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic]
and http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e)).

The preferred format for changes is "diff -u" output. You might
generate it like this:

# cd openssl-work
# [your changes]
# ./Configure dist; make clean
# cd ..
# diff -ur openssl-orig openssl-work > mydiffs.patch