base/md5.h

   1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_MD5_H__
   6 #define BASE_MD5_H__
   7
   8 #include <string>
   9
  10 // These functions perform MD5 operations. The simplest call is MD5Sum to
  11 // generate the MD5 sum of the given data.
  12 //
  13 // You can also compute the MD5 sum of data incrementally by making multiple
  14 // calls to MD5Update:
  15 //    MD5Context ctx; // intermediate MD5 data: do not use
  16 //    MD5Init(&ctx);
  17 //    MD5Update(&ctx, data1, length1);
  18 //    MD5Update(&ctx, data2, length2);
  19 //    ...
  20 //
  21 //    MD5Digest digest; // the result of the computation
  22 //    MD5Final(&digest, &ctx);
  23 //
  24 // You can call MD5DigestToBase16 to generate a string of the digest.
  25
  26 // The output of an MD5 operation
  27 typedef struct MD5Digest_struct {
  28   unsigned char a[16];
  29 } MD5Digest;
  30
  31 // Used for storing intermediate data during an MD5 computation. Callers
  32 // should not access the data.
  33 typedef char MD5Context[88];
  34
  35 // Computes the MD5 sum of the given data buffer with the given length.
  36 // The given 'digest' structure will be filled with the result data.
  37 void MD5Sum(const void* data, size_t length, MD5Digest* digest);
  38
  39 // Initializes the given MD5 context structure for subsequent calls to
  40 // MD5Update.
  41 void MD5Init(MD5Context* context);
  42
  43 // For the given buffer of data, updates the given MD5 context with the sum of
  44 // the data. You can call this any number of times during the computation,
  45 // exept that MD5Init must have been called first.
  46 void MD5Update(MD5Context* context, const void* buf, size_t len);
  47
  48 // Finalizes the MD5 operation and fills the buffer with the digest.
  49 void MD5Final(MD5Digest* digest, MD5Context* pCtx);
  50
  51 // Converts a digest into human-readable hexadecimal.
  52 std::string MD5DigestToBase16(const MD5Digest& digest);
  53
  54 // Returns the MD5 (in hexadecimal) of a string.
  55 std::string MD5String(const std::string& str);
  56
  57 #endif // BASE_MD5_H__
  58