A meta digest provider class for SHA256, SHA384 and SHA512.
Creates a new SHA2 hash object with a given bit length.
Valid bit lengths are 256, 384 and 512.
# File digest/sha2/lib/sha2.rb, line 26
def initialize(bitlen = 256)
case bitlen
when 256
@sha2 = Digest::SHA256.new
when 384
@sha2 = Digest::SHA384.new
when 512
@sha2 = Digest::SHA512.new
else
raise ArgumentError, "unsupported bit length: %s" % bitlen.inspect
end
@bitlen = bitlen
end
Returns the block length of the digest in bytes.
Digest::SHA256.new.digest_length * 8 # => 512 Digest::SHA384.new.digest_length * 8 # => 1024 Digest::SHA512.new.digest_length * 8 # => 1024
# File digest/sha2/lib/sha2.rb, line 77
def block_length
@sha2.block_length
end
Returns the length of the hash value of the digest in bytes.
Digest::SHA256.new.digest_length * 8 # => 256 Digest::SHA384.new.digest_length * 8 # => 384 Digest::SHA512.new.digest_length * 8 # => 512
For example, digests produced by Digest::SHA256 will always be 32 bytes (256 bits) in size.
# File digest/sha2/lib/sha2.rb, line 95
def digest_length
@sha2.digest_length
end
Resets the digest to the initial state and returns self.
# File digest/sha2/lib/sha2.rb, line 44
def reset
@sha2.reset
self
end
Updates the digest using a given string and returns self.
# File digest/sha2/lib/sha2.rb, line 54
def update(str)
@sha2.update(str)
self
end
Commenting is here to help enhance the documentation. For example, sample code, or clarification of the documentation.
If you are posting code samples in your comments, please wrap them in "<pre><code class="ruby" > ... </code></pre>" markup in order to get syntax highlighting.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file a bug report so that it can be corrected for the next release. Thank you.