README.md

   1 Description
   2 ===========
   3
   4 The OpenSSL Project is a collaborative effort to develop a robust,
   5 commercial-grade, fully featured, and Open Source toolkit implementing the
   6 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
   7 full-strength general purpose cryptographic library.
   8
   9 OpenSSL is descended from the SSLeay library developed by Eric A. Young
  10 and Tim J. Hudson.
  11
  12 The OpenSSL toolkit is licensed under the Apache License 2.0, which means
  13 that you are free to get and use it for commercial and non-commercial
  14 purposes as long as you fulfill its conditions.
  15
  16 Overview
  17 ========
  18
  19 The OpenSSL toolkit includes:
  20
  21  * **libssl**
  22      Provides the client and server-side implementations for SSLv3 and TLS.
  23
  24  * **libcrypto:**
  25      Provides general cryptographic and X.509 support needed by SSL/TLS but
  26      not logically part of it.
  27
  28  * **openssl:**
  29      A command line tool that can be used for:
  30         Creation of key parameters
  31         Creation of X.509 certificates, CSRs and CRLs
  32         Calculation of message digests
  33         Encryption and decryption
  34         SSL/TLS client and server tests
  35         Handling of S/MIME signed or encrypted mail
  36         And more...
  37
  38 Installation
  39 ============
  40
  41 See the appropriate file:
  42
  43  * [INSTALL](INSTALL): General installation instructions for all platforms
  44  * Additional instructions for specific platforms
  45     * [NOTES.ANDROID](NOTES.ANDROID)
  46     * [NOTES.DJGPP](NOTES.DJGPP)
  47     * [NOTES.PERL](NOTES.PERL)
  48     * [NOTES.UNIX](NOTES.UNIX)
  49     * [NOTES.VALGRIND](NOTES.VALGRIND)
  50     * [NOTES.VMS](NOTES.VMS)
  51     * [NOTES.WIN](NOTES.WIN)
  52
  53 Support
  54 =======
  55
  56 See the OpenSSL website www.openssl.org for details on how to obtain
  57 commercial technical support. Free community support is available through the
  58 openssl-users email list (see
  59 https://www.openssl.org/community/mailinglists.html for further details).
  60
  61 If you have any problems with OpenSSL then please take the following steps
  62 first:
  63
  64  - Download the latest version from the repository
  65    to see if the problem has already been addressed
  66  - Configure with no-asm
  67  - Remove compiler optimization flags
  68
  69 If you wish to report a bug then please include the following information
  70 and create an issue on GitHub:
  71
  72  - OpenSSL version: output of 'openssl version -a'
  73  - Configuration data: output of 'perl configdata.pm --dump'
  74  - OS Name, Version, Hardware platform
  75  - Compiler Details (name, version)
  76  - Application Details (name, version)
  77  - Problem Description (steps that will reproduce the problem, if known)
  78  - Stack Traceback (if the application dumps core)
  79
  80 Just because something doesn't work the way you expect does not mean it
  81 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
  82 of query.
  83
  84 How to contribute to OpenSSL
  85 ============================
  86
  87  See [CONTRIBUTING](CONTRIBUTING.md)
  88
  89  Legalities
  90  ==========
  91
  92  A number of nations restrict the use or export of cryptography. If you
  93  are potentially subject to such restrictions you should seek competent
  94  professional legal advice before attempting to develop or distribute
  95  cryptographic code.
  96
  97
  98 Copyright
  99 =========
 100
 101 Copyright (c) 1998-2018 The OpenSSL Project
 102
 103 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 104
 105 All rights reserved.