rc4.h
Go to the documentation of this file.
1 /**
2  * @file rc4.h
3  * @brief RC4 encryption algorithm
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.0
29  **/
30 
31 #ifndef _RC4_H
32 #define _RC4_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Common interface for encryption algorithms
38 #define RC4_CIPHER_ALGO (&rc4CipherAlgo)
39 
40 //C++ guard
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 
46 /**
47  * @brief RC4 algorithm context
48  **/
49 
50 typedef struct
51 {
52  uint_t i;
53  uint_t j;
54  uint8_t s[256];
55 } Rc4Context;
56 
57 
58 //RC4 related constants
59 extern const CipherAlgo rc4CipherAlgo;
60 
61 //RC4 related functions
62 error_t rc4Init(Rc4Context *context, const uint8_t *key, size_t length);
63 
64 void rc4Cipher(Rc4Context *context, const uint8_t *input, uint8_t *output,
65  size_t length);
66 
67 void rc4Deinit(Rc4Context *context);
68 
69 //C++ guard
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
uint_t
unsigned int uint_t
Definition: compiler_port.h:50
crypto.h
General definitions for cryptographic algorithms.
error_t
error_t
Error codes.
Definition: error.h:43
s
uint8_t s
Definition: ndp.h:345
rc4Init
error_t rc4Init(Rc4Context *context, const uint8_t *key, size_t length)
Initialize an RC4 context using the supplied key.
Definition: rc4.c:65
rc4Deinit
void rc4Deinit(Rc4Context *context)
Release RC4 context.
Definition: rc4.c:158
rc4CipherAlgo
const CipherAlgo rc4CipherAlgo
Definition: rc4.c:42
rc4Cipher
void rc4Cipher(Rc4Context *context, const uint8_t *input, uint8_t *output, size_t length)
Encrypt/decrypt data with the RC4 algorithm.
Definition: rc4.c:110
CipherAlgo
Common interface for encryption algorithms.
Definition: crypto.h:1036
Rc4Context
RC4 algorithm context.
Definition: rc4.h:51
Rc4Context::i
uint_t i
Definition: rc4.h:52
Rc4Context::j
uint_t j
Definition: rc4.h:53
length
uint8_t length
Definition: tcp.h:368