1 /* 2 * Copyright (C) 2012 Martin Storsjo 3 * 4 * This file is part of FFmpeg. 5 * 6 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 19 */ 20 21 module ffmpeg.libavutil.hmac; 22 23 extern (C): 24 import ffmpeg; @nogc nothrow: 25 26 /** 27 * @defgroup lavu_hmac HMAC 28 * @ingroup lavu_crypto 29 * @{ 30 */ 31 32 enum AVHMACType 33 { 34 AV_HMAC_MD5 = 0, 35 AV_HMAC_SHA1 = 1, 36 AV_HMAC_SHA224 = 2, 37 AV_HMAC_SHA256 = 3, 38 AV_HMAC_SHA384 = 4, 39 AV_HMAC_SHA512 = 5 40 } 41 42 struct AVHMAC; 43 44 /** 45 * Allocate an AVHMAC context. 46 * @param type The hash function used for the HMAC. 47 */ 48 AVHMAC* av_hmac_alloc (AVHMACType type); 49 50 /** 51 * Free an AVHMAC context. 52 * @param ctx The context to free, may be NULL 53 */ 54 void av_hmac_free (AVHMAC* ctx); 55 56 /** 57 * Initialize an AVHMAC context with an authentication key. 58 * @param ctx The HMAC context 59 * @param key The authentication key 60 * @param keylen The length of the key, in bytes 61 */ 62 void av_hmac_init (AVHMAC* ctx, const(ubyte)* key, uint keylen); 63 64 /** 65 * Hash data with the HMAC. 66 * @param ctx The HMAC context 67 * @param data The data to hash 68 * @param len The length of the data, in bytes 69 */ 70 void av_hmac_update (AVHMAC* ctx, const(ubyte)* data, uint len); 71 72 /** 73 * Finish hashing and output the HMAC digest. 74 * @param ctx The HMAC context 75 * @param out The output buffer to write the digest into 76 * @param outlen The length of the out buffer, in bytes 77 * @return The number of bytes written to out, or a negative error code. 78 */ 79 int av_hmac_final (AVHMAC* ctx, ubyte* out_, uint outlen); 80 81 /** 82 * Hash an array of data with a key. 83 * @param ctx The HMAC context 84 * @param data The data to hash 85 * @param len The length of the data, in bytes 86 * @param key The authentication key 87 * @param keylen The length of the key, in bytes 88 * @param out The output buffer to write the digest into 89 * @param outlen The length of the out buffer, in bytes 90 * @return The number of bytes written to out, or a negative error code. 91 */ 92 int av_hmac_calc ( 93 AVHMAC* ctx, 94 const(ubyte)* data, 95 uint len, 96 const(ubyte)* key, 97 uint keylen, 98 ubyte* out_, 99 uint outlen); 100 101 /** 102 * @} 103 */ 104 105 /* AVUTIL_HMAC_H */