ffmpeg.libavutil.sha source code

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 module ffmpeg.libavutil.sha;
27 extern (C) @nogc nothrow:
28 
29 /**
30  * @defgroup lavu_sha SHA
31  * @ingroup lavu_hash
32  * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations.
33  *
34  * This module supports the following SHA hash functions:
35  *
36  * - SHA-1: 160 bits
37  * - SHA-224: 224 bits, as a variant of SHA-2
38  * - SHA-256: 256 bits, as a variant of SHA-2
39  *
40  * @see For SHA-384, SHA-512, and variants thereof, see @ref lavu_sha512.
41  *
42  * @{
43  */
44 
45 extern __gshared const int av_sha_size;
46 
47 struct AVSHA;
48 
49 /**
50  * Allocate an AVSHA context.
51  */
52 AVSHA* av_sha_alloc ();
53 
54 /**
55  * Initialize SHA-1 or SHA-2 hashing.
56  *
57  * @param context pointer to the function context (of size av_sha_size)
58  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
59  * @return        zero if initialization succeeded, -1 otherwise
60  */
61 int av_sha_init (AVSHA* context, int bits);
62 
63 /**
64  * Update hash value.
65  *
66  * @param ctx     hash function context
67  * @param data    input data to update hash with
68  * @param len     input data length
69  */
70 void av_sha_update (AVSHA* ctx, const(ubyte)* data, uint len);
71 
72 /**
73  * Finish hashing and output digest value.
74  *
75  * @param context hash function context
76  * @param digest  buffer where output digest value is stored
77  */
78 void av_sha_final (AVSHA* context, ubyte* digest);
79 
80 /**
81  * @}
82  */
83 
84 /* AVUTIL_SHA_H */