mbed TLS v1.3.21
Data Structures | Macros | Functions
blowfish.h File Reference

Blowfish block cipher. More...

#include "config.h"
#include <stddef.h>
#include <inttypes.h>
Include dependency graph for blowfish.h:

Go to the source code of this file.

Data Structures

struct  blowfish_context
 Blowfish context structure. More...
 

Macros

#define BLOWFISH_ENCRYPT   1
 
#define BLOWFISH_DECRYPT   0
 
#define BLOWFISH_MAX_KEY   448
 
#define BLOWFISH_MIN_KEY   32
 
#define BLOWFISH_ROUNDS   16
 Rounds to use. More...
 
#define BLOWFISH_BLOCKSIZE   8 /* Blowfish uses 64 bit blocks */
 
#define POLARSSL_ERR_BLOWFISH_INVALID_KEY_LENGTH   -0x0016
 Invalid key length. More...
 
#define POLARSSL_ERR_BLOWFISH_INVALID_INPUT_LENGTH   -0x0018
 Invalid data input length. More...
 

Functions

void blowfish_init (blowfish_context *ctx)
 Initialize Blowfish context. More...
 
void blowfish_free (blowfish_context *ctx)
 Clear Blowfish context. More...
 
int blowfish_setkey (blowfish_context *ctx, const unsigned char *key, unsigned int keysize)
 Blowfish key schedule. More...
 
int blowfish_crypt_ecb (blowfish_context *ctx, int mode, const unsigned char input[BLOWFISH_BLOCKSIZE], unsigned char output[BLOWFISH_BLOCKSIZE])
 Blowfish-ECB block encryption/decryption. More...
 
int blowfish_crypt_cbc (blowfish_context *ctx, int mode, size_t length, unsigned char iv[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 blowfish_crypt_cfb64 (blowfish_context *ctx, int mode, size_t length, size_t *iv_off, unsigned char iv[BLOWFISH_BLOCKSIZE], const unsigned char *input, unsigned char *output)
 Blowfish CFB buffer encryption/decryption. More...
 
int blowfish_crypt_ctr (blowfish_context *ctx, size_t length, size_t *nc_off, unsigned char nonce_counter[BLOWFISH_BLOCKSIZE], unsigned char stream_block[BLOWFISH_BLOCKSIZE], const unsigned char *input, unsigned char *output)
 Blowfish-CTR buffer encryption/decryption. More...
 

Detailed Description

Blowfish block cipher.

Copyright (C) 2012-2014, ARM Limited, All Rights Reserved

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

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file blowfish.h.

Macro Definition Documentation

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

Definition at line 47 of file blowfish.h.

#define BLOWFISH_DECRYPT   0

Definition at line 43 of file blowfish.h.

#define BLOWFISH_ENCRYPT   1

Definition at line 42 of file blowfish.h.

#define BLOWFISH_MAX_KEY   448

Definition at line 44 of file blowfish.h.

#define BLOWFISH_MIN_KEY   32

Definition at line 45 of file blowfish.h.

#define BLOWFISH_ROUNDS   16

Rounds to use.

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

Definition at line 46 of file blowfish.h.

#define POLARSSL_ERR_BLOWFISH_INVALID_INPUT_LENGTH   -0x0018

Invalid data input length.

Definition at line 50 of file blowfish.h.

#define POLARSSL_ERR_BLOWFISH_INVALID_KEY_LENGTH   -0x0016

Invalid key length.

Definition at line 49 of file blowfish.h.

Function Documentation

int blowfish_crypt_cbc ( blowfish_context ctx,
int  mode,
size_t  length,
unsigned char  iv[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
ctxBlowfish context
modeBLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
lengthlength of the input data
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns
0 if successful, or POLARSSL_ERR_BLOWFISH_INVALID_INPUT_LENGTH
int blowfish_crypt_cfb64 ( blowfish_context ctx,
int  mode,
size_t  length,
size_t *  iv_off,
unsigned char  iv[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
ctxBlowfish context
modeBLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
lengthlength of the input data
iv_offoffset in IV (updated after use)
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns
0 if successful
int blowfish_crypt_ctr ( blowfish_context ctx,
size_t  length,
size_t *  nc_off,
unsigned char  nonce_counter[BLOWFISH_BLOCKSIZE],
unsigned char  stream_block[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
ctxBlowfish context
lengthThe length of the data
nc_offThe 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_counterThe 64-bit nonce and counter.
stream_blockThe saved stream-block for resuming. Is overwritten by the function.
inputThe input data stream
outputThe output data stream
Returns
0 if successful
int blowfish_crypt_ecb ( blowfish_context ctx,
int  mode,
const unsigned char  input[BLOWFISH_BLOCKSIZE],
unsigned char  output[BLOWFISH_BLOCKSIZE] 
)

Blowfish-ECB block encryption/decryption.

Parameters
ctxBlowfish context
modeBLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
input8-byte input block
output8-byte output block
Returns
0 if successful
void blowfish_free ( blowfish_context ctx)

Clear Blowfish context.

Parameters
ctxBlowfish context to be cleared
void blowfish_init ( blowfish_context ctx)

Initialize Blowfish context.

Parameters
ctxBlowfish context to be initialized
int blowfish_setkey ( blowfish_context ctx,
const unsigned char *  key,
unsigned int  keysize 
)

Blowfish key schedule.

Parameters
ctxBlowfish context to be initialized
keyencryption key
keysizemust be between 32 and 448 bits
Returns
0 if successful, or POLARSSL_ERR_BLOWFISH_INVALID_KEY_LENGTH