README revision 295016
1 2 OpenSSL 1.0.1r 28 Jan 2016 3 4 Copyright (c) 1998-2015 The OpenSSL Project 5 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson 6 All rights reserved. 7 8 DESCRIPTION 9 ----------- 10 11 The OpenSSL Project is a collaborative effort to develop a robust, 12 commercial-grade, fully featured, and Open Source toolkit implementing the 13 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as 14 well as a full-strength general purpose cryptograpic library. The project is 15 managed by a worldwide community of volunteers that use the Internet to 16 communicate, plan, and develop the OpenSSL toolkit and its related 17 documentation. 18 19 OpenSSL is descended from the SSLeay library developed by Eric A. Young 20 and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the 21 OpenSSL license plus the SSLeay license), which means that you are free to 22 get and use it for commercial and non-commercial purposes as long as you 23 fulfill the conditions of both licenses. 24 25 OVERVIEW 26 -------- 27 28 The OpenSSL toolkit includes: 29 30 libssl.a: 31 Provides the client and server-side implementations for SSLv3 and TLS. 32 33 libcrypto.a: 34 Provides general cryptographic and X.509 support needed by SSL/TLS but 35 not logically part of it. 36 37 openssl: 38 A command line tool that can be used for: 39 Creation of key parameters 40 Creation of X.509 certificates, CSRs and CRLs 41 Calculation of message digests 42 Encryption and decryption 43 SSL/TLS client and server tests 44 Handling of S/MIME signed or encrypted mail 45 And more... 46 47 INSTALLATION 48 ------------ 49 50 See the appropriate file: 51 INSTALL Linux, Unix, etc. 52 INSTALL.DJGPP DOS platform with DJGPP 53 INSTALL.NW Netware 54 INSTALL.OS2 OS/2 55 INSTALL.VMS VMS 56 INSTALL.W32 Windows (32bit) 57 INSTALL.W64 Windows (64bit) 58 INSTALL.WCE Windows CE 59 60 SUPPORT 61 ------- 62 63 See the OpenSSL website www.openssl.org for details on how to obtain 64 commercial technical support. 65 66 If you have any problems with OpenSSL then please take the following steps 67 first: 68 69 - Download the current snapshot from ftp://ftp.openssl.org/snapshot/ 70 to see if the problem has already been addressed 71 - Remove ASM versions of libraries 72 - Remove compiler optimisation flags 73 74 If you wish to report a bug then please include the following information in 75 any bug report: 76 77 - On Unix systems: 78 Self-test report generated by 'make report' 79 - On other systems: 80 OpenSSL version: output of 'openssl version -a' 81 OS Name, Version, Hardware platform 82 Compiler Details (name, version) 83 - Application Details (name, version) 84 - Problem Description (steps that will reproduce the problem, if known) 85 - Stack Traceback (if the application dumps core) 86 87 Email the report to: 88 89 rt@openssl.org 90 91 In order to avoid spam, this is a moderated mailing list, and it might 92 take a day for the ticket to show up. (We also scan posts to make sure 93 that security disclosures aren't publically posted by mistake.) Mail 94 to this address is recorded in the public RT (request tracker) database 95 (see https://www.openssl.org/community/index.html#bugs for details) and 96 also forwarded the public openssl-dev mailing list. Confidential mail 97 may be sent to openssl-security@openssl.org (PGP key available from the 98 key servers). 99 100 Please do NOT use this for general assistance or support queries. 101 Just because something doesn't work the way you expect does not mean it 102 is necessarily a bug in OpenSSL. 103 104 You can also make GitHub pull requests. If you do this, please also send 105 mail to rt@openssl.org with a link to the PR so that we can more easily 106 keep track of it. 107 108 HOW TO CONTRIBUTE TO OpenSSL 109 ---------------------------- 110 111 See CONTRIBUTING 112 113 LEGALITIES 114 ---------- 115 116 A number of nations, in particular the U.S., restrict the use or export 117 of cryptography. If you are potentially subject to such restrictions 118 you should seek competent professional legal advice before attempting to 119 develop or distribute cryptographic code. 120