X-Git-Url: https://git.cryptolib.org/?p=avr-crypto-lib.git;a=blobdiff_plain;f=arcfour.h;h=9adf28dea63dac08d24af816f84543967a3d6048;hp=23fb458aad26cb272a24806b6166de15c8cfe3b3;hb=5ac75cfae217122b540c1a6d258054230dc534c3;hpb=7c4486d3328c45462fd276916cb94b80b48725fc diff --git a/arcfour.h b/arcfour.h index 23fb458..9adf28d 100644 --- a/arcfour.h +++ b/arcfour.h @@ -16,29 +16,29 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . */ -/* +/* * File: arcfour.h * Author: Daniel Otte * Date: 2006-06-07 * License: GPLv3+ - * Description: Implementation of the ARCFOUR (RC4 compatible) stream cipher algorithm. + * Description: Implementation of the ARCFOUR (RC4 compatible) stream cipher algorithm. */ - -/** + +/** * \file arcfour.h * \author Daniel Otte * \date 2006-06-07 * \license GPLv3+ - * \brief Implementation of the ARCFOUR (RC4 compatible) stream cipher algorithm. - * + * \brief Implementation of the ARCFOUR (RC4 compatible) stream cipher algorithm. + * * This header file defines the interface of the ARCFOUR cipher implementation. - * + * * This implementation aims to be compatible with the ARCFOUR description - * availabe at + * available at * http://www.mozilla.org/projects/security/pki/nss/draft-kaukonen-cipher-arcfour-03.txt */ - - + + #ifndef ARCFOUR_H_ #define ARCFOUR_H_ @@ -46,46 +46,46 @@ /** \typedef arcfour_ctx_t * \brief type for arcfour context - * + * * A variable of this type may contain a complete ARCFOUR context. * The context is used to store the state of the cipher and gets * created by the arcfour_init(arcfour_ctx_t *c, uint8_t *key, uint8_t length_B) * function. The context is of the fixed size of 258 bytes */ - + /** \struct arcfour_ctx_st * \brief base for ::arcfour_ctx_t - * + * * The struct holds the two indices and the S-Box */ typedef struct arcfour_ctx_st { uint8_t i,j; uint8_t s[256]; } arcfour_ctx_t; - + /** \fn void arcfour_init(arcfour_ctx_t *ctx, void *key, uint8_t length_B) * \brief setup a context with a key - * + * * This function sets up a ::arcfour_ctx_t context using * the supplied key of the given length. * \param ctx pointer to the context * \param key pointer to the key * \param length_B length of the key in bytes (between 1 and 255) */ - + void arcfour_init(const void *key, uint8_t length_B, arcfour_ctx_t *ctx); /** \fn uint8_t arcfour_gen(arcfour_ctx_t *ctx) * \brief generates a byte of keystream - * + * * This function generates the next byte of keystream - * from the supplied ::arcfour_ctx_t context which is updated acordingly - * + * from the supplied ::arcfour_ctx_t context which is updated accordingly + * * \param ctx pointer to the context * \return byte of keystream */ - + uint8_t arcfour_gen(arcfour_ctx_t *ctx); #endif