https://wiki.openssl.org/api.php?action=feedcontributions&user=Mark&feedformat=atomOpenSSLWiki - User contributions [en]2024-03-28T20:07:15ZUser contributionsMediaWiki 1.35.6https://wiki.openssl.org/index.php?title=Guidelines_for_Manual_Page_Authors&diff=2643Guidelines for Manual Page Authors2018-03-08T15:40:28Z<p>Mark: no one edits the pages here and we will be removing them, so update the advice on how to submit man page changes</p>
<hr />
<div>OpenSSL Manual pages are included in the [https://github.com/openssl/openssl/tree/master/doc main source tree]. Contributions and corrections to the Manual pages are welcomed and encouraged by opening an [https://www.openssl.org/community/#bugs issue on GitHub]<br />
<br />
However, some guidelines need to be considered when writing or amending these pages.<br />
<br />
==Manual Page Content==<br />
<br />
Manual pages are written in the POD documentation language. A guide to POD syntax is available [http://perldoc.perl.org/perlpod.html here].<br />
<br />
The POD syntax used in the manual pages is quite versatile and is used to generate manual pages in a number of different formats:<br />
* Linux/Unix style "man" pages<br />
* HTML docs<br />
<br />
When writing content you should be mindful of all the different formats that your page will be translated into. You should not assume for example that the end user will be using a web browser.<br />
<br />
The different headings shown in each page do vary slightly. Generally you should at least include the following:<br />
* Name<br />
* Synopsis<br />
* Description<br />
* See Also<br />
<br />
Where possible you should also include a "History" heading. Pages describing libssl and libcrypto functions usually also include a "Return Values" section.<br />
<br />
Refer to the other existing pages for examples of what should go in to each of these headings. The content under the "Name" heading is particularly important and should conform to a standard format. Here you should provide a comma separated list starting with the name of the page itself followed by all of the aliases that this page can have. After the list there should be a minus, "-", followed by a brief description of the page. For example:<br />
<br />
<pre><br />
EVP_PKEY_new, EVP_PKEY_free - private key allocation functions.<br />
</pre><br />
<br />
This is particularly important for pages describing libssl and libcrypto functions. The aliases should include all of the different functions that are described on the page.<br />
<br />
This list of aliases is used during Linux/Unix man page generation so that (for example) <code>man EVP_PKEY_set1_RSA</code> gives you the same man page as <code>man EVP_PKEY_set1_DSA</code>.<br />
<br />
==Linking==<br />
<br />
When writing manual page content consider how this page will be reached. This is particularly important for users accessing these pages through a web browser. It is no good having an excellent Manual page if no one can reach it! Ensure that there is a link to your page from other similar pages, and preferably from one of the "collection" pages such as Evp(3) or Bio(3).</div>Markhttps://wiki.openssl.org/index.php?title=Mailing_Lists&diff=2642Mailing Lists2018-03-08T15:32:24Z<p>Mark: </p>
<hr />
<div>We have several community mailing lists, see [https://www.openssl.org/community/mailinglists.html)</div>Markhttps://wiki.openssl.org/index.php?title=Code_reformatting&diff=2641Code reformatting2018-03-08T15:30:56Z<p>Mark: /* Code Reformatting */</p>
<hr />
<div><br />
== Code Reformatting ==<br />
<br />
In 2015, all the OpenSSL code was reformatted, in all release branches.<br />
<br />
As a result the code is consistent and, to almost everyone, easier to read.<br />
<br />
[https://www.openssl.org/policies/codingstyle.txt Coding Style Policy]<br />
<br />
Matt wrote a couple of blog entries about the reformatting: [[https://www.openssl.org/blog/blog/2015/01/05/source-code-reformat/]] and [[https://www.openssl.org/blog/blog/2015/02/11/code-reformat-finished/]].<br />
<br />
If you have a smaller number of local patches, you might find this recipe useful to upgrade:<br />
<br />
* Take the original release you are currently using. Reformat it according to the second blog entry. Don't worry too much about minor failures or inconsistencies. Save that.<br />
<br />
* Take your patched release. Reformat it according to the second blog entry. Don't worry too much about minor failures or inconsistencies. Save that.<br />
<br />
* Run a diff between the two releases. You should, for the most part, have just your patches, reformatted.</div>Markhttps://wiki.openssl.org/index.php?title=Standard_commands&diff=2640Standard commands2018-03-08T15:28:31Z<p>Mark: </p>
<hr />
<div>The OpenSSL [[standard commands]] can be listed via<br />
<pre><br />
$ openssl list-standard-commands<br />
</pre><br />
<br />
In later versions of OpenSSL [[standard commands]] can be listed via<br />
<br />
<pre><br />
$ openssl list -commands<br />
</pre><br />
<br />
Besides there are also [[cipher commands]] and [[message-digest commands]]. You can use these like<br />
<br />
<pre><br />
$ openssl command [options]<br />
</pre><br />
<br />
The Options heavily depend on the command. Please consult the dedicated pages or use<br />
<br />
<pre><br />
$ openssl command -help<br />
</pre><br />
<br />
<br />
===List of standard commands===<br />
<br />
*asn1parse<br />
*ca<br />
*ciphers - [[Command Line Utilities#ciphers]]<br />
*cms<br />
*crl<br />
*crl2pkcs7<br />
*dgst<br />
*dh<br />
*dhparam<br />
*dsa<br />
*dsaparam<br />
*ec<br />
*ecparam<br />
*[[enc]] - encryption and decryption tasks with symmetric ciphers.<br />
*engine<br />
*errstr<br />
*gendh<br />
*gendsa - [[Command Line Utilities#Key Generation]]<br />
*genpkey<br />
*genrsa - [[Command Line Utilities#Key Generation]]<br />
*nseq<br />
*ocsp<br />
*passwd<br />
*pkcs12 - [[Command Line Utilities#Client Certificates AKA pkcs12]]<br />
*pkcs7<br />
*pkcs8<br />
*pkey<br />
*pkeyparam<br />
*pkeyutl<br />
*prime<br />
*rand -- see [[Random Numbers]]<br />
*req<br />
*rsa<br />
*rsautl<br />
*s_client<br />
*s_server<br />
*s_time<br />
*sess_id<br />
*smime<br />
*speed<br />
*spkac<br />
*srp<br />
*ts<br />
*verify<br />
*version<br />
*x509</div>Markhttps://wiki.openssl.org/index.php?title=Standard_commands&diff=2639Standard commands2018-03-08T15:27:27Z<p>Mark: </p>
<hr />
<div>The OpenSSL [[standard commands]] can be listed via<br />
<pre><br />
$ openssl list-standard-commands<br />
</pre><br />
<br />
In later versions of OpenSSL [[standard commands]] can be listed via<br />
<br />
<pre><br />
$ openssl list -commands<br />
</pre><br />
<br />
Besides there are also [[cipher commands]] and [[message-digest commands]]. You can use these like<br />
<br />
<pre><br />
$ openssl command [options]<br />
</pre><br />
<br />
The Options heavily depend on the command. Please consult the dedicated pages.<br />
<br />
===List of standard commands===<br />
<br />
*asn1parse<br />
*ca<br />
*ciphers - [[Command Line Utilities#ciphers]]<br />
*cms<br />
*crl<br />
*crl2pkcs7<br />
*dgst<br />
*dh<br />
*dhparam<br />
*dsa<br />
*dsaparam<br />
*ec<br />
*ecparam<br />
*[[enc]] - encryption and decryption tasks with symmetric ciphers.<br />
*engine<br />
*errstr<br />
*gendh<br />
*gendsa - [[Command Line Utilities#Key Generation]]<br />
*genpkey<br />
*genrsa - [[Command Line Utilities#Key Generation]]<br />
*nseq<br />
*ocsp<br />
*passwd<br />
*pkcs12 - [[Command Line Utilities#Client Certificates AKA pkcs12]]<br />
*pkcs7<br />
*pkcs8<br />
*pkey<br />
*pkeyparam<br />
*pkeyutl<br />
*prime<br />
*rand -- see [[Random Numbers]]<br />
*req<br />
*rsa<br />
*rsautl<br />
*s_client<br />
*s_server<br />
*s_time<br />
*sess_id<br />
*smime<br />
*speed<br />
*spkac<br />
*srp<br />
*ts<br />
*verify<br />
*version<br />
*x509</div>Markhttps://wiki.openssl.org/index.php?title=Developing_For_OpenSSL&diff=2638Developing For OpenSSL2018-03-08T15:21:28Z<p>Mark: </p>
<hr />
<div>Periodically people ask us how to join the OpenSSL development team. This page is an attempt to answer that question.<br />
<br />
Firstly it is important to understand that OpenSSL is complex. It is both a fully featured cryptography library as well as an SSL/TLS library. In addition the command line tools provide a wide array of capabilities. It can take quite a while to become proficient in coding in the internals. It is also clearly security sensitive. For those reasons joining the main development team is by invitation only. Most of the current development team have had an association with OpenSSL of one sort or another for a long time. Some have been on the project since the beginning, whilst many others joined later. For those joining later, without exception, everyone had a number of years of experience working with OpenSSL before they joined the team itself. The list of current development team members is available here: https://www.openssl.org/community/<br />
<br />
However, there are still a number of ways to contribute to the project without joining the development team. We welcome such contributions:<br />
<br />
* A good place to start is the openssl-users mailing list. This will give you the opportunity to help out other users of OpenSSL, and learn from other experts in its use. Development issues that the team is tackling can be viewed via the [https://github.com/openssl/openssl/issues GitHub issue tracking] system.<br />
<br />
* We are always looking for good people to help us build up the information held within this wiki. Documentation is one area where we are keen to improve things, and this wiki is an important location for people to come to. Information on how to get an account is available on the [[Welcome]] page.<br />
<br />
* Bug fixes and enhancements to the code and documentation can be submitted via [https://github.com/openssl/openssl GitHub] as [https://github.com/openssl/openssl/issues issues] or [https://github.com/openssl/openssl/pulls pull requests]. See the README for details. If using GitHub pull requests please create and/or reference an issue so that it will automatically show up in the issue timeline.</div>Markhttps://wiki.openssl.org/index.php?title=Developing_For_OpenSSL&diff=2637Developing For OpenSSL2018-03-08T15:19:15Z<p>Mark: </p>
<hr />
<div>Periodically people ask us how to join the OpenSSL development team. This page is an attempt to answer that question.<br />
<br />
Firstly it is important to understand that OpenSSL is complex. It is both a fully featured cryptography library as well as an SSL/TLS library. In addition the command line tools provide a wide array of capabilities. It can take quite a while to become proficient in coding in the internals. It is also clearly security sensitive. For those reasons joining the main development team is by invitation only. Most of the current development team have had an association with OpenSSL of one sort or another for a long time. Some have been on the project since the beginning, whilst many others joined later. For those joining later, without exception, everyone had a number of years of experience working with OpenSSL before they joined the team itself. The list of current development team members is available here: https://www.openssl.org/community/<br />
<br />
However, there are still a number of ways to contribute to the project without joining the development team. We welcome such contributions:<br />
<br />
* A good place to start is the openssl-users and openssl-dev mailing lists. The first of these forums will give you the opportunity to help out other users of OpenSSL, and learn from other experts in its use. The latter will give you an insight into some of the development issues that the team is tackling - and in particular issues being raised through the [https://github.com/openssl/openssl/issues GitHub issue tracking] system and responses to those issues.<br />
<br />
* We are always looking for good people to help us build up the information held within this wiki. Documentation is one area where we are keen to improve things, and this wiki is an important location for people to come to. Information on how to get an account is available on the [[Welcome]] page.<br />
<br />
* Bug fixes and enhancements to the code and documentation can be submitted via [https://github.com/openssl/openssl GitHub] as [https://github.com/openssl/openssl/issues issues] or [https://github.com/openssl/openssl/pulls pull requests]. See the README for details. If using GitHub pull requests please create and/or reference an issue so that it will automatically show up in the issue timeline.</div>Markhttps://wiki.openssl.org/index.php?title=Main_Page&diff=2636Main Page2018-03-08T15:14:56Z<p>Mark: /* Feedback and Contributions */</p>
<hr />
<div>This is the OpenSSL wiki. The main site is https://www.openssl.org . If this is your first visit or to get an account please see the [[Welcome]] page. Your participation and [[Contributions]] are valued.<br />
<br />
This wiki is intended as a place for collecting, organizing, and refining useful information about OpenSSL that is currently strewn among multiple locations and formats.<br />
<br />
== OpenSSL Quick Links ==<br />
<br />
<TABLE border=0><br />
<TR><br />
<TD>[[OpenSSL Overview]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Compilation and Installation]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Internals]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Mailing Lists]] </TD><br />
</TR><br />
<TR><br />
<TD>[[libcrypto API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[libssl API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Examples]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Documentation Index|Index of all API functions]]</TD><br />
</TR><br />
<TR><br />
<TD>[[License]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Command Line Utilities]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Related Links]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Binaries]]</TD><br />
</TR><br />
<TR><br />
<TD>[[SSL and TLS Protocols]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[1.1 API Changes]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[FIPS modules]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
</TR><br />
</TABLE><br />
<br />
== Administrivia ==<br />
Site guidelines, legal and admininstrative issues.<br />
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]<br />
:* Using This Wiki<br />
:: [http://meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide], [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list], [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ], [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki Mailing List]<br />
<br />
== Reference ==<br />
This section contains the automagically generated man pages from the OpenSSL git repository, and similar "man" style reference documentation. The man pages are automatically imported from the OpenSSL git repository and local wiki modifications are submitted as patches.<br />
:* [https://www.openssl.org/docs/manpages.html OpenSSL Manual Pages]<br />
:* [[API]], [[Libcrypto API]], [[Libssl API]]<br />
:* [[FIPS mode()]], [[FIPS_mode_set()]]<br />
<br />
== Usage and Programming ==<br />
This section has discussions of practical issues in using OpenSSL<br />
:* Building from Source<br />
:: Where to find it, the different versions, how to build and install it.<br />
:* [[OpenSSL Overview]]<br />
:* [[Versioning]]<br />
:* [[Compilation and Installation]]<br />
:* [[EVP]]<br />
:: Programming techniques and example code<br />
:: Use of EVP is preferred for most applications and circumstances<br />
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]<br />
::* [[EVP Authenticated Encryption and Decryption]]<br />
::* [[EVP Symmetric Encryption and Decryption]]<br />
::* [[EVP Key and Parameter Generation]]<br />
::* [[EVP Key Agreement]]<br />
::* [[EVP Message Digests]]<br />
::* [[EVP Key Derivation]]<br />
::* [[EVP Signing and Verifying|EVP Signing and Verifying (including MAC codes)]]<br />
:* [[STACK API]]<br />
:* [[List of SSL OP Flags]]<br />
:* Low Level APIs<br />
::[[Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms]]<br />
:: More specialized non-EVP usage<br />
::* [[Diffie-Hellman parameters]]<br />
:* [[FIPS Mode]]<br />
:* [[Simple TLS Server]]<br />
<br />
== Concepts and Theory ==<br />
Discussions of basic cryptographic theory and concepts<br />
Discussions of common operational issues<br />
:* [[Base64]]<br />
:* [http://wiki.openssl.org/index.php/Category:FIPS_140 FIPS 140-2]<br />
:* [[Random Numbers]]<br />
:* [[Diffie Hellman]]<br />
:* [[Elliptic Curve Diffie Hellman]]<br />
:* [[Elliptic Curve Cryptography]]<br />
<br />
== Security Advisories ==<br />
:* [https://www.openssl.org/policies/secpolicy.html OpenSSL Security Policy]<br />
:* [https://www.openssl.org/news/vulnerabilities.html OpenSSL Vulnerabilities List]<br />
:* [[Security_Advisories|Security Advisories Additional Information]]<br />
<br />
== Feedback and Contributions ==<br />
:* [https://www.openssl.org/news/vulnerabilities.html How to notify us of suspected security vulnerabilities]<br />
:* [https://www.openssl.org/community/#bugs How to report bugs, other than for suspected vulnerabilities]<br />
:* [[Contributions|General background on source and documentation contributions - '''must read''']]<br />
:* Contributing code fixes, other than for suspected vulnerabilities, as well as fixes and other improvements to manual pages:<br />
::* If you are unsure as to whether a feature will be useful for the general OpenSSL community please discuss it on the [https://www.openssl.org/community/ openssl-users mailing list] first. Someone may be already working on the same thing or there may be a good reason as to why that feature isn't implemented.<br />
::* Follow the [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|instructions for accessing source code]] in the appropriate branches. Note that manual pages and the FAQ are maintained with the source code.<br />
::* Submit a pull request for each separate fix (also documented [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|there]])<br />
::* Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.<br />
:* Contributing fixes and other improvements to the web site<br />
::* Follow the [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|instructions for accessing web site sources]]<br />
::* Create a patch (also documented [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|there]])<br />
::* Submit a bug report and add the patch as an attachment<br />
:* [[Developing For OpenSSL]]<br />
:* [[KnownPatches|Known patches not part of OpenSSL]]<br />
:* [[Welcome|Contributing to this wiki]]<br />
<br />
== Internals and Development ==<br />
This section is for internal details of primary interest to OpenSSL maintainers and power users<br />
:* [[Code reformatting]]<br />
<br />
:* [[Internals]]<br />
:* [[Code Quality]]<br />
:* [[Static and Dynamic Analysis]]<br />
:* [[OCB|OCB Licence details]]<br />
:* [[Defect and Feature Review Process]]<br />
:* [[Unit Testing]] (includes other automated testing information)<br />
:* [[How to Integrate a Symmetric Cipher]]</div>Markhttps://wiki.openssl.org/index.php?title=Main_Page&diff=2635Main Page2018-03-08T15:12:13Z<p>Mark: /* Feedback and Contributions */</p>
<hr />
<div>This is the OpenSSL wiki. The main site is https://www.openssl.org . If this is your first visit or to get an account please see the [[Welcome]] page. Your participation and [[Contributions]] are valued.<br />
<br />
This wiki is intended as a place for collecting, organizing, and refining useful information about OpenSSL that is currently strewn among multiple locations and formats.<br />
<br />
== OpenSSL Quick Links ==<br />
<br />
<TABLE border=0><br />
<TR><br />
<TD>[[OpenSSL Overview]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Compilation and Installation]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Internals]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Mailing Lists]] </TD><br />
</TR><br />
<TR><br />
<TD>[[libcrypto API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[libssl API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Examples]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Documentation Index|Index of all API functions]]</TD><br />
</TR><br />
<TR><br />
<TD>[[License]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Command Line Utilities]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Related Links]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Binaries]]</TD><br />
</TR><br />
<TR><br />
<TD>[[SSL and TLS Protocols]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[1.1 API Changes]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[FIPS modules]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
</TR><br />
</TABLE><br />
<br />
== Administrivia ==<br />
Site guidelines, legal and admininstrative issues.<br />
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]<br />
:* Using This Wiki<br />
:: [http://meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide], [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list], [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ], [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki Mailing List]<br />
<br />
== Reference ==<br />
This section contains the automagically generated man pages from the OpenSSL git repository, and similar "man" style reference documentation. The man pages are automatically imported from the OpenSSL git repository and local wiki modifications are submitted as patches.<br />
:* [https://www.openssl.org/docs/manpages.html OpenSSL Manual Pages]<br />
:* [[API]], [[Libcrypto API]], [[Libssl API]]<br />
:* [[FIPS mode()]], [[FIPS_mode_set()]]<br />
<br />
== Usage and Programming ==<br />
This section has discussions of practical issues in using OpenSSL<br />
:* Building from Source<br />
:: Where to find it, the different versions, how to build and install it.<br />
:* [[OpenSSL Overview]]<br />
:* [[Versioning]]<br />
:* [[Compilation and Installation]]<br />
:* [[EVP]]<br />
:: Programming techniques and example code<br />
:: Use of EVP is preferred for most applications and circumstances<br />
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]<br />
::* [[EVP Authenticated Encryption and Decryption]]<br />
::* [[EVP Symmetric Encryption and Decryption]]<br />
::* [[EVP Key and Parameter Generation]]<br />
::* [[EVP Key Agreement]]<br />
::* [[EVP Message Digests]]<br />
::* [[EVP Key Derivation]]<br />
::* [[EVP Signing and Verifying|EVP Signing and Verifying (including MAC codes)]]<br />
:* [[STACK API]]<br />
:* [[List of SSL OP Flags]]<br />
:* Low Level APIs<br />
::[[Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms]]<br />
:: More specialized non-EVP usage<br />
::* [[Diffie-Hellman parameters]]<br />
:* [[FIPS Mode]]<br />
:* [[Simple TLS Server]]<br />
<br />
== Concepts and Theory ==<br />
Discussions of basic cryptographic theory and concepts<br />
Discussions of common operational issues<br />
:* [[Base64]]<br />
:* [http://wiki.openssl.org/index.php/Category:FIPS_140 FIPS 140-2]<br />
:* [[Random Numbers]]<br />
:* [[Diffie Hellman]]<br />
:* [[Elliptic Curve Diffie Hellman]]<br />
:* [[Elliptic Curve Cryptography]]<br />
<br />
== Security Advisories ==<br />
:* [https://www.openssl.org/policies/secpolicy.html OpenSSL Security Policy]<br />
:* [https://www.openssl.org/news/vulnerabilities.html OpenSSL Vulnerabilities List]<br />
:* [[Security_Advisories|Security Advisories Additional Information]]<br />
<br />
== Feedback and Contributions ==<br />
:* [https://www.openssl.org/news/vulnerabilities.html How to notify us of suspected security vulnerabilities]<br />
:* [https://www.openssl.org/community/#bugs How to report bugs, other than for suspected vulnerabilities]<br />
:* [[Contributions|General background on source and documentation contributions - '''must read''']]<br />
:* Contributing code fixes, other than for suspected vulnerabilities, as well as fixes and other improvements to manual pages:<br />
::* If you are unsure as to whether a feature will be useful for the general OpenSSL community please discuss it on the [https://www.openssl.org/support/community.html openssl-dev mailing list] first. Someone may be already working on the same thing or there may be a good reason as to why that feature isn't implemented.<br />
::* Follow the [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|instructions for accessing source code]] in the appropriate branches. Note that manual pages and the FAQ are maintained with the source code.<br />
::* Submit a pull request for each separate fix (also documented [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|there]])<br />
::* Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.<br />
:* Contributing fixes and other improvements to the web site<br />
::* Follow the [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|instructions for accessing web site sources]]<br />
::* Create a patch (also documented [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|there]])<br />
::* Submit a bug report and add the patch as an attachment<br />
:* [[Developing For OpenSSL]]<br />
:* [[KnownPatches|Known patches not part of OpenSSL]]<br />
:* [[Welcome|Contributing to this wiki]]<br />
<br />
== Internals and Development ==<br />
This section is for internal details of primary interest to OpenSSL maintainers and power users<br />
:* [[Code reformatting]]<br />
<br />
:* [[Internals]]<br />
:* [[Code Quality]]<br />
:* [[Static and Dynamic Analysis]]<br />
:* [[OCB|OCB Licence details]]<br />
:* [[Defect and Feature Review Process]]<br />
:* [[Unit Testing]] (includes other automated testing information)<br />
:* [[How to Integrate a Symmetric Cipher]]</div>Markhttps://wiki.openssl.org/index.php?title=Main_Page&diff=2634Main Page2018-03-08T15:08:41Z<p>Mark: </p>
<hr />
<div>This is the OpenSSL wiki. The main site is https://www.openssl.org . If this is your first visit or to get an account please see the [[Welcome]] page. Your participation and [[Contributions]] are valued.<br />
<br />
This wiki is intended as a place for collecting, organizing, and refining useful information about OpenSSL that is currently strewn among multiple locations and formats.<br />
<br />
== OpenSSL Quick Links ==<br />
<br />
<TABLE border=0><br />
<TR><br />
<TD>[[OpenSSL Overview]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Compilation and Installation]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Internals]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Mailing Lists]] </TD><br />
</TR><br />
<TR><br />
<TD>[[libcrypto API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[libssl API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Examples]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Documentation Index|Index of all API functions]]</TD><br />
</TR><br />
<TR><br />
<TD>[[License]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Command Line Utilities]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Related Links]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Binaries]]</TD><br />
</TR><br />
<TR><br />
<TD>[[SSL and TLS Protocols]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[1.1 API Changes]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[FIPS modules]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
</TR><br />
</TABLE><br />
<br />
== Administrivia ==<br />
Site guidelines, legal and admininstrative issues.<br />
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]<br />
:* Using This Wiki<br />
:: [http://meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide], [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list], [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ], [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki Mailing List]<br />
<br />
== Reference ==<br />
This section contains the automagically generated man pages from the OpenSSL git repository, and similar "man" style reference documentation. The man pages are automatically imported from the OpenSSL git repository and local wiki modifications are submitted as patches.<br />
:* [https://www.openssl.org/docs/manpages.html OpenSSL Manual Pages]<br />
:* [[API]], [[Libcrypto API]], [[Libssl API]]<br />
:* [[FIPS mode()]], [[FIPS_mode_set()]]<br />
<br />
== Usage and Programming ==<br />
This section has discussions of practical issues in using OpenSSL<br />
:* Building from Source<br />
:: Where to find it, the different versions, how to build and install it.<br />
:* [[OpenSSL Overview]]<br />
:* [[Versioning]]<br />
:* [[Compilation and Installation]]<br />
:* [[EVP]]<br />
:: Programming techniques and example code<br />
:: Use of EVP is preferred for most applications and circumstances<br />
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]<br />
::* [[EVP Authenticated Encryption and Decryption]]<br />
::* [[EVP Symmetric Encryption and Decryption]]<br />
::* [[EVP Key and Parameter Generation]]<br />
::* [[EVP Key Agreement]]<br />
::* [[EVP Message Digests]]<br />
::* [[EVP Key Derivation]]<br />
::* [[EVP Signing and Verifying|EVP Signing and Verifying (including MAC codes)]]<br />
:* [[STACK API]]<br />
:* [[List of SSL OP Flags]]<br />
:* Low Level APIs<br />
::[[Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms]]<br />
:: More specialized non-EVP usage<br />
::* [[Diffie-Hellman parameters]]<br />
:* [[FIPS Mode]]<br />
:* [[Simple TLS Server]]<br />
<br />
== Concepts and Theory ==<br />
Discussions of basic cryptographic theory and concepts<br />
Discussions of common operational issues<br />
:* [[Base64]]<br />
:* [http://wiki.openssl.org/index.php/Category:FIPS_140 FIPS 140-2]<br />
:* [[Random Numbers]]<br />
:* [[Diffie Hellman]]<br />
:* [[Elliptic Curve Diffie Hellman]]<br />
:* [[Elliptic Curve Cryptography]]<br />
<br />
== Security Advisories ==<br />
:* [https://www.openssl.org/policies/secpolicy.html OpenSSL Security Policy]<br />
:* [https://www.openssl.org/news/vulnerabilities.html OpenSSL Vulnerabilities List]<br />
:* [[Security_Advisories|Security Advisories Additional Information]]<br />
<br />
== Feedback and Contributions ==<br />
:* [https://www.openssl.org/support/faq.html#BUILD18 How to notify us of suspected security vulnerabilities]<br />
:* [https://www.openssl.org/community/#bugs How to report bugs, other than for suspected vulnerabilities]<br />
:* [[Contributions|General background on source and documentation contributions - '''must read''']]<br />
:* Contributing code fixes, other than for suspected vulnerabilities, as well as fixes and other improvements to manual pages:<br />
::* If you are unsure as to whether a feature will be useful for the general OpenSSL community please discuss it on the [https://www.openssl.org/support/community.html openssl-dev mailing list] first. Someone may be already working on the same thing or there may be a good reason as to why that feature isn't implemented.<br />
::* Follow the [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|instructions for accessing source code]] in the appropriate branches. Note that manual pages and the FAQ are maintained with the source code.<br />
::* Submit a pull request for each separate fix (also documented [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|there]])<br />
::* Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.<br />
:* Contributing fixes and other improvements to the web site<br />
::* Follow the [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|instructions for accessing web site sources]]<br />
::* Create a patch (also documented [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|there]])<br />
::* Submit a bug report and add the patch as an attachment<br />
:* [[Developing For OpenSSL]]<br />
:* [[KnownPatches|Known patches not part of OpenSSL]]<br />
:* [[Welcome|Contributing to this wiki]]<br />
<br />
== Internals and Development ==<br />
This section is for internal details of primary interest to OpenSSL maintainers and power users<br />
:* [[Code reformatting]]<br />
<br />
:* [[Internals]]<br />
:* [[Code Quality]]<br />
:* [[Static and Dynamic Analysis]]<br />
:* [[OCB|OCB Licence details]]<br />
:* [[Defect and Feature Review Process]]<br />
:* [[Unit Testing]] (includes other automated testing information)<br />
:* [[How to Integrate a Symmetric Cipher]]</div>Markhttps://wiki.openssl.org/index.php?title=Main_Page&diff=2633Main Page2018-03-08T15:07:54Z<p>Mark: replace link to outdated man pages with site live version</p>
<hr />
<div>This is the OpenSSL wiki. The main site is https://www.openssl.org . If this is your first visit or to get an account please see the [[Welcome]] page. Your participation and [[Contributions]] are valued.<br />
<br />
This wiki is intended as a place for collecting, organizing, and refining useful information about OpenSSL that is currently strewn among multiple locations and formats.<br />
<br />
== OpenSSL Quick Links ==<br />
<br />
<TABLE border=0><br />
<TR><br />
<TD>[[OpenSSL Overview]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Compilation and Installation]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Internals]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Mailing Lists]] </TD><br />
</TR><br />
<TR><br />
<TD>[[libcrypto API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[libssl API]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Examples]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Documentation Index|Index of all API functions]]</TD><br />
</TR><br />
<TR><br />
<TD>[[License]] </TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Command Line Utilities]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Related Links]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[Binaries]]</TD><br />
</TR><br />
<TR><br />
<TD>[[SSL and TLS Protocols]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[1.1 API Changes]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
<TD>[[FIPS modules]]</TD><br />
<TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD><br />
</TR><br />
</TABLE><br />
<br />
== Administrivia ==<br />
Site guidelines, legal and admininstrative issues.<br />
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]<br />
:* Using This Wiki<br />
:: [http://meta.wikimedia.org/wiki/Help:Contents Wiki User's Guide], [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list], [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ], [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki Mailing List]<br />
<br />
== Reference ==<br />
This section contains the automagically generated man pages from the OpenSSL git repository, and similar "man" style reference documentation. The man pages are automatically imported from the OpenSSL git repository and local wiki modifications are submitted as patches.<br />
:* [https://www.openssl.org/docs/manpages.html:OpenSSL Manual Pages]<br />
:* [[API]], [[Libcrypto API]], [[Libssl API]]<br />
:* [[FIPS mode()]], [[FIPS_mode_set()]]<br />
<br />
== Usage and Programming ==<br />
This section has discussions of practical issues in using OpenSSL<br />
:* Building from Source<br />
:: Where to find it, the different versions, how to build and install it.<br />
:* [[OpenSSL Overview]]<br />
:* [[Versioning]]<br />
:* [[Compilation and Installation]]<br />
:* [[EVP]]<br />
:: Programming techniques and example code<br />
:: Use of EVP is preferred for most applications and circumstances<br />
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]<br />
::* [[EVP Authenticated Encryption and Decryption]]<br />
::* [[EVP Symmetric Encryption and Decryption]]<br />
::* [[EVP Key and Parameter Generation]]<br />
::* [[EVP Key Agreement]]<br />
::* [[EVP Message Digests]]<br />
::* [[EVP Key Derivation]]<br />
::* [[EVP Signing and Verifying|EVP Signing and Verifying (including MAC codes)]]<br />
:* [[STACK API]]<br />
:* [[List of SSL OP Flags]]<br />
:* Low Level APIs<br />
::[[Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms]]<br />
:: More specialized non-EVP usage<br />
::* [[Diffie-Hellman parameters]]<br />
:* [[FIPS Mode]]<br />
:* [[Simple TLS Server]]<br />
<br />
== Concepts and Theory ==<br />
Discussions of basic cryptographic theory and concepts<br />
Discussions of common operational issues<br />
:* [[Base64]]<br />
:* [http://wiki.openssl.org/index.php/Category:FIPS_140 FIPS 140-2]<br />
:* [[Random Numbers]]<br />
:* [[Diffie Hellman]]<br />
:* [[Elliptic Curve Diffie Hellman]]<br />
:* [[Elliptic Curve Cryptography]]<br />
<br />
== Security Advisories ==<br />
:* [https://www.openssl.org/policies/secpolicy.html OpenSSL Security Policy]<br />
:* [https://www.openssl.org/news/vulnerabilities.html OpenSSL Vulnerabilities List]<br />
:* [[Security_Advisories|Security Advisories Additional Information]]<br />
<br />
== Feedback and Contributions ==<br />
:* [https://www.openssl.org/support/faq.html#BUILD18 How to notify us of suspected security vulnerabilities]<br />
:* [https://www.openssl.org/community/#bugs How to report bugs, other than for suspected vulnerabilities]<br />
:* [[Contributions|General background on source and documentation contributions - '''must read''']]<br />
:* Contributing code fixes, other than for suspected vulnerabilities, as well as fixes and other improvements to manual pages:<br />
::* If you are unsure as to whether a feature will be useful for the general OpenSSL community please discuss it on the [https://www.openssl.org/support/community.html openssl-dev mailing list] first. Someone may be already working on the same thing or there may be a good reason as to why that feature isn't implemented.<br />
::* Follow the [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|instructions for accessing source code]] in the appropriate branches. Note that manual pages and the FAQ are maintained with the source code.<br />
::* Submit a pull request for each separate fix (also documented [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|there]])<br />
::* Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.<br />
:* Contributing fixes and other improvements to the web site<br />
::* Follow the [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|instructions for accessing web site sources]]<br />
::* Create a patch (also documented [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|there]])<br />
::* Submit a bug report and add the patch as an attachment<br />
:* [[Developing For OpenSSL]]<br />
:* [[KnownPatches|Known patches not part of OpenSSL]]<br />
:* [[Welcome|Contributing to this wiki]]<br />
<br />
== Internals and Development ==<br />
This section is for internal details of primary interest to OpenSSL maintainers and power users<br />
:* [[Code reformatting]]<br />
<br />
:* [[Internals]]<br />
:* [[Code Quality]]<br />
:* [[Static and Dynamic Analysis]]<br />
:* [[OCB|OCB Licence details]]<br />
:* [[Defect and Feature Review Process]]<br />
:* [[Unit Testing]] (includes other automated testing information)<br />
:* [[How to Integrate a Symmetric Cipher]]</div>Markhttps://wiki.openssl.org/index.php?title=Welcome&diff=2632Welcome2018-03-08T15:04:54Z<p>Mark: remove out of date contact info</p>
<hr />
<div>'''Welcome to the OpenSSL Wiki'''<br />
<br />
This wiki is under construction as we figure out what works and what doesn't. Please see the [[basic rules]] which are summarized here:<br />
<br />
This wiki is intended for the OpenSSL community. There are a few minor restrictions so we don't have to fool with capchas and constantly monitor for spam, defacements, and vandalism. The essence of the restrictions are:<br />
<br />
* Everyone can read content<br />
* Approved registered users can add or edit content<br />
<br />
We encourage your participation and hope you will add pages and improve existing pages. If you want to add or edit content you should request an account by sending an email to wiki-support@openssl.org. Let us know what username you would like and give a sentence or two describing your interest in OpenSSL so that we know that you are not a spammer!!<br />
<br />
We hope to have multiple administrators. Those who have an interest may request admission to the Administrator or Bureaucrat groups.<br />
<br />
We would like the content to be as accessible and usable as possible. All contributions must be made available under the current OpenSSL licence (and any future OpenSSL license) as described on the [[License]] page. We understand existing OpenSSL subject matter from other sources will inevitably appear here. Please respect copyright restrictions, and only place material here if it is already under the OpenSSL license or if you are the copyright holder and release it under the current and future OpenSSL license, or it is currently in the public domain.</div>Mark