README revision 291721
155714Skris 2291721Sjkim OpenSSL 1.0.1q 3 Dec 2015 355714Skris 4291721Sjkim Copyright (c) 1998-2015 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 13291721Sjkim Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as 14291721Sjkim well as a full-strength general purpose cryptograpic library. The project is 15291721Sjkim managed by a worldwide community of volunteers that use the Internet to 16291721Sjkim communicate, plan, and develop the OpenSSL toolkit and its related 17291721Sjkim documentation. 1855714Skris 19291721Sjkim OpenSSL is descended from the SSLeay library developed by Eric A. Young 2055714Skris and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the 21291721Sjkim OpenSSL license plus the SSLeay license), which means that you are free to 22291721Sjkim get and use it for commercial and non-commercial purposes as long as you 23291721Sjkim fulfill the conditions of both licenses. 2455714Skris 2555714Skris OVERVIEW 2655714Skris -------- 2755714Skris 2855714Skris The OpenSSL toolkit includes: 2955714Skris 3055714Skris libssl.a: 31291721Sjkim Provides the client and server-side implementations for SSLv3 and TLS. 3255714Skris 3355714Skris libcrypto.a: 34291721Sjkim Provides general cryptographic and X.509 support needed by SSL/TLS but 35291721Sjkim not logically part of it. 3655714Skris 37160814Ssimon openssl: 3859191Skris A command line tool that can be used for: 39291721Sjkim Creation of key parameters 40160814Ssimon Creation of X.509 certificates, CSRs and CRLs 41291721Sjkim Calculation of message digests 42291721Sjkim Encryption and decryption 43291721Sjkim SSL/TLS client and server tests 4459191Skris Handling of S/MIME signed or encrypted mail 45291721Sjkim And more... 4655714Skris 4755714Skris INSTALLATION 4855714Skris ------------ 4955714Skris 50291721Sjkim See the appropriate file: 51291721Sjkim INSTALL Linux, Unix, etc. 52291721Sjkim INSTALL.DJGPP DOS platform with DJGPP 53291721Sjkim INSTALL.NW Netware 54291721Sjkim INSTALL.OS2 OS/2 55291721Sjkim INSTALL.VMS VMS 56291721Sjkim INSTALL.W32 Windows (32bit) 57291721Sjkim INSTALL.W64 Windows (64bit) 58291721Sjkim INSTALL.WCE Windows CE 5955714Skris 60160814Ssimon SUPPORT 6155714Skris ------- 6255714Skris 63291721Sjkim See the OpenSSL website www.openssl.org for details on how to obtain 64205128Ssimon commercial technical support. 65205128Ssimon 6655714Skris If you have any problems with OpenSSL then please take the following steps 6755714Skris first: 6855714Skris 6959191Skris - Download the current snapshot from ftp://ftp.openssl.org/snapshot/ 7059191Skris to see if the problem has already been addressed 7155714Skris - Remove ASM versions of libraries 72160814Ssimon - Remove compiler optimisation flags 7355714Skris 7455714Skris If you wish to report a bug then please include the following information in 7555714Skris any bug report: 7655714Skris 7759191Skris - On Unix systems: 7859191Skris Self-test report generated by 'make report' 7959191Skris - On other systems: 8059191Skris OpenSSL version: output of 'openssl version -a' 8159191Skris OS Name, Version, Hardware platform 8259191Skris Compiler Details (name, version) 8359191Skris - Application Details (name, version) 8459191Skris - Problem Description (steps that will reproduce the problem, if known) 8559191Skris - Stack Traceback (if the application dumps core) 8655714Skris 87291721Sjkim Email the report to: 8855714Skris 89291721Sjkim rt@openssl.org 9055714Skris 91291721Sjkim In order to avoid spam, this is a moderated mailing list, and it might 92291721Sjkim take a day for the ticket to show up. (We also scan posts to make sure 93291721Sjkim that security disclosures aren't publically posted by mistake.) Mail to 94291721Sjkim this address is recorded in the public RT (request tracker) database (see 95291721Sjkim https://www.openssl.org/support/rt.html for details) and also forwarded 96291721Sjkim the public openssl-dev mailing list. Confidential mail may be sent to 97291721Sjkim openssl-security@openssl.org (PGP key available from the key servers). 98205128Ssimon 99291721Sjkim Please do NOT use this for general assistance or support queries. 100291721Sjkim Just because something doesn't work the way you expect does not mean it 101291721Sjkim is necessarily a bug in OpenSSL. 10259191Skris 103291721Sjkim You can also make GitHub pull requests. If you do this, please also send 104291721Sjkim mail to rt@openssl.org with a link to the PR so that we can more easily 105291721Sjkim keep track of it. 106291721Sjkim 10755714Skris HOW TO CONTRIBUTE TO OpenSSL 10855714Skris ---------------------------- 10955714Skris 110291721Sjkim See CONTRIBUTING 11155714Skris 112291721Sjkim LEGALITIES 113291721Sjkim ---------- 114205128Ssimon 115291721Sjkim A number of nations, in particular the U.S., restrict the use or export 116291721Sjkim of cryptography. If you are potentially subject to such restrictions 117291721Sjkim you should seek competent professional legal advice before attempting to 118291721Sjkim develop or distribute cryptographic code. 119