[thirdparty/openssl.git] / README


 OpenSSL 1.1.0-pre5-dev

 Copyright (c) 1998-2016 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
 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
 well as a full-strength general purpose cryptographic library. The project is
 managed by a worldwide community of volunteers that use the Internet to
 communicate, plan, and develop the OpenSSL toolkit and its related
 documentation.

 OpenSSL is descended from the SSLeay library developed by Eric A. Young
 and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
 OpenSSL license plus the SSLeay license), which means that you are free to
 get and use it for commercial and non-commercial purposes as long as you
 fulfill the conditions of both licenses.

 OVERVIEW
 --------

 The OpenSSL toolkit includes:

 libssl.a:
     Provides the client and server-side implementations for SSLv3 and TLS.

 libcrypto.a:
     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, etc.
        INSTALL.DJGPP   DOS platform with DJGPP
        INSTALL.VMS     VMS
        INSTALL.WIN     Windows
        INSTALL.WCE     Windows CE

 SUPPORT
 -------

 See the OpenSSL website www.openssl.org for details on how to obtain
 commercial technical support.

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

    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
      to see if the problem has already been addressed
    - Remove ASM versions of libraries
    - Remove compiler optimisation flags

 If you wish to report a bug then please include the following information in
 any bug report:

    - On Unix systems:
        Self-test report generated by 'make report'
    - On other systems:
        OpenSSL version: output of 'openssl version -a'
        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)

 Email the report to:

    rt@openssl.org

 In order to avoid spam, this is a moderated mailing list, and it might
 take a day for the ticket to show up.  (We also scan posts to make sure
 that security disclosures aren't publically posted by mistake.) Mail
 to this address is recorded in the public RT (request tracker) database
 (see https://www.openssl.org/community/index.html#bugs for details) and
 also forwarded the public openssl-dev mailing list.  Confidential mail
 may be sent to openssl-security@openssl.org (PGP key available from the
 key servers).

 Please do NOT use this for general assistance or support queries.
 Just because something doesn't work the way you expect does not mean it
 is necessarily a bug in OpenSSL.

 You can also make GitHub pull requests. If you do this, please also send
 mail to rt@openssl.org with a link to the PR so that we can more easily
 keep track of it.

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

 See CONTRIBUTING

 LEGALITIES
 ----------

 A number of nations, in particular the U.S., 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.
Commit	Line	Data
d02b48c6	1
37d42aae	2	OpenSSL 1.1.0-pre5-dev
651d0aff	3
58add896	4	Copyright (c) 1998-2016 The OpenSSL Project
058bf559	5	Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
651d0aff RE	6	All rights reserved.
651d0aff RE	7
dfca822f RE	8	DESCRIPTION
	9	-----------
	10
f1c236f8	11	The OpenSSL Project is a collaborative effort to develop a robust,
651d0aff	12	commercial-grade, fully featured, and Open Source toolkit implementing the
b06935f4	13	Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
57a143fd	14	well as a full-strength general purpose cryptographic library. The project is
b06935f4 RS	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.
651d0aff	18
b06935f4	19	OpenSSL is descended from the SSLeay library developed by Eric A. Young
1c308226	20	and Tim J. Hudson. The OpenSSL toolkit is licensed under a dual-license (the
b06935f4 RS	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.
651d0aff	24
dfca822f RE	25	OVERVIEW
	26	--------
	27
1c308226	28	The OpenSSL toolkit includes:
651d0aff RE	29
651d0aff RE	30	libssl.a:
b06935f4	31	Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff RE	32
651d0aff RE	33	libcrypto.a:
b06935f4 RS	34	Provides general cryptographic and X.509 support needed by SSL/TLS but
b06935f4 RS	35	not logically part of it.
651d0aff	36
a2c96d88	37	openssl:
d7f0ab5f	38	A command line tool that can be used for:
b06935f4	39	Creation of key parameters
a2c96d88	40	Creation of X.509 certificates, CSRs and CRLs
b06935f4 RS	41	Calculation of message digests
	42	Encryption and decryption
	43	SSL/TLS client and server tests
d7f0ab5f	44	Handling of S/MIME signed or encrypted mail
b06935f4	45	And more...
d7f0ab5f	46
dfca822f RE	47	INSTALLATION
	48	------------
	49
b06935f4 RS	50	See the appropriate file:
	51	INSTALL Linux, Unix, etc.
	52	INSTALL.DJGPP DOS platform with DJGPP
b06935f4	53	INSTALL.VMS VMS
7a77bd9d	54	INSTALL.WIN Windows
b06935f4	55	INSTALL.WCE Windows CE
80e1495b	56
a2c96d88	57	SUPPORT
dfca822f RE	58	-------
dfca822f RE	59
b06935f4	60	See the OpenSSL website www.openssl.org for details on how to obtain
0e37c909 DSH	61	commercial technical support.
0e37c909 DSH	62
dfca822f RE	63	If you have any problems with OpenSSL then please take the following steps
	64	first:
	65
d7f0ab5f UM	66	- Download the current snapshot from ftp://ftp.openssl.org/snapshot/
d7f0ab5f UM	67	to see if the problem has already been addressed
dfca822f	68	- Remove ASM versions of libraries
a2c96d88	69	- Remove compiler optimisation flags
dfca822f RE	70
	71	If you wish to report a bug then please include the following information in
	72	any bug report:
	73
d7f0ab5f UM	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)
dfca822f	83
468ab1c2	84	Email the report to:
dfca822f	85
932af161	86	rt@openssl.org
dfca822f	87
932af161 RS	88	In order to avoid spam, this is a moderated mailing list, and it might
932af161 RS	89	take a day for the ticket to show up. (We also scan posts to make sure
41977c53 RS	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).
0e37c909	96
932af161 RS	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.
a5ec86d1	104
b282fdae UM	105	HOW TO CONTRIBUTE TO OpenSSL
	106	----------------------------
	107
eb05f173	108	See CONTRIBUTING
b06935f4 RS	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.