umac.h 5.45 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
/* umac.h
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

   UMAC message authentication code (RFC-4418).

   Copyright (C) 2013 Niels Möller

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
Niels Möller's avatar
Niels Möller committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

#ifndef NETTLE_UMAC_H_INCLUDED
#define NETTLE_UMAC_H_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif

/* Namespace mangling */
#define umac32_set_key  nettle_umac32_set_key
#define umac64_set_key  nettle_umac64_set_key
#define umac96_set_key  nettle_umac96_set_key
#define umac128_set_key nettle_umac128_set_key
#define umac32_set_nonce  nettle_umac32_set_nonce
#define umac64_set_nonce  nettle_umac64_set_nonce
#define umac96_set_nonce  nettle_umac96_set_nonce
#define umac128_set_nonce nettle_umac128_set_nonce
#define umac32_update  nettle_umac32_update
#define umac64_update  nettle_umac64_update
#define umac96_update  nettle_umac96_update
#define umac128_update nettle_umac128_update
#define umac32_digest  nettle_umac32_digest
#define umac64_digest  nettle_umac64_digest
#define umac96_digest  nettle_umac96_digest
#define umac128_digest nettle_umac128_digest

#include "nettle-types.h"
#include "aes.h"

62
#define UMAC_KEY_SIZE AES128_KEY_SIZE
63 64 65 66
#define UMAC32_DIGEST_SIZE 4
#define UMAC64_DIGEST_SIZE 8
#define UMAC96_DIGEST_SIZE 12
#define UMAC128_DIGEST_SIZE 16
67
#define UMAC_BLOCK_SIZE 1024
68 69
#define UMAC_MIN_NONCE_SIZE 1
#define UMAC_MAX_NONCE_SIZE AES_BLOCK_SIZE
70 71
/* For backwards compatibility */
#define UMAC_DATA_SIZE UMAC_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
72 73 74

/* Subkeys and state for UMAC with tag size 32*n bits. */
#define _UMAC_STATE(n)					\
75
  uint32_t l1_key[UMAC_BLOCK_SIZE/4 + 4*((n)-1)];	\
Niels Möller's avatar
Niels Möller committed
76 77 78 79 80
  /* Keys in 32-bit pieces, high first */		\
  uint32_t l2_key[6*(n)];				\
  uint64_t l3_key1[8*(n)];				\
  uint32_t l3_key2[(n)];				\
  /* AES cipher for encrypting the nonce */		\
81
  struct aes128_ctx pdf_key;				\
82 83 84 85
  /* The l2_state consists of 2*n uint64_t, for poly64	\
     and poly128 hashing, followed by n additional	\
     uint64_t used as an input buffer. */		\
  uint64_t l2_state[3*(n)];				\
Niels Möller's avatar
Niels Möller committed
86 87 88
  /* Input to the pdf_key, zero-padded and low bits	\
     cleared if appropriate. */				\
  uint8_t nonce[AES_BLOCK_SIZE];			\
89 90 91 92
  unsigned short nonce_length /* For incrementing */

  /* Buffering */ 
#define _UMAC_BUFFER					\
Niels Möller's avatar
Niels Möller committed
93
  unsigned index;					\
Niels Möller's avatar
Niels Möller committed
94
  /* Complete blocks processed */			\
95
  uint64_t count;					\
96
  uint8_t block[UMAC_BLOCK_SIZE]
97
  
Niels Möller's avatar
Niels Möller committed
98 99 100 101 102
#define _UMAC_NONCE_CACHED 0x80

struct umac32_ctx
{
  _UMAC_STATE(1);
103 104
  /* Low bits and cache flag. */
  unsigned short nonce_low;
Niels Möller's avatar
Niels Möller committed
105 106
  /* Previous padding block */
  uint32_t pad_cache[AES_BLOCK_SIZE / 4];
107
  _UMAC_BUFFER;
Niels Möller's avatar
Niels Möller committed
108 109 110 111 112
};

