]> git.cryptolib.org Git - avr-crypto-lib.git/blob - noekeon.h
5817d9fcbe3f4daa606d8d387e19150be5afdae3
[avr-crypto-lib.git] / noekeon.h
1 /* noekeon.h */
2 /*
3     This file is part of the Crypto-avr-lib/microcrypt-lib.
4     Copyright (C) 2008  Daniel Otte (daniel.otte@rub.de)
5
6     This program is free software: you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation, either version 3 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19 #ifndef NOEKEON_H_
20 #define NOEKEON_H_
21
22 /**
23  * \author  Daniel Otte
24  * \email   daniel.otte@rub.de
25  * \date    2008-04-11
26  * \license GPLv3
27  * \brief
28  * 
29  * 
30  */
31
32 #include <stdint.h>
33
34 typedef uint8_t noekeon_ctx_t[16];
35
36 /** \fn void noekeon_enc(void* buffer, void* key)
37  * \brief noekeon encrytion funtion
38  * 
39  * This function encrypts a block (64 bit = 8 byte) with the noekeon encrytion
40  * algorithm. Due to the two modes of noekeon (direct mode and indirect mode)
41  * the second parameter either points directly to the key (direct mode) or to a
42  * context generated by the noekeon_init() function (indirect mode)
43  * \param buffer pointer to the 64 bit (8 byte) block to encrypt
44  * \param key    pointer to either the key (128 bit = 16 byte; direct mode) or 
45  * to the context (indirect mode)
46  */
47 void noekeon_enc(void* buffer, const void* key);
48
49 /** \fn void noekeon_enc(void* buffer, void* key)
50  * \brief noekeon encrytion funtion
51  * 
52  * This function decrypts a block (64 bit = 8 byte) encrypted with the noekeon 
53  * encrytion algorithm. Due to the two modes of noekeon (direct mode and 
54  * indirect mode) the second parameter either points directly to the key 
55  * (direct mode) or to a context generated by the noekeon_init() function 
56  * (indirect mode)
57  * \param buffer pointer to the 64 bit (8 byte) block to decrypt
58  * \param key    pointer to either the key (128 bit = 16 byte; direct mode) or 
59  * to the context (indirect mode)
60  */
61 void noekeon_dec(void* buffer, const void* key);
62
63
64 /** \fn void noekeon_init(void* key, noekeon_ctx_t* ctx)
65  * \brief noekeon context generation function for indirect mode
66  * 
67  * This function generates a context from the supplied key for using
68  * noekeon in indirect mode. For using noekeon in direct mode supply the key
69  * direct to the noekeon_enc() and noekeon_dec() functions
70  * \param key pointer to the key (128 bit = 16 byte)
71  * \param ctx pointer to the context to fill with key material 
72  * to the context (indirect mode)
73  */
74 void noekeon_init(const void* key, noekeon_ctx_t* ctx);
75
76 #endif /*NOEKEON_H_*/