Prepare for 1.0.2p release
[openssl.git] / README
1
2  OpenSSL 1.0.2p 14 Aug 2018
3
4  Copyright (c) 1998-2018 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 latest version from the repository
70       to see if the problem has already been addressed
71     - Configure with no-asm
72     - Remove compiler optimisation flags
73
74  If you wish to report a bug then please include the following information
75  and create an issue on GitHub:
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  Just because something doesn't work the way you expect does not mean it
88  is necessarily a bug in OpenSSL.
89
90  HOW TO CONTRIBUTE TO OpenSSL
91  ----------------------------
92
93  See CONTRIBUTING
94
95  LEGALITIES
96  ----------
97
98  A number of nations restrict the use or export of cryptography. If you
99  are potentially subject to such restrictions you should seek competent
100  professional legal advice before attempting to develop or distribute
101  cryptographic code.