Difference between revisions of "Main Page"

From OpenSSLWiki
Jump to navigationJump to search
 
(77 intermediate revisions by 21 users not shown)
Line 1: Line 1:
−
'''Welcome to the OpenSSL Wiki'''
+
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.
  
−
Under construction as we figure out what works and what doesn't.
+
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.
  
−
This wiki is intended for open participation by the user community, with only enough restrictions so we don't have to fool with capchas and constantly monitor for spam and vandalism. So while we may not have implemented it quite right, the intent is that:
+
== OpenSSL Quick Links ==
  
−
* Anyone can read anything
+
  <TABLE border=0>
−
* To edit content you must register with an E-mail address and be given edit privileges by any sysop.
+
    <TR>
 +
        <TD>[[OpenSSL Overview]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Compilation and Installation]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Configuration "packages"]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Internals]]</TD>
 +
      </TR>
 +
      <TR>
 +
        <TD>[[libcrypto API]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[libssl API]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Examples]] </TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Documentation Index|Index of all API functions]]</TD>
 +
      </TR>
 +
      <TR>
 +
        <TD>[[License]] </TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Command Line Utilities]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Related Links]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[Binaries]]</TD>
 +
      </TR>
 +
      <TR>
 +
        <TD>[[SSL and TLS Protocols]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[1.1 API Changes]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[FIPS modules]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[TLS1.3]]</TD>
 +
      </TR>
 +
      <TR>
 +
        <TD>[[Mailing Lists]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD>[[OpenSSL 3.0]]</TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD></TD>
 +
        <TD>[[Image:HTAB.png]][[Image:HTAB.png]]</TD>
 +
        <TD></TD>
 +
      </TR>
 +
  </TABLE>
  
−
At least for now anyone who wants to edit content and/or handle sysop duties is welcome; we want your participation and are not asking for any qualifications, references, etc. other than an interest in the subject matter. We hope and expect to have multiple "sysops" (administrators).
+
== Administrivia ==
 +
Site guidelines, legal and admininstrative issues.
 +
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]
 +
:* Using This Wiki
 +
:: [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]
  
−
It remains to be seen how this will work out. If you think your contributions have been blocked or modified inappropriately it was probably done by accident; please contact Steve Marquess, marquess@opensslfoundation.com, +1 301-874-2571.
+
== Reference ==
 +
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.
 +
:* [https://www.openssl.org/docs/manpages.html OpenSSL Manual Pages]
 +
:* [[API]], [[Libcrypto API]], [[Libssl API]]
 +
:* [[FIPS mode()]], [[FIPS_mode_set()]]
  
−
Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
+
== Usage and Programming ==
−
{{CategoryTOC}}
+
This section has discussions of practical issues in using OpenSSL
 +
:* Building from Source
 +
:: Where to find it, the different versions, how to build and install it.
 +
:* [[OpenSSL Overview]]
 +
:* [[Versioning]]
 +
:* [[Compilation and Installation]]
 +
:* [[EVP]]
 +
:: Programming techniques and example code
 +
:: Use of EVP is preferred for most applications and circumstances
 +
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]
 +
::* [[EVP Authenticated Encryption and Decryption]]
 +
::* [[EVP Symmetric Encryption and Decryption]]
 +
::* [[EVP Key and Parameter Generation]]
 +
::* [[EVP Key Agreement]]
 +
::* [[EVP Message Digests]]
 +
::* [[EVP Key Derivation]]
 +
::* [[EVP Signing and Verifying|EVP Signing and Verifying (including MAC codes)]]
 +
:* [[STACK API]]
 +
:* [[List of SSL OP Flags]]
 +
:* Low Level APIs
 +
::[[Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms]]
 +
:: More specialized non-EVP usage
 +
::* [[Diffie-Hellman parameters]]
 +
:* [[FIPS Mode]]
 +
:* [[Simple TLS Server]]
 +
:* [[Simple TLS Client]]
 +
:* [[Simple DTLS Server]]
 +
:* [[Simple DTLS Client]]
  
−
== Getting started ==
+
== Concepts and Theory ==
−
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
+
Discussions of basic cryptographic theory and concepts
−
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
+
Discussions of common operational issues
−
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
+
:* [[Base64]]
 +
