rabbit.h
Go to the documentation of this file.
1 /* rabbit.h
2  *
3  * Copyright (C) 2006-2020 wolfSSL Inc.
4  *
5  * This file is part of wolfSSL.
6  *
7  * wolfSSL is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * wolfSSL is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
20  */
21 
27 #ifndef WOLF_CRYPT_RABBIT_H
28 #define WOLF_CRYPT_RABBIT_H
29 
31 
32 #ifndef NO_RABBIT
33 
34 #ifdef __cplusplus
35  extern "C" {
36 #endif
37 
38 
39 enum {
40  RABBIT_ENC_TYPE = 5 /* cipher unique type */
41 };
42 
43 
44 /* Rabbit Context */
45 typedef struct RabbitCtx {
46  word32 x[8];
47  word32 c[8];
48  word32 carry;
49 } RabbitCtx;
50 
51 
52 /* Rabbit stream cipher */
53 typedef struct Rabbit {
54  RabbitCtx masterCtx;
55  RabbitCtx workCtx;
56 #ifdef XSTREAM_ALIGN
57  void* heap; /* heap hint, currently XMALLOC only used with aligning */
58 #endif
59 } Rabbit;
60 
61 
62 WOLFSSL_API int wc_RabbitProcess(Rabbit*, byte*, const byte*, word32);
63 WOLFSSL_API int wc_RabbitSetKey(Rabbit*, const byte* key, const byte* iv);
64 
65 WOLFSSL_LOCAL int wc_Rabbit_SetHeap(Rabbit* ctx, void* heap);
66 
67 #ifdef __cplusplus
68  } /* extern "C" */
69 #endif
70 
71 #endif /* NO_RABBIT */
72 #endif /* WOLF_CRYPT_RABBIT_H */
73 
Definition: rabbit.h:53
WOLFSSL_API int wc_RabbitSetKey(Rabbit *, const byte *key, const byte *iv)
This function initializes a Rabbit context for use with encryption or decryption by setting its iv an...
Definition: rabbit.c:219
WOLFSSL_API int wc_RabbitProcess(Rabbit *, byte *, const byte *, word32)
This function encrypts or decrypts a message of any size, storing the result in output. It requires that the Rabbit ctx structure be initialized with a key and an iv before encryption.
Definition: rabbit.c:310
Definition: rabbit.h:45