Difference between revisions of "Talk:Main Page"

From OpenSSLWiki
Jump to: navigation, search
(Added a tweak and my thoughts)
(Update with section headers)
Line 1: Line 1:
This [[Main Page]] really needs some work. Here are some initial thoughts on an overall organization:
+
Content Outline
  
* Administrivia
+
== Administrivia ==
: Site guidelines, legal and admininstrative issues.
+
Site guidelines, legal and admininstrative issues.
** [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]
+
:* [[Basic rules]], [[Commercial Product Disclaimer]], [[Contributions]], [[Copyright]], [[License]]
  
  
* Reference
+
== Reference ==
: This section has the automagically generated man pages from the OpenSSL git repository, and similar "man" style reference documentation
+
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.
** OpenSSL Manual Pages
+
:* OpenSSL Manual Pages
*** [[Manual:Openssl(1)]], [[Manual:Ssl(3)]], [[Manual:Crypto(3)]], [[Documentation Index]]
+
:* [[Manual:Openssl(1)]], [[Manual:Ssl(3)]], [[Manual:Crypto(3)]], [[Documentation Index]]
** [[API]], [[Libcrypto API]], [[Libssl API]]
+
:* [[API]], [[Libcrypto API]], [[Libssl API]]
** [[FIPS mode()]], [[FIPS_mode_set()]]
+
:* [[FIPS mode()]], [[FIPS_mode_set()]]
  
  
* Usage (or Programming?)
+
== Usage and Programming ==
: This section has discussions of practical issues in using OpenSSL
+
This section has discussions of practical issues in using OpenSSL
** Building from Source
+
:* Building from Source
** [[OpenSSL Overview]]
+
:: Where to find it, the different versions, how to build and install it.
** [[Versioning]]
+
:* [[OpenSSL Overview]]
** [[Compilation and Installation]]
+
:* [[Versioning]]
** EVP
+
:* [[Compilation and Installation]]
 +
:* EVP
 
:: Programming techniques and example code
 
:: Programming techniques and example code
 
:: Use of EVP is preferred for most applications and circumstances
 
:: Use of EVP is preferred for most applications and circumstances
*** [[EVP Asymmetric Encryption and Decryption of an Envelope]]
+
::* [[EVP Asymmetric Encryption and Decryption of an Envelope]]
*** [[EVP Authenticated Encryption and Decryption]]
+
::* [[EVP Authenticated Encryption and Decryption]]
*** [[EVP Symmetric Encryption and Decryption]]
+
::* [[EVP Symmetric Encryption and Decryption]]
*** [[EVP Key and Parameter Generation]]
+
::* [[EVP Key and Parameter Generation]]
*** [[EVP Key Agreement]]
+
::* [[EVP Key Agreement]]
*** [[EVP Message Digests]]
+
::* [[EVP Message Digests]]
*** [[EVP Key Derivation]]
+
::* [[EVP Key Derivation]]
*** [[EVP Signing and Verifying]]
+
::* [[EVP Signing and Verifying]]
** Low Level APIs
+
:* Low Level APIs
 
:: More specialized non-EVP usage
 
:: More specialized non-EVP usage
*** [[Diffie-Hellman parameters]]
+
::* [[Diffie-Hellman parameters]]
  
  
* Concepts and Theory
+
== Concepts and Theory ==
: Discussions of basic cryptographic theory and concepts
+
Discussions of basic cryptographic theory and concepts
: Discussions of common operational issues
+
Discussions of common operational issues
** [[Base64]]
+
:* [[Base64]]
** [[FIPS 140-2]]
+
:* [[FIPS 140-2]]
** [[Random Numbers]]
+
:* [[Random Numbers]]
** [[Diffie Hellman]]
+
:* [[Diffie Hellman]]
** [[Elliptic Curve Diffie Hellman]]
+
:* [[Elliptic Curve Diffie Hellman]]
** [[Elliptic Curve Cryptography]]
+
:* [[Elliptic Curve Cryptography]]
  
  
* Internals and Development
+
== Internals and Development ==
: This section is for internal details of primary interest to OpenSSL maintainers and power users
+
This section is for internal details of primary interest to OpenSSL maintainers and power users
** [[Internals]]
+
:* [[Internals]]
** [[Code Quality]]
+
:* [[Code Quality]]
** [[Static and Dynamic Analysis]]
+
:* [[Static and Dynamic Analysis]]
  
  
* Miscellanous
+
== Miscellanous ==
 
+
For the material that doesn't seem to fit anywhere else
 +
:* New topics pending categorization (not yet linked elsewhere)
 +
:* Incomplete or contentious pages under discussion
  
  

Revision as of 17:59, 30 May 2013

Content Outline

Administrivia

Site guidelines, legal and admininstrative issues.


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.


Usage and Programming

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
  • Low Level APIs
More specialized non-EVP usage


Concepts and Theory

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


Internals and Development

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


Miscellanous

For the material that doesn't seem to fit anywhere else

  • New topics pending categorization (not yet linked elsewhere)
  • Incomplete or contentious pages under discussion



I like it - it brings the interesting content right up front. It probably needs to have some top and tail text to describe what this wiki is for, and how to contribute. I added a link to the Elliptic Curve Cryptography page above --Matt 15:02, 30 May 2013 (UTC)