README

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