spritz/spritz.h

/* spritz.h, spritz C implementation, header
 *
 * Copyright (c) 2015 Marc Alexander Lehmann <libev@schmorp.de>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 *
 *   1.  Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *
 *   2.  Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * the GNU General Public License ("GPL") version 2 or any later version,
 * in which case the provisions of the GPL are applicable instead of
 * the above. If you wish to allow the use of your version of this file
 * only under the terms of the GPL and not to allow others to use your
 * version of this file under the BSD license, indicate your decision
 * by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL. If you do not delete the
 * provisions above, a recipient may use your version of this file under
 * either the BSD or the GPL.
 */
#ifndef SPRITZ_H
#define SPRITZ_H

#include <stdint.h>
#include <sys/types.h>

/*******************************************************************************/
/* spritz parameters/state type */

enum {
  spritz_N = 256
};

typedef struct
{
  uint8_t a, i, j, k, z, w;
  uint8_t S[spritz_N];
} spritz_state;

/*******************************************************************************/
/* the spritz primitives */

void    spritz_init            (spritz_state *s);
void    spritz_update          (spritz_state *s);
void    spritz_whip            (spritz_state *s, uint_fast16_t r);
void    spritz_crush           (spritz_state *s);
void    spritz_shuffle         (spritz_state *s);
void    spritz_absorb          (spritz_state *s, const void *I, size_t I_len);
void    spritz_absorb_stop     (spritz_state *s);
void    spritz_absorb_and_stop (spritz_state *s, const void *I, size_t I_len); /* commonly used helper function */
uint8_t spritz_output          (spritz_state *s);
void    spritz_squeeze         (spritz_state *s, void *P, size_t P_len);
uint8_t spritz_drip            (spritz_state *s);

/*******************************************************************************/
/* the spritz-xor cipher */

/* no IV is used if IV_len == 0 */
void spritz_cipher_xor_init  (spritz_state *s, const void *K, size_t K_len, const void *IV, size_t IV_len);

/* can be called multiple times/incrementally */
/* can work inplace */
/* works for both encryption and decryption */
void spritz_cipher_xor_crypt (spritz_state *s, const void *I, void *O, size_t len);

/*******************************************************************************/
/* the spritz hash */

static void spritz_hash_init   (spritz_state *s);
static void spritz_hash_add    (spritz_state *s, const void *M, size_t M_len); /* can be called multiple times/incrementally */
       void spritz_hash_finish (spritz_state *s, void *H, size_t H_len); /* must be called at most once at the end */

/*******************************************************************************/
/* the spritz MAC */

       void spritz_mac_init   (spritz_state *s, const void *K, size_t K_len);
static void spritz_mac_add    (spritz_state *s, const void *M, size_t M_len); /* can be called multiple times/incrementally */
static void spritz_mac_finish (spritz_state *s, void *H, size_t H_len); /* must be called at most once at the end */

/*******************************************************************************/
/* spritz authenticated encryption */

static void spritz_aead_xor_init            (spritz_state *s, const void *K, size_t K_len);
static void spritz_aead_xor_nonce           (spritz_state *s, const void *N, size_t N_len); /* must be called after construction, before associated_data */
static void spritz_aead_xor_associated_data (spritz_state *s, const void *D, size_t D_len); /* must be called after nonce, before crypt */
       void spritz_aead_xor_crypt           (spritz_state *s, const void *I, void *O, size_t len);
/* must be called after associated_data, only once, before finish */
/* works for both encryption and decryption */
static void spritz_aead_xor_finish          (spritz_state *s, void *H, size_t H_len); /* must be called at most once at the end */

/*******************************************************************************/
/* the spritz drbg/csprng */

/* constructor takes a seed if S_len != 0, same as spritz_prng_add */
       void spritz_prng_init (spritz_state *s, const void *S, size_t S_len);
static void spritz_prng_add  (spritz_state *s, const void *S, size_t S_len); /* add additional entropy */
static void spritz_prng_get  (spritz_state *s, void *R, size_t R_len); /* get random bytes */

/*******************************************************************************/
/* inline functions - some functions are so simple, they are defined inline */

/* the spritz hash inline functions */

static void
spritz_hash_init (spritz_state *s)
{
  spritz_init (s);
}

static void
spritz_hash_add (spritz_state *s, const void *M, size_t M_len)
{
  spritz_absorb (s, M, M_len);
}

/* the spritz MAC inline functions */

static void
spritz_mac_add (spritz_state *s, const void *M, size_t M_len)
{
  spritz_hash_add (s, M, M_len);
}

static void
spritz_mac_finish (spritz_state *s, void *H, size_t H_len)
{
  spritz_hash_finish (s, H, H_len);
}

/* spritz authenticated encryption inline functions */

static void
spritz_aead_xor_init (spritz_state *s, const void *K, size_t K_len)
{
  spritz_mac_init (s, K, K_len);
}

static void
spritz_aead_xor_nonce (spritz_state *s, const void *N, size_t N_len)
{
  spritz_absorb_and_stop (s, N, N_len);
}

static void
spritz_aead_xor_associated_data (spritz_state *s, const void *D, size_t D_len)
{
  spritz_absorb_and_stop (s, D, D_len);
}

static void
spritz_aead_xor_finish (spritz_state *s, void *H, size_t H_len)
{
  spritz_mac_finish (s, H, H_len);
}

/* the spritz drbg/csprng inline functions */

static void
spritz_prng_add (spritz_state *s, const void *S, size_t S_len)
{
  spritz_absorb (s, S, S_len);
}

/* get random bytes */
static void
spritz_prng_get (spritz_state *s, void *R, size_t R_len)
{
  spritz_squeeze (s, R, R_len);
}

#endif

