Sans Pareil Technologies, Inc.

/*
 * MD5Engine.h
 *
 * Definition of class MD5Engine.
 *
 * Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 * and Contributors.
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 *
 * MD5 (RFC 1321) algorithm:
 * Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
 * rights reserved.
 *
 * License to copy and use this software is granted provided that it
 * is identified as the "RSA Data Security, Inc. MD5 Message-Digest
 * Algorithm" in all material mentioning or referencing this software
 * or this function.
 *
 * License is also granted to make and use derivative works provided
 * that such works are identified as "derived from the RSA Data
 * Security, Inc. MD5 Message-Digest Algorithm" in all material
 * mentioning or referencing the derived work.
 *
 * RSA Data Security, Inc. makes no representations concerning either
 * the merchantability of this software or the suitability of this
 * software for any particular purpose. It is provided "as is"
 * without express or implied warranty of any kind.
 *
 * These notices must be retained in any copies of any part of this
 * documentation and/or software.
 */

#ifndef SPT_DIGEST_MD5ENGINE
#define SPT_DIGEST_MD5ENGINE


#include "DigestEngine.h"


namespace spt
{
  namespace digest
  {
    /// This class implementes the MD5 message digest algorithm,
    /// described in RFC 1321.
    class MD5Engine: public DigestEngine
    {
    public:
      enum
      {
        BLOCK_SIZE  = 64,
        DIGEST_SIZE = 16
      };

      MD5Engine();
      ~MD5Engine();

      uint32_t digestLength() const;
      void reset();
      const DigestEngine::Digest& digest();

    protected:
      void updateImpl( const void* data, uint32_t length );

    private:
      static void transform( uint32_t state[4], const Byte block[64] );
      static void encode( Byte* output, const uint32_t* input, uint32_t len );
      static void decode( uint32_t* output, const Byte* input, uint32_t len );

      struct Context
      {
        uint32_t state[4];  // state (ABCD)
        uint32_t count[2];  // number of bits, modulo 2^64 (lsb first)
        Byte buffer[64];    // input buffer
      };

      Context context;
      DigestEngine::Digest digestValue;

      MD5Engine( const MD5Engine& );
      MD5Engine& operator = ( const MD5Engine& );
    };

  } // namespace digest

} // namespace spt


#endif // SPT_DIGEST_MD5ENGINE

/*
 * MD5Engine.cpp
 *
 * Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 * and Contributors.
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 *
 * MD5 (RFC 1321) algorithm:
 * Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
 * rights reserved.
 *
 * License to copy and use this software is granted provided that it
 * is identified as the "RSA Data Security, Inc. MD5 Message-Digest
 * Algorithm" in all material mentioning or referencing this software
 * or this function.
 *
 * License is also granted to make and use derivative works provided
 * that such works are identified as "derived from the RSA Data
 * Security, Inc. MD5 Message-Digest Algorithm" in all material
 * mentioning or referencing the derived work.
 *
 * RSA Data Security, Inc. makes no representations concerning either
 * the merchantability of this software or the suitability of this
 * software for any particular purpose. It is provided "as is"
 * without express or implied warranty of any kind.
 *
 * These notices must be retained in any copies of any part of this
 * documentation and/or software.
 */


#include "MD5Engine.h"

#if defined( ARDUINO )
#include "../StandardCplusplus/cstring"
#else
#include <cstring>
#endif


using spt::Byte;
using spt::digest::DigestEngine;
using spt::digest::MD5Engine;


MD5Engine::MD5Engine()
{
  digestValue.reserve(16);
  reset();
}


MD5Engine::~MD5Engine()
{
  reset();
}

  
void MD5Engine::updateImpl( const void* input_, uint32_t inputLen )
{
  const Byte* input = static_cast<const Byte*>( input_ );
  uint32_t i, index, partLen;

  /* Compute number of bytes mod 64 */
  index = static_cast<uint32_t>( ( context.count[0] >> 3 ) & 0x3F );

  /* Update number of bits */
  if ( ( context.count[0] += static_cast<uint32_t>( inputLen << 3 ) ) <
      static_cast<uint32_t>( inputLen << 3 ) ) context.count[1]++;

  context.count[1] += static_cast<uint32_t>( inputLen >> 29 );

  partLen = 64 - index;

  /* Transform as many times as possible. */
  if ( inputLen >= partLen )
  {
    std::memcpy( &context.buffer[index], input, partLen );
    transform( context.state, context.buffer );

    for ( i = partLen; i + 63 < inputLen; i += 64 ) transform( context.state, &input[i] );

    index = 0;
  }
  else i = 0;

  /* Buffer remaining input */
  std::memcpy( &context.buffer[index], &input[i], inputLen - i );
}


