md5.h 2.68 KB
Newer Older
gejun's avatar
gejun committed
1 2 3 4
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
#ifndef BUTIL_MD5_H_
#define BUTIL_MD5_H_
gejun's avatar
gejun committed
7

8 9
#include "butil/base_export.h"
#include "butil/strings/string_piece.h"
gejun's avatar
gejun committed
10

11
namespace butil {
gejun's avatar
gejun committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

// MD5 stands for Message Digest algorithm 5.
// MD5 is a robust hash function, designed for cyptography, but often used
// for file checksums.  The code is complex and slow, but has few
// collisions.
// See Also:
//   http://en.wikipedia.org/wiki/MD5

// These functions perform MD5 operations. The simplest call is MD5Sum() to
// generate the MD5 sum of the given data.
//
// You can also compute the MD5 sum of data incrementally by making multiple
// calls to MD5Update():
//   MD5Context ctx; // intermediate MD5 data: do not use
//   MD5Init(&ctx);
//   MD5Update(&ctx, data1, length1);
//   MD5Update(&ctx, data2, length2);
//   ...
//
//   MD5Digest digest; // the result of the computation
//   MD5Final(&digest, &ctx);
//
// You can call MD5DigestToBase16() to generate a string of the digest.

// The output of an MD5 operation.
struct MD5Digest {
  unsigned char a[16];
};

// Used for storing intermediate data during an MD5 computation. Callers
// should not access the data.
typedef char MD5Context[88];

// Computes the MD5 sum of the given data buffer with the given length.
// The given 'digest' structure will be filled with the result data.
47
BUTIL_EXPORT void MD5Sum(const void* data, size_t length, MD5Digest* digest);
gejun's avatar
gejun committed
48 49 50

// Initializes the given MD5 context structure for subsequent calls to
// MD5Update().
51
BUTIL_EXPORT void MD5Init(MD5Context* context);
gejun's avatar
gejun committed
52 53 54 55

// For the given buffer of |data| as a StringPiece, updates the given MD5
// context with the sum of the data. You can call this any number of times
// during the computation, except that MD5Init() must have been called first.
56
BUTIL_EXPORT void MD5Update(MD5Context* context, const StringPiece& data);
gejun's avatar
gejun committed
57 58

// Finalizes the MD5 operation and fills the buffer with the digest.
59
BUTIL_EXPORT void MD5Final(MD5Digest* digest, MD5Context* context);
gejun's avatar
gejun committed
60 61 62 63

// MD5IntermediateFinal() generates a digest without finalizing the MD5
// operation.  Can be used to generate digests for the input seen thus far,
// without affecting the digest generated for the entire input.
64
BUTIL_EXPORT void MD5IntermediateFinal(MD5Digest* digest,
gejun's avatar
gejun committed
65 66 67
                                      const MD5Context* context);

// Converts a digest into human-readable hexadecimal.
68
BUTIL_EXPORT std::string MD5DigestToBase16(const MD5Digest& digest);
gejun's avatar
gejun committed
69 70

// Returns the MD5 (in hexadecimal) of a string.
71
BUTIL_EXPORT std::string MD5String(const StringPiece& str);
gejun's avatar
gejun committed
72

73
}  // namespace butil
gejun's avatar
gejun committed
74

75
#endif  // BUTIL_MD5_H_