Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

stddef.h

#include <stddef.h>
#include 

arc4_alt.h

#include "arc4_alt.h"
#include "arc4_alt.h"

Macros

Marco MBEDTLS_ARC4_H

#define MBEDTLS_ARC4_H


      

Marco MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED

#define MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED                 -25 /**< ARC4 hardware accelerator failed. */
/* MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED is deprecated and should not be used. */

Functions

Func mbedtls_arc4_init

void mbedtls_arc4_init( mbedtls_arc4_context *ctx );
/**
 * \brief          Initialize ARC4 context
 *
 * \param ctx      ARC4 context to be initialized
 *
 * \warning        ARC4 is considered a weak cipher and its use constitutes a
 *                 security risk. We recommend considering stronger ciphers
 *                 instead.
 *
 */

Func mbedtls_arc4_free

void mbedtls_arc4_free( mbedtls_arc4_context *ctx );
/**
 * \brief          Clear ARC4 context
 *
 * \param ctx      ARC4 context to be cleared
 *
 * \warning        ARC4 is considered a weak cipher and its use constitutes a
 *                 security risk. We recommend considering stronger ciphers
 *                 instead.
 *
 */

Func mbedtls_arc4_setup

void mbedtls_arc4_setup( mbedtls_arc4_context *ctx, const unsigned char *key,
                unsigned int keylen );
/**
 * \brief          ARC4 key schedule
 *
 * \param ctx      ARC4 context to be setup
 * \param key      the secret key
 * \param keylen   length of the key, in bytes
 *
 * \warning        ARC4 is considered a weak cipher and its use constitutes a
 *                 security risk. We recommend considering stronger ciphers
 *                 instead.
 *
 */

Func mbedtls_arc4_crypt

int mbedtls_arc4_crypt( mbedtls_arc4_context *ctx, size_t length, const unsigned char *input,
               unsigned char *output );
/**
 * \brief          ARC4 cipher function
 *
 * \param ctx      ARC4 context
 * \param length   length of the input data
 * \param input    buffer holding the input data
 * \param output   buffer for the output data
 *
 * \return         0 if successful
 *
 * \warning        ARC4 is considered a weak cipher and its use constitutes a
 *                 security risk. We recommend considering stronger ciphers
 *                 instead.
 *
 */

Func mbedtls_arc4_self_test

int mbedtls_arc4_self_test( int verbose );
/**
 * \brief          Checkup routine
 *
 * \return         0 if successful, or 1 if the test failed
 *
 * \warning        ARC4 is considered a weak cipher and its use constitutes a
 *                 security risk. We recommend considering stronger ciphers
 *                 instead.
 *
 */

Vars

Consts

Types

Typedefs

Typedef mbedtls_arc4_context;

typedef struct mbedtls_arc4_context
{
   int x;                     /*!< permutation index */
   int y;                     /*!< permutation index */
   unsigned char m[256];      /*!< permutation table */
}
mbedtls_arc4_context;
/**
 * \brief     ARC4 context structure
 *
 * \warning   ARC4 is considered a weak cipher and its use constitutes a
 *            security risk. We recommend considering stronger ciphers instead.
 *
 */