module Digest - Documentation for Ruby 2.3.0 (original) (raw)

This module provides a framework for message digest libraries.

You may want to look at OpenSSL::Digest as it supports more algorithms.

A cryptographic hash function is a procedure that takes data and returns a fixed bit string: the hash value, also known as digest. Hash functions are also called one-way functions, it is easy to compute a digest from a message, but it is infeasible to generate a message from a digest.

Examples ↑

require 'digest'

Digest::SHA256.digest 'message'

sha256 = Digest::SHA256.new sha256.digest 'message'

Digest::SHA256.hexdigest 'message'
Digest::SHA256.base64digest 'message'

md5 = Digest::MD5.new md5.update 'message1' md5 << 'message2'

md5.hexdigest

sha256 = Digest::SHA256.file 'testfile' sha256.hexdigest

Additionally digests can be encoded in “bubble babble” format as a sequence of consonants and vowels which is more recognizable and comparable than a hexadecimal digest.

require 'digest/bubblebabble'

Digest::SHA256.bubblebabble 'message'

See the bubble babble specification at web.mit.edu/kenta/www/one/bubblebabble/spec/jrtrjwzi/draft-huima-01.txt.

Digest algorithms ↑

Different digest algorithms (or hash functions) are available:

HMAC

See FIPS PUB 198 The Keyed-Hash Message Authentication Code (HMAC).

RIPEMD-160

As Digest::RMD160. See homes.esat.kuleuven.be/~bosselae/ripemd160.html.

SHA1

See FIPS 180 Secure Hash Standard.

SHA2 family

See FIPS 180 Secure Hash Standard which defines the following algorithms:

The latest versions of the FIPS publications can be found here: csrc.nist.gov/publications/PubsFIPS.html.

Constants

REQUIRE_MUTEX

A mutex for Digest().

Public Class Methods

bubblebabble(string) → bubblebabble_string click to toggle source

Returns a BubbleBabble encoded version of a given string.

static VALUE rb_digest_s_bubblebabble(VALUE klass, VALUE str) { return bubblebabble_str_new(str); }

hexencode(string) → hexencoded_string click to toggle source

Generates a hex-encoded version of a given string.

static VALUE rb_digest_s_hexencode(VALUE klass, VALUE str) { return hexencode_str_new(str); }