digest 3.1.1 → 3.2.0.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987de45a2894fa80f0d6ff23f3a70a7e813b9529b5ef4130b22be5e4c2f78020
-  data.tar.gz: 7241f2a350845b1478666dfbb0d6662a1b61e41a16e7504b064dd6eca6e3c0b2
+  metadata.gz: b483eb57905b2f3160885f8ed98050921b9b3e13005ddfdc5af7247f0c80941e
+  data.tar.gz: 5d2e8f21b545eba60d48fc2b1a8799f46f12ae5740257fef5d956843e6f285df
 SHA512:
-  metadata.gz: b1f322b8fed96de4cde9b2b8cd2997f99a80998b5b671924cb6f3e3b6b28215c95021f2919ef8a5176823639e56ddb3cd05e2a154c59d9945f4770138ae4d941
-  data.tar.gz: f2a9f6d45f28fe9be2d140d9f99147669f9a0ab32fbeac724254eca036a89a364f222beac6eb3b38def4f395f961dc646a7780344e7eb13eff0759a39b7c6ce7
+  metadata.gz: 0aebec72ac962b1ba44caad93e6df25076ae0622955f5cfdb068379919a2aa5aae85ef5cbe3ab186a0bbbd1bd0242cb47d4fb6406fd5fad0894fef77ed95d121
+  data.tar.gz: 615ebcf317c30885746bdd75b3d6c1c681036f2282ba912cdb2ff1eae5086d1460f37fc3fa7ae9f6dd9e9b2be9ee0be7ebe6fa276b0fb7acd73ce2ae250a1a1f

data/LICENSE.txt

@@ -4,10 +4,11 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the
+   distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/README.md

@@ -82,6 +82,16 @@ SHA2 family::
 
 The latest versions of the FIPS publications can be found here: http://csrc.nist.gov/publications/PubsFIPS.html.
 
