X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=README;h=2fb1e1a7adb5e824b92e615288a7668158c12c17;hp=98277d416c790f548f02b8606f4ef62f652d26e0;hb=08f3f07212954e711fd91d60b7a4417b8c42d0f8;hpb=a5ec86d16cbe78cf54ac8c9f95d6136765855e15 diff --git a/README b/README index 98277d416c..2fb1e1a7ad 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ - OpenSSL 0.9.5-dev xx XXX 1999 + OpenSSL 0.9.7-dev 24 Sep 2000 - Copyright (c) 1998-1999 The OpenSSL Project + Copyright (c) 1998-2000 The OpenSSL Project Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson All rights reserved. @@ -11,9 +11,10 @@ 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 @@ -80,40 +81,14 @@ A Configuration loader that uses a format similar to MS .ini files. openssl: - A command line tool which provides the following functions: - - 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. - gendsa - Generates DSA parameters. - 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 OpenSSL'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 OpenSSL hex error codes to a readable form. - nseq - Netscape certificate sequence utility + 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 ------- @@ -124,17 +99,16 @@ 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/. + 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 Data Security, so use of this label should perhaps - only be used with RSA Data Security's permission. + 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, Netherlands, Spain, Sweden, Switzerland, UK and the USA. They should - be contacted if that algorithm is to be used, their web page is + 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 @@ -144,12 +118,9 @@ 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 ------- @@ -157,30 +128,23 @@ 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 - - Add compiler debug flags (if using gcc then remove -fomit-frame-pointer - before you try to debug things) If you wish to report a bug then please include the following information in any bug report: - OpenSSL Details - - Version, most of these details can be got from the - 'openssl version -a' command. - Operating System Details - - On Unix systems: Output of './config -t' - - OS Name, Version - - Hardware platform - Compiler Details - - Name - - Version - Application Details - - Name - - Version - Problem Description - - include steps that will reproduce the problem (if known) - Stack Traceback (if the application dumps core) + - 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 at: @@ -188,7 +152,7 @@ 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.) + (PGP key available from the key servers). HOW TO CONTRIBUTE TO OpenSSL ---------------------------- @@ -199,6 +163,9 @@ 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 copy of the patch is sent to crypt@bxa.doc.gov + The preferred format for changes is "diff -u" output. You might generate it like this: @@ -206,4 +173,4 @@ # [your changes] # ./Configure dist; make clean # cd .. - # diff -urN openssl-orig openssl-work > mydiffs.patch + # diff -ur openssl-orig openssl-work > mydiffs.patch