Class: Digest::SHA2
Overview
A meta digest provider class for SHA256, SHA384 and SHA512.
Instance Method Summary collapse
-
#block_length ⇒ Object
call-seq: digest_obj.block_length -> Integer.
-
#digest_length ⇒ Object
call-seq: digest_obj.digest_length -> Integer.
-
#initialize(bitlen = 256) ⇒ SHA2
constructor
call-seq: Digest::SHA2.new(bitlen = 256) -> digest_obj.
-
#initialize_copy(other) ⇒ Object
:nodoc:.
-
#inspect ⇒ Object
:nodoc:.
-
#reset ⇒ Object
call-seq: digest_obj.reset -> digest_obj.
-
#update(str) ⇒ Object
(also: #<<)
call-seq: digest_obj.update(string) -> digest_obj digest_obj << string -> digest_obj.
Methods inherited from Class
base64digest, bubblebabble, digest, file, hexdigest
Methods included from Instance
#==, #base64digest, #base64digest!, #bubblebabble, #digest, #digest!, #file, #hexdigest, #hexdigest!, #length, #new, #size, #to_s
Constructor Details
#initialize(bitlen = 256) ⇒ SHA2
call-seq:
Digest::SHA2.new(bitlen = 256) -> digest_obj
Creates a new SHA2 hash object with a given bit length.
Valid bit lengths are 256, 384 and 512.
27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'sha2/lib/sha2.rb', line 27 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 |
Instance Method Details
#block_length ⇒ Object
78 79 80 |
# File 'sha2/lib/sha2.rb', line 78 def block_length @sha2.block_length end |
#digest_length ⇒ Object
call-seq:
digest_obj.digest_length -> Integer
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.
96 97 98 |
# File 'sha2/lib/sha2.rb', line 96 def digest_length @sha2.digest_length end |
#initialize_copy(other) ⇒ Object
:nodoc:
100 101 102 |
# File 'sha2/lib/sha2.rb', line 100 def initialize_copy(other) # :nodoc: @sha2 = other.instance_eval { @sha2.clone } end |
#inspect ⇒ Object
:nodoc:
104 105 106 |
# File 'sha2/lib/sha2.rb', line 104 def inspect # :nodoc: "#<%s:%d %s>" % [self.class.name, @bitlen, hexdigest] end |
#reset ⇒ Object
call-seq:
digest_obj.reset -> digest_obj
Resets the digest to the initial state and returns self.
45 46 47 48 |
# File 'sha2/lib/sha2.rb', line 45 def reset @sha2.reset self end |
#update(str) ⇒ Object Also known as: <<
call-seq:
digest_obj.update(string) -> digest_obj
digest_obj << string -> digest_obj
Updates the digest using a given string and returns self.
55 56 57 58 |
# File 'sha2/lib/sha2.rb', line 55 def update(str) @sha2.update(str) self end |