Revision:	1.4
Committed:	Sat Jan 10 04:14:21 2015 UTC (9 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.3:	+23 -14 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.3	/* spritz.h, spritz C implementation, header
2			*
3			* Copyright (c) 2015 Marc Alexander Lehmann <libev@schmorp.de>
4			* All rights reserved.
5			*
6			* Redistribution and use in source and binary forms, with or without modifica-
7			* tion, are permitted provided that the following conditions are met:
8			*
9			* 1. Redistributions of source code must retain the above copyright notice,
10			* this list of conditions and the following disclaimer.
11			*
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			*
16			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17			* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
18			* CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19			* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
20			* CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21			* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22			* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23			* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
24			* ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
25			* OF THE POSSIBILITY OF SUCH DAMAGE.
26			*
27			* Alternatively, the contents of this file may be used under the terms of
28			* the GNU General Public License ("GPL") version 2 or any later version,
29			* in which case the provisions of the GPL are applicable instead of
30			* the above. If you wish to allow the use of your version of this file
31			* only under the terms of the GPL and not to allow others to use your
32			* version of this file under the BSD license, indicate your decision
33			* by deleting the provisions above and replace them with the notice
34			* and other provisions required by the GPL. If you do not delete the
35			* provisions above, a recipient may use your version of this file under
36			* either the BSD or the GPL.
37			*/
38	root	1.4	#ifndef SPRITZ_H
39			#define SPRITZ_H
40	root	1.1
41			#include <stdint.h>
42			#include <sys/types.h>
43
44			/*******************************************************************************/
45			/* spritz parameters/state type */
46
47			enum {
48			spritz_N = 256
49			};
50
51			typedef struct
52			{
53			uint8_t a, i, j, k, z, w;
54			uint8_t S[spritz_N];
55			} spritz_state;
56
57			/*******************************************************************************/
58			/* the spritz primitives */
59
60			void spritz_init (spritz_state *s);
61			void spritz_update (spritz_state *s);
62			void spritz_whip (spritz_state *s, uint_fast16_t r);
63			void spritz_crush (spritz_state *s);
64			void spritz_shuffle (spritz_state *s);
65			void spritz_absorb (spritz_state s, const void I, size_t I_len);
66			void spritz_absorb_stop (spritz_state *s);
67			void spritz_absorb_and_stop (spritz_state s, const void I, size_t I_len); /* commonly used helper function */
68			uint8_t spritz_output (spritz_state *s);
69			void spritz_squeeze (spritz_state s, void P, size_t P_len);
70			uint8_t spritz_drip (spritz_state *s);
71
72			/*******************************************************************************/
73			/* the spritz-xor cipher */
74
75			/* no IV is used if IV_len == 0 */
76	root	1.4	void spritz_cipher_xor_init (spritz_state s, const void K, size_t K_len, const void *IV, size_t IV_len);
77	root	1.1
78			/* can be called multiple times/incrementally */
79			/* can work inplace */
80			/* works for both encryption and decryption */
81	root	1.4	void spritz_cipher_xor_crypt (spritz_state s, const void I, void *O, size_t len);
82	root	1.1
83			/*******************************************************************************/
84			/* the spritz hash */
85
86			static void spritz_hash_init (spritz_state *s);
87			static void spritz_hash_add (spritz_state s, const void M, size_t M_len); /* can be called multiple times/incrementally */
88			void spritz_hash_finish (spritz_state s, void H, size_t H_len); /* must be called at most once at the end */
89
90			/*******************************************************************************/
91			/* the spritz MAC */
92
93			void spritz_mac_init (spritz_state s, const void K, size_t K_len);
94			static void spritz_mac_add (spritz_state s, const void M, size_t M_len); /* can be called multiple times/incrementally */
95			static void spritz_mac_finish (spritz_state s, void H, size_t H_len); /* must be called at most once at the end */
96
97			/*******************************************************************************/
98			/* spritz authenticated encryption */
99
100	root	1.4	static void spritz_aead_xor_init (spritz_state s, const void K, size_t K_len);
101			static void spritz_aead_xor_nonce (spritz_state s, const void N, size_t N_len); /* must be called after construction, before associated_data */
102			static void spritz_aead_xor_associated_data (spritz_state s, const void D, size_t D_len); /* must be called after nonce, before crypt */
103			void spritz_aead_xor_crypt (spritz_state s, const void I, void *O, size_t len);
104	root	1.1	/* must be called after associated_data, only once, before finish */
105			/* works for both encryption and decryption */
106	root	1.4	static void spritz_aead_xor_finish (spritz_state s, void H, size_t H_len); /* must be called at most once at the end */
107	root	1.1
108			/*******************************************************************************/
109			/* the spritz drbg/csprng */
110
111	root	1.4	/* constructor takes a seed if S_len != 0, same as spritz_prng_add */
112	root	1.1	void spritz_prng_init (spritz_state s, const void S, size_t S_len);
113	root	1.4	static void spritz_prng_add (spritz_state s, const void S, size_t S_len); /* add additional entropy */
114	root	1.1	static void spritz_prng_get (spritz_state s, void R, size_t R_len); /* get random bytes */
115
116			/*******************************************************************************/
117			/* inline functions - some functions are so simple, they are defined inline */
118
119			/* the spritz hash inline functions */
120
121			static void
122			spritz_hash_init (spritz_state *s)
123			{
124			spritz_init (s);
125			}
126
127			static void
128			spritz_hash_add (spritz_state s, const void M, size_t M_len)
129			{
130			spritz_absorb (s, M, M_len);
131			}
132
133			/* the spritz MAC inline functions */
134
135			static void
136			spritz_mac_add (spritz_state s, const void M, size_t M_len)
137			{
138			spritz_hash_add (s, M, M_len);
139			}
140
141			static void
142			spritz_mac_finish (spritz_state s, void H, size_t H_len)
143			{
144			spritz_hash_finish (s, H, H_len);
145			}
146
147			/* spritz authenticated encryption inline functions */
148
149			static void
150	root	1.4	spritz_aead_xor_init (spritz_state s, const void K, size_t K_len)
151			{
152			spritz_mac_init (s, K, K_len);
153			}
154
155			static void
156			spritz_aead_xor_nonce (spritz_state s, const void N, size_t N_len)
157	root	1.1	{
158			spritz_absorb_and_stop (s, N, N_len);
159			}
160
161			static void
162	root	1.4	spritz_aead_xor_associated_data (spritz_state s, const void D, size_t D_len)
163	root	1.1	{
164			spritz_absorb_and_stop (s, D, D_len);
165			}
166
167			static void
168	root	1.4	spritz_aead_xor_finish (spritz_state s, void H, size_t H_len)
169	root	1.1	{
170			spritz_mac_finish (s, H, H_len);
171			}
172
173			/* the spritz drbg/csprng inline functions */
174
175			static void
176	root	1.4	spritz_prng_add (spritz_state s, const void S, size_t S_len)
177	root	1.1	{
178			spritz_absorb (s, S, S_len);
179			}
180
181			/* get random bytes */
182			static void
183			spritz_prng_get (spritz_state s, void R, size_t R_len)
184			{
185			spritz_squeeze (s, R, R_len);
186			}
187
188	root	1.4	#endif
189