Module: Digest::Instance
- Included in:
- Class
- Defined in:
- digest.c,
lib/digest.rb,
digest.c
Overview
This module provides instance methods for a digest implementation object to calculate message digest values.
Instance Method Summary collapse
-
#<< ⇒ Object
Updates the digest using a given string and returns self.
-
#== ⇒ Object
If a string is given, checks whether it is equal to the hex-encoded hash value of the digest object.
-
#base64digest(str = nil) ⇒ Object
If none is given, returns the resulting hash value of the digest in a base64 encoded form, keeping the digest’s state.
-
#base64digest! ⇒ Object
Returns the resulting hash value and resets the digest to the initial state.
-
#block_length ⇒ Integer
Returns the block length of the digest.
-
#bubblebabble ⇒ Object
Returns the resulting hash value in a Bubblebabble encoded form.
-
#digest ⇒ Object
If none is given, returns the resulting hash value of the digest, keeping the digest’s state.
-
#digest! ⇒ String
Returns the resulting hash value and resets the digest to the initial state.
-
#digest_length ⇒ Integer
Returns the length of the hash value of the digest.
-
#file(name) ⇒ Object
updates the digest with the contents of a given file name and returns self.
-
#hexdigest ⇒ Object
If none is given, returns the resulting hash value of the digest in a hex-encoded form, keeping the digest’s state.
-
#hexdigest! ⇒ String
Returns the resulting hash value in a hex-encoded form and resets the digest to the initial state.
-
#inspect ⇒ String
Creates a printable version of the digest object.
-
#length ⇒ Object
Returns digest_obj.digest_length().
-
#new ⇒ Object
Returns a new, initialized copy of the digest object.
-
#reset ⇒ Object
Resets the digest to the initial state and returns self.
-
#size ⇒ Object
Returns digest_obj.digest_length().
-
#to_s ⇒ String
Returns digest_obj.hexdigest().
-
#update ⇒ Object
Updates the digest using a given string and returns self.
Instance Method Details
#update(string) ⇒ Object #<<(string) ⇒ Object
Updates the digest using a given string and returns self.
The update() method and the left-shift operator are overridden by each implementation subclass. (One should be an alias for the other)
153 154 155 156 157 158 159 |
# File 'digest.c', line 153
static VALUE
rb_digest_instance_update(VALUE self, VALUE str)
{
rb_digest_instance_method_unimpl(self, "update");
UNREACHABLE;
}
|
#==(another_digest_obj) ⇒ Boolean #==(string) ⇒ Boolean
If a string is given, checks whether it is equal to the hex-encoded hash value of the digest object. If another digest instance is given, checks whether they have the same hash value. Otherwise returns false.
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'digest.c', line 349
static VALUE
rb_digest_instance_equal(VALUE self, VALUE other)
{
VALUE str1, str2;
if (rb_obj_is_kind_of(other, rb_mDigest_Instance) == Qtrue) {
str1 = rb_digest_instance_digest(0, 0, self);
str2 = rb_digest_instance_digest(0, 0, other);
} else {
str1 = rb_digest_instance_to_s(self);
str2 = other;
}
/* never blindly assume that subclass methods return strings */
StringValue(str1);
StringValue(str2);
if (RSTRING_LEN(str1) == RSTRING_LEN(str2) &&
rb_str_cmp(str1, str2) == 0) {
return Qtrue;
}
return Qfalse;
}
|
#base64digest(str = nil) ⇒ Object
If none is given, returns the resulting hash value of the digest in a base64 encoded form, keeping the digest’s state.
If a string
is given, returns the hash value for the given string
in a base64 encoded form, resetting the digest to the initial state before and after the process.
In either case, the return value is properly padded with ‘=’ and contains no line feeds.
62 63 64 |
# File 'lib/digest.rb', line 62 def base64digest(str = nil) [str ? digest(str) : digest].pack('m0') end |
#base64digest! ⇒ Object
Returns the resulting hash value and resets the digest to the initial state.
68 69 70 |
# File 'lib/digest.rb', line 68 def base64digest! [digest!].pack('m0') end |
#block_length ⇒ Integer
Returns the block length of the digest.
This method is overridden by each implementation subclass.
414 415 416 417 418 419 420 |
# File 'digest.c', line 414
static VALUE
rb_digest_instance_block_length(VALUE self)
{
rb_digest_instance_method_unimpl(self, "block_length");
UNREACHABLE;
}
|
#bubblebabble ⇒ Object
Returns the resulting hash value in a Bubblebabble encoded form.
111 112 113 114 115 |
# File 'bubblebabble/bubblebabble.c', line 111
static VALUE
rb_digest_instance_bubblebabble(VALUE self)
{
return bubblebabble_str_new(rb_funcall(self, id_digest, 0));
}
|
#digest ⇒ String #digest(string) ⇒ String
If none is given, returns the resulting hash value of the digest, keeping the digest’s state.
If a string is given, returns the hash value for the given string, resetting the digest to the initial state before and after the process.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'digest.c', line 224
static VALUE
rb_digest_instance_digest(int argc, VALUE *argv, VALUE self)
{
VALUE str, value;
if (rb_scan_args(argc, argv, "01", &str) > 0) {
rb_funcall(self, id_reset, 0);
rb_funcall(self, id_update, 1, str);
value = rb_funcall(self, id_finish, 0);
rb_funcall(self, id_reset, 0);
} else {
value = rb_funcall(rb_obj_clone(self), id_finish, 0);
}
return value;
}
|
#digest! ⇒ String
Returns the resulting hash value and resets the digest to the initial state.
248 249 250 251 252 253 254 255 |
# File 'digest.c', line 248
static VALUE
rb_digest_instance_digest_bang(VALUE self)
{
VALUE value = rb_funcall(self, id_finish, 0);
rb_funcall(self, id_reset, 0);
return value;
}
|
#digest_length ⇒ Integer
Returns the length of the hash value of the digest.
This method should be overridden by each implementation subclass. If not, digest_obj.digest().length() is returned.
382 383 384 385 386 387 388 389 390 391 |
# File 'digest.c', line 382
static VALUE
rb_digest_instance_digest_length(VALUE self)
{
/* subclasses really should redefine this method */
VALUE digest = rb_digest_instance_digest(0, 0, self);
/* never blindly assume that #digest() returns a string */
StringValue(digest);
return INT2NUM(RSTRING_LEN(digest));
}
|
#file(name) ⇒ Object
updates the digest with the contents of a given file name and returns self.
43 44 45 46 47 48 49 50 51 |
# File 'lib/digest.rb', line 43 def file(name) File.open(name, "rb") {|f| buf = "" while f.read(16384, buf) update buf end } self end |
#hexdigest ⇒ String #hexdigest(string) ⇒ String
If none is given, returns the resulting hash value of the digest in a hex-encoded form, keeping the digest’s state.
If a string is given, returns the hash value for the given string in a hex-encoded form, resetting the digest to the initial state before and after the process.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'digest.c', line 269
static VALUE
rb_digest_instance_hexdigest(int argc, VALUE *argv, VALUE self)
{
VALUE str, value;
if (rb_scan_args(argc, argv, "01", &str) > 0) {
rb_funcall(self, id_reset, 0);
rb_funcall(self, id_update, 1, str);
value = rb_funcall(self, id_finish, 0);
rb_funcall(self, id_reset, 0);
} else {
value = rb_funcall(rb_obj_clone(self), id_finish, 0);
}
return hexencode_str_new(value);
}
|
#hexdigest! ⇒ String
Returns the resulting hash value in a hex-encoded form and resets the digest to the initial state.
293 294 295 296 297 298 299 300 |
# File 'digest.c', line 293
static VALUE
rb_digest_instance_hexdigest_bang(VALUE self)
{
VALUE value = rb_funcall(self, id_finish, 0);
rb_funcall(self, id_reset, 0);
return hexencode_str_new(value);
}
|
#inspect ⇒ String
Creates a printable version of the digest object.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'digest.c', line 320
static VALUE
rb_digest_instance_inspect(VALUE self)
{
VALUE str;
size_t digest_len = 32; /* about this size at least */
const char *cname;
cname = rb_obj_classname(self);
/* #<Digest::ClassName: xxxxx...xxxx> */
str = rb_str_buf_new(2 + strlen(cname) + 2 + digest_len * 2 + 1);
rb_str_buf_cat2(str, "#<");
rb_str_buf_cat2(str, cname);
rb_str_buf_cat2(str, ": ");
rb_str_buf_append(str, rb_digest_instance_hexdigest(0, 0, self));
rb_str_buf_cat2(str, ">");
return str;
}
|
#length ⇒ Integer #size ⇒ Integer
Returns digest_obj.digest_length().
400 401 402 403 404 |
# File 'digest.c', line 400
static VALUE
rb_digest_instance_length(VALUE self)
{
return rb_funcall(self, id_digest_length, 0);
}
|
#new ⇒ Object
Returns a new, initialized copy of the digest object. Equivalent to digest_obj.clone().reset().
204 205 206 207 208 209 210 |
# File 'digest.c', line 204
static VALUE
rb_digest_instance_new(VALUE self)
{
VALUE clone = rb_obj_clone(self);
rb_funcall(clone, id_reset, 0);
return clone;
}
|
#reset ⇒ Object
Resets the digest to the initial state and returns self.
This method is overridden by each implementation subclass.
189 190 191 192 193 194 195 |
# File 'digest.c', line 189
static VALUE
rb_digest_instance_reset(VALUE self)
{
rb_digest_instance_method_unimpl(self, "reset");
UNREACHABLE;
}
|
#length ⇒ Integer #size ⇒ Integer
Returns digest_obj.digest_length().
400 401 402 403 404 |
# File 'digest.c', line 400
static VALUE
rb_digest_instance_length(VALUE self)
{
return rb_funcall(self, id_digest_length, 0);
}
|
#to_s ⇒ String
Returns digest_obj.hexdigest().
308 309 310 311 312 |
# File 'digest.c', line 308
static VALUE
rb_digest_instance_to_s(VALUE self)
{
return rb_funcall(self, id_hexdigest, 0);
}
|
#update(string) ⇒ Object #<<(string) ⇒ Object
Updates the digest using a given string and returns self.
The update() method and the left-shift operator are overridden by each implementation subclass. (One should be an alias for the other)
153 154 155 156 157 158 159 |
# File 'digest.c', line 153
static VALUE
rb_digest_instance_update(VALUE self, VALUE str)
{
rb_digest_instance_method_unimpl(self, "update");
UNREACHABLE;
}
|