summaryrefslogtreecommitdiff
path: root/ext/openssl/ossl_pkey_rsa.c
diff options
context:
space:
mode:
authoremboss <emboss@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-05-30 21:47:37 +0000
committeremboss <emboss@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-05-30 21:47:37 +0000
commit8b3e21b23d0b8e6dd545e8b97ae09ffbd0aeff53 (patch)
treefd065b34d53f036d26095392ee49769679d4d5c5 /ext/openssl/ossl_pkey_rsa.c
parent34913093f9b66fa3d515e6f951b534dbc91a4b53 (diff)
Tue Jun 30 06:45:21 2011 Martin Bosslet <Martin.Bosslet@googlemail.com>
* ext/openssl/ossl_pkey_rsa.c: Complete documentation. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31826 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/openssl/ossl_pkey_rsa.c')
-rw-r--r--ext/openssl/ossl_pkey_rsa.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/ext/openssl/ossl_pkey_rsa.c b/ext/openssl/ossl_pkey_rsa.c
index d57e5b5..e846a35 100644
--- a/ext/openssl/ossl_pkey_rsa.c
+++ b/ext/openssl/ossl_pkey_rsa.c
@@ -570,8 +570,24 @@ Init_ossl_rsa()
mPKey = rb_define_module_under(mOSSL, "PKey");
#endif
+ /* Document-class: OpenSSL::PKey::RSAError
+ *
+ * Generic exception that is raised if an operation on an RSA PKey
+ * fails unexpectedly or in case an instantiation of an instance of RSA
+ * fails due to non-conformant input data.
+ */
eRSAError = rb_define_class_under(mPKey, "RSAError", ePKeyError);
+ /* Document-class: OpenSSL::PKey::RSA
+ *
+ * RSA is an asymmetric public key algorithm that has been formalized in
+ * RFC 3447. It is in widespread use in public key infrastuctures (PKI)
+ * where certificates (cf. OpenSSL::X509::Certificate) often are issued
+ * on the basis of a public/private RSA key pair. RSA is used in a wide
+ * field of applications such as secure (symmetric) key exchange, e.g.
+ * when establishing a secure TLS/SSL connection. It is also used in
+ * various digital signature schemes.
+ */
cRSA = rb_define_class_under(mPKey, "RSA", cPKey);
rb_define_singleton_method(cRSA, "generate", ossl_rsa_s_generate, -1);