uint32_t MD5Engine::digestLength() const
{
  return DIGEST_SIZE;
}


void MD5Engine::reset()
{
  std::memset( &context, 0, sizeof(context) );
  context.count[0] = context.count[1] = 0;
  context.state[0] = 0x67452301;
  context.state[1] = 0xefcdab89;
  context.state[2] = 0x98badcfe;
  context.state[3] = 0x10325476;
}


const DigestEngine::Digest& MD5Engine::digest()
{
  static const Byte PADDING[64] =
  {
    0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
  };

  Byte bits[8];
  uint32_t index, padLen;

  /* Save number of bits */
  encode(bits, context.count, 8);

  /* Pad out to 56 mod 64. */
  index = static_cast<uint32_t>( ( context.count[0] >> 3 ) & 0x3f );
  padLen = ( index < 56 ) ? ( 56 - index ) : ( 120 - index );
  update( PADDING, padLen );

  /* Append length (before padding) */
  update( bits, 8 );

  /* Store state in digest */
  Byte digest[16];
  encode( digest, context.state, 16 );
  digestValue.clear();
  digestValue.insert( digestValue.begin(), digest, digest + sizeof( digest ) );

  /* Zeroize sensitive information. */
  std::memset( &context, 0, sizeof( context ) );
  reset();
  return digestValue;
}


namespace spt
{
  namespace digest
  {

/* Constants for MD5Transform routine. */
#define S11 7
#define S12 12
#define S13 17
#define S14 22
#define S21 5
#define S22 9
#define S23 14
#define S24 20
#define S31 4
#define S32 11
#define S33 16
#define S34 23
#define S41 6
#define S42 10
#define S43 15
#define S44 21


/* F, G, H and I are basic MD5 functions. */
#define F(x, y, z) (((x) & (y)) | ((~x) & (z)))
#define G(x, y, z) (((x) & (z)) | ((y) & (~z)))
#define H(x, y, z) ((x) ^ (y) ^ (z))
#define I(x, y, z) ((y) ^ ((x) | (~z)))


/* ROTATE_LEFT rotates x left n bits. */
#define ROTATE_LEFT(x, n) (((x) << (n)) | ((x) >> (32-(n))))


/* FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4.
   Rotation is separate from addition to prevent recomputation. */
#define FF(a, b, c, d, x, s, ac) { \
 (a) += F ((b), (c), (d)) + (x) + (uint32_t)(ac); \
 (a) = ROTATE_LEFT ((a), (s)); \
 (a) += (b); \
  }
#define GG(a, b, c, d, x, s, ac) { \
 (a) += G ((b), (c), (d)) + (x) + (uint32_t)(ac); \
 (a) = ROTATE_LEFT ((a), (s)); \
 (a) += (b); \
  }
#define HH(a, b, c, d, x, s, ac) { \
 (a) += H ((b), (c), (d)) + (x) + (uint32_t)(ac); \
 (a) = ROTATE_LEFT ((a), (s)); \
 (a) += (b); \
  }
#define II(a, b, c, d, x, s, ac) { \
 (a) += I ((b), (c), (d)) + (x) + (uint32_t)(ac); \
 (a) = ROTATE_LEFT ((a), (s)); \
 (a) += (b); \
  }

  }
}


