* ext/openssl/ossl_pkey_dh.c: completed documentation.

* ext/openssl/ossl_pkey_dsa.c: corrected examples. Improved parameter
  sections.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32031 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

ChangeLog

@@ -1,3 +1,9 @@
+Mon Jun 13 01:59:19 2011  Martin Bosslet  <Martin.Bosslet@googlemail.com>
+
+	* ext/openssl/ossl_pkey_dh.c: completed documentation.
+	* ext/openssl/ossl_pkey_dsa.c: corrected examples. Improved parameter
+	  sections.
+
 Mon Jun 13 00:25:10 2011  Martin Bosslet  <Martin.Bosslet@googlemail.com>
 
 	* ext/openssl/ossl_pkey_dsa.c: completed documentation.

ext/openssl/ossl_pkey_dh.c

@@ -103,9 +103,13 @@ dh_generate(int size, int gen)
  *  call-seq:
  *     DH.generate(size [, generator]) -> dh
  *
- *  === Parameters
+ * Creates a new DH instance from scratch by generating the private and public
- *  * +size+ is an integer representing the desired key size.  Keys smaller than 1024 should be considered insecure.
+ * components alike.
- *  * +generator+ is a small number > 1, typically 2 or 5.
+ *
+ * === Parameters
+ * * +size+ is an integer representing the desired key size. Keys smaller than
+ * 1024 bits should be considered insecure.
+ * * +generator+ is a small number > 1, typically 2 or 5.
  *
  */
 static VALUE
@@ -132,16 +136,20 @@ ossl_dh_s_generate(int argc, VALUE *argv, VALUE klass)
  *  call-seq:
  *     DH.new([size [, generator] | string]) -> dh
  *
- *  === Parameters
+ * Either generates a DH instance from scratch or by reading already existing
- *  * +size+ is an integer representing the desired key size.  Keys smaller than 1024 should be considered insecure.
+ * DH parameters from +string+.
- *  * +generator+ is a small number > 1, typically 2 or 5.
- *  * +string+ contains the DER or PEM encoded key.
  *
- *  === Examples
+ * === Parameters
- *  * DH.new -> dh
+ * * +size+ is an integer representing the desired key size. Keys smaller than
- *  * DH.new(1024) -> dh
+ * 1024 bits should be considered insecure.
- *  * DH.new(1024, 5) -> dh
+ * * +generator+ is a small number > 1, typically 2 or 5.
- *  * DH.new(File.read('key.pem')) -> dh
+ * * +string+ contains the DER or PEM encoded key.
+ *
+ * === Examples
+ *  DH.new # -> dh
+ *  DH.new(1024) # -> dh
+ *  DH.new(1024, 5) # -> dh
+ *  DH.new(File.read('key.pem')) # -> dh
  */
 static VALUE
 ossl_dh_initialize(int argc, VALUE *argv, VALUE self)
@@ -190,6 +198,8 @@ ossl_dh_initialize(int argc, VALUE *argv, VALUE self)
  *  call-seq:
  *     dh.public? -> true | false
  *
+ * Indicates whether this DH instance has a public key associated with it or
+ * not. The public key may be retrieved with DH#public_key.
  */
 static VALUE
 ossl_dh_is_public(VALUE self)
@@ -205,6 +215,8 @@ ossl_dh_is_public(VALUE self)
  *  call-seq:
  *     dh.private? -> true | false
  *
+ * Indicates whether this DH instance has a private key associated with it or
+ * not. The private key may be retrieved with DH#private_key.
  */
 static VALUE
 ossl_dh_is_private(VALUE self)
@@ -220,6 +232,7 @@ ossl_dh_is_private(VALUE self)
  *  call-seq:
  *     dh.to_pem -> aString
  *
+ * Encodes this DH to its PEM encoding.
  */
 static VALUE
 ossl_dh_export(VALUE self)
@@ -245,6 +258,7 @@ ossl_dh_export(VALUE self)
  *  call-seq:
  *     dh.to_der -> aString
  *
+ * Encodes this DH to its DER encoding.
  */
 static VALUE
 ossl_dh_to_der(VALUE self)
@@ -324,7 +338,16 @@ ossl_dh_to_text(VALUE self)
  *  call-seq:
  *     dh.public_key -> aDH
  *
- *  Makes new instance DH PUBLIC_KEY from PRIVATE_KEY
+ * Returns a new DH instance that carries just the public information.
+ * If the current instance has also private information, this will no
+ * longer be present in the new instance. This feature is helpful for
+ * publishing the public information without leaking any of the private
+ * information.
+ *
+ * === Example
+ *  dh = OpenSSL::PKey::DH.new(2048) # has public and private information
+ *  pub_key = dh.public_key # has only the public part available
+ *  pub_key_der = pub_key.to_der # it's safe to publish this
  */
 static VALUE
 ossl_dh_to_public_key(VALUE self)
@@ -348,6 +371,9 @@ ossl_dh_to_public_key(VALUE self)
  *  call-seq:
  *     dh.check_params -> true | false
  *
