[thirdparty/openssl.git] / README


 OpenSSL 1.0.1u-dev

 Copyright (c) 1998-2015 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 cryptograpic 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.NW      Netware
        INSTALL.OS2     OS/2
        INSTALL.VMS     VMS
        INSTALL.W32     Windows (32bit)
        INSTALL.W64     Windows (64bit)
        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
c33e6897	2	OpenSSL 1.0.1u-dev
651d0aff	3
0f5fdb73	4	Copyright (c) 1998-2015 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
0f5fdb73 RS	13	Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
	14	well as a full-strength general purpose cryptograpic 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.
651d0aff	18
0f5fdb73	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
0f5fdb73 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:
0f5fdb73	31	Provides the client and server-side implementations for SSLv3 and TLS.
651d0aff RE	32
651d0aff RE	33	libcrypto.a:
0f5fdb73 RS	34	Provides general cryptographic and X.509 support needed by SSL/TLS but
0f5fdb73 RS	35	not logically part of it.
651d0aff	36
a2c96d88	37	openssl:
d7f0ab5f	38	A command line tool that can be used for:
0f5fdb73	39	Creation of key parameters
a2c96d88	40	Creation of X.509 certificates, CSRs and CRLs
0f5fdb73 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
0f5fdb73	45	And more...
dd0514e2	46
dfca822f RE	47	INSTALLATION
	48	------------
	49
0f5fdb73 RS	50	See the appropriate file:
	51	INSTALL Linux, Unix, etc.
	52	INSTALL.DJGPP DOS platform with DJGPP
	53	INSTALL.NW Netware
	54	INSTALL.OS2 OS/2
	55	INSTALL.VMS VMS
	56	INSTALL.W32 Windows (32bit)
	57	INSTALL.W64 Windows (64bit)
	58	INSTALL.WCE Windows CE
80e1495b	59
a2c96d88	60	SUPPORT
dfca822f RE	61	-------
dfca822f RE	62
0f5fdb73	63	See the OpenSSL website www.openssl.org for details on how to obtain
11b6cb8a DSH	64	commercial technical support.
11b6cb8a DSH	65
dfca822f RE	66	If you have any problems with OpenSSL then please take the following steps
	67	first:
	68
d7f0ab5f UM	69	- Download the current snapshot from ftp://ftp.openssl.org/snapshot/
d7f0ab5f UM	70	to see if the problem has already been addressed
dfca822f	71	- Remove ASM versions of libraries
a2c96d88	72	- Remove compiler optimisation flags
dfca822f RE	73
	74	If you wish to report a bug then please include the following information in
	75	any bug report:
	76
d7f0ab5f UM	77	- On Unix systems:
	78	Self-test report generated by 'make report'
	79	- On other systems:
	80	OpenSSL version: output of 'openssl version -a'
	81	OS Name, Version, Hardware platform
	82	Compiler Details (name, version)
	83	- Application Details (name, version)
	84	- Problem Description (steps that will reproduce the problem, if known)
	85	- Stack Traceback (if the application dumps core)
dfca822f	86
0f5fdb73	87	Email the report to:
dfca822f	88
372e7490	89	rt@openssl.org
dfca822f	90
372e7490 RS	91	In order to avoid spam, this is a moderated mailing list, and it might
372e7490 RS	92	take a day for the ticket to show up. (We also scan posts to make sure
b5dbbebb RS	93	that security disclosures aren't publically posted by mistake.) Mail
	94	to this address is recorded in the public RT (request tracker) database
	95	(see https://www.openssl.org/community/index.html#bugs for details) and
	96	also forwarded the public openssl-dev mailing list. Confidential mail
	97	may be sent to openssl-security@openssl.org (PGP key available from the
	98	key servers).
11b6cb8a	99
372e7490 RS	100	Please do NOT use this for general assistance or support queries.
	101	Just because something doesn't work the way you expect does not mean it
	102	is necessarily a bug in OpenSSL.
	103
	104	You can also make GitHub pull requests. If you do this, please also send
	105	mail to rt@openssl.org with a link to the PR so that we can more easily
	106	keep track of it.
a5ec86d1	107
b282fdae UM	108	HOW TO CONTRIBUTE TO OpenSSL
	109	----------------------------
	110
0f5fdb73 RS	111	See CONTRIBUTING
	112
	113	LEGALITIES
	114	----------
d979d09c	115
0f5fdb73 RS	116	A number of nations, in particular the U.S., restrict the use or export
	117	of cryptography. If you are potentially subject to such restrictions
	118	you should seek competent professional legal advice before attempting to
	119	develop or distribute cryptographic code.