]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/modes/ocb128.c
1 /* ====================================================================
2 * Copyright (c) 2014 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
51 #include <openssl/crypto.h>
52 #include "modes_lcl.h"
54 #ifndef OPENSSL_NO_OCB
57 unsigned char *chrblk
;
62 * Calculate the number of binary trailing zero's in any given number
64 static u32
ocb_ntz(u64 n
)
69 * We do a right-to-left simple sequential search. This is surprisingly
70 * efficient as the distribution of trailing zeros is not uniform,
71 * e.g. the number of possible inputs with no trailing zeros is equal to
72 * the number with 1 or more; the number with exactly 1 is equal to the
73 * number with 2 or more, etc. Checking the last two bits covers 75% of
74 * all numbers. Checking the last three covers 87.5%
84 * Shift a block of 16 bytes left by shift bits
86 static void ocb_block_lshift(OCB_BLOCK
*in
, size_t shift
, OCB_BLOCK
*out
)
88 unsigned char shift_mask
;
90 unsigned char mask
[15];
98 shift_mask
<<= (8 - shift
);
99 for (i
= 15; i
>= 0; i
--) {
101 mask
[i
- 1] = locin
.chrblk
[i
] & shift_mask
;
102 mask
[i
- 1] >>= 8 - shift
;
104 locout
.chrblk
[i
] = locin
.chrblk
[i
] << shift
;
107 locout
.chrblk
[i
] ^= mask
[i
];
113 * Perform a "double" operation as per OCB spec
115 static void ocb_double(OCB_BLOCK
*in
, OCB_BLOCK
*out
)
125 * Calculate the mask based on the most significant bit. There are more
126 * efficient ways to do this - but this way is constant time
128 mask
= locin
.chrblk
[0] & 0x80;
132 ocb_block_lshift(in
, 1, out
);
134 locout
.chrblk
[15] ^= mask
;
138 * Perform an xor on in1 and in2 - each of len bytes. Store result in out
140 static void ocb_block_xor(const unsigned char *in1
,
141 const unsigned char *in2
, size_t len
,
145 for (i
= 0; i
< len
; i
++) {
146 out
[i
] = in1
[i
] ^ in2
[i
];
151 * Lookup L_index in our lookup table. If we haven't already got it we need to
154 static OCB_BLOCK
*ocb_lookup_l(OCB128_CONTEXT
*ctx
, size_t index
)
156 if (index
<= ctx
->l_index
) {
157 return ctx
->l
+ index
;
160 /* We don't have it - so calculate it */
162 if (ctx
->l_index
== ctx
->max_l_index
) {
163 ctx
->max_l_index
*= 2;
165 OPENSSL_realloc(ctx
->l
, ctx
->max_l_index
* sizeof(OCB_BLOCK
));
169 ocb_double(ctx
->l
+ (index
- 1), ctx
->l
+ index
);
171 return ctx
->l
+ index
;
175 * Encrypt a block from |in| and store the result in |out|
177 static void ocb_encrypt(OCB128_CONTEXT
*ctx
, OCB_BLOCK
*in
, OCB_BLOCK
*out
,
186 ctx
->encrypt(locin
.chrblk
, locout
.chrblk
, keyenc
);
190 * Decrypt a block from |in| and store the result in |out|
192 static void ocb_decrypt(OCB128_CONTEXT
*ctx
, OCB_BLOCK
*in
, OCB_BLOCK
*out
,
201 ctx
->decrypt(locin
.chrblk
, locout
.chrblk
, keydec
);
205 * Create a new OCB128_CONTEXT
207 OCB128_CONTEXT
*CRYPTO_ocb128_new(void *keyenc
, void *keydec
,
208 block128_f encrypt
, block128_f decrypt
)
210 OCB128_CONTEXT
*octx
;
213 if ((octx
= (OCB128_CONTEXT
*)OPENSSL_malloc(sizeof(OCB128_CONTEXT
)))) {
214 ret
= CRYPTO_ocb128_init(octx
, keyenc
, keydec
, encrypt
, decrypt
);
224 * Initialise an existing OCB128_CONTEXT
226 int CRYPTO_ocb128_init(OCB128_CONTEXT
*ctx
, void *keyenc
, void *keydec
,
227 block128_f encrypt
, block128_f decrypt
)
229 /* Clear everything to NULLs */
230 memset(ctx
, 0, sizeof(*ctx
));
233 ctx
->max_l_index
= 1;
234 ctx
->l
= OPENSSL_malloc(ctx
->max_l_index
* 16);
239 * We set both the encryption and decryption key schedules - decryption
240 * needs both. Don't really need decryption schedule if only doing
241 * encryption - but it simplifies things to take it anyway
243 ctx
->encrypt
= encrypt
;
244 ctx
->decrypt
= decrypt
;
245 ctx
->keyenc
= keyenc
;
246 ctx
->keydec
= keydec
;
248 /* L_* = ENCIPHER(K, zeros(128)) */
249 ocb_encrypt(ctx
, &ctx
->l_star
, &ctx
->l_star
, ctx
->keyenc
);
251 /* L_$ = double(L_*) */
252 ocb_double(&ctx
->l_star
, &ctx
->l_dollar
);
254 /* L_0 = double(L_$) */
255 ocb_double(&ctx
->l_dollar
, ctx
->l
);
261 * Copy an OCB128_CONTEXT object
263 int CRYPTO_ocb128_copy_ctx(OCB128_CONTEXT
*dest
, OCB128_CONTEXT
*src
,
264 void *keyenc
, void *keydec
)
266 memcpy(dest
, src
, sizeof(OCB128_CONTEXT
));
268 dest
->keyenc
= keyenc
;
270 dest
->keydec
= keydec
;
272 dest
->l
= OPENSSL_malloc(src
->max_l_index
* 16);
275 memcpy(dest
->l
, src
->l
, (src
->l_index
+ 1) * 16);
281 * Set the IV to be used for this operation. Must be 1 - 15 bytes.
283 int CRYPTO_ocb128_setiv(OCB128_CONTEXT
*ctx
, const unsigned char *iv
,
284 size_t len
, size_t taglen
)
286 unsigned char ktop
[16], tmp
[16], mask
;
287 unsigned char stretch
[24], nonce
[16];
288 size_t bottom
, shift
;
291 offset
.ocbblk
= &ctx
->offset
;
294 * Spec says IV is 120 bits or fewer - it allows non byte aligned lengths.
295 * We don't support this at this stage
297 if ((len
> 15) || (len
< 1) || (taglen
> 16) || (taglen
< 1)) {
301 /* Nonce = num2str(TAGLEN mod 128,7) || zeros(120-bitlen(N)) || 1 || N */
302 nonce
[0] = ((taglen
* 8) % 128) << 1;
303 memset(nonce
+ 1, 0, 15);
304 memcpy(nonce
+ 16 - len
, iv
, len
);
305 nonce
[15 - len
] |= 1;
307 /* Ktop = ENCIPHER(K, Nonce[1..122] || zeros(6)) */
308 memcpy(tmp
, nonce
, 16);
310 ctx
->encrypt(tmp
, ktop
, ctx
->keyenc
);
312 /* Stretch = Ktop || (Ktop[1..64] xor Ktop[9..72]) */
313 memcpy(stretch
, ktop
, 16);
314 ocb_block_xor(ktop
, ktop
+ 1, 8, stretch
+ 16);
316 /* bottom = str2num(Nonce[123..128]) */
317 bottom
= nonce
[15] & 0x3f;
319 /* Offset_0 = Stretch[1+bottom..128+bottom] */
321 ocb_block_lshift((OCB_BLOCK
*)(stretch
+ (bottom
/ 8)), shift
,
326 (*(stretch
+ (bottom
/ 8) + 16) & mask
) >> (8 - shift
);
332 * Provide any AAD. This can be called multiple times. Only the final time can
333 * have a partial block
335 int CRYPTO_ocb128_aad(OCB128_CONTEXT
*ctx
, const unsigned char *aad
,
338 u64 all_num_blocks
, num_blocks
;
344 /* Calculate the number of blocks of AAD provided now, and so far */
345 num_blocks
= len
/ 16;
346 all_num_blocks
= num_blocks
+ ctx
->blocks_hashed
;
348 /* Loop through all full blocks of AAD */
349 for (i
= ctx
->blocks_hashed
+ 1; i
<= all_num_blocks
; i
++) {
351 OCB_BLOCK
*aad_block
;
353 /* Offset_i = Offset_{i-1} xor L_{ntz(i)} */
354 lookup
= ocb_lookup_l(ctx
, ocb_ntz(i
));
357 ocb_block16_xor(&ctx
->offset_aad
, lookup
, &ctx
->offset_aad
);
359 /* Sum_i = Sum_{i-1} xor ENCIPHER(K, A_i xor Offset_i) */
360 aad_block
= (OCB_BLOCK
*)(aad
+ ((i
- ctx
->blocks_hashed
- 1) * 16));
361 ocb_block16_xor(&ctx
->offset_aad
, aad_block
, &tmp1
);
362 ocb_encrypt(ctx
, &tmp1
, &tmp2
, ctx
->keyenc
);
363 ocb_block16_xor(&ctx
->sum
, &tmp2
, &ctx
->sum
);
367 * Check if we have any partial blocks left over. This is only valid in the
368 * last call to this function
373 /* Offset_* = Offset_m xor L_* */
374 ocb_block16_xor(&ctx
->offset_aad
, &ctx
->l_star
, &ctx
->offset_aad
);
376 /* CipherInput = (A_* || 1 || zeros(127-bitlen(A_*))) xor Offset_* */
377 memset((void *)&tmp1
, 0, 16);
378 memcpy((void *)&tmp1
, aad
+ (num_blocks
* 16), last_len
);
379 ((unsigned char *)&tmp1
)[last_len
] = 0x80;
380 ocb_block16_xor(&ctx
->offset_aad
, &tmp1
, &tmp2
);
382 /* Sum = Sum_m xor ENCIPHER(K, CipherInput) */
383 ocb_encrypt(ctx
, &tmp2
, &tmp1
, ctx
->keyenc
);
384 ocb_block16_xor(&ctx
->sum
, &tmp1
, &ctx
->sum
);
387 ctx
->blocks_hashed
= all_num_blocks
;
393 * Provide any data to be encrypted. This can be called multiple times. Only
394 * the final time can have a partial block
396 int CRYPTO_ocb128_encrypt(OCB128_CONTEXT
*ctx
,
397 const unsigned char *in
, unsigned char *out
,
401 u64 all_num_blocks
, num_blocks
;
408 * Calculate the number of blocks of data to be encrypted provided now, and
411 num_blocks
= len
/ 16;
412 all_num_blocks
= num_blocks
+ ctx
->blocks_processed
;
414 /* Loop through all full blocks to be encrypted */
415 for (i
= ctx
->blocks_processed
+ 1; i
<= all_num_blocks
; i
++) {
420 /* Offset_i = Offset_{i-1} xor L_{ntz(i)} */
421 lookup
= ocb_lookup_l(ctx
, ocb_ntz(i
));
424 ocb_block16_xor(&ctx
->offset
, lookup
, &ctx
->offset
);
426 /* C_i = Offset_i xor ENCIPHER(K, P_i xor Offset_i) */
427 inblock
= (OCB_BLOCK
*)(in
+ ((i
- ctx
->blocks_processed
- 1) * 16));
428 ocb_block16_xor(&ctx
->offset
, inblock
, &tmp1
);
429 ocb_encrypt(ctx
, &tmp1
, &tmp2
, ctx
->keyenc
);
431 (OCB_BLOCK
*)(out
+ ((i
- ctx
->blocks_processed
- 1) * 16));
432 ocb_block16_xor(&ctx
->offset
, &tmp2
, outblock
);
434 /* Checksum_i = Checksum_{i-1} xor P_i */
435 ocb_block16_xor(&ctx
->checksum
, inblock
, &ctx
->checksum
);
439 * Check if we have any partial blocks left over. This is only valid in the
440 * last call to this function
445 /* Offset_* = Offset_m xor L_* */
446 ocb_block16_xor(&ctx
->offset
, &ctx
->l_star
, &ctx
->offset
);
448 /* Pad = ENCIPHER(K, Offset_*) */
449 ocb_encrypt(ctx
, &ctx
->offset
, &pad
, ctx
->keyenc
);
451 /* C_* = P_* xor Pad[1..bitlen(P_*)] */
452 ocb_block_xor(in
+ (len
/ 16) * 16, (unsigned char *)&pad
, last_len
,
453 out
+ (num_blocks
* 16));
455 /* Checksum_* = Checksum_m xor (P_* || 1 || zeros(127-bitlen(P_*))) */
456 memset((void *)&tmp1
, 0, 16);
457 memcpy((void *)&tmp1
, in
+ (len
/ 16) * 16, last_len
);
458 ((unsigned char *)(&tmp1
))[last_len
] = 0x80;
459 ocb_block16_xor(&ctx
->checksum
, &tmp1
, &ctx
->checksum
);
462 ctx
->blocks_processed
= all_num_blocks
;
468 * Provide any data to be decrypted. This can be called multiple times. Only
469 * the final time can have a partial block
471 int CRYPTO_ocb128_decrypt(OCB128_CONTEXT
*ctx
,
472 const unsigned char *in
, unsigned char *out
,
476 u64 all_num_blocks
, num_blocks
;
482 * Calculate the number of blocks of data to be decrypted provided now, and
485 num_blocks
= len
/ 16;
486 all_num_blocks
= num_blocks
+ ctx
->blocks_processed
;
488 /* Loop through all full blocks to be decrypted */
489 for (i
= ctx
->blocks_processed
+ 1; i
<= all_num_blocks
; i
++) {
493 /* Offset_i = Offset_{i-1} xor L_{ntz(i)} */
494 OCB_BLOCK
*lookup
= ocb_lookup_l(ctx
, ocb_ntz(i
));
497 ocb_block16_xor(&ctx
->offset
, lookup
, &ctx
->offset
);
499 /* P_i = Offset_i xor DECIPHER(K, C_i xor Offset_i) */
500 inblock
= (OCB_BLOCK
*)(in
+ ((i
- ctx
->blocks_processed
- 1) * 16));
501 ocb_block16_xor(&ctx
->offset
, inblock
, &tmp1
);
502 ocb_decrypt(ctx
, &tmp1
, &tmp2
, ctx
->keydec
);
504 (OCB_BLOCK
*)(out
+ ((i
- ctx
->blocks_processed
- 1) * 16));
505 ocb_block16_xor(&ctx
->offset
, &tmp2
, outblock
);
507 /* Checksum_i = Checksum_{i-1} xor P_i */
508 ocb_block16_xor(&ctx
->checksum
, outblock
, &ctx
->checksum
);
512 * Check if we have any partial blocks left over. This is only valid in the
513 * last call to this function
518 /* Offset_* = Offset_m xor L_* */
519 ocb_block16_xor(&ctx
->offset
, &ctx
->l_star
, &ctx
->offset
);
521 /* Pad = ENCIPHER(K, Offset_*) */
522 ocb_encrypt(ctx
, &ctx
->offset
, &pad
, ctx
->keyenc
);
524 /* P_* = C_* xor Pad[1..bitlen(C_*)] */
525 ocb_block_xor(in
+ (len
/ 16) * 16, (unsigned char *)&pad
, last_len
,
526 out
+ (num_blocks
* 16));
528 /* Checksum_* = Checksum_m xor (P_* || 1 || zeros(127-bitlen(P_*))) */
529 memset((void *)&tmp1
, 0, 16);
530 memcpy((void *)&tmp1
, out
+ (len
/ 16) * 16, last_len
);
531 ((unsigned char *)(&tmp1
))[last_len
] = 0x80;
532 ocb_block16_xor(&ctx
->checksum
, &tmp1
, &ctx
->checksum
);
535 ctx
->blocks_processed
= all_num_blocks
;
541 * Calculate the tag and verify it against the supplied tag
543 int CRYPTO_ocb128_finish(OCB128_CONTEXT
*ctx
, const unsigned char *tag
,
546 OCB_BLOCK tmp1
, tmp2
;
549 * Tag = ENCIPHER(K, Checksum_* xor Offset_* xor L_$) xor HASH(K,A)
551 ocb_block16_xor(&ctx
->checksum
, &ctx
->offset
, &tmp1
);
552 ocb_block16_xor(&tmp1
, &ctx
->l_dollar
, &tmp2
);
553 ocb_encrypt(ctx
, &tmp2
, &tmp1
, ctx
->keyenc
);
554 ocb_block16_xor(&tmp1
, &ctx
->sum
, &ctx
->tag
);
556 if (len
> 16 || len
< 1) {
560 /* Compare the tag if we've been given one */
562 return CRYPTO_memcmp(&ctx
->tag
, tag
, len
);
568 * Retrieve the calculated tag
570 int CRYPTO_ocb128_tag(OCB128_CONTEXT
*ctx
, unsigned char *tag
, size_t len
)
572 if (len
> 16 || len
< 1) {
576 /* Calculate the tag */
577 CRYPTO_ocb128_finish(ctx
, NULL
, 0);
579 /* Copy the tag into the supplied buffer */
580 memcpy(tag
, &ctx
->tag
, len
);
586 * Release all resources
588 void CRYPTO_ocb128_cleanup(OCB128_CONTEXT
*ctx
)
592 OPENSSL_cleanse(ctx
->l
, ctx
->max_l_index
* 16);
593 OPENSSL_free(ctx
->l
);
595 OPENSSL_cleanse(ctx
, sizeof(*ctx
));
599 #endif /* OPENSSL_NO_OCB */