blowfish.h File Reference

Blowfish block cipher. More...

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

Include dependency graph for blowfish.h:

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

Go to the source code of this file.

Classes
struct	mbedtls_blowfish_context
	Blowfish context structure. More...

Macros
#define	MBEDTLS_BLOWFISH_ENCRYPT   1
#define	MBEDTLS_BLOWFISH_DECRYPT   0
#define	MBEDTLS_BLOWFISH_MAX_KEY_BITS   448
#define	MBEDTLS_BLOWFISH_MIN_KEY_BITS   32
#define	MBEDTLS_BLOWFISH_ROUNDS   16
#define	MBEDTLS_BLOWFISH_BLOCKSIZE   8 /* Blowfish uses 64 bit blocks */
#define	MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH   -0x0016
#define	MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH   -0x0018

Functions
void	mbedtls_blowfish_init (mbedtls_blowfish_context *ctx)
	Initialize Blowfish context. More...
void	mbedtls_blowfish_free (mbedtls_blowfish_context *ctx)
	Clear Blowfish context. More...
int	mbedtls_blowfish_setkey (mbedtls_blowfish_context *ctx, const unsigned char *key, unsigned int keybits)
	Blowfish key schedule. More...
int	mbedtls_blowfish_crypt_ecb (mbedtls_blowfish_context *ctx, int mode, const unsigned char input[MBEDTLS_BLOWFISH_BLOCKSIZE], unsigned char output[MBEDTLS_BLOWFISH_BLOCKSIZE])
	Blowfish-ECB block encryption/decryption. More...
int	mbedtls_blowfish_crypt_cbc (mbedtls_blowfish_context *ctx, int mode, size_t length, unsigned char iv[MBEDTLS_BLOWFISH_BLOCKSIZE], const unsigned char *input, unsigned char *output)
	Blowfish-CBC buffer encryption/decryption Length should be a multiple of the block size (8 bytes) More...
int	mbedtls_blowfish_crypt_cfb64 (mbedtls_blowfish_context *ctx, int mode, size_t length, size_t *iv_off, unsigned char iv[MBEDTLS_BLOWFISH_BLOCKSIZE], const unsigned char *input, unsigned char *output)
	Blowfish CFB buffer encryption/decryption. More...
int	mbedtls_blowfish_crypt_ctr (mbedtls_blowfish_context *ctx, size_t length, size_t *nc_off, unsigned char nonce_counter[MBEDTLS_BLOWFISH_BLOCKSIZE], unsigned char stream_block[MBEDTLS_BLOWFISH_BLOCKSIZE], const unsigned char *input, unsigned char *output)
	Blowfish-CTR buffer encryption/decryption. More...

Detailed Description

Blowfish 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_BLOWFISH_BLOCKSIZE

#define MBEDTLS_BLOWFISH_BLOCKSIZE   8 /* Blowfish uses 64 bit blocks */

MBEDTLS_BLOWFISH_DECRYPT

#define MBEDTLS_BLOWFISH_DECRYPT   0

MBEDTLS_BLOWFISH_ENCRYPT

#define MBEDTLS_BLOWFISH_ENCRYPT   1

MBEDTLS_BLOWFISH_MAX_KEY_BITS

#define MBEDTLS_BLOWFISH_MAX_KEY_BITS   448

MBEDTLS_BLOWFISH_MIN_KEY_BITS

#define MBEDTLS_BLOWFISH_MIN_KEY_BITS   32

MBEDTLS_BLOWFISH_ROUNDS

#define MBEDTLS_BLOWFISH_ROUNDS   16

Rounds to use. When increasing this value, make sure to extend the initialisation vectors

MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH

#define MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH   -0x0018

Invalid data input length.

MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH

#define MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH   -0x0016

Invalid key length.

Function Documentation

mbedtls_blowfish_crypt_cbc()

int mbedtls_blowfish_crypt_cbc	(	mbedtls_blowfish_context *	ctx,
		int	mode,
		size_t	length,
		unsigned char	iv[MBEDTLS_BLOWFISH_BLOCKSIZE],
		const unsigned char *	input,
		unsigned char *	output
	)

Blowfish-CBC buffer encryption/decryption Length should be a multiple of the block size (8 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	Blowfish context
mode	MBEDTLS_BLOWFISH_ENCRYPT or MBEDTLS_BLOWFISH_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_BLOWFISH_INVALID_INPUT_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_blowfish_crypt_cfb64()

int mbedtls_blowfish_crypt_cfb64	(	mbedtls_blowfish_context *	ctx,
		int	mode,
		size_t	length,
		size_t *	iv_off,
		unsigned char	iv[MBEDTLS_BLOWFISH_BLOCKSIZE],
		const unsigned char *	input,
		unsigned char *	output
	)

Blowfish CFB buffer encryption/decryption.

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	Blowfish context
mode	MBEDTLS_BLOWFISH_ENCRYPT or MBEDTLS_BLOWFISH_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

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_blowfish_crypt_ctr()

int mbedtls_blowfish_crypt_ctr	(	mbedtls_blowfish_context *	ctx,
		size_t	length,
		size_t *	nc_off,
		unsigned char	nonce_counter[MBEDTLS_BLOWFISH_BLOCKSIZE],
		unsigned char	stream_block[MBEDTLS_BLOWFISH_BLOCKSIZE],
		const unsigned char *	input,
		unsigned char *	output
	)

Blowfish-CTR buffer encryption/decryption.

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

Parameters

ctx	Blowfish 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 64-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_blowfish_crypt_ecb()

int mbedtls_blowfish_crypt_ecb	(	mbedtls_blowfish_context *	ctx,
		int	mode,
		const unsigned char	input[MBEDTLS_BLOWFISH_BLOCKSIZE],
		unsigned char	output[MBEDTLS_BLOWFISH_BLOCKSIZE]
	)

Blowfish-ECB block encryption/decryption.

Parameters

ctx	Blowfish context
mode	MBEDTLS_BLOWFISH_ENCRYPT or MBEDTLS_BLOWFISH_DECRYPT
input	8-byte input block
output	8-byte output block

Returns

0 if successful

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_blowfish_free()

void mbedtls_blowfish_free

(

mbedtls_blowfish_context *

ctx

)

Clear Blowfish context.

Parameters

ctx	Blowfish context to be cleared

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_blowfish_init()

void mbedtls_blowfish_init

(

mbedtls_blowfish_context *

ctx

)

Initialize Blowfish context.

Parameters

ctx	Blowfish context to be initialized

Here is the call graph for this function:

Here is the caller graph for this function:

mbedtls_blowfish_setkey()

int mbedtls_blowfish_setkey	(	mbedtls_blowfish_context *	ctx,
		const unsigned char *	key,
		unsigned int	keybits
	)

Blowfish key schedule.

Parameters

ctx	Blowfish context to be initialized
key	encryption key
keybits	must be between 32 and 448 bits

Returns

0 if successful, or MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH

Here is the call graph for this function:

Here is the caller graph for this function: