D Programming Language 2.0

# std.digest.ripemd

Category | Functions
--- | ---
Template API | RIPEMD160
OOP API | RIPEMD160Digest
Helpers | ripemd160Of

Computes RIPEMD-160 hashes of arbitrary data. RIPEMD-160 hashes are 20 byte quantities that are like a checksum or CRC, but are more robust.

This module conforms to the APIs defined in std.digest.digest. To understand the differences between the template and the OOP API, see std.digest.digest.

This module publicly imports std.digest.digest and can be used as a stand-alone module.

License:
Boost License 1.0

CTFE:
Digests do not work in CTFE

Authors:
Kai Nacke
The algorithm was designed by Hans Dobbertin, Antoon Bosselaers, and Bart Preneel.
The D implementation is a direct translation of the ANSI C implementation by Antoon Bosselaers.

References:

- The hash function RIPEMD-160
- Wikipedia on RIPEMD-160

Source:
std/digest/ripemd.d

Examples:

    //Template API
    import std.digest.ripemd;

    ubyte[20] hash = ripemd160Of("abc");
    assert(toHexString(hash) == "8EB208F7E05D987A9B044A8E98C6B087F15A0BFC");

    //Feeding data
    ubyte[1024] data;
    RIPEMD160 md;
    md.start();
    md.put(data[]);
    md.start(); //Start again
    md.put(data[]);
    hash = md.finish();

    //OOP API
    import std.digest.ripemd;

    auto md = new RIPEMD160Digest();
    ubyte[] hash = md.digest("abc");
    assert(toHexString(hash) == "8EB208F7E05D987A9B044A8E98C6B087F15A0BFC");

    //Feeding data
    ubyte[1024] data;
    md.put(data[]);
    md.reset(); //Start again
    md.put(data[]);
    hash = md.finish();

struct RIPEMD160;
  Template API RIPEMD160 implementation. See std.digest.digest for differences between template and OOP API.

  Examples:

      //Simple example, hashing a string using ripemd160Of helper function
      ubyte[20] hash = ripemd160Of("abc");
      //Let's get a hash string
      assert(toHexString(hash) == "8EB208F7E05D987A9B044A8E98C6B087F15A0BFC");

      //Using the basic API
      RIPEMD160 hash;
      hash.start();
      ubyte[1024] data;
      //Initialize data here...
      hash.put(data);
      ubyte[20] result = hash.finish();

      //Let's use the template features:
      //Note: When passing a RIPEMD160 to a function, it must be passed by referece!
      void doSomething(T)(ref T hash) if(isDigest!T)
      {
          hash.put(cast(ubyte)0);
      }
      RIPEMD160 md;
      md.start();
      doSomething(md);
      assert(toHexString(md.finish()) == "C81B94933420221A7AC004A90242D8B1D3E5070D");

  pure nothrow @trusted void put(scope const(ubyte)[] data...);
    Use this to feed the digest with data. Also implements the std.range.OutputRange interface for ubyte and const(ubyte)[].

    Examples:

        RIPEMD160 dig;
        dig.put(cast(ubyte)0); //single ubyte
        dig.put(cast(ubyte)0, cast(ubyte)0); //variadic
        ubyte[10] buf;
        dig.put(buf); //buffer

  pure nothrow @trusted void start();
    Used to (re)initialize the RIPEMD160 digest.

    Note:
    For this RIPEMD160 Digest implementation calling start after default construction is not necessary. Calling start is only necessary to reset the Digest.

    Generic code which deals with different Digest types should always call start though.

    Examples:

        RIPEMD160 digest;
        //digest.start(); //Not necessary
        digest.put(0);

  pure nothrow @trusted ubyte[20] finish();
    Returns the finished RIPEMD160 hash. This also calls start to reset the internal state.

    Examples:

        //Simple example
        RIPEMD160 hash;
        hash.start();
        hash.put(cast(ubyte)0);
        ubyte[20] result = hash.finish();
        assert(toHexString(result) == "C81B94933420221A7AC004A90242D8B1D3E5070D");

auto ripemd160Of(T...)(T data);
  This is a convenience alias for std.digest.digest.digest using the RIPEMD160 implementation.

  Examples:

      ubyte[20] hash = ripemd160Of("abc");
      assert(hash == digest!RIPEMD160("abc")); //This is the same as above

alias RIPEMD160Digest = std.digest.digest.WrapperDigest!(RIPEMD160).WrapperDigest;
  OOP API RIPEMD160 implementation. See std.digest.digest for differences between template and OOP API.

  This is an alias for std.digest.digest.WrapperDigest!RIPEMD160, see std.digest.digest.WrapperDigest for more information.

  Examples:

      //Simple example, hashing a string using Digest.digest helper function
      auto md = new RIPEMD160Digest();
      ubyte[] hash = md.digest("abc");
      //Let's get a hash string
      assert(toHexString(hash) == "8EB208F7E05D987A9B044A8E98C6B087F15A0BFC");

      //Let's use the OOP features:
      void test(Digest dig)
      {
          dig.put(cast(ubyte)0);
      }
      auto md = new RIPEMD160Digest();
      test(md);

      //Let's use a custom buffer:
      ubyte[20] buf;
      ubyte[] result = md.finish(buf[]);
      assert(toHexString(result) == "C81B94933420221A7AC004A90242D8B1D3E5070D");

Copyright © 1999-2013 by Digital Mars, All Rights Reserved | Page generated by Ddoc.