mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
aecd5b67d5
based on a patch by @repah documenting-ruby/ruby#14 https://github.com/documenting-ruby/ruby/pull/14 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42416 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
364 lines
8.5 KiB
C
364 lines
8.5 KiB
C
/*
|
|
* $Id$
|
|
* 'OpenSSL for Ruby' project
|
|
* Copyright (C) 2001-2002 Michal Rokos <m.rokos@sh.cvut.cz>
|
|
* All rights reserved.
|
|
*/
|
|
/*
|
|
* This program is licenced under the same licence as Ruby.
|
|
* (See the file 'LICENCE'.)
|
|
*/
|
|
#if !defined(OPENSSL_NO_HMAC)
|
|
|
|
#include "ossl.h"
|
|
|
|
#define MakeHMAC(obj, klass, ctx) \
|
|
(obj) = Data_Make_Struct((klass), HMAC_CTX, 0, ossl_hmac_free, (ctx))
|
|
#define GetHMAC(obj, ctx) do { \
|
|
Data_Get_Struct((obj), HMAC_CTX, (ctx)); \
|
|
if (!(ctx)) { \
|
|
ossl_raise(rb_eRuntimeError, "HMAC wasn't initialized"); \
|
|
} \
|
|
} while (0)
|
|
#define SafeGetHMAC(obj, ctx) do { \
|
|
OSSL_Check_Kind((obj), cHMAC); \
|
|
GetHMAC((obj), (ctx)); \
|
|
} while (0)
|
|
|
|
/*
|
|
* Classes
|
|
*/
|
|
VALUE cHMAC;
|
|
VALUE eHMACError;
|
|
|
|
/*
|
|
* Public
|
|
*/
|
|
|
|
/*
|
|
* Private
|
|
*/
|
|
static void
|
|
ossl_hmac_free(HMAC_CTX *ctx)
|
|
{
|
|
HMAC_CTX_cleanup(ctx);
|
|
ruby_xfree(ctx);
|
|
}
|
|
|
|
static VALUE
|
|
ossl_hmac_alloc(VALUE klass)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
VALUE obj;
|
|
|
|
MakeHMAC(obj, klass, ctx);
|
|
HMAC_CTX_init(ctx);
|
|
|
|
return obj;
|
|
}
|
|
|
|
|
|
/*
|
|
* call-seq:
|
|
* HMAC.new(key, digest) -> hmac
|
|
*
|
|
* Returns an instance of OpenSSL::HMAC set with the key and digest
|
|
* algorithm to be used. The instance represents the initial state of
|
|
* the message authentication code before any data has been processed.
|
|
* To process data with it, use the instance method #update with your
|
|
* data as an argument.
|
|
*
|
|
* === Example
|
|
*
|
|
* key = 'key'
|
|
* digest = OpenSSL::Digest.new('sha1')
|
|
* instance = OpenSSL::HMAC.new(key, digest)
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
* instance.class
|
|
* #=> OpenSSL::HMAC
|
|
*
|
|
* === A note about comparisons
|
|
*
|
|
* Two instances won't be equal when they're compared, even if they have the
|
|
* same value. Use #to_s or #hexdigest to return the authentication code that
|
|
* the instance represents. For example:
|
|
*
|
|
* other_instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1'))
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
* instance
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
* instance == other_instance
|
|
* #=> false
|
|
* instance.to_s == other_instance.to_s
|
|
* #=> true
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
|
|
StringValue(key);
|
|
GetHMAC(self, ctx);
|
|
HMAC_Init(ctx, RSTRING_PTR(key), RSTRING_LENINT(key),
|
|
GetDigestPtr(digest));
|
|
|
|
return self;
|
|
}
|
|
|
|
static VALUE
|
|
ossl_hmac_copy(VALUE self, VALUE other)
|
|
{
|
|
HMAC_CTX *ctx1, *ctx2;
|
|
|
|
rb_check_frozen(self);
|
|
if (self == other) return self;
|
|
|
|
GetHMAC(self, ctx1);
|
|
SafeGetHMAC(other, ctx2);
|
|
|
|
HMAC_CTX_copy(ctx1, ctx2);
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* hmac.update(string) -> self
|
|
*
|
|
* Returns +self+ updated with the message to be authenticated.
|
|
* Can be called repeatedly with chunks of the message.
|
|
*
|
|
* === Example
|
|
*
|
|
* first_chunk = 'The quick brown fox jumps '
|
|
* second_chunk = 'over the lazy dog'
|
|
*
|
|
* instance.update(first_chunk)
|
|
* #=> 5b9a8038a65d571076d97fe783989e52278a492a
|
|
* instance.update(second_chunk)
|
|
* #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_update(VALUE self, VALUE data)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
|
|
StringValue(data);
|
|
GetHMAC(self, ctx);
|
|
HMAC_Update(ctx, (unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data));
|
|
|
|
return self;
|
|
}
|
|
|
|
static void
|
|
hmac_final(HMAC_CTX *ctx, unsigned char **buf, unsigned int *buf_len)
|
|
{
|
|
HMAC_CTX final;
|
|
|
|
HMAC_CTX_copy(&final, ctx);
|
|
if (!(*buf = OPENSSL_malloc(HMAC_size(&final)))) {
|
|
HMAC_CTX_cleanup(&final);
|
|
OSSL_Debug("Allocating %d mem", HMAC_size(&final));
|
|
ossl_raise(eHMACError, "Cannot allocate memory for hmac");
|
|
}
|
|
HMAC_Final(&final, *buf, buf_len);
|
|
HMAC_CTX_cleanup(&final);
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* hmac.digest -> string
|
|
*
|
|
* Returns the authentication code an instance represents as a binary string.
|
|
*
|
|
* === Example
|
|
*
|
|
* instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1'))
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
* instance.digest
|
|
* #=> "\xF4+\xB0\xEE\xB0\x18\xEB\xBDE\x97\xAEr\x13q\x1E\xC6\a`\x84?"
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_digest(VALUE self)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
unsigned char *buf;
|
|
unsigned int buf_len;
|
|
VALUE digest;
|
|
|
|
GetHMAC(self, ctx);
|
|
hmac_final(ctx, &buf, &buf_len);
|
|
digest = ossl_buf2str((char *)buf, buf_len);
|
|
|
|
return digest;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* hmac.hexdigest -> string
|
|
*
|
|
* Returns the authentication code an instance represents as a hex-encoded
|
|
* string.
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_hexdigest(VALUE self)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
unsigned char *buf;
|
|
char *hexbuf;
|
|
unsigned int buf_len;
|
|
VALUE hexdigest;
|
|
|
|
GetHMAC(self, ctx);
|
|
hmac_final(ctx, &buf, &buf_len);
|
|
if (string2hex(buf, buf_len, &hexbuf, NULL) != 2 * (int)buf_len) {
|
|
OPENSSL_free(buf);
|
|
ossl_raise(eHMACError, "Memory alloc error");
|
|
}
|
|
OPENSSL_free(buf);
|
|
hexdigest = ossl_buf2str(hexbuf, 2 * buf_len);
|
|
|
|
return hexdigest;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* hmac.reset -> self
|
|
*
|
|
* Returns +self+ as it was when it was first initialized, with all processed
|
|
* data cleared from it.
|
|
*
|
|
* === Example
|
|
*
|
|
* data = "The quick brown fox jumps over the lazy dog"
|
|
* instance = OpenSSL::HMAC.new('key', OpenSSL::Digest.new('sha1'))
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
*
|
|
* instance.update(data)
|
|
* #=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9
|
|
* instance.reset
|
|
* #=> f42bb0eeb018ebbd4597ae7213711ec60760843f
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_reset(VALUE self)
|
|
{
|
|
HMAC_CTX *ctx;
|
|
|
|
GetHMAC(self, ctx);
|
|
HMAC_Init(ctx, NULL, 0, NULL);
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* HMAC.digest(digest, key, data) -> aString
|
|
*
|
|
* Returns the authentication code as a binary string. The +digest+ parameter
|
|
* must be an instance of OpenSSL::Digest.
|
|
*
|
|
* === Example
|
|
*
|
|
* key = 'key'
|
|
* data = 'The quick brown fox jumps over the lazy dog'
|
|
* digest = OpenSSL::Digest.new('sha1')
|
|
*
|
|
* hmac = OpenSSL::HMAC.digest(digest, key, data)
|
|
* #=> "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9"
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_s_digest(VALUE klass, VALUE digest, VALUE key, VALUE data)
|
|
{
|
|
unsigned char *buf;
|
|
unsigned int buf_len;
|
|
|
|
StringValue(key);
|
|
StringValue(data);
|
|
buf = HMAC(GetDigestPtr(digest), RSTRING_PTR(key), RSTRING_LENINT(key),
|
|
(unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data), NULL, &buf_len);
|
|
|
|
return rb_str_new((const char *)buf, buf_len);
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* HMAC.hexdigest(digest, key, data) -> aString
|
|
*
|
|
* Returns the authentication code as a hex-encoded string. The +digest+
|
|
* parameter must be an instance of OpenSSL::Digest.
|
|
*
|
|
* === Example
|
|
*
|
|
* key = 'key'
|
|
* data = 'The quick brown fox jumps over the lazy dog'
|
|
* digest = OpenSSL::Digest.new('sha1')
|
|
*
|
|
* hmac = OpenSSL::HMAC.hexdigest(digest, key, data)
|
|
* #=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"
|
|
*
|
|
*/
|
|
static VALUE
|
|
ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data)
|
|
{
|
|
unsigned char *buf;
|
|
char *hexbuf;
|
|
unsigned int buf_len;
|
|
VALUE hexdigest;
|
|
|
|
StringValue(key);
|
|
StringValue(data);
|
|
|
|
buf = HMAC(GetDigestPtr(digest), RSTRING_PTR(key), RSTRING_LENINT(key),
|
|
(unsigned char *)RSTRING_PTR(data), RSTRING_LEN(data), NULL, &buf_len);
|
|
if (string2hex(buf, buf_len, &hexbuf, NULL) != 2 * (int)buf_len) {
|
|
ossl_raise(eHMACError, "Cannot convert buf to hexbuf");
|
|
}
|
|
hexdigest = ossl_buf2str(hexbuf, 2 * buf_len);
|
|
|
|
return hexdigest;
|
|
}
|
|
|
|
/*
|
|
* INIT
|
|
*/
|
|
void
|
|
Init_ossl_hmac()
|
|
{
|
|
#if 0
|
|
/* :nodoc: */
|
|
mOSSL = rb_define_module("OpenSSL"); /* let rdoc know about mOSSL */
|
|
#endif
|
|
|
|
eHMACError = rb_define_class_under(mOSSL, "HMACError", eOSSLError);
|
|
|
|
cHMAC = rb_define_class_under(mOSSL, "HMAC", rb_cObject);
|
|
|
|
rb_define_alloc_func(cHMAC, ossl_hmac_alloc);
|
|
rb_define_singleton_method(cHMAC, "digest", ossl_hmac_s_digest, 3);
|
|
rb_define_singleton_method(cHMAC, "hexdigest", ossl_hmac_s_hexdigest, 3);
|
|
|
|
rb_define_method(cHMAC, "initialize", ossl_hmac_initialize, 2);
|
|
rb_define_copy_func(cHMAC, ossl_hmac_copy);
|
|
|
|
rb_define_method(cHMAC, "reset", ossl_hmac_reset, 0);
|
|
rb_define_method(cHMAC, "update", ossl_hmac_update, 1);
|
|
rb_define_alias(cHMAC, "<<", "update");
|
|
rb_define_method(cHMAC, "digest", ossl_hmac_digest, 0);
|
|
rb_define_method(cHMAC, "hexdigest", ossl_hmac_hexdigest, 0);
|
|
rb_define_alias(cHMAC, "inspect", "hexdigest");
|
|
rb_define_alias(cHMAC, "to_s", "hexdigest");
|
|
}
|
|
|
|
#else /* NO_HMAC */
|
|
# warning >>> OpenSSL is compiled without HMAC support <<<
|
|
void
|
|
Init_ossl_hmac()
|
|
{
|
|
rb_warning("HMAC will NOT be avaible: OpenSSL is compiled without HMAC.");
|
|
}
|
|
#endif /* NO_HMAC */
|