mbed TLS  Version 2.16.8
SSL/TLS Library for the Embedded Space
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
arc4.h File Reference

Data Structures

struct  mbedtls_arc4_context
 ARC4 context structure. More...
 

Macros

#define MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED   -0x0019
 ARC4 hardware accelerator failed. More...
 

Functions

void mbedtls_arc4_init (mbedtls_arc4_context *ctx)
 Initialize ARC4 context. More...
 
void mbedtls_arc4_free (mbedtls_arc4_context *ctx)
 Clear ARC4 context. More...
 
void mbedtls_arc4_setup (mbedtls_arc4_context *ctx, const unsigned char *key, unsigned int keylen)
 ARC4 key schedule. More...
 
int mbedtls_arc4_crypt (mbedtls_arc4_context *ctx, size_t length, const unsigned char *input, unsigned char *output)
 ARC4 cipher function. More...
 
int mbedtls_arc4_self_test (int verbose)
 Checkup routine. More...
 

Description

The ARCFOUR stream cipher.

Warning
ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead.

Data Structure Documentation

struct mbedtls_arc4_context

ARC4 context structure.

Warning
ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead.
Data Fields
unsigned char m[256]

permutation table

int x

permutation index

int y

permutation index

Macro Definition Documentation

#define MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED   -0x0019

ARC4 hardware accelerator failed.

Function Documentation

int mbedtls_arc4_crypt ( mbedtls_arc4_context ctx,
size_t  length,
const unsigned char *  input,
unsigned char *  output 
)

ARC4 cipher function.

Parameters
ctxARC4 context
lengthlength of the input data
inputbuffer holding the input data
outputbuffer for the output data
Returns
0 if successful
Warning
ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead.
void mbedtls_arc4_free ( mbedtls_arc4_context ctx)

Clear ARC4 context.

Parameters
ctxARC4 context to be cleared
Warning
ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead.
void mbedtls_arc4_init ( mbedtls_arc4_context ctx)

Initialize ARC4 context.

Parameters
ctxARC4 context to be initialized
Warning
ARC4 is considered a weak cipher and its use constitutes a security risk. We recommend considering stronger ciphers instead.
int mbedtls_arc4_self_test ( int  verbose)

Checkup routine.

Returns
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.
void mbedtls_arc4_setup ( mbedtls_arc4_context ctx,
const unsigned char *  key,
unsigned int  keylen 
)

ARC4 key schedule.

Parameters
ctxARC4 context to be setup
keythe secret key
keylenlength 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.