chacha20poly1305
[openssl.git] / crypto / poly1305 / poly1305.h
1 /* ====================================================================
2  * Copyright (c) 2011-2013 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    licensing@OpenSSL.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  */
49
50 #ifndef HEADER_POLY1305_H_
51 #define HEADER_POLY1305_H_
52
53 #include <stdint.h>
54 #include <openssl/opensslconf.h>
55
56 #if defined(OPENSSL_NO_POLY1305)
57 #error Poly1305 support is disabled.
58 #endif
59
60 typedef unsigned char poly1305_state[512];
61
62 /* poly1305_init sets up |state| so that it can be used to calculate an
63  * authentication tag with the one-time key |key|. Note that |key| is a
64  * one-time key and therefore there is no `reset' method because that would
65  * enable several messages to be authenticated with the same key. */
66 extern void CRYPTO_poly1305_init(poly1305_state* state,
67                                  const unsigned char key[32]);
68
69 /* poly1305_update processes |in_len| bytes from |in|. It can be called zero or
70  * more times after poly1305_init. */
71 extern void CRYPTO_poly1305_update(poly1305_state* state,
72                                    const unsigned char *in,
73                                    size_t in_len);
74
75 /* poly1305_finish completes the poly1305 calculation and writes a 16 byte
76  * authentication tag to |mac|. */
77 extern void CRYPTO_poly1305_finish(poly1305_state* state,
78                                    unsigned char mac[16]);
79
80 #endif  /* HEADER_POLY1305_H_ */