From b0fb4fb689062826730d0712a685787daf796b9a Mon Sep 17 00:00:00 2001 From: drbrain Date: Thu, 25 Aug 2011 00:29:02 +0000 Subject: * ext/openssl/ossl_digest.c: Document OpenSSL::Digest::digest and add an example to OpenSSL::Digest. Patch by Sylvain Daubert. [Ruby 1.9 - Bug #5166] * ext/openssl/lib/openssl/digest.rb (module OpenSSL): ditto git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33065 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ext/openssl/lib/openssl/digest.rb | 11 +++++++++++ ext/openssl/ossl_digest.c | 11 +++++++++++ 2 files changed, 22 insertions(+) (limited to 'ext/openssl') diff --git a/ext/openssl/lib/openssl/digest.rb b/ext/openssl/lib/openssl/digest.rb index d841fef242..40fc08066b 100644 --- a/ext/openssl/lib/openssl/digest.rb +++ b/ext/openssl/lib/openssl/digest.rb @@ -22,6 +22,17 @@ module OpenSSL alg += %w(SHA224 SHA256 SHA384 SHA512) end + # Return the +data+ hash computed with +name+ Digest. +name+ is either the + # long name or short name of a supported digest algorithm. + # + # === Examples + # + # OpenSSL::Digest.digest("SHA256, "abc") + # + # which is equivalent to: + # + # OpenSSL::Digest::SHA256.digest("abc") + def self.digest(name, data) super(data, name) end diff --git a/ext/openssl/ossl_digest.c b/ext/openssl/ossl_digest.c index ab165c4a84..8fd6b75c36 100644 --- a/ext/openssl/ossl_digest.c +++ b/ext/openssl/ossl_digest.c @@ -403,6 +403,17 @@ Init_ossl_digest() * sha256 << data2 * sha256 << data3 * digest = sha256.digest + * + * === Reuse a Digest instance + * + * data1 = File.read('file1') + * sha256 = OpenSSL::Digest::SHA256.new + * digest1 = sha256.digest(data1) + * + * data2 = File.read('file2') + * sha256.reset + * digest2 = sha256.digest(data2) + * */ cDigest = rb_define_class_under(mOSSL, "Digest", rb_path2class("Digest::Class")); /* Document-class: OpenSSL::Digest::DigestError -- cgit v1.2.3