+ * Validates the Diffie-Hellman parameters associated with this instance.
+ * It checks whether a safe prime and a suitable generator are used. If this
+ * is not the case, +false+ is returned.
  */
 static VALUE
 ossl_dh_check_params(VALUE self)
@@ -370,6 +396,8 @@ ossl_dh_check_params(VALUE self)
  *  call-seq:
  *     dh.generate_key -> self
  *
+ * Generates a private key unless one already exists. It also computes the
+ * public key for the generated private key.
  */
 static VALUE
 ossl_dh_generate_key(VALUE self)
@@ -389,13 +417,11 @@ ossl_dh_generate_key(VALUE self)
  *  call-seq:
  *     dh.compute_key(pub_bn) -> aString
  *
- *  === Parameters
+ * Returns aString containing a shared secret computed from the other parties public value.
- *  * +pub_bn+ is a OpenSSL::BN.
+ * See DH_compute_key() for further information.
- *
- *  Returns aString containing a shared secret computed from the other parties public value.
- *
- *  See DH_compute_key() for further information.
  *
+ * === Parameters
+ * * +pub_bn+ is a OpenSSL::BN.
  */
 static VALUE
 ossl_dh_compute_key(VALUE self, VALUE pub)
@@ -498,7 +524,19 @@ Init_ossl_dh()
     mPKey = rb_define_module_under(mOSSL, "PKey");
 #endif
 
+    /* Document-class: OpenSSL::PKey::DHError
+     *
+     * Generic exception that is raised if an operation on a DH PKey
+     * fails unexpectedly or in case an instantiation of an instance of DH
+     * fails due to non-conformant input data.
+     */
     eDHError = rb_define_class_under(mPKey, "DHError", ePKeyError);
+    /* Document-class: OpenSSL::PKey::DH
+     *
+     * An implementation of the Diffie-Hellman key exchange protocol based on
+     * discrete logarithms in finite fields, the same basis that DSA is built
+     * on.
+     */
     cDH = rb_define_class_under(mPKey, "DH", cPKey);
     rb_define_singleton_method(cDH, "generate", ossl_dh_s_generate, -1);
     rb_define_method(cDH, "initialize", ossl_dh_initialize, -1);

ext/openssl/ossl_pkey_dsa.c

@@ -107,7 +107,7 @@ dsa_generate(int size)
  * from scratch.
  *
  * === Parameters
- * +size+ is an integer representing the desired key size.
+ * * +size+ is an integer representing the desired key size.
  *
  */
 static VALUE
@@ -131,9 +131,9 @@ ossl_dsa_s_generate(VALUE klass, VALUE size)
  * Creates a new DSA instance by reading an existing key from +string+.
  *
  * === Parameters
- * +size+ is an integer representing the desired key size.
+ * * +size+ is an integer representing the desired key size.
- * +string+ contains a DER or PEM encoded key.
+ * * +string+ contains a DER or PEM encoded key.
- * +pass+ is a string that contains an optional password.
+ * * +pass+ is a string that contains an optional password.
  *
  * === Examples
  *  DSA.new -> dsa
@@ -240,8 +240,8 @@ ossl_dsa_is_private(VALUE self)
  * Encodes this DSA to its PEM encoding.
  *
  * === Parameters
- * +cipher+ is an OpenSSL::Cipher.
+ * * +cipher+ is an OpenSSL::Cipher.
- * +password+ is a string containing your password.
+ * * +password+ is a string containing your password.
  *
  * === Examples
  *  DSA.to_pem -> aString
@@ -383,7 +383,7 @@ ossl_dsa_to_text(VALUE self)
  * information.
  *
  * === Example
- *  dsa = OpenSSL::DSA.new(2048) # has public and private information
+ *  dsa = OpenSSL::PKey::DSA.new(2048) # has public and private information
  *  pub_key = dsa.public_key # has only the public part available
  *  pub_key_der = pub_key.to_der # it's safe to publish this
  *
@@ -418,10 +418,10 @@ ossl_dsa_to_public_key(VALUE self)
  * data. The signature is issued using the private key of this DSA instance.
  *
  * === Parameters
- * +string+ is a message digest of the original input data to be signed
+ * * +string+ is a message digest of the original input data to be signed
  *
  * === Example
- *  dsa = OpenSSL::DSA.new(2048)
+ *  dsa = OpenSSL::PKey::DSA.new(2048)
  *  doc = "Sign me"
  *  digest = OpenSSL::Digest::SHA1.digest(doc)
  *  sig = dsa.syssign(digest)
@@ -459,11 +459,11 @@ ossl_dsa_sign(VALUE self, VALUE data)
  * does so by validating +sig+ using the public key of this DSA instance.
  *
  * === Parameters
- * +digest+ is a message digest of the original input data to be signed
+ * * +digest+ is a message digest of the original input data to be signed
- * +sig+ is a DSA signature value
+ * * +sig+ is a DSA signature value
  *
  * === Example
- *  dsa = OpenSSL::DSA.new(2048)
+ *  dsa = OpenSSL::PKey::DSA.new(2048)
  *  doc = "Sign me"
  *  digest = OpenSSL::Digest::SHA1.digest(doc)
  *  sig = dsa.syssign(digest)