x86inc: Various minor backports from x264
[ffmpeg.git] / libavutil / hmac.h
1 /*
2  * Copyright (C) 2012 Martin Storsjo
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVUTIL_HMAC_H
22 #define AVUTIL_HMAC_H
23
24 #include <stdint.h>
25
26 /**
27  * @defgroup lavu_hmac HMAC
28  * @ingroup lavu_crypto
29  * @{
30  */
31
32 enum AVHMACType {
33     AV_HMAC_MD5,
34     AV_HMAC_SHA1,
35     AV_HMAC_SHA224,
36     AV_HMAC_SHA256,
37 };
38
39 typedef struct AVHMAC AVHMAC;
40
41 /**
42  * Allocate an AVHMAC context.
43  * @param type The hash function used for the HMAC.
44  */
45 AVHMAC *av_hmac_alloc(enum AVHMACType type);
46
47 /**
48  * Free an AVHMAC context.
49  * @param ctx The context to free, may be NULL
50  */
51 void av_hmac_free(AVHMAC *ctx);
52
53 /**
54  * Initialize an AVHMAC context with an authentication key.
55  * @param ctx    The HMAC context
56  * @param key    The authentication key
57  * @param keylen The length of the key, in bytes
58  */
59 void av_hmac_init(AVHMAC *ctx, const uint8_t *key, unsigned int keylen);
60
61 /**
62  * Hash data with the HMAC.
63  * @param ctx  The HMAC context
64  * @param data The data to hash
65  * @param len  The length of the data, in bytes
66  */
67 void av_hmac_update(AVHMAC *ctx, const uint8_t *data, unsigned int len);
68
69 /**
70  * Finish hashing and output the HMAC digest.
71  * @param ctx    The HMAC context
72  * @param out    The output buffer to write the digest into
73  * @param outlen The length of the out buffer, in bytes
74  * @return       The number of bytes written to out, or a negative error code.
75  */
76 int av_hmac_final(AVHMAC *ctx, uint8_t *out, unsigned int outlen);
77
78 /**
79  * Hash an array of data with a key.
80  * @param ctx    The HMAC context
81  * @param data   The data to hash
82  * @param len    The length of the data, in bytes
83  * @param key    The authentication key
84  * @param keylen The length of the key, in bytes
85  * @param out    The output buffer to write the digest into
86  * @param outlen The length of the out buffer, in bytes
87  * @return       The number of bytes written to out, or a negative error code.
88  */
89 int av_hmac_calc(AVHMAC *ctx, const uint8_t *data, unsigned int len,
90                  const uint8_t *key, unsigned int keylen,
91                  uint8_t *out, unsigned int outlen);
92
93 /**
94  * @}
95  */
96
97 #endif /* AVUTIL_HMAC_H */