void MD5Engine::transform( uint32_t state[4], const Byte block[64] )
{
  uint32_t a = state[0], b = state[1], c = state[2], d = state[3], x[16];

  decode( x, block, 64 );

  /* Round 1 */
  FF (a, b, c, d, x[ 0], S11, 0xd76aa478); /* 1 */
  FF (d, a, b, c, x[ 1], S12, 0xe8c7b756); /* 2 */
  FF (c, d, a, b, x[ 2], S13, 0x242070db); /* 3 */
  FF (b, c, d, a, x[ 3], S14, 0xc1bdceee); /* 4 */
  FF (a, b, c, d, x[ 4], S11, 0xf57c0faf); /* 5 */
  FF (d, a, b, c, x[ 5], S12, 0x4787c62a); /* 6 */
  FF (c, d, a, b, x[ 6], S13, 0xa8304613); /* 7 */
  FF (b, c, d, a, x[ 7], S14, 0xfd469501); /* 8 */
  FF (a, b, c, d, x[ 8], S11, 0x698098d8); /* 9 */
  FF (d, a, b, c, x[ 9], S12, 0x8b44f7af); /* 10 */
  FF (c, d, a, b, x[10], S13, 0xffff5bb1); /* 11 */
  FF (b, c, d, a, x[11], S14, 0x895cd7be); /* 12 */
  FF (a, b, c, d, x[12], S11, 0x6b901122); /* 13 */
  FF (d, a, b, c, x[13], S12, 0xfd987193); /* 14 */
  FF (c, d, a, b, x[14], S13, 0xa679438e); /* 15 */
  FF (b, c, d, a, x[15], S14, 0x49b40821); /* 16 */

  /* Round 2 */
  GG (a, b, c, d, x[ 1], S21, 0xf61e2562); /* 17 */
  GG (d, a, b, c, x[ 6], S22, 0xc040b340); /* 18 */
  GG (c, d, a, b, x[11], S23, 0x265e5a51); /* 19 */
  GG (b, c, d, a, x[ 0], S24, 0xe9b6c7aa); /* 20 */
  GG (a, b, c, d, x[ 5], S21, 0xd62f105d); /* 21 */
  GG (d, a, b, c, x[10], S22,  0x2441453); /* 22 */
  GG (c, d, a, b, x[15], S23, 0xd8a1e681); /* 23 */
  GG (b, c, d, a, x[ 4], S24, 0xe7d3fbc8); /* 24 */
  GG (a, b, c, d, x[ 9], S21, 0x21e1cde6); /* 25 */
  GG (d, a, b, c, x[14], S22, 0xc33707d6); /* 26 */
  GG (c, d, a, b, x[ 3], S23, 0xf4d50d87); /* 27 */
  GG (b, c, d, a, x[ 8], S24, 0x455a14ed); /* 28 */
  GG (a, b, c, d, x[13], S21, 0xa9e3e905); /* 29 */
  GG (d, a, b, c, x[ 2], S22, 0xfcefa3f8); /* 30 */
  GG (c, d, a, b, x[ 7], S23, 0x676f02d9); /* 31 */
  GG (b, c, d, a, x[12], S24, 0x8d2a4c8a); /* 32 */

  /* Round 3 */
  HH (a, b, c, d, x[ 5], S31, 0xfffa3942); /* 33 */
  HH (d, a, b, c, x[ 8], S32, 0x8771f681); /* 34 */
  HH (c, d, a, b, x[11], S33, 0x6d9d6122); /* 35 */
  HH (b, c, d, a, x[14], S34, 0xfde5380c); /* 36 */
  HH (a, b, c, d, x[ 1], S31, 0xa4beea44); /* 37 */
  HH (d, a, b, c, x[ 4], S32, 0x4bdecfa9); /* 38 */
  HH (c, d, a, b, x[ 7], S33, 0xf6bb4b60); /* 39 */
  HH (b, c, d, a, x[10], S34, 0xbebfbc70); /* 40 */
  HH (a, b, c, d, x[13], S31, 0x289b7ec6); /* 41 */
  HH (d, a, b, c, x[ 0], S32, 0xeaa127fa); /* 42 */
  HH (c, d, a, b, x[ 3], S33, 0xd4ef3085); /* 43 */
  HH (b, c, d, a, x[ 6], S34,  0x4881d05); /* 44 */
  HH (a, b, c, d, x[ 9], S31, 0xd9d4d039); /* 45 */
  HH (d, a, b, c, x[12], S32, 0xe6db99e5); /* 46 */
  HH (c, d, a, b, x[15], S33, 0x1fa27cf8); /* 47 */
  HH (b, c, d, a, x[ 2], S34, 0xc4ac5665); /* 48 */

  /* Round 4 */
  II (a, b, c, d, x[ 0], S41, 0xf4292244); /* 49 */
  II (d, a, b, c, x[ 7], S42, 0x432aff97); /* 50 */
  II (c, d, a, b, x[14], S43, 0xab9423a7); /* 51 */
  II (b, c, d, a, x[ 5], S44, 0xfc93a039); /* 52 */
  II (a, b, c, d, x[12], S41, 0x655b59c3); /* 53 */
  II (d, a, b, c, x[ 3], S42, 0x8f0ccc92); /* 54 */
  II (c, d, a, b, x[10], S43, 0xffeff47d); /* 55 */
  II (b, c, d, a, x[ 1], S44, 0x85845dd1); /* 56 */
  II (a, b, c, d, x[ 8], S41, 0x6fa87e4f); /* 57 */
  II (d, a, b, c, x[15], S42, 0xfe2ce6e0); /* 58 */
  II (c, d, a, b, x[ 6], S43, 0xa3014314); /* 59 */
  II (b, c, d, a, x[13], S44, 0x4e0811a1); /* 60 */
  II (a, b, c, d, x[ 4], S41, 0xf7537e82); /* 61 */
  II (d, a, b, c, x[11], S42, 0xbd3af235); /* 62 */
  II (c, d, a, b, x[ 2], S43, 0x2ad7d2bb); /* 63 */
  II (b, c, d, a, x[ 9], S44, 0xeb86d391); /* 64 */

  state[0] += a;
  state[1] += b;
  state[2] += c;
  state[3] += d;

  /* Zeroize sensitive information. */
  std::memset( x, 0, sizeof( x ) );
}


