README

   1
   2  OpenSSL 1.1.0-pre6-dev
   3
   4  Copyright (c) 1998-2016 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  Transport Layer Security (TLS) protocols (including SSLv3) as well as a
  14  full-strength general purpose cryptographic library.
  15
  16  OpenSSL is descended from the SSLeay library developed by Eric A. Young
  17  and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
  18  OpenSSL license plus the SSLeay license), which means that you are free to
  19  get and use it for commercial and non-commercial purposes as long as you
  20  fulfill the conditions of both licenses.
  21
  22  OVERVIEW
  23  --------
  24
  25  The OpenSSL toolkit includes:
  26
  27  libssl (with platform specific naming):
  28      Provides the client and server-side implementations for SSLv3 and TLS.
  29
  30  libcrypto (with platform specific naming):
  31      Provides general cryptographic and X.509 support needed by SSL/TLS but
  32      not logically part of it.
  33
  34  openssl:
  35      A command line tool that can be used for:
  36         Creation of key parameters
  37         Creation of X.509 certificates, CSRs and CRLs
  38         Calculation of message digests
  39         Encryption and decryption
  40         SSL/TLS client and server tests
  41         Handling of S/MIME signed or encrypted mail
  42         And more...
  43
  44  INSTALLATION
  45  ------------
  46
  47  See the appropriate file:
  48         INSTALL         Linux, Unix, Windows, OpenVMS, ...
  49         NOTES.*         INSTALL addendums for different platforms
  50
  51  SUPPORT
  52  -------
  53
  54  See the OpenSSL website www.openssl.org for details on how to obtain
  55  commercial technical support. Free community support is available through the
  56  openssl-users email list (see
  57  https://www.openssl.org/community/mailinglists.html for further details).
  58
  59  If you have any problems with OpenSSL then please take the following steps
  60  first:
  61
  62     - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
  63       to see if the problem has already been addressed
  64     - Remove ASM versions of libraries
  65     - Remove compiler optimisation flags
  66
  67  If you wish to report a bug then please include the following information in
  68  any bug report:
  69
  70     - OpenSSL version: output of 'openssl version -a'
  71     - Any "Configure" options that you selected during compilation of the
  72       library if applicable (see INSTALL)
  73     - OS Name, Version, Hardware platform
  74     - Compiler Details (name, version)
  75     - Application Details (name, version)
  76     - Problem Description (steps that will reproduce the problem, if known)
  77     - Stack Traceback (if the application dumps core)
  78
  79  Email the report to:
  80
  81     rt@openssl.org
  82
  83  In order to avoid spam, this is a moderated mailing list, and it might
  84  take a couple of days for the ticket to show up.  (We also scan posts to make
  85  sure that security disclosures aren't publicly posted by mistake.) Mail
  86  to this address is recorded in the public RT (request tracker) database
  87  (see https://www.openssl.org/community/index.html#bugs for details) and
  88  also forwarded the public openssl-dev mailing list.  Confidential mail
  89  may be sent to openssl-security@openssl.org (PGP key available from the
  90  key servers).
  91
  92  Please do NOT use this for general assistance or support queries.
  93  Just because something doesn't work the way you expect does not mean it
  94  is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
  95  of query.
  96
  97  You can also make GitHub pull requests. See the CONTRIBUTING file for more
  98  details.
  99
 100  HOW TO CONTRIBUTE TO OpenSSL
 101  ----------------------------
 102
 103  See CONTRIBUTING
 104
 105  LEGALITIES
 106  ----------
 107
 108  A number of nations, in particular the U.S., restrict the use or export
 109  of cryptography. If you are potentially subject to such restrictions
 110  you should seek competent professional legal advice before attempting to
 111  develop or distribute cryptographic code.