Merge branch 'doc-types' into 'master'
[glib.git] / glib / ghmac.h
blob36e24eb29bd5d990f8b2f5e5df124210b3c2f40f
1 /* ghmac.h - secure data hashing
3 * Copyright (C) 2011 Stef Walter <stefw@collabora.co.uk>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
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 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with this library; if not, see <http://www.gnu.org/licenses/>.
19 #ifndef __G_HMAC_H__
20 #define __G_HMAC_H__
22 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
23 #error "Only <glib.h> can be included directly."
24 #endif
26 #include <glib/gtypes.h>
27 #include "gchecksum.h"
29 G_BEGIN_DECLS
31 /**
32 * GHmac:
34 * An opaque structure representing a HMAC operation.
35 * To create a new GHmac, use g_hmac_new(). To free
36 * a GHmac, use g_hmac_unref().
38 * Since: 2.30
40 typedef struct _GHmac GHmac;
42 GLIB_AVAILABLE_IN_2_30
43 GHmac * g_hmac_new (GChecksumType digest_type,
44 const guchar *key,
45 gsize key_len);
46 GLIB_AVAILABLE_IN_2_30
47 GHmac * g_hmac_copy (const GHmac *hmac);
48 GLIB_AVAILABLE_IN_2_30
49 GHmac * g_hmac_ref (GHmac *hmac);
50 GLIB_AVAILABLE_IN_2_30
51 void g_hmac_unref (GHmac *hmac);
52 GLIB_AVAILABLE_IN_2_30
53 void g_hmac_update (GHmac *hmac,
54 const guchar *data,
55 gssize length);
56 GLIB_AVAILABLE_IN_2_30
57 const gchar * g_hmac_get_string (GHmac *hmac);
58 GLIB_AVAILABLE_IN_2_30
59 void g_hmac_get_digest (GHmac *hmac,
60 guint8 *buffer,
61 gsize *digest_len);
63 GLIB_AVAILABLE_IN_2_30
64 gchar *g_compute_hmac_for_data (GChecksumType digest_type,
65 const guchar *key,
66 gsize key_len,
67 const guchar *data,
68 gsize length);
69 GLIB_AVAILABLE_IN_2_30
70 gchar *g_compute_hmac_for_string (GChecksumType digest_type,
71 const guchar *key,
72 gsize key_len,
73 const gchar *str,
74 gssize length);
75 GLIB_AVAILABLE_IN_2_50
76 gchar *g_compute_hmac_for_bytes (GChecksumType digest_type,
77 GBytes *key,
78 GBytes *data);
81 G_END_DECLS
83 #endif /* __G_CHECKSUM_H__ */