+## For Gem developers
+
+If you want to use digest algorithms in your C extension, you can use the `digest.h` header file provided by digest gem. You should add the following code to your `extconf.rb`:
+
+```ruby
+spec = Gem::Specification.find_by_name("digest")
+source_dir = File.join(spec.full_gem_path, "ext", "digest")
+$INCFLAGS += " -I#{source_dir}"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/ext/digest/bubblebabble/bubblebabble.c

@@ -129,15 +129,14 @@ Init_bubblebabble(void)
 
     rb_require("digest");
 
-    rb_mDigest = rb_path2class("Digest");
-    rb_mDigest_Instance = rb_path2class("Digest::Instance");
-    rb_cDigest_Class = rb_path2class("Digest::Class");
-
 #if 0
     rb_mDigest = rb_define_module("Digest");
     rb_mDigest_Instance = rb_define_module_under(rb_mDigest, "Instance");
     rb_cDigest_Class = rb_define_class_under(rb_mDigest, "Class", rb_cObject);
 #endif
+    rb_mDigest = rb_digest_namespace();
+    rb_mDigest_Instance = rb_const_get(rb_mDigest, rb_intern_const("Instance"));
+    rb_cDigest_Class = rb_const_get(rb_mDigest, rb_intern_const("Class"));
 
     rb_define_module_function(rb_mDigest, "bubblebabble", rb_digest_s_bubblebabble, 1);
     rb_define_singleton_method(rb_cDigest_Class, "bubblebabble", rb_digest_class_s_bubblebabble, -1);

data/ext/digest/digest.c

@@ -534,9 +534,39 @@ rb_digest_class_init(VALUE self)
  *
  *
  *  rb_ivar_set(cDigest_SHA1, rb_intern("metadata"),
- *		Data_Wrap_Struct(0, 0, 0, (void *)&sha1));
+ *		rb_digest_make_metadata(&sha1));
  */
 
+#ifdef DIGEST_USE_RB_EXT_RESOLVE_SYMBOL
+static const rb_data_type_t metadata_type = {
+    "digest/metadata",
+    {0},
+};
+
+RUBY_FUNC_EXPORTED VALUE
+rb_digest_wrap_metadata(const rb_digest_metadata_t *meta)
+{
+    return rb_obj_freeze(TypedData_Wrap_Struct(0, &metadata_type, (void *)meta));
+}
+#endif
+
+static rb_digest_metadata_t *
+get_metadata_ptr(VALUE obj)
+{
+    rb_digest_metadata_t *algo;
+
+#ifdef DIGEST_USE_RB_EXT_RESOLVE_SYMBOL
+    if (!rb_typeddata_is_kind_of(obj, &metadata_type)) return 0;
+    algo = RTYPEDDATA_DATA(obj);
+#else
+# undef RUBY_UNTYPED_DATA_WARNING
+# define RUBY_UNTYPED_DATA_WARNING 0
+    Data_Get_Struct(obj, rb_digest_metadata_t, algo);
+#endif
+
+    return algo;
+}
+
 static rb_digest_metadata_t *
 get_digest_base_metadata(VALUE klass)
 {
@@ -554,8 +584,8 @@ get_digest_base_metadata(VALUE klass)
     if (NIL_P(p))
         rb_raise(rb_eRuntimeError, "Digest::Base cannot be directly inherited in Ruby");
 
-    if (!RB_TYPE_P(obj, T_DATA) || RTYPEDDATA_P(obj)) {
-      wrong:
+    algo = get_metadata_ptr(obj);
+    if (!algo) {
         if (p == klass)
             rb_raise(rb_eTypeError, "%"PRIsVALUE"::metadata is not initialized properly",
                      klass);
@@ -564,12 +594,6 @@ get_digest_base_metadata(VALUE klass)
                      klass, p);
     }
 
-#undef RUBY_UNTYPED_DATA_WARNING
-#define RUBY_UNTYPED_DATA_WARNING 0
-    Data_Get_Struct(obj, rb_digest_metadata_t, algo);
-
-    if (!algo) goto wrong;
-
     switch (algo->api_version) {
       case 3:
         break;

data/ext/digest/digest.h

@@ -40,7 +40,8 @@ rb_digest_##name##_update(void *ctx, unsigned char *ptr, size_t size) \
     for (; size > stride; size -= stride, ptr += stride) { \
         name##_Update(ctx, ptr, stride); \
     } \
-    if (size > 0) name##_Update(ctx, ptr, size); \
+    /* Since size <= stride, size should fit into an unsigned int */ \
+    if (size > 0) name##_Update(ctx, ptr, (unsigned int)size); \
 }
 
 #define DEFINE_FINISH_FUNC_FROM_FINAL(name) \
@@ -63,10 +64,43 @@ rb_id_metadata(void)
     return rb_intern_const("metadata");
 }
 
+#if !defined(HAVE_RB_EXT_RESOLVE_SYMBOL)
+#elif !defined(RUBY_UNTYPED_DATA_WARNING)
+# error RUBY_UNTYPED_DATA_WARNING is not defined
+#elif RUBY_UNTYPED_DATA_WARNING
+/* rb_ext_resolve_symbol() has been defined since Ruby 3.3, but digest
+ * bundled with 3.3 didn't use it. */
+# define DIGEST_USE_RB_EXT_RESOLVE_SYMBOL 1
+#endif
+
 static inline VALUE
 rb_digest_make_metadata(const rb_digest_metadata_t *meta)
 {
-#undef RUBY_UNTYPED_DATA_WARNING
-#define RUBY_UNTYPED_DATA_WARNING 0
+#if defined(EXTSTATIC) && EXTSTATIC
+    /* The extension is built as a static library, so safe to refer to
+     * rb_digest_wrap_metadata directly. */
+    extern VALUE rb_digest_wrap_metadata(const rb_digest_metadata_t *meta);
+    return rb_digest_wrap_metadata(meta);
+#else
+    /* The extension is built as a shared library, so we can't refer
+     * to rb_digest_wrap_metadata directly. */
+# ifdef DIGEST_USE_RB_EXT_RESOLVE_SYMBOL
+    /* If rb_ext_resolve_symbol() is available, use it to get the address of
+     * rb_digest_wrap_metadata. */
+    typedef VALUE (*wrapper_func_type)(const rb_digest_metadata_t *meta);
+    static wrapper_func_type wrapper;
+    if (!wrapper) {
+        wrapper = (wrapper_func_type)(uintptr_t)
+            rb_ext_resolve_symbol("digest.so", "rb_digest_wrap_metadata");
+        if (!wrapper) rb_raise(rb_eLoadError, "rb_digest_wrap_metadata not found");
+    }
+    return wrapper(meta);
+# else
+    /* If rb_ext_resolve_symbol() is not available, keep using untyped
+     * data. */
+# undef RUBY_UNTYPED_DATA_WARNING
+# define RUBY_UNTYPED_DATA_WARNING 0
     return rb_obj_freeze(Data_Wrap_Struct(0, 0, 0, (void *)meta));
+# endif
+#endif
 }

data/ext/digest/md5/md5cc.h

@@ -1,8 +1,16 @@
 #define COMMON_DIGEST_FOR_OPENSSL 1
 #include <CommonCrypto/CommonDigest.h>
 
-#ifdef __clang__
-# pragma clang diagnostic ignored "-Wdeprecated-declarations"
+#ifdef __GNUC__
+# define RB_DIGEST_DIAGNOSTIC(compiler, op, flag) _Pragma(STRINGIZE(compiler diagnostic op flag))
+# ifdef RBIMPL_WARNING_IGNORED
+#   define RB_DIGEST_WARNING_IGNORED(flag) RBIMPL_WARNING_IGNORED(flag)
+# elif defined(__clang__)
+#   define RB_DIGEST_WARNING_IGNORED(flag) RB_DIGEST_DIAGNOSTIC(clang, ignored, #flag)
+# else /* __GNUC__ */
+#   define RB_DIGEST_WARNING_IGNORED(flag) RB_DIGEST_DIAGNOSTIC(GCC, ignored, #flag)
+# endif
+RB_DIGEST_WARNING_IGNORED(-Wdeprecated-declarations)
 /* Suppress deprecation warnings of MD5 from Xcode 11.1 */
 /* Although we know MD5 is deprecated too, provide just for backward
  * compatibility, as well as Apple does. */
@@ -17,3 +25,11 @@ static DEFINE_FINISH_FUNC_FROM_FINAL(MD5)
 #undef MD5_Finish
 #define MD5_Update rb_digest_MD5_update
 #define MD5_Finish rb_digest_MD5_finish
+
+/*
+ * Pre-10.6 defines are with args, which don't match the argless use in
+ * the function pointer inits.  Thus, we redefine MD5_Init as well.
+ * This is a NOP on 10.6+.
+ */
+#undef MD5_Init
+#define MD5_Init CC_MD5_Init

data/ext/digest/md5/md5init.c

@@ -53,9 +53,8 @@ Init_md5(void)
     mDigest = rb_define_module("Digest"); /* let rdoc know */
 #endif
     mDigest = rb_digest_namespace();
-    cDigest_Base = rb_path2class("Digest::Base");
+    cDigest_Base = rb_const_get(mDigest, rb_intern_const("Base"));
 
     cDigest_MD5 = rb_define_class_under(mDigest, "MD5", cDigest_Base);
-
     rb_iv_set(cDigest_MD5, "metadata", rb_digest_make_metadata(&md5));
 }

data/ext/digest/rmd160/rmd160init.c

@@ -49,9 +49,8 @@ Init_rmd160(void)
     mDigest = rb_define_module("Digest"); /* let rdoc know */
 #endif
     mDigest = rb_digest_namespace();
-    cDigest_Base = rb_path2class("Digest::Base");
+    cDigest_Base = rb_const_get(mDigest, rb_intern_const("Base"));
 
     cDigest_RMD160 = rb_define_class_under(mDigest, "RMD160", cDigest_Base);
-
     rb_iv_set(cDigest_RMD160, "metadata", rb_digest_make_metadata(&rmd160));
 }

data/ext/digest/sha1/sha1cc.h

@@ -12,3 +12,11 @@ static DEFINE_FINISH_FUNC_FROM_FINAL(SHA1)
 #undef SHA1_Finish
 #define SHA1_Update rb_digest_SHA1_update
 #define SHA1_Finish rb_digest_SHA1_finish
+
+/*
+ * Pre-10.6 defines are with args, which don't match the argless use in
+ * the function pointer inits.  Thus, we redefine SHA1_Init as well.
+ * This is a NOP on 10.6+.
+ */
+#undef SHA1_Init
+#define SHA1_Init CC_SHA1_Init

data/ext/digest/sha1/sha1init.c

@@ -55,9 +55,8 @@ Init_sha1(void)
     mDigest = rb_define_module("Digest"); /* let rdoc know */
 #endif
     mDigest = rb_digest_namespace();
-    cDigest_Base = rb_path2class("Digest::Base");
+    cDigest_Base = rb_const_get(mDigest, rb_intern_const("Base"));
 
     cDigest_SHA1 = rb_define_class_under(mDigest, "SHA1", cDigest_Base);
-
     rb_iv_set(cDigest_SHA1, "metadata", rb_digest_make_metadata(&sha1));
 }

data/ext/digest/sha2/sha2cc.h

@@ -1,6 +1,33 @@
 #define COMMON_DIGEST_FOR_OPENSSL 1
 #include <CommonCrypto/CommonDigest.h>
 
+/*
+ * Prior to 10.5, OpenSSL-compatible definitions are missing for
+ * SHA2 macros, though the CC_ versions are present.
+ * Add the missing definitions we actually use here if needed.
+ * Note that the definitions are the argless 10.6+-style.
+ * The weird CTX mismatch is copied from the 10.6 header.
+ */
+#ifndef SHA256_DIGEST_LENGTH
+#define SHA256_DIGEST_LENGTH	CC_SHA256_DIGEST_LENGTH
+#define SHA256_CTX		CC_SHA256_CTX
+#define SHA256_Update		CC_SHA256_Update
+#define SHA256_Final		CC_SHA256_Final
+#endif /* !defined SHA256_DIGEST_LENGTH */
+
+#ifndef SHA384_DIGEST_LENGTH
+#define SHA384_DIGEST_LENGTH	CC_SHA384_DIGEST_LENGTH
+#define SHA512_CTX		CC_SHA512_CTX
+#define SHA384_Update		CC_SHA384_Update
+#define SHA384_Final		CC_SHA384_Final
+#endif /* !defined SHA384_DIGEST_LENGTH */
+
+#ifndef SHA512_DIGEST_LENGTH
+#define SHA512_DIGEST_LENGTH	CC_SHA512_DIGEST_LENGTH
+#define SHA512_Update		CC_SHA512_Update
+#define SHA512_Final		CC_SHA512_Final
+#endif /* !defined SHA512_DIGEST_LENGTH */
+
 #define SHA256_BLOCK_LENGTH	CC_SHA256_BLOCK_BYTES
 #define SHA384_BLOCK_LENGTH	CC_SHA384_BLOCK_BYTES
 #define SHA512_BLOCK_LENGTH	CC_SHA512_BLOCK_BYTES
@@ -29,3 +56,15 @@ static DEFINE_FINISH_FUNC_FROM_FINAL(SHA512)
 #undef SHA512_Finish
 #define SHA512_Update rb_digest_SHA512_update
 #define SHA512_Finish rb_digest_SHA512_finish
+
+/*
+ * Pre-10.6 defines are with args, which don't match the argless use in
+ * the function pointer inits.  Thus, we redefine SHA*_Init as well.
+ * This is a NOP on 10.6+.
+ */
+#undef SHA256_Init
+#define SHA256_Init CC_SHA256_Init
+#undef SHA384_Init
+#define SHA384_Init CC_SHA384_Init
+#undef SHA512_Init
+#define SHA512_Init CC_SHA512_Init

data/ext/digest/sha2/sha2init.c

@@ -25,29 +25,50 @@ static const rb_digest_metadata_t sha##bitlen = { \
 FOREACH_BITLEN(DEFINE_ALGO_METADATA)
 
 /*
+ * Document-class: Digest::SHA256 < Digest::Base
+ *
  * Classes for calculating message digests using the SHA-256/384/512
  * Secure Hash Algorithm(s) by NIST (the US' National Institute of
  * Standards and Technology), described in FIPS PUB 180-2.
+ *
+ * See SHA2.
+ */
+/*
+ * Document-class: Digest::SHA384 < Digest::Base
+ *
+ * Classes for calculating message digests using the SHA-256/384/512
+ * Secure Hash Algorithm(s) by NIST (the US' National Institute of
+ * Standards and Technology), described in FIPS PUB 180-2.
+ *
+ * See SHA2.
+ */
+/*
+ * Document-class: Digest::SHA512 < Digest::Base
+ *
+ * Classes for calculating message digests using the SHA-256/384/512
+ * Secure Hash Algorithm(s) by NIST (the US' National Institute of
+ * Standards and Technology), described in FIPS PUB 180-2.
+ *
+ * See SHA2.
  */
 void
 Init_sha2(void)
 {
-    VALUE mDigest, cDigest_Base;
+    VALUE mDigest, cDigest_Base, cDigest_SHA2;
     ID id_metadata = rb_id_metadata();
 
-#define DECLARE_ALGO_CLASS(bitlen) \
-    VALUE cDigest_SHA##bitlen;
-
-    FOREACH_BITLEN(DECLARE_ALGO_CLASS)
-
+#if 0
+    mDigest = rb_define_module("Digest"); /* let rdoc know */
+#endif
     mDigest = rb_digest_namespace();
-    cDigest_Base = rb_path2class("Digest::Base");
+    cDigest_Base = rb_const_get(mDigest, rb_intern_const("Base"));
+
+    cDigest_SHA2 = rb_define_class_under(mDigest, "SHA256", cDigest_Base);
+    rb_ivar_set(cDigest_SHA2, id_metadata, rb_digest_make_metadata(&sha256));
 
-#define DEFINE_ALGO_CLASS(bitlen) \
-    cDigest_SHA##bitlen = rb_define_class_under(mDigest, "SHA" #bitlen, cDigest_Base); \
-\
-    rb_ivar_set(cDigest_SHA##bitlen, id_metadata, \
-                rb_digest_make_metadata(&sha##bitlen));
+    cDigest_SHA2 = rb_define_class_under(mDigest, "SHA384", cDigest_Base);
+    rb_ivar_set(cDigest_SHA2, id_metadata, rb_digest_make_metadata(&sha384));
 
-    FOREACH_BITLEN(DEFINE_ALGO_CLASS)
+    cDigest_SHA2 = rb_define_class_under(mDigest, "SHA512", cDigest_Base);
+    rb_ivar_set(cDigest_SHA2, id_metadata, rb_digest_make_metadata(&sha512));
 }

data/lib/digest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Digest
-  VERSION = "3.1.1"
+  VERSION = "3.2.0.pre0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0.pre0
 platform: ruby
 authors:
 - Akinori MUSHA
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies: []
 description: Provides a framework for message digest libraries.
 email:
@@ -53,7 +53,6 @@ files:
 - ext/digest/sha2/sha2.h
 - ext/digest/sha2/sha2cc.h
 - ext/digest/sha2/sha2init.c
-- ext/digest/test.sh
 - lib/digest.rb
 - lib/digest/sha2.rb
 - lib/digest/version.rb
@@ -78,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Provides a framework for message digest libraries.

data/ext/digest/test.sh

@@ -1,30 +0,0 @@
-#!/bin/sh
-#
-# $RoughId: test.sh,v 1.5 2001/07/13 15:38:27 knu Exp $
-# $Id$
-
-RUBY=${RUBY:=ruby}
-MAKE=${MAKE:=make}
-CFLAGS=${CFLAGS:=-Wall}
-
-${RUBY} extconf.rb --with-cflags="${CFLAGS}"
-${MAKE} clean
-${MAKE}
-
-for algo in md5 rmd160 sha1 sha2; do
-    args=--with-cflags="${CFLAGS}"
-
-    if [ $WITH_BUNDLED_ENGINES ]; then
-	args="$args --with-bundled-$algo"
-    fi
-
-    (cd $algo &&
-	${RUBY} extconf.rb $args;
-	${MAKE} clean;
-	${MAKE})
-    ln -sf ../../$algo/$algo.so lib/digest/
-done
-
-${RUBY} -I. -I./lib ../../test/digest/test_digest.rb
-
-rm lib/digest/*.so