ffmpeg.libavutil.sha512 source code

1 /*
2  * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
3  * Copyright (C) 2013 James Almer <jamrial@gmail.com>
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * @ingroup lavu_sha512
25  * Public header for SHA-512 implementation.
26  */
27 module ffmpeg.libavutil.sha512;
28 extern (C) @nogc nothrow:
29 
30 /**
31  * @defgroup lavu_sha512 SHA-512
32  * @ingroup lavu_hash
33  * SHA-512 (Secure Hash Algorithm) hash function implementations.
34  *
35  * This module supports the following SHA-2 hash functions:
36  *
37  * - SHA-512/224: 224 bits
38  * - SHA-512/256: 256 bits
39  * - SHA-384: 384 bits
40  * - SHA-512: 512 bits
41  *
42  * @see For SHA-1, SHA-256, and variants thereof, see @ref lavu_sha.
43  *
44  * @{
45  */
46 
47 extern __gshared const int av_sha512_size;
48 
49 struct AVSHA512;
50 
51 /**
52  * Allocate an AVSHA512 context.
53  */
54 AVSHA512* av_sha512_alloc ();
55 
56 /**
57  * Initialize SHA-2 512 hashing.
58  *
59  * @param context pointer to the function context (of size av_sha512_size)
60  * @param bits    number of bits in digest (224, 256, 384 or 512 bits)
61  * @return        zero if initialization succeeded, -1 otherwise
62  */
63 int av_sha512_init (AVSHA512* context, int bits);
64 
65 /**
66  * Update hash value.
67  *
68  * @param context hash function context
69  * @param data    input data to update hash with
70  * @param len     input data length
71  */
72 void av_sha512_update (AVSHA512* context, const(ubyte)* data, uint len);
73 
74 /**
75  * Finish hashing and output digest value.
76  *
77  * @param context hash function context
78  * @param digest  buffer where output digest value is stored
79  */
80 void av_sha512_final (AVSHA512* context, ubyte* digest);
81 
82 /**
83  * @}
84  */
85 
86 /* AVUTIL_SHA512_H */