ruby--ruby/ext/digest/digest.c

/************************************************

  digest.c -

  $Author$
  created at: Fri May 25 08:57:27 JST 2001

  Copyright (C) 1995-2001 Yukihiro Matsumoto
  Copyright (C) 2001-2006 Akinori MUSHA

  $RoughId: digest.c,v 1.16 2001/07/13 15:38:27 knu Exp $
  $Id$

************************************************/

#include "digest.h"

static VALUE mDigest, cDigest_Base;
static ID id_metadata, id_new, id_initialize, id_update, id_digest;

/*
 * Document-class: Digest
 *
 * This module provides a framework for message digest libraries.
 */

/*
 * Document-class: Digest::Base
 *
 * This class provides a common interface to message digest
 * algorithms.
 */

static algo_t *
get_digest_base_metadata(VALUE klass)
{
    VALUE obj;
    algo_t *algo;

    if (rb_ivar_defined(klass, id_metadata) == Qfalse) {
        return NULL;
    }

    obj = rb_ivar_get(klass, id_metadata);

    Data_Get_Struct(obj, algo_t, algo);

    if (algo->api_version != 1) {
        /*
         * put conversion here if possible when API is updated
         */
        rb_raise(rb_eRuntimeError, "Incompatible digest API version");
    }

    return algo;
}

static VALUE
hexdigest_str_new(VALUE str_digest)
{
    char *digest;
    size_t digest_len;
    int i;
    VALUE str;
    char *p;
    static const char hex[] = {
        '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        'a', 'b', 'c', 'd', 'e', 'f'
    };

    StringValue(str_digest);
    digest = RSTRING_PTR(str_digest);
    digest_len = RSTRING_LEN(str_digest);

    if (LONG_MAX / 2 < digest_len) {
        rb_raise(rb_eRuntimeError, "digest string too long");
    }

    str = rb_str_new(0, digest_len * 2);

    for (i = 0, p = RSTRING_PTR(str); i < digest_len; i++) {
        unsigned char byte = digest[i];

        p[i + i]     = hex[byte >> 4];
        p[i + i + 1] = hex[byte & 0x0f];
    }

    return str;
}

static VALUE
rb_digest_base_alloc(VALUE klass)
{
    algo_t *algo;
    VALUE obj;
    void *pctx;

    if (klass == cDigest_Base) {
	rb_raise(rb_eNotImpError, "Digest::Base is an abstract class");
    }

    algo = get_digest_base_metadata(klass);

    if (algo == NULL) {
        return Data_Wrap_Struct(klass, 0, free, 0);
    }

    pctx = xmalloc(algo->ctx_size);
    algo->init_func(pctx);

    obj = Data_Wrap_Struct(klass, 0, free, pctx);

    return obj;
}

/*
 * call-seq:
 *     Digest::ALGORITHM.digest(string[, ...]) -> hash_string
 *
 * Returns the hash value of a given string _data_.  This is almost
 * equivalent to Digest::ALGORITHM.new(...).update(string).digest()
 * where extra arguments, if any, are passed through to the
 * constructor.
 */
static VALUE
rb_digest_base_s_digest(int argc, VALUE *argv, VALUE klass)
{
    VALUE str;
    algo_t *algo;
    void *pctx;
    volatile VALUE obj;

    if (argc < 1) {
        rb_raise(rb_eArgError, "no data given");
    }

    str = *argv++;
    argc--;

    StringValue(str);

    algo = get_digest_base_metadata(klass);

    if (algo == NULL) {
        VALUE obj = rb_funcall2(klass, id_new, argc, argv);
        rb_funcall(obj, id_update, 1, str);
        return rb_funcall(obj, id_digest, 0);
    }

    obj = rb_digest_base_alloc(klass);
    Data_Get_Struct(obj, void, pctx);

    algo->update_func(pctx, RSTRING_PTR(str), RSTRING_LEN(str));

    str = rb_str_new(0, algo->digest_len);
    algo->finish_func(pctx, RSTRING_PTR(str));

    return str;
}

/*
 * call-seq:
 *     Digest::ALGORITHM.hexdigest(string[, ...]) -> hash_string
 *
 * Returns the hex-encoded hash value of a given _string_.  This
 * method just hex-encode the return value of
 * Digest::ALGORITHM.digest(string[, ...]) where extra arguments, if
 * any, are passed through along with the _string_.
 */
static VALUE
rb_digest_base_s_hexdigest(int argc, VALUE *argv, VALUE klass)
{
    return hexdigest_str_new(rb_funcall2(klass, id_digest, argc, argv));
}

