sha2.h File Reference

SHA-224 and SHA-256 cryptographic hash function. More...

Data Structures
struct	sha2_context
	SHA-256 context structure. More...

Macros
#define	POLARSSL_ERR_SHA2_FILE_IO_ERROR   -0x0078
	Read/write error in file. More...

Functions
void	sha2_starts (sha2_context *ctx, int is224)
	SHA-256 context setup. More...
void	sha2_update (sha2_context *ctx, unsigned char *input, size_t ilen)
	SHA-256 process buffer. More...
void	sha2_finish (sha2_context *ctx, unsigned char output[32])
	SHA-256 final digest. More...
void	sha2 (unsigned char *input, size_t ilen, unsigned char output[32], int is224)
	Output = SHA-256( input buffer ) More...
int	sha2_file (char *path, unsigned char output[32], int is224)
	Output = SHA-256( file contents ) More...
void	sha2_hmac_starts (sha2_context *ctx, unsigned char *key, size_t keylen, int is224)
	SHA-256 HMAC context setup. More...
void	sha2_hmac_update (sha2_context *ctx, unsigned char *input, size_t ilen)
	SHA-256 HMAC process buffer. More...
void	sha2_hmac_finish (sha2_context *ctx, unsigned char output[32])
	SHA-256 HMAC final digest. More...
void	sha2_hmac_reset (sha2_context *ctx)
	SHA-256 HMAC context reset. More...
void	sha2_hmac (unsigned char *key, size_t keylen, unsigned char *input, size_t ilen, unsigned char output[32], int is224)
	Output = HMAC-SHA-256( hmac key, input buffer ) More...
int	sha2_self_test (int verbose)
	Checkup routine. More...

Detailed Description

SHA-224 and SHA-256 cryptographic hash function.

Copyright (C) 2006-2010, Brainspark B.V.

This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

All rights reserved.

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.

Macro Definition Documentation

#define POLARSSL_ERR_SHA2_FILE_IO_ERROR   -0x0078

Read/write error in file.

Function Documentation

void sha2	(	unsigned char *	input,
		size_t	ilen,
		unsigned char	output[32],
		int	is224
	)

Output = SHA-256( input buffer )

Parameters

input	buffer holding the data
ilen	length of the input data
output	SHA-224/256 checksum result
is224	0 = use SHA256, 1 = use SHA224

int sha2_file	(	char *	path,
		unsigned char	output[32],
		int	is224
	)

Output = SHA-256( file contents )

Parameters

path	input file name
output	SHA-224/256 checksum result
is224	0 = use SHA256, 1 = use SHA224

Returns

0 if successful, or POLARSSL_ERR_SHA2_FILE_IO_ERROR

void sha2_finish	(	sha2_context *	ctx,
		unsigned char	output[32]
	)

SHA-256 final digest.

Parameters

ctx	SHA-256 context
output	SHA-224/256 checksum result

void sha2_hmac	(	unsigned char *	key,
		size_t	keylen,
		unsigned char *	input,
		size_t	ilen,
		unsigned char	output[32],
		int	is224
	)

Output = HMAC-SHA-256( hmac key, input buffer )

Parameters

key	HMAC secret key
keylen	length of the HMAC key
input	buffer holding the data
ilen	length of the input data
output	HMAC-SHA-224/256 result
is224	0 = use SHA256, 1 = use SHA224

void sha2_hmac_finish	(	sha2_context *	ctx,
		unsigned char	output[32]
	)

SHA-256 HMAC final digest.

Parameters

ctx	HMAC context
output	SHA-224/256 HMAC checksum result

void sha2_hmac_reset

(

sha2_context *

ctx

)

SHA-256 HMAC context reset.

Parameters

ctx	HMAC context to be reset

void sha2_hmac_starts	(	sha2_context *	ctx,
		unsigned char *	key,
		size_t	keylen,
		int	is224
	)

SHA-256 HMAC context setup.

Parameters

ctx	HMAC context to be initialized
key	HMAC secret key
keylen	length of the HMAC key
is224	0 = use SHA256, 1 = use SHA224

void sha2_hmac_update	(	sha2_context *	ctx,
		unsigned char *	input,
		size_t	ilen
	)

SHA-256 HMAC process buffer.

Parameters

ctx	HMAC context
input	buffer holding the data
ilen	length of the input data

int sha2_self_test

(

int

verbose

)

Checkup routine.

Returns

0 if successful, or 1 if the test failed

void sha2_starts	(	sha2_context *	ctx,
		int	is224
	)

SHA-256 context setup.

Parameters

ctx	context to be initialized
is224	0 = use SHA256, 1 = use SHA224

void sha2_update	(	sha2_context *	ctx,
		unsigned char *	input,
		size_t	ilen
	)

SHA-256 process buffer.

Parameters

ctx	SHA-256 context
input	buffer holding the data
ilen	length of the input data