summaryrefslogtreecommitdiff
path: root/ext/openssl/ossl_pkey_dh.c
diff options
context:
space:
mode:
authoremboss <emboss@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-12 20:39:38 +0000
committeremboss <emboss@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-12 20:39:38 +0000
commitbbb3cfb12b16c7681a58e9a16cec49c37edab1ab (patch)
tree27d8a24a2f44b9e153f577cb68fb0faa54aa1fac /ext/openssl/ossl_pkey_dh.c
parent7b614a53dd50508410c48113dce87abfc003df6b (diff)
* ext/openssl/ossl_pkey.c: added PKey.read module function that allow
reading arbitrary public/private keys from DER-/PEM-encoded File or string instances. * ext/openssl/ossl_pkey_dh.c: improved documentation. * test/openssl/utils.rb: added EC test key. * test/openssl/test_pkey_rsa.rb test/openssl/test_pkey_dsa.rb: Test PKey.read. Reuse keys from OpenSSL::TestUtils. * test/openssl/test_pkey_ec.rb: Created test file for EC tests. Test PKey.read. [Ruby 1.9 - Feature #4424] [ruby-core:35330] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32036 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/openssl/ossl_pkey_dh.c')
-rw-r--r--ext/openssl/ossl_pkey_dh.c19
1 files changed, 13 insertions, 6 deletions
diff --git a/ext/openssl/ossl_pkey_dh.c b/ext/openssl/ossl_pkey_dh.c
index 3f1ebda..8342610 100644
--- a/ext/openssl/ossl_pkey_dh.c
+++ b/ext/openssl/ossl_pkey_dh.c
@@ -338,15 +338,17 @@ ossl_dh_to_text(VALUE self)
* call-seq:
* dh.public_key -> aDH
*
- * Returns a new DH instance that carries just the public information.
- * If the current instance has also private information, this will no
+ * Returns a new DH instance that carries just the public information, i.e.
+ * the prime +p+ and the generator +g+, but no public/private key yet. Such
+ * a pair may be generated using DH#generate_key!.
+ * If the current instance already contains 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 = dh.public_key # contains only prime and generator
* pub_key_der = pub_key.to_der # it's safe to publish this
*/
static VALUE
@@ -394,10 +396,15 @@ ossl_dh_check_params(VALUE self)
/*
* call-seq:
- * dh.generate_key -> self
+ * dh.generate_key! -> self
*
- * Generates a private key unless one already exists. It also computes the
- * public key for the generated private key.
+ * Generates a private and public key unless one already exists.
+ *
+ * === Example
+ * dh = OpenSSL::PKey::DH.new(2048)
+ * public_key = dh.public_key #contains no private/public key yet
+ * public_key.generate_key!
+ * puts public_key.private? # => true
*/
static VALUE
ossl_dh_generate_key(VALUE self)