155714Skris 2296341Sdelphij OpenSSL 1.0.1p 9 Jul 2015 355714Skris 4237657Sjkim Copyright (c) 1998-2011 The OpenSSL Project 555714Skris Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson 655714Skris All rights reserved. 755714Skris 855714Skris DESCRIPTION 955714Skris ----------- 1055714Skris 1155714Skris The OpenSSL Project is a collaborative effort to develop a robust, 1255714Skris commercial-grade, fully featured, and Open Source toolkit implementing the 1355714Skris Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1) 1459191Skris protocols as well as a full-strength general purpose cryptography library. 1559191Skris The project is managed by a worldwide community of volunteers that use the 1659191Skris Internet to communicate, plan, and develop the OpenSSL toolkit and its 17160814Ssimon related documentation. 1855714Skris 1955714Skris OpenSSL is based on the excellent SSLeay library developed from Eric A. Young 2055714Skris and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the 2155714Skris OpenSSL license plus the SSLeay license) situation, which basically means 2255714Skris that you are free to get and use it for commercial and non-commercial 23160814Ssimon purposes as long as you fulfill the conditions of both licenses. 2455714Skris 2555714Skris OVERVIEW 2655714Skris -------- 2755714Skris 2855714Skris The OpenSSL toolkit includes: 2955714Skris 3055714Skris libssl.a: 3155714Skris Implementation of SSLv2, SSLv3, TLSv1 and the required code to support 3255714Skris both SSLv2, SSLv3 and TLSv1 in the one server and client. 3355714Skris 3455714Skris libcrypto.a: 3555714Skris General encryption and X.509 v1/v3 stuff needed by SSL/TLS but not 3655714Skris actually logically part of it. It includes routines for the following: 3755714Skris 3855714Skris Ciphers 39194206Ssimon libdes - EAY's libdes DES encryption package which was floating 40194206Ssimon around the net for a few years, and was then relicensed by 41194206Ssimon him as part of SSLeay. It includes 15 'modes/variations' 42194206Ssimon of DES (1, 2 and 3 key versions of ecb, cbc, cfb and ofb; 43194206Ssimon pcbc and a more general form of cfb and ofb) including desx 44194206Ssimon in cbc mode, a fast crypt(3), and routines to read 45194206Ssimon passwords from the keyboard. 4655714Skris RC4 encryption, 4755714Skris RC2 encryption - 4 different modes, ecb, cbc, cfb and ofb. 4855714Skris Blowfish encryption - 4 different modes, ecb, cbc, cfb and ofb. 4955714Skris IDEA encryption - 4 different modes, ecb, cbc, cfb and ofb. 5055714Skris 5155714Skris Digests 5255714Skris MD5 and MD2 message digest algorithms, fast implementations, 5355714Skris SHA (SHA-0) and SHA-1 message digest algorithms, 5455714Skris MDC2 message digest. A DES based hash that is popular on smart cards. 5555714Skris 5655714Skris Public Key 57160814Ssimon RSA encryption/decryption/generation. 5855714Skris There is no limit on the number of bits. 59160814Ssimon DSA encryption/decryption/generation. 6055714Skris There is no limit on the number of bits. 61160814Ssimon Diffie-Hellman key-exchange/key generation. 6255714Skris There is no limit on the number of bits. 6355714Skris 6455714Skris X.509v3 certificates 6555714Skris X509 encoding/decoding into/from binary ASN1 and a PEM 6689837Skris based ASCII-binary encoding which supports encryption with a 6755714Skris private key. Program to generate RSA and DSA certificate 6855714Skris requests and to generate RSA and DSA certificates. 6955714Skris 7055714Skris Systems 7155714Skris The normal digital envelope routines and base64 encoding. Higher 7255714Skris level access to ciphers and digests by name. New ciphers can be 7355714Skris loaded at run time. The BIO io system which is a simple non-blocking 7455714Skris IO abstraction. Current methods supported are file descriptors, 7555714Skris sockets, socket accept, socket connect, memory buffer, buffering, SSL 7655714Skris client/server, file pointer, encryption, digest, non-blocking testing 7755714Skris and null. 7855714Skris 7955714Skris Data structures 8055714Skris A dynamically growing hashing system 8155714Skris A simple stack. 8255714Skris A Configuration loader that uses a format similar to MS .ini files. 8355714Skris 84160814Ssimon openssl: 8559191Skris A command line tool that can be used for: 8659191Skris Creation of RSA, DH and DSA key parameters 87160814Ssimon Creation of X.509 certificates, CSRs and CRLs 8859191Skris Calculation of Message Digests 8959191Skris Encryption and Decryption with Ciphers 9059191Skris SSL/TLS Client and Server Tests 9159191Skris Handling of S/MIME signed or encrypted mail 9255714Skris 93160814Ssimon 9455714Skris PATENTS 9555714Skris ------- 9655714Skris 9755714Skris Various companies hold various patents for various algorithms in various 9855714Skris locations around the world. _YOU_ are responsible for ensuring that your use 9955714Skris of any algorithms is legal by checking if there are any patents in your 10055714Skris country. The file contains some of the patents that we know about or are 10189837Skris rumored to exist. This is not a definitive list. 10255714Skris 10368651Skris RSA Security holds software patents on the RC5 algorithm. If you 10468651Skris intend to use this cipher, you must contact RSA Security for 10568651Skris licensing conditions. Their web page is http://www.rsasecurity.com/. 10655714Skris 10768651Skris RC4 is a trademark of RSA Security, so use of this label should perhaps 108160814Ssimon only be used with RSA Security's permission. 10955714Skris 11055714Skris The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy, 11189837Skris Japan, the Netherlands, Spain, Sweden, Switzerland, UK and the USA. They 11289837Skris should be contacted if that algorithm is to be used; their web page is 11355714Skris http://www.ascom.ch/. 11455714Skris 115162911Ssimon NTT and Mitsubishi have patents and pending patents on the Camellia 116162911Ssimon algorithm, but allow use at no charge without requiring an explicit 117162911Ssimon licensing agreement: http://info.isl.ntt.co.jp/crypt/eng/info/chiteki.html 118162911Ssimon 11955714Skris INSTALLATION 12055714Skris ------------ 12155714Skris 12255714Skris To install this package under a Unix derivative, read the INSTALL file. For 12355714Skris a Win32 platform, read the INSTALL.W32 file. For OpenVMS systems, read 12455714Skris INSTALL.VMS. 12555714Skris 12655714Skris Read the documentation in the doc/ directory. It is quite rough, but it 12789837Skris lists the functions; you will probably have to look at the code to work out 12889837Skris how to use them. Look at the example programs. 12955714Skris 130100936Snectar PROBLEMS 131100936Snectar -------- 132100936Snectar 133100936Snectar For some platforms, there are some known problems that may affect the user 134100936Snectar or application author. We try to collect those in doc/PROBLEMS, with current 135100936Snectar thoughts on how they should be solved in a future of OpenSSL. 136100936Snectar 137160814Ssimon SUPPORT 13855714Skris ------- 13955714Skris 140205128Ssimon See the OpenSSL website www.openssl.org for details of how to obtain 141205128Ssimon commercial technical support. 142205128Ssimon 14355714Skris If you have any problems with OpenSSL then please take the following steps 14455714Skris first: 14555714Skris 14659191Skris - Download the current snapshot from ftp://ftp.openssl.org/snapshot/ 14759191Skris to see if the problem has already been addressed 14855714Skris - Remove ASM versions of libraries 149160814Ssimon - Remove compiler optimisation flags 15055714Skris 15155714Skris If you wish to report a bug then please include the following information in 15255714Skris any bug report: 15355714Skris 15459191Skris - On Unix systems: 15559191Skris Self-test report generated by 'make report' 15659191Skris - On other systems: 15759191Skris OpenSSL version: output of 'openssl version -a' 15859191Skris OS Name, Version, Hardware platform 15959191Skris Compiler Details (name, version) 16059191Skris - Application Details (name, version) 16159191Skris - Problem Description (steps that will reproduce the problem, if known) 16259191Skris - Stack Traceback (if the application dumps core) 16355714Skris 164100936Snectar Report the bug to the OpenSSL project via the Request Tracker 165194206Ssimon (http://www.openssl.org/support/rt.html) by mail to: 16655714Skris 16755714Skris openssl-bugs@openssl.org 16855714Skris 169205128Ssimon Note that the request tracker should NOT be used for general assistance 170205128Ssimon or support queries. Just because something doesn't work the way you expect 171205128Ssimon does not mean it is necessarily a bug in OpenSSL. 172205128Ssimon 173100936Snectar Note that mail to openssl-bugs@openssl.org is recorded in the publicly 174100936Snectar readable request tracker database and is forwarded to a public 17559191Skris mailing list. Confidential mail may be sent to openssl-security@openssl.org 17659191Skris (PGP key available from the key servers). 17759191Skris 17855714Skris HOW TO CONTRIBUTE TO OpenSSL 17955714Skris ---------------------------- 18055714Skris 18155714Skris Development is coordinated on the openssl-dev mailing list (see 18255714Skris http://www.openssl.org for information on subscribing). If you 183205128Ssimon would like to submit a patch, send it to openssl-bugs@openssl.org with 18459191Skris the string "[PATCH]" in the subject. Please be sure to include a 18559191Skris textual explanation of what your patch does. 18655714Skris 187205128Ssimon If you are unsure as to whether a feature will be useful for the general 188205128Ssimon OpenSSL community please discuss it on the openssl-dev mailing list first. 189205128Ssimon Someone may be already working on the same thing or there may be a good 190205128Ssimon reason as to why that feature isn't implemented. 191205128Ssimon 192205128Ssimon Patches should be as up to date as possible, preferably relative to the 193246772Sjkim current Git or the last snapshot. They should follow the coding style of 194205128Ssimon OpenSSL and compile without warnings. Some of the core team developer targets 195205128Ssimon can be used for testing purposes, (debug-steve64, debug-geoff etc). OpenSSL 196205128Ssimon compiles on many varied platforms: try to ensure you only use portable 197205128Ssimon features. 198205128Ssimon 19968651Skris Note: For legal reasons, contributions from the US can be accepted only 200142425Snectar if a TSU notification and a copy of the patch are sent to crypt@bis.doc.gov 201142425Snectar (formerly BXA) with a copy to the ENC Encryption Request Coordinator; 202142425Snectar please take some time to look at 203142425Snectar http://www.bis.doc.gov/Encryption/PubAvailEncSourceCodeNofify.html [sic] 204142425Snectar and 205142425Snectar http://w3.access.gpo.gov/bis/ear/pdf/740.pdf (EAR Section 740.13(e)) 206142425Snectar for the details. If "your encryption source code is too large to serve as 207142425Snectar an email attachment", they are glad to receive it by fax instead; hope you 208142425Snectar have a cheap long-distance plan. 20968651Skris 210142425Snectar Our preferred format for changes is "diff -u" output. You might 21155714Skris generate it like this: 21255714Skris 21355714Skris # cd openssl-work 21455714Skris # [your changes] 21555714Skris # ./Configure dist; make clean 21655714Skris # cd .. 21768651Skris # diff -ur openssl-orig openssl-work > mydiffs.patch 218160814Ssimon 219