glib/gchecksum.h

   1 /* gchecksum.h - data hashing functions
   2  *
   3  * Copyright (C) 2007  Emmanuele Bassi  <ebassi@gnome.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __G_CHECKSUM_H__
  20 #define __G_CHECKSUM_H__
  21
  22 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  23 #error "Only <glib.h> can be included directly."
  24 #endif
  25
  26 #include <glib/gtypes.h>
  27 #include <glib/gbytes.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /**
  32  * GChecksumType:
  33  * @G_CHECKSUM_MD5: Use the MD5 hashing algorithm
  34  * @G_CHECKSUM_SHA1: Use the SHA-1 hashing algorithm
  35  * @G_CHECKSUM_SHA256: Use the SHA-256 hashing algorithm
  36  * @G_CHECKSUM_SHA512: Use the SHA-512 hashing algorithm
  37  *
  38  * The hashing algorithm to be used by #GChecksum when performing the
  39  * digest of some data.
  40  *
  41  * Note that the #GChecksumType enumeration may be extended at a later
  42  * date to include new hashing algorithm types.
  43  *
  44  * Since: 2.16
  45  */
  46 typedef enum {
  47   G_CHECKSUM_MD5,
  48   G_CHECKSUM_SHA1,
  49   G_CHECKSUM_SHA256,
  50   G_CHECKSUM_SHA512
  51 } GChecksumType;
  52
  53 /**
  54  * GChecksum:
  55  *
  56  * An opaque structure representing a checksumming operation.
  57  * To create a new GChecksum, use g_checksum_new(). To free
  58  * a GChecksum, use g_checksum_free().
  59  *
  60  * Since: 2.16
  61  */
  62 typedef struct _GChecksum       GChecksum;
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 gssize                g_checksum_type_get_length    (GChecksumType    checksum_type);
  66
  67 GLIB_AVAILABLE_IN_ALL
  68 GChecksum *           g_checksum_new                (GChecksumType    checksum_type);
  69 GLIB_AVAILABLE_IN_ALL
  70 void                  g_checksum_reset              (GChecksum       *checksum);
  71 GLIB_AVAILABLE_IN_ALL
  72 GChecksum *           g_checksum_copy               (const GChecksum *checksum);
  73 GLIB_AVAILABLE_IN_ALL
  74 void                  g_checksum_free               (GChecksum       *checksum);
  75 GLIB_AVAILABLE_IN_ALL
  76 void                  g_checksum_update             (GChecksum       *checksum,
  77                                                      const guchar    *data,
  78                                                      gssize           length);
  79 GLIB_AVAILABLE_IN_ALL
  80 const gchar *         g_checksum_get_string         (GChecksum       *checksum);
  81 GLIB_AVAILABLE_IN_ALL
  82 void                  g_checksum_get_digest         (GChecksum       *checksum,
  83                                                      guint8          *buffer,
  84                                                      gsize           *digest_len);
  85
  86 GLIB_AVAILABLE_IN_ALL
  87 gchar                *g_compute_checksum_for_data   (GChecksumType    checksum_type,
  88                                                      const guchar    *data,
  89                                                      gsize            length);
  90 GLIB_AVAILABLE_IN_ALL
  91 gchar                *g_compute_checksum_for_string (GChecksumType    checksum_type,
  92                                                      const gchar     *str,
  93                                                      gssize           length);
  94
  95 GLIB_AVAILABLE_IN_2_34
  96 gchar                *g_compute_checksum_for_bytes  (GChecksumType    checksum_type,
  97                                                      GBytes          *data);
  98
  99 G_END_DECLS
 100
 101 #endif /* __G_CHECKSUM_H__ */