README

   1
   2  OpenSSL 1.1.0-pre5-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  Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
  14  well as a full-strength general purpose cryptographic 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.VMS     VMS
  54         INSTALL.WIN     Windows
  55         INSTALL.WCE     Windows CE
  56
  57  SUPPORT
  58  -------
  59
  60  See the OpenSSL website www.openssl.org for details on how to obtain
  61  commercial technical support.
  62
  63  If you have any problems with OpenSSL then please take the following steps
  64  first:
  65
  66     - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
  67       to see if the problem has already been addressed
  68     - Remove ASM versions of libraries
  69     - Remove compiler optimisation flags
  70
  71  If you wish to report a bug then please include the following information in
  72  any bug report:
  73
  74     - On Unix systems:
  75         Self-test report generated by 'make report'
  76     - On other systems:
  77         OpenSSL version: output of 'openssl version -a'
  78         OS Name, Version, Hardware platform
  79         Compiler Details (name, version)
  80     - Application Details (name, version)
  81     - Problem Description (steps that will reproduce the problem, if known)
  82     - Stack Traceback (if the application dumps core)
  83
  84  Email the report to:
  85
  86     rt@openssl.org
  87
  88  In order to avoid spam, this is a moderated mailing list, and it might
  89  take a day for the ticket to show up.  (We also scan posts to make sure
  90  that security disclosures aren't publically posted by mistake.) Mail
  91  to this address is recorded in the public RT (request tracker) database
  92  (see https://www.openssl.org/community/index.html#bugs for details) and
  93  also forwarded the public openssl-dev mailing list.  Confidential mail
  94  may be sent to openssl-security@openssl.org (PGP key available from the
  95  key servers).
  96
  97  Please do NOT use this for general assistance or support queries.
  98  Just because something doesn't work the way you expect does not mean it
  99  is necessarily a bug in OpenSSL.
 100
 101  You can also make GitHub pull requests. If you do this, please also send
 102  mail to rt@openssl.org with a link to the PR so that we can more easily
 103  keep track of it.
 104
 105  HOW TO CONTRIBUTE TO OpenSSL
 106  ----------------------------
 107
 108  See CONTRIBUTING
 109
 110  LEGALITIES
 111  ----------
 112
 113  A number of nations, in particular the U.S., restrict the use or export
 114  of cryptography. If you are potentially subject to such restrictions
 115  you should seek competent professional legal advice before attempting to
 116  develop or distribute cryptographic code.