Module: Digest::Instance

Included in:
Class
Defined in:
digest.c,
lib/digest.rb,
digest.c,
bubblebabble/bubblebabble.c

Overview

This module provides instance methods for a digest implementation object to calculate message digest values.

Instance Method Summary collapse

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)


169
170
171
172
173
174
175
# File 'digest.c', line 169

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.


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'digest.c', line 365

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 = rb_check_string_type(other);
        if (NIL_P(str2)) return Qfalse;
    }

    /* 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.


67
68
69
# File 'lib/digest.rb', line 67

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.


73
74
75
# File 'lib/digest.rb', line 73

def base64digest!
  [digest!].pack('m0')
end

#block_lengthInteger

Returns the block length of the digest.

This method is overridden by each implementation subclass.


431
432
433
434
435
436
437
# File 'digest.c', line 431

static VALUE
rb_digest_instance_block_length(VALUE self)
{
    rb_digest_instance_method_unimpl(self, "block_length");

    UNREACHABLE;
}

#bubblebabbleObject

call-seq:

digest_obj.bubblebabble -> hash_string

Returns the resulting hash value in a Bubblebabble encoded form.


114
115
116
117
118
# File 'bubblebabble/bubblebabble.c', line 114

static VALUE
rb_digest_instance_bubblebabble(VALUE self)
{
    return bubblebabble_str_new(rb_funcall(self, id_digest, 0));
}

#digestString #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.


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'digest.c', line 240

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.


264
265
266
267
268
269
270
271
# File 'digest.c', line 264

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_lengthInteger

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.


399
400
401
402
403
404
405
406
407
408
# File 'digest.c', line 399

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.


48
49
50
51
52
53
54
55
56
# File 'lib/digest.rb', line 48

def file(name)
  File.open(name, "rb") {|f|
    buf = ""
    while f.read(16384, buf)
      update buf
    end
  }
  self
end

#hexdigestString #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.


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'digest.c', line 285

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.


309
310
311
312
313
314
315
316
# File 'digest.c', line 309

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);
}

#inspectString

Creates a printable version of the digest object.


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'digest.c', line 336

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;
}

#lengthInteger #sizeInteger

Returns digest_obj.digest_length().


417
418
419
420
421
# File 'digest.c', line 417

static VALUE
rb_digest_instance_length(VALUE self)
{
    return rb_funcall(self, id_digest_length, 0);
}

#newObject

Returns a new, initialized copy of the digest object. Equivalent to digest_obj.clone().reset().


220
221
222
223
224
225
226
# File 'digest.c', line 220

static VALUE
rb_digest_instance_new(VALUE self)
{
    VALUE clone = rb_obj_clone(self);
    rb_funcall(clone, id_reset, 0);
    return clone;
}

#resetObject

Resets the digest to the initial state and returns self.

This method is overridden by each implementation subclass.


205
206
207
208
209
210
211
# File 'digest.c', line 205

static VALUE
rb_digest_instance_reset(VALUE self)
{
    rb_digest_instance_method_unimpl(self, "reset");

    UNREACHABLE;
}

#lengthInteger #sizeInteger

Returns digest_obj.digest_length().


417
418
419
420
421
# File 'digest.c', line 417

static VALUE
rb_digest_instance_length(VALUE self)
{
    return rb_funcall(self, id_digest_length, 0);
}

#to_sString

Returns digest_obj.hexdigest().


324
325
326
327
328
# File 'digest.c', line 324

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)


169
170
171
172
173
174
175
# File 'digest.c', line 169

static VALUE
rb_digest_instance_update(VALUE self, VALUE str)
{
    rb_digest_instance_method_unimpl(self, "update");

    UNREACHABLE;
}