Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

include/polarssl/arc4.h@0:137634ff4186, 2015-06-11 (annotated)

Committer:
ansond
Date:
Thu Jun 11 03:27:03 2015 +0000
Revision:
0:137634ff4186
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:137634ff4186 1 /**
ansond 0:137634ff4186 2 * \file arc4.h
ansond 0:137634ff4186 3 *
ansond 0:137634ff4186 4 * \brief The ARCFOUR stream cipher
ansond 0:137634ff4186 5 *
ansond 0:137634ff4186 6 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
ansond 0:137634ff4186 7 *
ansond 0:137634ff4186 8 * This file is part of mbed TLS (https://tls.mbed.org)
ansond 0:137634ff4186 9 *
ansond 0:137634ff4186 10 * This program is free software; you can redistribute it and/or modify
ansond 0:137634ff4186 11 * it under the terms of the GNU General Public License as published by
ansond 0:137634ff4186 12 * the Free Software Foundation; either version 2 of the License, or
ansond 0:137634ff4186 13 * (at your option) any later version.
ansond 0:137634ff4186 14 *
ansond 0:137634ff4186 15 * This program is distributed in the hope that it will be useful,
ansond 0:137634ff4186 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ansond 0:137634ff4186 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ansond 0:137634ff4186 18 * GNU General Public License for more details.
ansond 0:137634ff4186 19 *
ansond 0:137634ff4186 20 * You should have received a copy of the GNU General Public License along
ansond 0:137634ff4186 21 * with this program; if not, write to the Free Software Foundation, Inc.,
ansond 0:137634ff4186 22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
ansond 0:137634ff4186 23 */
ansond 0:137634ff4186 24 #ifndef POLARSSL_ARC4_H
ansond 0:137634ff4186 25 #define POLARSSL_ARC4_H
ansond 0:137634ff4186 26
ansond 0:137634ff4186 27 #if !defined(POLARSSL_CONFIG_FILE)
ansond 0:137634ff4186 28 #include "config.h"
ansond 0:137634ff4186 29 #else
ansond 0:137634ff4186 30 #include POLARSSL_CONFIG_FILE
ansond 0:137634ff4186 31 #endif
ansond 0:137634ff4186 32
ansond 0:137634ff4186 33 #include <stddef.h>
ansond 0:137634ff4186 34
ansond 0:137634ff4186 35 #if !defined(POLARSSL_ARC4_ALT)
ansond 0:137634ff4186 36 // Regular implementation
ansond 0:137634ff4186 37 //
ansond 0:137634ff4186 38
ansond 0:137634ff4186 39 #ifdef __cplusplus
ansond 0:137634ff4186 40 extern "C" {
ansond 0:137634ff4186 41 #endif
ansond 0:137634ff4186 42
ansond 0:137634ff4186 43 /**
ansond 0:137634ff4186 44 * \brief ARC4 context structure
ansond 0:137634ff4186 45 */
ansond 0:137634ff4186 46 typedef struct
ansond 0:137634ff4186 47 {
ansond 0:137634ff4186 48 int x; /*!< permutation index */
ansond 0:137634ff4186 49 int y; /*!< permutation index */
ansond 0:137634ff4186 50 unsigned char m[256]; /*!< permutation table */
ansond 0:137634ff4186 51 }
ansond 0:137634ff4186 52 arc4_context;
ansond 0:137634ff4186 53
ansond 0:137634ff4186 54 /**
ansond 0:137634ff4186 55 * \brief Initialize ARC4 context
ansond 0:137634ff4186 56 *
ansond 0:137634ff4186 57 * \param ctx ARC4 context to be initialized
ansond 0:137634ff4186 58 */
ansond 0:137634ff4186 59 void arc4_init( arc4_context *ctx );
ansond 0:137634ff4186 60
ansond 0:137634ff4186 61 /**
ansond 0:137634ff4186 62 * \brief Clear ARC4 context
ansond 0:137634ff4186 63 *
ansond 0:137634ff4186 64 * \param ctx ARC4 context to be cleared
ansond 0:137634ff4186 65 */
ansond 0:137634ff4186 66 void arc4_free( arc4_context *ctx );
ansond 0:137634ff4186 67
ansond 0:137634ff4186 68 /**
ansond 0:137634ff4186 69 * \brief ARC4 key schedule
ansond 0:137634ff4186 70 *
ansond 0:137634ff4186 71 * \param ctx ARC4 context to be setup
ansond 0:137634ff4186 72 * \param key the secret key
ansond 0:137634ff4186 73 * \param keylen length of the key, in bytes
ansond 0:137634ff4186 74 */
ansond 0:137634ff4186 75 void arc4_setup( arc4_context *ctx, const unsigned char *key,
ansond 0:137634ff4186 76 unsigned int keylen );
ansond 0:137634ff4186 77
ansond 0:137634ff4186 78 /**
ansond 0:137634ff4186 79 * \brief ARC4 cipher function
ansond 0:137634ff4186 80 *
ansond 0:137634ff4186 81 * \param ctx ARC4 context
ansond 0:137634ff4186 82 * \param length length of the input data
ansond 0:137634ff4186 83 * \param input buffer holding the input data
ansond 0:137634ff4186 84 * \param output buffer for the output data
ansond 0:137634ff4186 85 *
ansond 0:137634ff4186 86 * \return 0 if successful
ansond 0:137634ff4186 87 */
ansond 0:137634ff4186 88 int arc4_crypt( arc4_context *ctx, size_t length, const unsigned char *input,
ansond 0:137634ff4186 89 unsigned char *output );
ansond 0:137634ff4186 90
ansond 0:137634ff4186 91 #ifdef __cplusplus
ansond 0:137634ff4186 92 }
ansond 0:137634ff4186 93 #endif
ansond 0:137634ff4186 94
ansond 0:137634ff4186 95 #else /* POLARSSL_ARC4_ALT */
ansond 0:137634ff4186 96 #include "arc4_alt.h"
ansond 0:137634ff4186 97 #endif /* POLARSSL_ARC4_ALT */
ansond 0:137634ff4186 98
ansond 0:137634ff4186 99 #ifdef __cplusplus
ansond 0:137634ff4186 100 extern "C" {
ansond 0:137634ff4186 101 #endif
ansond 0:137634ff4186 102
ansond 0:137634ff4186 103 /**
ansond 0:137634ff4186 104 * \brief Checkup routine
ansond 0:137634ff4186 105 *
ansond 0:137634ff4186 106 * \return 0 if successful, or 1 if the test failed
ansond 0:137634ff4186 107 */
ansond 0:137634ff4186 108 int arc4_self_test( int verbose );
ansond 0:137634ff4186 109
ansond 0:137634ff4186 110 #ifdef __cplusplus
ansond 0:137634ff4186 111 }
ansond 0:137634ff4186 112 #endif
ansond 0:137634ff4186 113
ansond 0:137634ff4186 114 #endif /* arc4.h */
ansond 0:137634ff4186 115