struct umac64_ctx
{
  _UMAC_STATE(2);
113 114
  /* Low bit and cache flag. */
  unsigned short nonce_low;
Niels Möller's avatar
Niels Möller committed
115 116
  /* Previous padding block */
  uint32_t pad_cache[AES_BLOCK_SIZE/4];
117
  _UMAC_BUFFER;
Niels Möller's avatar
Niels Möller committed
118 119 120 121 122
};

struct umac96_ctx
{
  _UMAC_STATE(3);
123
  _UMAC_BUFFER;
Niels Möller's avatar
Niels Möller committed
124 125 126 127 128
};

struct umac128_ctx
{
  _UMAC_STATE(4);
129
  _UMAC_BUFFER;
Niels Möller's avatar
Niels Möller committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
};

/* The _set_key function initialize the nonce to zero. */
void
umac32_set_key (struct umac32_ctx *ctx, const uint8_t *key);
void
umac64_set_key (struct umac64_ctx *ctx, const uint8_t *key);
void
umac96_set_key (struct umac96_ctx *ctx, const uint8_t *key);
void
umac128_set_key (struct umac128_ctx *ctx, const uint8_t *key);

/* Optional, if not used, messages get incrementing nonces starting from zero. */
void
umac32_set_nonce (struct umac32_ctx *ctx,
145
		  size_t nonce_length, const uint8_t *nonce);
Niels Möller's avatar
Niels Möller committed
146 147
void
umac64_set_nonce (struct umac64_ctx *ctx,
148
		  size_t nonce_length, const uint8_t *nonce);
Niels Möller's avatar
Niels Möller committed
149 150
void
umac96_set_nonce (struct umac96_ctx *ctx,
151
		  size_t nonce_length, const uint8_t *nonce);
Niels Möller's avatar
Niels Möller committed
152 153
void
umac128_set_nonce (struct umac128_ctx *ctx,
154
		   size_t nonce_length, const uint8_t *nonce);
Niels Möller's avatar
Niels Möller committed
155 156 157

void
umac32_update (struct umac32_ctx *ctx,
158
	       size_t length, const uint8_t *data);
Niels Möller's avatar
Niels Möller committed
159 160
void
umac64_update (struct umac64_ctx *ctx,
161
	       size_t length, const uint8_t *data);
Niels Möller's avatar
Niels Möller committed
162 163
void
umac96_update (struct umac96_ctx *ctx,
164
	       size_t length, const uint8_t *data);
Niels Möller's avatar
Niels Möller committed
165 166
void
umac128_update (struct umac128_ctx *ctx,
167
		size_t length, const uint8_t *data);
Niels Möller's avatar
Niels Möller committed
168 169 170 171

/* The _digest functions increment the nonce */
void
umac32_digest (struct umac32_ctx *ctx,
172
	       size_t length, uint8_t *digest);
Niels Möller's avatar
Niels Möller committed
173 174
void
umac64_digest (struct umac64_ctx *ctx,
175
	       size_t length, uint8_t *digest);
Niels Möller's avatar
Niels Möller committed
176 177
void
umac96_digest (struct umac96_ctx *ctx,
178
	       size_t length, uint8_t *digest);
Niels Möller's avatar
Niels Möller committed
179 180
void
umac128_digest (struct umac128_ctx *ctx,
181
		size_t length, uint8_t *digest);
Niels Möller's avatar
Niels Möller committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198


/* Internal functions */
#define UMAC_POLY64_BLOCKS 16384

#define UMAC_P64_OFFSET 59
#define UMAC_P64 (- (uint64_t) UMAC_P64_OFFSET)

#define UMAC_P128_OFFSET 159
#define UMAC_P128_HI (~(uint64_t) 0)
#define UMAC_P128_LO (-(uint64_t) UMAC_P128_OFFSET)

#ifdef __cplusplus
}
#endif

#endif /* NETTLE_UMAC_H_INCLUDED */