class OpenSSL::HMAC

Overview

Allows computing Hash-based Message Authentication Code (HMAC).

It is a type of message authentication code (MAC) involving a hash function in combination with a key.

HMAC can be used to verify the integrity of a message as well as the authenticity.

See also RFC2104.

Defined in:

openssl/hmac.cr

Class Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other) ==, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self from_json, from_yaml(string_or_io) : self from_yaml

Class Method Detail

def self.digest(algorithm : Symbol, key, data) : Bytes #

Returns the HMAC digest of data using the secret key.

It may contain non-ASCII bytes, including NUL bytes.

algorithm is a Symbol of a supported digest algorithm:

  • :md4.
  • :md5.
  • :ripemd160.
  • :sha1.
  • :sha224.
  • :sha256.
  • :sha384.
  • :sha512.

View source
def self.hexdigest(algorithm : Symbol, key, data) : String #

Returns the HMAC digest of data using the secret key, formatted as a hexadecimal string. This is neccesary to safely transfer the digest where binary messages are not allowed.

See also #digest.


View source