blob: c7558a89646b1ba2fba6445eb3a4970c0852f128
| 1 | /* |
| 2 | * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at> |
| 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 | /** |
| 22 | * @file |
| 23 | * @ingroup lavu_sha |
| 24 | * Public header for SHA-1 & SHA-256 hash function implementations. |
| 25 | */ |
| 26 | |
| 27 | #ifndef AVUTIL_SHA_H |
| 28 | #define AVUTIL_SHA_H |
| 29 | |
| 30 | #include <stdint.h> |
| 31 | |
| 32 | #include "attributes.h" |
| 33 | #include "version.h" |
| 34 | |
| 35 | /** |
| 36 | * @defgroup lavu_sha SHA |
| 37 | * @ingroup lavu_hash |
| 38 | * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations. |
| 39 | * |
| 40 | * This module supports the following SHA hash functions: |
| 41 | * |
| 42 | * - SHA-1: 160 bits |
| 43 | * - SHA-224: 224 bits, as a variant of SHA-2 |
| 44 | * - SHA-256: 256 bits, as a variant of SHA-2 |
| 45 | * |
| 46 | * @see For SHA-384, SHA-512, and variants thereof, see @ref lavu_sha512. |
| 47 | * |
| 48 | * @{ |
| 49 | */ |
| 50 | |
| 51 | extern const int av_sha_size; |
| 52 | |
| 53 | struct AVSHA; |
| 54 | |
| 55 | /** |
| 56 | * Allocate an AVSHA context. |
| 57 | */ |
| 58 | struct AVSHA *av_sha_alloc(void); |
| 59 | |
| 60 | /** |
| 61 | * Initialize SHA-1 or SHA-2 hashing. |
| 62 | * |
| 63 | * @param context pointer to the function context (of size av_sha_size) |
| 64 | * @param bits number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits) |
| 65 | * @return zero if initialization succeeded, -1 otherwise |
| 66 | */ |
| 67 | int av_sha_init(struct AVSHA* context, int bits); |
| 68 | |
| 69 | /** |
| 70 | * Update hash value. |
| 71 | * |
| 72 | * @param context hash function context |
| 73 | * @param data input data to update hash with |
| 74 | * @param len input data length |
| 75 | */ |
| 76 | void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len); |
| 77 | |
| 78 | /** |
| 79 | * Finish hashing and output digest value. |
| 80 | * |
| 81 | * @param context hash function context |
| 82 | * @param digest buffer where output digest value is stored |
| 83 | */ |
| 84 | void av_sha_final(struct AVSHA* context, uint8_t *digest); |
| 85 | |
| 86 | /** |
| 87 | * @} |
| 88 | */ |
| 89 | |
| 90 | #endif /* AVUTIL_SHA_H */ |
| 91 |