Spec-Zone.ru › Ruby 2.7

класс OpenSSL::HMAC

Родитель:
Объект

OpenSSL::HMAC позволяет вычислить код аутентификации сообщения, основанный на хэше (HMAC). Это тип кода аутентификации сообщения (MAC), включающий в себя хэш-функцию в сочетании с ключом. HMAC может использоваться для проверки целостности сообщения, а также подлинности.

OpenSSL::HMAC имеет интерфейс, аналогичный интерфейсу OpenSSL::Digest.

HMAC-SHA256 с использованием одноразового интерфейса

key = "key"
data = "message-to-be-authenticated"
mac = OpenSSL::HMAC.hexdigest("SHA256", key, data)
#=> "cddb0db23f469c8bf072b21fd837149bd6ace9ab771cceef14c9e517cc93282e"

HMAC-SHA256 с использованием инкрементального интерфейса

data1 = File.read("file1")
data2 = File.read("file2")
key = "key"
digest = OpenSSL::Digest::SHA256.new
hmac = OpenSSL::HMAC.new(key, digest)
hmac << data1
hmac << data2
mac = hmac.digest

Публичные методы класса

digest(digest, key, data) → aString Показать исходный код
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(ossl_evp_get_digestbyname(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);
}

Возвращает код аутентификации в виде двоичной строки. Параметр digest указывает алгоритм хэширования, который нужно использовать. Это может быть String, представляющий имя алгоритма, или экземпляр OpenSSL::Digest.

Пример

key = 'key'
data = 'The quick brown fox jumps over the lazy dog'

hmac = OpenSSL::HMAC.digest('sha1', key, data)
#=> "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9"
hexdigest(digest, key, data) → aString Показать исходный код
static VALUE
ossl_hmac_s_hexdigest(VALUE klass, VALUE digest, VALUE key, VALUE data)
{
    unsigned char buf[EVP_MAX_MD_SIZE];
    unsigned int buf_len;
    VALUE ret;

    StringValue(key);
    StringValue(data);

    if (!HMAC(ossl_evp_get_digestbyname(digest), RSTRING_PTR(key),
              RSTRING_LENINT(key), (unsigned char *)RSTRING_PTR(data),
              RSTRING_LEN(data), buf, &buf_len))
        ossl_raise(eHMACError, "HMAC");

    ret = rb_str_new(NULL, buf_len * 2);
    ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len);

    return ret;
}

Возвращает код аутентификации в виде строки, закодированной в шестнадцатеричном формате. Параметр digest указывает алгоритм хэширования, который нужно использовать. Это может быть String, представляющий имя алгоритма, или экземпляр OpenSSL::Digest.

Пример

key = 'key'
data = 'The quick brown fox jumps over the lazy dog'

hmac = OpenSSL::HMAC.hexdigest('sha1', key, data)
#=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"
new(key, digest) → hmac Показать исходный код
static VALUE
ossl_hmac_initialize(VALUE self, VALUE key, VALUE digest)
{
    HMAC_CTX *ctx;

    StringValue(key);
    GetHMAC(self, ctx);
    HMAC_Init_ex(ctx, RSTRING_PTR(key), RSTRING_LENINT(key),
                 ossl_evp_get_digestbyname(digest), NULL);

    return self;
}

Возвращает экземпляр OpenSSL::HMAC, настроенный с ключом и алгоритмом хэширования, которые нужно использовать. Экземпляр представляет начальное состояние кода аутентификации сообщения до обработки любых данных. Для обработки данных используйте метод экземпляра update с вашими данными в качестве аргумента.

Пример

key = 'key'
digest = OpenSSL::Digest.new('sha1')
instance = OpenSSL::HMAC.new(key, digest)
#=> f42bb0eeb018ebbd4597ae7213711ec60760843f
instance.class
#=> OpenSSL::HMAC

Примечание о сравнениях

Два экземпляра не будут равны при сравнении, даже если они имеют одинаковое значение. Используйте to_s или hexdigest, чтобы вернуть код аутентификации, который представляет экземпляр. Например:

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

Публичные методы экземпляра

<<(p1)
Псевдоним для: update
digest → string Показать исходный код
static VALUE
ossl_hmac_digest(VALUE self)
{
    HMAC_CTX *ctx;
    unsigned int buf_len;
    VALUE ret;

    GetHMAC(self, ctx);
    ret = rb_str_new(NULL, EVP_MAX_MD_SIZE);
    hmac_final(ctx, (unsigned char *)RSTRING_PTR(ret), &buf_len);
    assert(buf_len <= EVP_MAX_MD_SIZE);
    rb_str_set_len(ret, buf_len);

    return ret;
}

Возвращает код аутентификации, представленный экземпляром, в виде двоичной строки.

Пример

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?"
hexdigest → string Показать исходный код
static VALUE
ossl_hmac_hexdigest(VALUE self)
{
    HMAC_CTX *ctx;
    unsigned char buf[EVP_MAX_MD_SIZE];
    unsigned int buf_len;
    VALUE ret;

    GetHMAC(self, ctx);
    hmac_final(ctx, buf, &buf_len);
    ret = rb_str_new(NULL, buf_len * 2);
    ossl_bin2hex(buf, RSTRING_PTR(ret), buf_len);

    return ret;
}

Возвращает код аутентификации, представленный экземпляром, в виде строки, закодированной в шестнадцатеричном формате.

Также псевдоним для: inspect, to_s
initialize_copy(p1) Показать исходный код
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);
    GetHMAC(other, ctx2);

    if (!HMAC_CTX_copy(ctx1, ctx2))
        ossl_raise(eHMACError, "HMAC_CTX_copy");
    return self;
}
inspect()
Псевдоним для: hexdigest
reset → self Показать исходный код
static VALUE
ossl_hmac_reset(VALUE self)
{
    HMAC_CTX *ctx;

    GetHMAC(self, ctx);
    HMAC_Init_ex(ctx, NULL, 0, NULL, NULL);

    return self;
}

Возвращает hmac в том виде, в котором он был первоначально инициализирован, при этом все обработанные данные из него удаляются.

Пример

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
to_s()
Псевдоним для: hexdigest
update(string) → self Показать исходный код
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;
}

Возвращает hmac, обновлённый сообщением, подлежащим аутентификации. Его можно вызывать повторно с частями сообщения.

Пример

first_chunk = 'The quick brown fox jumps '
second_chunk = 'over the lazy dog'

instance.update(first_chunk)
#=> 5b9a8038a65d571076d97fe783989e52278a492a
instance.update(second_chunk)
#=> de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9
Также псевдоним для: <<

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API