/* :nodoc: */
static VALUE
rb_digest_base_copy(VALUE copy, VALUE obj)
{
    algo_t *algo;
    void *pctx1, *pctx2;

    if (copy == obj) return copy;
    rb_check_frozen(copy);
    algo = get_digest_base_metadata(rb_obj_class(copy));

    if (algo == NULL) {
        /* initialize_copy() is undefined or something */
        rb_notimplement();
    }

    /* get_digest_base_metadata() may return a NULL */
    if (algo != get_digest_base_metadata(rb_obj_class(obj))) {
	rb_raise(rb_eTypeError, "wrong argument class");
    }
    Data_Get_Struct(obj, void, pctx1);
    Data_Get_Struct(copy, void, pctx2);
    memcpy(pctx2, pctx1, algo->ctx_size);

    return copy;
}

/*
 * call-seq:
 *     digest_obj.reset -> digest_obj
 *
 * Resets the digest to the initial state and returns self.
 *
 * Every implementation subclass which constructor takes arguments
 * must redefine this method because Digest::Base#reset() internally
 * calls initialize() with no argument.
 */
static VALUE
rb_digest_base_reset(VALUE self)
{
    algo_t *algo;
    void *pctx;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        rb_funcall(self, id_initialize, 0);

        return self;
    }

    Data_Get_Struct(self, void, pctx);

    memset(pctx, 0, algo->ctx_size);
    algo->init_func(pctx);

    return self;
}

/*
 * call-seq:
 *     digest_obj.update(string) -> digest_obj
 *
 * Updates the digest using a given _string_ and returns self.
 *
 * Implementation subclasses must redefine this method, and should
 * make `<<' an alias to it.
 */
static VALUE
rb_digest_base_update(VALUE self, VALUE str)
{
    algo_t *algo;
    void *pctx;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        /* subclasses must define update() */
        rb_notimplement();
    }

    Data_Get_Struct(self, void, pctx);

    StringValue(str);
    algo->update_func(pctx, RSTRING_PTR(str), RSTRING_LEN(str));

    return self;
}

/*
 * call-seq:
 *     digest_obj << string -> digest_obj
 *
 * Calls update(string).
 *
 * Implementation subclasses need not but should alias this method to
 * update() to eliminate chain calls.
 */
static VALUE
rb_digest_base_lshift(VALUE self, VALUE str)
{
    algo_t *algo;
    void *pctx;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        /* subclasses just need to define update(), not << */
        rb_funcall(self, id_update, 1, str);

        return self;
    }

    Data_Get_Struct(self, void, pctx);

    StringValue(str);
    algo->update_func(pctx, RSTRING_PTR(str), RSTRING_LEN(str));

    return self;
}

/*
 * call-seq:
 *     digest_obj.digest -> string
 *
 * Returns the resulting hash value.
 *
 * Implementation subclasses must redefine this method.
 */
static VALUE
rb_digest_base_digest(VALUE self)
{
    algo_t *algo;
    void *pctx1, *pctx2;
    size_t ctx_size;
    VALUE str;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        /* subclasses must define update() */
        rb_notimplement();
    }

    Data_Get_Struct(self, void, pctx1);

    ctx_size = algo->ctx_size;
    pctx2 = xmalloc(ctx_size);
    memcpy(pctx2, pctx1, ctx_size);

    str = rb_str_new(0, algo->digest_len);
    algo->finish_func(pctx2, RSTRING_PTR(str));
    free(pctx2);

    return str;
}

/*
 * call-seq:
 *     digest_obj.hexdigest -> string
 *     digest_obj.to_s -> string
 *
 * Returns the resulting hash value in a hex-encoded form.
 */
static VALUE
rb_digest_base_hexdigest(VALUE self)
{
    return hexdigest_str_new(rb_funcall(self, id_digest, 0));
}

/*
 * call-seq:
 *     digest_obj.inspect -> string
 *
 * Creates a printable version of the digest object.
 */