:* [http://wiki.openssl.org/index.php/Category:FIPS_140 FIPS 140-2]
 +
:* [[Random Numbers]]
 +
:* [[Diffie Hellman]]
 +
:* [[Elliptic Curve Diffie Hellman]]
 +
:* [[Elliptic Curve Cryptography]]
 +
 
 +
== Security Advisories ==
 +
:* [https://www.openssl.org/policies/secpolicy.html OpenSSL Security Policy]
 +
:* [https://www.openssl.org/news/vulnerabilities.html OpenSSL Vulnerabilities List]
 +
:* [[Security_Advisories|Security Advisories Additional Information]]
 +
 
 +
== Feedback and Contributions ==
 +
:* [https://www.openssl.org/news/vulnerabilities.html How to notify us of suspected security vulnerabilities]
 +
:* [https://www.openssl.org/community/#bugs How to report bugs, other than for suspected vulnerabilities]
 +
:* [[Contributions|General background on source and documentation contributions - '''must read''']]
 +
:* Contributing code fixes, other than for suspected vulnerabilities, as well as fixes and other improvements to manual pages:
 +
::* 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.
 +
::* 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.
 +
::* Submit a pull request for each separate fix (also documented [[Use of Git#Use_of_Git_with_OpenSSL_source_tree|there]])
 +
::* Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.
 +
:* Contributing fixes and other improvements to the web site
 +
::* Follow the [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|instructions for accessing web site sources]]
 +
::* Create a patch (also documented [[Use_of_Git#Use_of_Git_with_the_OpenSSL_web_site|there]])
 +
::* Submit a bug report and add the patch as an attachment
 +
:* [[Developing For OpenSSL]]
 +
:* [[KnownPatches|Known patches not part of OpenSSL]]
 +
:* [[Welcome|Contributing to this wiki]]
 +
 
 +
== Internals and Development ==
 +
This section is for internal details of primary interest to OpenSSL maintainers and power users
 +
:* [[Code reformatting]]
 +
 
 +
:* [[Internals]]
 +
:* [[Code Quality]]
 +
:* [[Static and Dynamic Analysis]]
 +
:* [[OCB|OCB Licence details]]
 +
:* [[Defect and Feature Review Process]]
 +
:* [[Unit Testing]] (includes other automated testing information)
 +
:* [[How to Integrate a Symmetric Cipher]]

Latest revision as of 05:26, 16 February 2021

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.

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.

OpenSSL Quick Links[edit]

OpenSSL Overview HTAB.pngHTAB.png Compilation and Installation HTAB.pngHTAB.png Configuration "packages" HTAB.pngHTAB.png Internals
libcrypto API HTAB.pngHTAB.png libssl API HTAB.pngHTAB.png Examples HTAB.pngHTAB.png Index of all API functions
License HTAB.pngHTAB.png Command Line Utilities HTAB.pngHTAB.png Related Links HTAB.pngHTAB.png Binaries
SSL and TLS Protocols HTAB.pngHTAB.png 1.1 API Changes HTAB.pngHTAB.png FIPS modules HTAB.pngHTAB.png TLS1.3
Mailing Lists HTAB.pngHTAB.png OpenSSL 3.0 HTAB.pngHTAB.png HTAB.pngHTAB.png

Administrivia[edit]

Site guidelines, legal and admininstrative issues.

Wiki User's Guide, Configuration settings list, MediaWiki FAQ, MediaWiki Mailing List

Reference[edit]

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.

Usage and Programming[edit]

This section has discussions of practical issues in using OpenSSL

  • Building from Source
Where to find it, the different versions, how to build and install it.
Programming techniques and example code
Use of EVP is preferred for most applications and circumstances
Creating an OpenSSL Engine to use indigenous ECDH ECDSA and HASH Algorithms
More specialized non-EVP usage

Concepts and Theory[edit]

Discussions of basic cryptographic theory and concepts Discussions of common operational issues

Security Advisories[edit]

Feedback and Contributions[edit]

  • If you are unsure as to whether a feature will be useful for the general OpenSSL community please discuss it on the 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.
  • Follow the instructions for accessing source code in the appropriate branches. Note that manual pages and the FAQ are maintained with the source code.
  • Submit a pull request for each separate fix (also documented there)
  • Submit a bug report (see second bullet, above) and reference the pull request. Or you can attach the patch to the ticket.
  • Contributing fixes and other improvements to the web site

Internals and Development[edit]

This section is for internal details of primary interest to OpenSSL maintainers and power users

Retrieved from "https://wiki.openssl.org/index.php?title=Main_Page&oldid=3143"