void MD5Engine::encode( Byte* output, const uint32_t* input, uint32_t len)
{
  uint32_t i, j;

  for ( i = 0, j = 0; j < len; i++, j += 4 )
  {
    output[j]   = static_cast<Byte>( input[i] & 0xff );
    output[j+1] = static_cast<Byte>( ( input[i] >> 8 ) & 0xff );
    output[j+2] = static_cast<Byte>( ( input[i] >> 16 ) & 0xff );
    output[j+3] = static_cast<Byte>( ( input[i] >> 24 ) & 0xff );
  }
}


void MD5Engine::decode( uint32_t* output, const Byte* input, uint32_t len )
{
  uint32_t i, j;

  for ( i = 0, j = 0; j < len; i++, j += 4 )
  {
    output[i] = static_cast<uint32_t>( input[j] ) |
        ( static_cast<uint32_t>( input[j+1] ) << 8 ) |
        ( static_cast<uint32_t>( input[j+2] ) << 16 ) |
        ( static_cast<uint32_t>( input[j+3] ) << 24 );
  }
}

#if defined( ARDUINO )
#include "tut.hpp"
#include "MD5Engine.h"
#else
#include <tut/tut.hpp>
#include <SPT.h>
#include <digest/MD5Engine.h>
#endif

using spt::digest::DigestEngine;
using spt::digest::MD5Engine;

namespace tut
{
  struct MD5EngineTestData {};

  typedef test_group<MD5EngineTestData> MD5EngineTestGroup;
  typedef MD5EngineTestGroup::object MD5EngineTest;
  MD5EngineTestGroup md5EngineTestGroup( "MD5Engine test suite" );


  template<>
  template<>
  void MD5EngineTest::test<1>()
  {
    set_test_name( "basic" );

    MD5Engine engine;

    // test vectors from RFC 1321

    engine.update( "" );
    ensure( "Empty string",
      DigestEngine::digestToHex(engine.digest()) == "d41d8cd98f00b204e9800998ecf8427e" );

    engine.update("a");
    ensure( "Add a",
        DigestEngine::digestToHex(engine.digest()) == "0cc175b9c0f1b6a831c399e269772661" );

    engine.update("abc");
    ensure( "Add abc",
        DigestEngine::digestToHex(engine.digest()) == "900150983cd24fb0d6963f7d28e17f72");

    engine.update("message digest");
    ensure( "Add message digest",
        DigestEngine::digestToHex(engine.digest()) == "f96b697d7cb7938d525a2f31aaf161d0");

    engine.update("abcdefghijklmnopqrstuvwxyz");
    ensure( "Add lower case",
        DigestEngine::digestToHex(engine.digest()) == "c3fcd3d76192e4007dfb496cca67e13b");

    engine.update("ABCDEFGHIJKLMNOPQRSTUVWXYZ");
    engine.update("abcdefghijklmnopqrstuvwxyz0123456789");
    ensure( "Added upper and lower",
        DigestEngine::digestToHex(engine.digest()) == "d174ab98d277d9f5a5611c2c9f419d9f");

    engine.update("12345678901234567890123456789012345678901234567890123456789012345678901234567890");
    ensure( "Added numbers",
        DigestEngine::digestToHex(engine.digest()) == "57edf4a22be3c955ac49da2e2107b67a");
    std::cout << "Free SRAM: " << spt::freeRam() << std::endl;
  }
}