Google Git
Sign in
flutter / third_party / openssl / 497910833e6992b4b8645900f2086a56f5557424 / . / README
blob: ae5e24bf349cdb091c3e4071f06d2d5f164eae67 [file] [log] [blame]
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]1
Richard Levitte156e34f2016-08-25 19:07:17 +0200[diff] [blame]2 OpenSSL 1.1.1-dev
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]3
Richard Levitte58add892016-01-14 15:13:50 +0100[diff] [blame]4 Copyright (c) 1998-2016 The OpenSSL Project
Ralf S. Engelschall058bf551999-01-31 11:15:44 +0000[diff] [blame]5 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
Ralf S. Engelschall651d0af1998-12-22 15:04:48 +0000[diff] [blame]6 All rights reserved.
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]7
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]8 DESCRIPTION
9 -----------
10
Ralf S. Engelschallf1c236f1998-12-23 07:38:54 +0000[diff] [blame]11 The OpenSSL Project is a collaborative effort to develop a robust,
Ralf S. Engelschall651d0af1998-12-22 15:04:48 +0000[diff] [blame]12 commercial-grade, fully featured, and Open Source toolkit implementing the
Matt Caswell26dee422016-06-02 11:01:32 +0100[diff] [blame]13 Transport Layer Security (TLS) protocols (including SSLv3) as well as a
14 full-strength general purpose cryptographic library.
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]15
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]16 OpenSSL is descended from the SSLeay library developed by Eric A. Young
Ralf S. Engelschall1c308221999-03-06 13:35:14 +0000[diff] [blame]17 and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]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.
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]21
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]22 OVERVIEW
23 --------
24
Ralf S. Engelschall1c308221999-03-06 13:35:14 +0000[diff] [blame]25 The OpenSSL toolkit includes:
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]26
Richard Levittef33d63c2016-03-17 21:13:23 +0100[diff] [blame]27 libssl (with platform specific naming):
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]28 Provides the client and server-side implementations for SSLv3 and TLS.
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]29
Richard Levittef33d63c2016-03-17 21:13:23 +0100[diff] [blame]30 libcrypto (with platform specific naming):
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]31 Provides general cryptographic and X.509 support needed by SSL/TLS but
32 not logically part of it.
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]33
Bodo Möllera2c96d82005-04-25 21:36:56 +0000[diff] [blame]34 openssl:
Ulf Möllerd7f0ab52000-02-23 23:47:05 +0000[diff] [blame]35 A command line tool that can be used for:
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]36 Creation of key parameters
Bodo Möllera2c96d82005-04-25 21:36:56 +0000[diff] [blame]37 Creation of X.509 certificates, CSRs and CRLs
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]38 Calculation of message digests
39 Encryption and decryption
40 SSL/TLS client and server tests
Ulf Möllerd7f0ab52000-02-23 23:47:05 +0000[diff] [blame]41 Handling of S/MIME signed or encrypted mail
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]42 And more...
Ralf S. Engelschalld02b48c1998-12-21 10:52:47 +0000[diff] [blame]43
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]44 INSTALLATION
45 ------------
46
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]47 See the appropriate file:
Richard Levitte07930a72016-05-23 15:11:04 +0200[diff] [blame]48 INSTALL Linux, Unix, Windows, OpenVMS, ...
49 NOTES.* INSTALL addendums for different platforms
Richard Levitte80e14952002-07-16 10:04:40 +0000[diff] [blame]50
Bodo Möllera2c96d82005-04-25 21:36:56 +0000[diff] [blame]51 SUPPORT
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]52 -------
53
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]54 See the OpenSSL website www.openssl.org for details on how to obtain
Matt Caswell26dee422016-06-02 11:01:32 +0100[diff] [blame]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).
Dr. Stephen Henson0e37c902009-08-12 16:44:33 +0000[diff] [blame]58
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]59 If you have any problems with OpenSSL then please take the following steps
60 first:
61
Rich Salz7954dce2016-10-12 15:49:06 -0400[diff] [blame]62 - Download the latest version from the repository
Ulf Möllerd7f0ab52000-02-23 23:47:05 +0000[diff] [blame]63 to see if the problem has already been addressed
Rich Salz7954dce2016-10-12 15:49:06 -0400[diff] [blame]64 - Configure with no-asm
Bodo Möllera2c96d82005-04-25 21:36:56 +0000[diff] [blame]65 - Remove compiler optimisation flags
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]66
Rich Salz7954dce2016-10-12 15:49:06 -0400[diff] [blame]67 If you wish to report a bug then please include the following information
68 and create an issue on GitHub:
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]69
Matt Caswell26dee422016-06-02 11:01:32 +0100[diff] [blame]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)
Ulf Möllerd7f0ab52000-02-23 23:47:05 +0000[diff] [blame]75 - Application Details (name, version)
76 - Problem Description (steps that will reproduce the problem, if known)
77 - Stack Traceback (if the application dumps core)
Ralf S. Engelschalldfca8221999-03-06 14:04:40 +0000[diff] [blame]78
Rich Salz932af162015-07-28 12:41:36 -0400[diff] [blame]79 Just because something doesn't work the way you expect does not mean it
Matt Caswell26dee422016-06-02 11:01:32 +0100[diff] [blame]80 is necessarily a bug in OpenSSL. Use the openssl-users email list for this type
81 of query.
Rich Salz932af162015-07-28 12:41:36 -0400[diff] [blame]82
Ulf Möllerb282fda1999-05-06 00:40:46 +0000[diff] [blame]83 HOW TO CONTRIBUTE TO OpenSSL
84 ----------------------------
85
Manish Goregaokareb05f172015-10-17 16:40:55 +0530[diff] [blame]86 See CONTRIBUTING
Rich Salzb06935f2015-10-29 12:06:06 -0400[diff] [blame]87
88 LEGALITIES
89 ----------
90
Rich Salz12a77152016-10-26 11:48:43 -0400[diff] [blame]91 A number of nations restrict the use or export of cryptography. If you
Rich Salz7954dce2016-10-12 15:49:06 -0400[diff] [blame]92 are potentially subject to such restrictions you should seek competent
93 professional legal advice before attempting to develop or distribute
94 cryptographic code.