camellia.h File Reference

Camellia block cipher. More...

#include "config.h"
#include <stddef.h>
#include <stdint.h>

Include dependency graph for camellia.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	mbedtls_camellia_context
	CAMELLIA context structure. More...

Macros
#define	MBEDTLS_CAMELLIA_ENCRYPT   1
#define	MBEDTLS_CAMELLIA_DECRYPT   0
#define	MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH   -0x0024
#define	MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH   -0x0026

Functions
void	mbedtls_camellia_init (mbedtls_camellia_context *ctx)
	Initialize CAMELLIA context. More...
void	mbedtls_camellia_free (mbedtls_camellia_context *ctx)
	Clear CAMELLIA context. More...
int	mbedtls_camellia_setkey_enc (mbedtls_camellia_context *ctx, const unsigned char *key, unsigned int keybits)
	CAMELLIA key schedule (encryption) More...
int	mbedtls_camellia_setkey_dec (mbedtls_camellia_context *ctx, const unsigned char *key, unsigned int keybits)
	CAMELLIA key schedule (decryption) More...
int	mbedtls_camellia_crypt_ecb (mbedtls_camellia_context *ctx, int mode, const unsigned char input[16], unsigned char output[16])
	CAMELLIA-ECB block encryption/decryption. More...
int	mbedtls_camellia_crypt_cbc (mbedtls_camellia_context *ctx, int mode, size_t length, unsigned char iv[16], const unsigned char *input, unsigned char *output)
	CAMELLIA-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes) More...
int	mbedtls_camellia_crypt_cfb128 (mbedtls_camellia_context *ctx, int mode, size_t length, size_t *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)
	CAMELLIA-CFB128 buffer encryption/decryption. More...
int	mbedtls_camellia_crypt_ctr (mbedtls_camellia_context *ctx, size_t length, size_t *nc_off, unsigned char nonce_counter[16], unsigned char stream_block[16], const unsigned char *input, unsigned char *output)
	CAMELLIA-CTR buffer encryption/decryption. More...
int	mbedtls_camellia_self_test (int verbose)
	Checkup routine. More...

Detailed Description

Camellia block cipher.

Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This file is part of mbed TLS (https://tls.mbed.org)

Macro Definition Documentation

MBEDTLS_CAMELLIA_DECRYPT

#define MBEDTLS_CAMELLIA_DECRYPT   0

MBEDTLS_CAMELLIA_ENCRYPT

#define MBEDTLS_CAMELLIA_ENCRYPT   1

MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH

#define MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH   -0x0026

Invalid data input length.

MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH

#define MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH   -0x0024

Invalid key length.

Function Documentation

mbedtls_camellia_crypt_cbc()

int mbedtls_camellia_crypt_cbc	(	mbedtls_camellia_context *	ctx,
		int	mode,
		size_t	length,
		unsigned char	iv[16],
		const unsigned char *	input,
		unsigned char *	output
	)

CAMELLIA-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes)

Note

Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.

Parameters

ctx	CAMELLIA context
mode	MBEDTLS_CAMELLIA_ENCRYPT or MBEDTLS_CAMELLIA_DECRYPT
length	length of the input data
iv	initialization vector (updated after use)
input	buffer holding the input data
output	buffer holding the output data

Returns

0 if successful, or MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_crypt_cfb128()

int mbedtls_camellia_crypt_cfb128	(	mbedtls_camellia_context *	ctx,
		int	mode,
		size_t	length,
		size_t *	iv_off,
		unsigned char	iv[16],
		const unsigned char *	input,
		unsigned char *	output
	)

CAMELLIA-CFB128 buffer encryption/decryption.

Note: Due to the nature of CFB you should use the same key schedule for both encryption and decryption. So a context initialized with mbedtls_camellia_setkey_enc() for both MBEDTLS_CAMELLIA_ENCRYPT and CAMELLIE_DECRYPT.

Note

Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.

Parameters

ctx	CAMELLIA context
mode	MBEDTLS_CAMELLIA_ENCRYPT or MBEDTLS_CAMELLIA_DECRYPT
length	length of the input data
iv_off	offset in IV (updated after use)
iv	initialization vector (updated after use)
input	buffer holding the input data
output	buffer holding the output data

Returns

0 if successful, or MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_crypt_ctr()

int mbedtls_camellia_crypt_ctr	(	mbedtls_camellia_context *	ctx,
		size_t	length,
		size_t *	nc_off,
		unsigned char	nonce_counter[16],
		unsigned char	stream_block[16],
		const unsigned char *	input,
		unsigned char *	output
	)

CAMELLIA-CTR buffer encryption/decryption.

Warning: You have to keep the maximum use of your counter in mind!

Note: Due to the nature of CTR you should use the same key schedule for both encryption and decryption. So a context initialized with mbedtls_camellia_setkey_enc() for both MBEDTLS_CAMELLIA_ENCRYPT and MBEDTLS_CAMELLIA_DECRYPT.

Parameters

ctx	CAMELLIA context
length	The length of the data
nc_off	The offset in the current stream_block (for resuming within current cipher stream). The offset pointer to should be 0 at the start of a stream.
nonce_counter	The 128-bit nonce and counter.
stream_block	The saved stream-block for resuming. Is overwritten by the function.
input	The input data stream
output	The output data stream

Returns

0 if successful

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_crypt_ecb()

int mbedtls_camellia_crypt_ecb	(	mbedtls_camellia_context *	ctx,
		int	mode,
		const unsigned char	input[16],
		unsigned char	output[16]
	)

CAMELLIA-ECB block encryption/decryption.

Parameters

ctx	CAMELLIA context
mode	MBEDTLS_CAMELLIA_ENCRYPT or MBEDTLS_CAMELLIA_DECRYPT
input	16-byte input block
output	16-byte output block

Returns

0 if successful

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_free()

void mbedtls_camellia_free

(

mbedtls_camellia_context *

ctx

)

Clear CAMELLIA context.

Parameters

ctx	CAMELLIA context to be cleared

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_init()

void mbedtls_camellia_init

(

mbedtls_camellia_context *

ctx

)

Initialize CAMELLIA context.

Parameters

ctx	CAMELLIA context to be initialized

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_self_test()

int mbedtls_camellia_self_test

(

int

verbose

)

Checkup routine.

Returns

0 if successful, or 1 if the test failed

Here is the call graph for this function:

mbedtls_camellia_setkey_dec()

int mbedtls_camellia_setkey_dec	(	mbedtls_camellia_context *	ctx,
		const unsigned char *	key,
		unsigned int	keybits
	)

CAMELLIA key schedule (decryption)

Parameters

ctx	CAMELLIA context to be initialized
key	decryption key
keybits	must be 128, 192 or 256

Returns

0 if successful, or MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_camellia_setkey_enc()

int mbedtls_camellia_setkey_enc	(	mbedtls_camellia_context *	ctx,
		const unsigned char *	key,
		unsigned int	keybits
	)

CAMELLIA key schedule (encryption)

Parameters

ctx	CAMELLIA context to be initialized
key	encryption key
keybits	must be 128, 192 or 256

Returns

0 if successful, or MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function: