X-Git-Url: https://git.openssl.org/gitweb/?a=blobdiff_plain;f=README;h=1ee02b342511f865d5f6a9a5bf8a979d7b1f1e8f;hb=b7fa1f989d0059ad7b992c11797f37f095d61204;hp=7ef77c83c66365d83cb679c7334c867b70a74a92;hpb=74cdf6f73adf00b3c7d2fb0c0773fd824221a4c6;p=openssl.git diff --git a/README b/README index 7ef77c83c6..1ee02b3425 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ - OpenSSL 0.9.5 28 Feb 2000 + OpenSSL 1.1.0-dev - Copyright (c) 1998-2000 The OpenSSL Project + Copyright (c) 1998-2015 The OpenSSL Project Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson All rights reserved. @@ -11,15 +11,16 @@ 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 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 OpenSSL toolkit and its related documentation. + 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. + purposes as long as you fulfill the conditions of both licenses. OVERVIEW -------- @@ -35,12 +36,13 @@ 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. + libdes - EAY's libdes DES encryption package which was floating + around the net for a few years, and was then relicensed by + him as part of SSLeay. 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. @@ -52,16 +54,16 @@ MDC2 message digest. A DES based hash that is popular on smart cards. Public Key - RSA encryption/decryption/generation. + RSA encryption/decryption/generation. There is no limit on the number of bits. - DSA encryption/decryption/generation. + DSA encryption/decryption/generation. There is no limit on the number of bits. - Diffie-Hellman key-exchange/key generation. + 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 + 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. @@ -79,38 +81,15 @@ A simple stack. A Configuration loader that uses a format similar to MS .ini files. - openssl: + 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 + 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 - rumoured to exist. This is not a definitive list. - - RSA Data Security holds software patents on the RSA and RC5 algorithms. If - their ciphers are used used inside the USA (and Japan?), you must contact RSA - Data Security for licensing conditions. Their web page is - http://www.rsa.com/. - - RC4 is a trademark of RSA Data Security, so use of this label should perhaps - only be used with RSA Data Security's permission. - - The IDEA algorithm is patented by Ascom in Austria, France, Germany, Italy, - Japan, 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 ------------ @@ -118,23 +97,30 @@ a Win32 platform, read the INSTALL.W32 file. For OpenVMS systems, read INSTALL.VMS. - For people in the USA, it is possible to compile OpenSSL to use RSA Inc.'s - public key library, RSAREF, by configuring OpenSSL with the option "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. Look at the example programs. + lists the functions; you will probably have to look at the code to work out + how to use them. Look at the example programs. - SUPPORT + 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 ------- + See the OpenSSL website www.openssl.org for details of how to obtain + commercial technical 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 + - Remove compiler optimisation flags If you wish to report a bug then please include the following information in any bug report: @@ -149,28 +135,27 @@ - Problem Description (steps that will reproduce the problem, if known) - Stack Traceback (if the application dumps core) - Report the bug to the OpenSSL project at: + Email the report to: - openssl-bugs@openssl.org + rt@openssl.org - Note that mail to openssl-bugs@openssl.org is forwarded to a public - mailing list. Confidential mail may be sent to openssl-security@openssl.org - (PGP key available from the key servers). + In order to avoid spam, this is a moderated mailing list, and it might + take a day for the ticket to show up. (We also scan posts to make sure + that security disclosures aren't publically posted by mistake.) Mail to + this address is recorded in the public RT (request tracker) database (see + https://www.openssl.org/support/rt.html for details) and also forwarded + the public openssl-dev mailing list. Confidential mail may be sent to + openssl-security@openssl.org (PGP key available from the key servers). - HOW TO CONTRIBUTE TO OpenSSL - ---------------------------- + Please do NOT use this for general assistance or support queries. + Just because something doesn't work the way you expect does not mean it + is necessarily a bug in 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. + You can also make GitHub pull requests. If you do this, please also send + mail to rt@openssl.org with a link to the PR so that we can more easily + keep track of it. - The preferred format for changes is "diff -u" output. You might - generate it like this: + HOW TO CONTRIBUTE TO OpenSSL + ---------------------------- - # cd openssl-work - # [your changes] - # ./Configure dist; make clean - # cd .. - # diff -urN openssl-orig openssl-work > mydiffs.patch + See CONTRIBUTING