static VALUE
rb_digest_base_inspect(VALUE self)
{
    algo_t *algo;
    VALUE klass, str;
    size_t digest_len = 32;	/* no need to be just the right size */
    char *cname;

    klass = rb_obj_class(self);
    algo = get_digest_base_metadata(klass);

    if (algo != NULL)
        digest_len = algo->digest_len;

    cname = rb_obj_classname(self);

    /* #<Digest::Alg: 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_base_hexdigest(self));
    rb_str_buf_cat2(str, ">");
    return str;
}

/*
 * call-seq:
 *     digest_obj == string -> boolean
 *     digest_obj == another_digest_obj -> boolean
 *
 * If a string is given, checks whether it is equal to the hash value
 * of the digest object.  If another instance of the same digest class
 * is given, checks whether they have the same hash value.  Otherwise
 * returns false.
 */
static VALUE
rb_digest_base_equal(VALUE self, VALUE other)
{
    algo_t *algo;
    VALUE klass;
    VALUE str1, str2;

    klass = rb_obj_class(self);

    if (rb_obj_class(other) == klass) {
        str1 = rb_funcall(self, id_digest, 0);
        str2 = rb_funcall(other, id_digest, 0);
    } else {
        StringValue(other);
        str2 = other;

        algo = get_digest_base_metadata(klass);

        if (RSTRING_LEN(str2) == algo->digest_len)
            str1 = rb_funcall(self, id_digest, 0);
        else
            str1 = rb_digest_base_hexdigest(self);
    }

    if (RSTRING_LEN(str1) == RSTRING_LEN(str2)
	&& rb_str_cmp(str1, str2) == 0)
	return Qtrue;

    return Qfalse;
}

/*
 * call-seq:
 *     Digest::ALGORITHM.block_length(...) -> integer
 *
 * Returns the digest length of the digest algorithm.  Parameters
 * follow the same specification as the constructor.
 *
 * If an implementation subclass does not redefine this method,
 * returns Digest::ALGORITHM.new(...).digest_length().
 */
static VALUE
rb_digest_base_s_digest_length(int argc, VALUE *argv,VALUE klass)
{
    algo_t *algo;

    algo = get_digest_base_metadata(klass);

    if (algo == NULL) {
        /* Subclasses really should redefine this method */
        VALUE obj = rb_funcall2(klass, id_new, argc, argv);
        return rb_funcall(obj, rb_intern("digest_length"), 0);
    }

    return INT2NUM(algo->digest_len);
}

/*
 * call-seq:
 *     digest_obj.block_length -> integer
 *
 * Returns the length of the hash value of the digest object.
 *
 * If an implementation subclass does not redefine this method,
 * returns digest_obj.digest().length().
 */
static VALUE
rb_digest_base_digest_length(VALUE self)
{
    algo_t *algo;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        /* subclasses really should redefine this method */
        VALUE digest = rb_funcall(self, id_digest, 0);
        StringValue(digest);
        return INT2NUM(RSTRING_LEN(digest));
    }

    return INT2NUM(algo->digest_len);
}

/*
 * call-seq:
 *     Digest::ALGORITHM.block_length(...) -> integer
 *
 * Returns the block length of the digest algorithm.  Parameters
 * follow the same specification as the constructor.
 *
 * If an implementation subclass does not redefine this method,
 * returns Digest::ALGORITHM.new(...).block_length().
 */
static VALUE
rb_digest_base_s_block_length(int argc, VALUE *argv,VALUE klass)
{
    algo_t *algo;

    algo = get_digest_base_metadata(klass);

    if (algo == NULL) {
        VALUE obj = rb_funcall2(klass, id_new, argc, argv);
        return rb_funcall(obj, rb_intern("block_length"), 0);
    }

    return INT2NUM(algo->block_len);
}

/*
 * call-seq:
 *     digest_obj.block_length -> length
 *
 * Returns the block length of the digest.
 *
 * Implementation subclasses must redefine this method if used.
 */
static VALUE
rb_digest_base_block_length(VALUE self)
{
    algo_t *algo;

    algo = get_digest_base_metadata(rb_obj_class(self));

    if (algo == NULL) {
        /* subclasses must define this method (only if used) */
        rb_notimplement();
    }

    return INT2NUM(algo->block_len);
}

void
Init_digest(void)
{
    mDigest = rb_define_module("Digest");

    cDigest_Base = rb_define_class_under(mDigest, "Base", rb_cObject);

    rb_define_alloc_func(cDigest_Base, rb_digest_base_alloc);
    rb_define_singleton_method(cDigest_Base, "digest", rb_digest_base_s_digest, -1);
    rb_define_singleton_method(cDigest_Base, "hexdigest", rb_digest_base_s_hexdigest, -1);

    rb_define_singleton_method(cDigest_Base, "digest_length", rb_digest_base_s_digest_length, -1);
    rb_define_singleton_method(cDigest_Base, "block_length", rb_digest_base_s_block_length, -1);

    rb_define_method(cDigest_Base, "initialize_copy",  rb_digest_base_copy, 1);
    rb_define_method(cDigest_Base, "reset", rb_digest_base_reset, 0);
    rb_define_method(cDigest_Base, "update", rb_digest_base_update, 1);
    rb_define_method(cDigest_Base, "<<", rb_digest_base_lshift, 1);
    rb_define_method(cDigest_Base, "digest", rb_digest_base_digest, 0);
    rb_define_method(cDigest_Base, "hexdigest", rb_digest_base_hexdigest, 0);
    rb_define_method(cDigest_Base, "to_s", rb_digest_base_hexdigest, 0);
    rb_define_method(cDigest_Base, "inspect", rb_digest_base_inspect, 0);
    rb_define_method(cDigest_Base, "==", rb_digest_base_equal, 1);

    rb_define_method(cDigest_Base, "digest_length", rb_digest_base_digest_length, 0);
    rb_define_method(cDigest_Base, "block_length", rb_digest_base_block_length, 0);

    id_metadata = rb_intern("metadata");
    id_new = rb_intern("new");
    id_initialize = rb_intern("initialize");
    id_update = rb_intern("update");
    id_digest = rb_intern("digest");
}