dacbdf59dc651d8463201a0a5e2e891cd7c8b302
[openssl.git] / crypto / include / internal / chacha.h
1 /* ====================================================================
2  * Copyright (c) 2014 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  *    openssl-core@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
51 #ifndef HEADER_CHACHA_H
52 #define HEADER_CHACHA_H
53
54 #include <stddef.h>
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 /*
61  * ChaCha20_ctr32 encrypts |len| bytes from |inp| with the given key and
62  * nonce and writes the result to |out|, which may be equal to |inp|.
63  * The |key| is not 32 bytes of verbatim key material though, but the
64  * said material collected into 8 32-bit elements array in host byte
65  * order. Same approach applies to nonce: the |counter| argument is
66  * pointer to concatenated nonce and counter values collected into 4
67  * 32-bit elements. This, passing crypto material collected into 32-bit
68  * elements as opposite to passing verbatim byte vectors, is chosen for
69  * efficiency in multi-call scenarios.
70  */
71 void ChaCha20_ctr32(unsigned char *out, const unsigned char *inp,
72                     size_t len, const unsigned int key[8],
73                     const unsigned int counter[4]);
74 /*
75  * You can notice that there is no key setup procedure. Because it's
76  * as trivial as collecting bytes into 32-bit elements, it's reckoned
77  * that below macro is sufficient.
78  */
79 #define CHACHA_U8TOU32(p)  ( \
80                 ((unsigned int)(p)[0])     | ((unsigned int)(p)[1]<<8) | \
81                 ((unsigned int)(p)[2]<<16) | ((unsigned int)(p)[3]<<24)  )
82
83 #define CHACHA_KEY_SIZE         32
84 #define CHACHA_CTR_SIZE         16
85 #define CHACHA_BLK_SIZE         64
86
87 #ifdef __cplusplus
88 }
89 #endif
90 #endif