Go to file
Richard Levitte b0940b33a6 Adapt *.tmpl to generate docs at build time
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6236)
2019-11-29 09:51:17 +01:00
.github Add a GitHub issue template for documentation issues 2019-10-30 17:46:00 +01:00
Configurations Adapt *.tmpl to generate docs at build time 2019-11-29 09:51:17 +01:00
VMS
apps apps/ocsp.c: sock_timeout -> socket_timeout 2019-11-29 09:45:48 +01:00
boringssl@2070f8ad91
crypto chacha/asm/chacha-armv8.pl: preserve FP registers d8 and d9 correctly 2019-11-28 16:40:43 +01:00
demos Remove RANDFILE settings from configuration files 2019-11-24 08:35:14 +01:00
doc Add doc/build.info to build the documentation 2019-11-29 09:51:17 +01:00
engines Update source files for deprecation at 3.0 2019-11-07 11:37:25 +01:00
external/perl Update the bundled external perl module Text-Template to version 1.56 2019-09-12 12:53:32 +02:00
fuzz Update source files for deprecation at 3.0 2019-11-07 11:37:25 +01:00
include Tweak some algorithm naming inconsistencies 2019-11-21 15:45:37 +00:00
krb5@b9ad6c4950
ms Unify all assembler file generators 2019-09-16 16:29:57 +02:00
os-dep
providers PROV: Avoid NULL dereference in SHA3 dup call. 2019-11-22 15:20:54 +10:00
pyca-cryptography@09403100de
ssl Support ciphersuites using a SHA2 384 digest in FreeBSD KTLS. 2019-11-24 23:12:38 +01:00
test test/cipher_overhead_test.c: build unconditionally 2019-11-27 20:37:16 +01:00
tools
util configdata.pm.in, util/dofile.pl: load 'platform' unconditionally 2019-11-29 09:47:57 +01:00
.gitattributes
.gitignore Add doc/build.info to build the documentation 2019-11-29 09:51:17 +01:00
.gitmodules
.travis-apt-pin.preferences
.travis-create-release.sh
.travis.yml travis.yml: add arch s390x target 2019-11-15 11:15:43 +01:00
ACKNOWLEDGEMENTS
AUTHORS
CHANGES Add a .pragma directive for configuration files 2019-11-12 13:33:12 +01:00
CONTRIBUTING Add a note in the contributing file about trivial commits. 2019-06-27 23:23:17 +10:00
Configure Add the possibility to generate documentation at build time 2019-11-29 09:51:16 +01:00
FAQ
HACKING A very brief explanation of how to add custom functions to OpenSSL. 2019-07-08 20:09:13 +10:00
INSTALL Adapt *.tmpl to generate docs at build time 2019-11-29 09:51:17 +01:00
LICENSE
NEWS Document recent changes in NEWS and CHANGES 2019-07-31 09:33:24 +02:00
NOTES.ANDROID
NOTES.DJGPP
NOTES.PERL Fix typo in NOTES.PERL 2019-05-16 11:46:59 +10:00
NOTES.UNIX
NOTES.VALGRIND
NOTES.VMS
NOTES.WIN Configure: final cleanup of asm related things 2019-06-17 16:08:53 +02:00
README Remove the version number in README 2019-10-18 12:22:00 +02:00
README.ENGINE
README.FIPS
VERSION Configure: get version from the file 'VERSION' instead of 'opensslv.h' 2019-10-18 12:22:00 +02:00
appveyor.yml Configure: Make --strict-warnings meaningful with MSVC cl 2019-11-02 11:00:13 +01:00
build.info Add doc/build.info to build the documentation 2019-11-29 09:51:17 +01:00
config iOS build: Replace %20 with space in config script 2019-07-08 10:55:57 +02:00
config.com
configdata.pm.in configdata.pm.in, util/dofile.pl: load 'platform' unconditionally 2019-11-29 09:47:57 +01:00
e_os.h Move random-related defines from e_os.h to rand_unix.c 2019-10-19 00:04:27 +02:00

README

 Copyright (c) 1998-2018 The OpenSSL Project
 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
 All rights reserved.

 DESCRIPTION
 -----------

 The OpenSSL Project is a collaborative effort to develop a robust,
 commercial-grade, fully featured, and Open Source toolkit implementing the
 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
 full-strength general purpose cryptographic library.

 OpenSSL is descended from the SSLeay library developed by Eric A. Young
 and Tim J. Hudson.

 The OpenSSL toolkit is licensed under the Apache License 2.0, which means
 that you are free to get and use it for commercial and non-commercial
 purposes as long as you fulfill its conditions.

 OVERVIEW
 --------

 The OpenSSL toolkit includes:

 libssl (with platform specific naming):
     Provides the client and server-side implementations for SSLv3 and TLS.

 libcrypto (with platform specific naming):
     Provides general cryptographic and X.509 support needed by SSL/TLS but
     not logically part of it.

 openssl:
     A command line tool that can be used for:
        Creation of key parameters
        Creation of X.509 certificates, CSRs and CRLs
        Calculation of message digests
        Encryption and decryption
        SSL/TLS client and server tests
        Handling of S/MIME signed or encrypted mail
        And more...

 INSTALLATION
 ------------

 See the appropriate file:
        INSTALL         Linux, Unix, Windows, OpenVMS, ...
        NOTES.*         INSTALL addendums for different platforms

 SUPPORT
 -------

 See the OpenSSL website www.openssl.org for details on how to obtain
 commercial technical support. Free community support is available through the
 openssl-users email list (see
 https://www.openssl.org/community/mailinglists.html for further details).

 If you have any problems with OpenSSL then please take the following steps
 first:

    - Download the latest version from the repository
      to see if the problem has already been addressed
    - Configure with no-asm
    - Remove compiler optimization flags

 If you wish to report a bug then please include the following information
 and create an issue on GitHub:

    - OpenSSL version: output of 'openssl version -a'
    - Configuration data: output of 'perl configdata.pm --dump'
    - OS Name, Version, Hardware platform
    - Compiler Details (name, version)
    - Application Details (name, version)
    - Problem Description (steps that will reproduce the problem, if known)
    - Stack Traceback (if the application dumps core)

 Just because something doesn't work the way you expect does not mean it
 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
 of query.

 HOW TO CONTRIBUTE TO OpenSSL
 ----------------------------

 See CONTRIBUTING

 LEGALITIES
 ----------

 A number of nations restrict the use or export of cryptography. If you
 are potentially subject to such restrictions you should seek competent
 professional legal advice before attempting to develop or distribute
 cryptographic code.