subversion/include/svn_md5.h

   1 /**
   2  * @copyright
   3  * ====================================================================
   4  * Copyright (c) 2000-2004 CollabNet.  All rights reserved.
   5  *
   6  * This software is licensed as described in the file COPYING, which
   7  * you should have received as part of this distribution.  The terms
   8  * are also available at http://subversion.tigris.org/license-1.html.
   9  * If newer versions of this license are posted there, you may use a
  10  * newer version instead, at your option.
  11  *
  12  * This software consists of voluntary contributions made by many
  13  * individuals.  For exact contribution history, see the revision
  14  * history and logs, available at http://subversion.tigris.org/.
  15  * ====================================================================
  16  * @endcopyright
  17  *
  18  * @file svn_md5.h
  19  * @brief Converting and comparing MD5 checksums.
  20  */
  21
  22 #ifndef SVN_MD5_H
  23 #define SVN_MD5_H
  24
  25 #include <apr_pools.h>
  26 #include <apr_md5.h>
  27 #include "svn_error.h"
  28 #include "svn_pools.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 \f
  35
  36 /** The MD5 digest for the empty string. */
  37 const unsigned char *svn_md5_empty_string_digest(void);
  38
  39
  40 /** Return the hex representation of @a digest, which must be
  41  * @c APR_MD5_DIGESTSIZE bytes long, allocating the string in @a pool.
  42  */
  43 const char *svn_md5_digest_to_cstring_display(const unsigned char digest[],
  44                                               apr_pool_t *pool);
  45
  46
  47 /** Return the hex representation of @a digest, which must be
  48  * @c APR_MD5_DIGESTSIZE bytes long, allocating the string in @a pool.
  49  * If @a digest is all zeros, then return NULL.
  50  */
  51 const char *svn_md5_digest_to_cstring(const unsigned char digest[],
  52                                       apr_pool_t *pool);
  53
  54
  55 /** Compare digests @a d1 and @a d2, each @c APR_MD5_DIGESTSIZE bytes long.
  56  * If neither is all zeros, and they do not match, then return FALSE;
  57  * else return TRUE.
  58  */
  59 svn_boolean_t svn_md5_digests_match(const unsigned char d1[],
  60                                     const unsigned char d2[]);
  61
  62 #ifdef __cplusplus
  63 }
  64 #endif /* __cplusplus */
  65
  66 #endif /* SVN_MD5_H */