From f518b16f97fd5d1306478a97ae33331e0173e9c5 Mon Sep 17 00:00:00 2001 From: Paul Bakker Date: Thu, 23 Aug 2012 13:03:18 +0000 Subject: [PATCH] - Added PKCS#5 PBKDF2 key derivation function --- ChangeLog | 1 + include/polarssl/config.h | 13 ++ include/polarssl/error.h | 1 + include/polarssl/pbkdf2.h | 73 ++++++++ library/CMakeLists.txt | 1 + library/Makefile | 3 +- library/pbkdf2.c | 215 ++++++++++++++++++++++++ programs/test/selftest.c | 6 + tests/CMakeLists.txt | 1 + tests/Makefile | 7 +- tests/suites/test_suite_pbkdf2.data | 14 ++ tests/suites/test_suite_pbkdf2.function | 39 +++++ 12 files changed, 372 insertions(+), 2 deletions(-) create mode 100644 include/polarssl/pbkdf2.h create mode 100644 library/pbkdf2.c create mode 100644 tests/suites/test_suite_pbkdf2.data create mode 100644 tests/suites/test_suite_pbkdf2.function diff --git a/ChangeLog b/ChangeLog index 39c45afd6c..8292eb6177 100644 --- a/ChangeLog +++ b/ChangeLog @@ -23,6 +23,7 @@ Features * Added Thumb assembly optimizations * Added DEFLATE compression support as per RFC3749 (requires zlib) * Added blowfish algorithm (Generic and cipher layer) + * Added PKCS#5 PBKDF2 key derivation function Changes * Removed redundant POLARSSL_DEBUG_MSG define diff --git a/include/polarssl/config.h b/include/polarssl/config.h index d6d16593d2..c5ac1c56d7 100644 --- a/include/polarssl/config.h +++ b/include/polarssl/config.h @@ -582,6 +582,19 @@ */ #define POLARSSL_PADLOCK_C +/** + * \def POLARSSL_PBKDF2_C + * + * Enable PKCS#5 PBKDF2 key derivation function + * + * Module: library/pbkdf2.c + * + * Requires: POLARSSL_MD_C + * + * This module adds support for the PKCS#5 PBKDF2 key derivation function. +#define POLARSSL_PBKDF2_C + */ + /** * \def POLARSSL_PEM_C * diff --git a/include/polarssl/error.h b/include/polarssl/error.h index 4bad908f5f..96815a73a7 100644 --- a/include/polarssl/error.h +++ b/include/polarssl/error.h @@ -67,6 +67,7 @@ * SHA1 1 0x0076-0x0076 * SHA2 1 0x0078-0x0078 * SHA4 1 0x007A-0x007A + * PBKDF2 1 0x007C-0x007C * * High-level module nr (3 bits - 0x1...-0x8...) * Name ID Nr of Errors diff --git a/include/polarssl/pbkdf2.h b/include/polarssl/pbkdf2.h new file mode 100644 index 0000000000..5a23150bce --- /dev/null +++ b/include/polarssl/pbkdf2.h @@ -0,0 +1,73 @@ +/** + * \file pbkdf2.h + * + * \brief Password-Based Key Derivation Function 2 (from PKCS#5) + * + * \author Mathias Olsson + * + * Copyright (C) 2006-2012, Brainspark B.V. + * + * This file is part of PolarSSL (http://www.polarssl.org) + * Lead Maintainer: Paul Bakker + * + * 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. + */ +#ifndef POLARSSL_PBKDF2_H +#define POLARSSL_PBKDF2_H + +#include + +#include "md.h" + +#define POLARSSL_ERR_PBKDF2_BAD_INPUT_DATA -0x007C /**< Bad input parameters to function. */ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * \brief PKCS#5 PBKDF2 using HMAC + * + * \param ctx Generic HMAC context + * \param password Password to use when generating key + * \param plen Length of password + * \param salt Salt to use when generating key + * \param slen Length of salt + * \param iteration_count Iteration count + * \param key_length Length of generated key + * \param output Generated key. Must be at least as big as key_length + * + * \returns 0 on success, or a PolarSSL error code if verification fails. + */ +int pbkdf2_hmac( md_context_t *ctx, const unsigned char *password, + size_t plen, const unsigned char *salt, size_t slen, + unsigned int iteration_count, + unsigned long key_length, unsigned char *output ); + + +/** + * \brief Checkup routine + * + * \return 0 if successful, or 1 if the test failed + */ +int pbkdf2_self_test( int verbose ); + +#ifdef __cplusplus +} +#endif + +#endif /* pbkdf2.h */ diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt index 501a38337b..7a0cedf352 100644 --- a/library/CMakeLists.txt +++ b/library/CMakeLists.txt @@ -28,6 +28,7 @@ set(src md5.c net.c padlock.c + pbkdf2.c pem.c pkcs11.c rsa.c diff --git a/library/Makefile b/library/Makefile index f282c5ddcc..56148a009d 100644 --- a/library/Makefile +++ b/library/Makefile @@ -41,7 +41,8 @@ OBJS= aes.o arc4.o asn1parse.o \ error.o gcm.o havege.o \ md.o md_wrap.o md2.o \ md4.o md5.o net.o \ - padlock.o pem.o pkcs11.o \ + padlock.o pbkdf2.o pem.o \ + pkcs11.o \ rsa.o sha1.o sha2.o \ sha4.o ssl_cli.o ssl_srv.o \ ssl_tls.o timing.o version.o \ diff --git a/library/pbkdf2.c b/library/pbkdf2.c new file mode 100644 index 0000000000..19a8f41cc7 --- /dev/null +++ b/library/pbkdf2.c @@ -0,0 +1,215 @@ +/** + * \file pbkdf2.c + * + * \brief Password-Based Key Derivation Function 2 (from PKCS#5) + * + * \author Mathias Olsson + * + * Copyright (C) 2006-2012, Brainspark B.V. + * + * This file is part of PolarSSL (http://www.polarssl.org) + * Lead Maintainer: Paul Bakker + * + * 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. + */ +/* + * PBKDF2 is part of PKCS#5 + * + * http://tools.ietf.org/html/rfc2898 (Specification) + * http://tools.ietf.org/html/rfc6070 (Test vectors) + */ + +#include "polarssl/config.h" + +#if defined(POLARSSL_PBKDF2_C) + +#include "polarssl/pbkdf2.h" + +int pbkdf2_hmac( md_context_t *ctx, const unsigned char *password, size_t plen, + const unsigned char *salt, size_t slen, + unsigned int iteration_count, + unsigned long key_length, unsigned char *output ) +{ + int ret, j; + unsigned int i; + unsigned char md1[POLARSSL_MD_MAX_SIZE]; + unsigned char work[POLARSSL_MD_MAX_SIZE]; + unsigned char md_size = md_get_size( ctx->md_info ); + size_t use_len; + unsigned char *out_p = output; + unsigned char counter[4]; + + memset( counter, 0, 4 ); + counter[3] = 1; + + if( iteration_count > 0xFFFFFFFF ) + return( POLARSSL_ERR_PBKDF2_BAD_INPUT_DATA ); + + while( key_length ) + { + // U1 ends up in work + // + if( ( ret = md_hmac_starts( ctx, password, plen ) ) != 0 ) + return( ret ); + + if( ( ret = md_hmac_update( ctx, salt, slen ) ) != 0 ) + return( ret ); + + if( ( ret = md_hmac_update( ctx, counter, 4 ) ) != 0 ) + return( ret ); + + if( ( ret = md_hmac_finish( ctx, work ) ) != 0 ) + return( ret ); + + memcpy( md1, work, md_size ); + + for ( i = 1; i < iteration_count; i++ ) + { + // U2 ends up in md1 + // + if( ( ret = md_hmac_starts( ctx, password, plen ) ) != 0 ) + return( ret ); + + if( ( ret = md_hmac_update( ctx, md1, md_size ) ) != 0 ) + return( ret ); + + if( ( ret = md_hmac_finish( ctx, md1 ) ) != 0 ) + return( ret ); + + // U1 xor U2 + // + for( j = 0; j < md_size; j++ ) + work[j] ^= md1[j]; + } + + use_len = ( key_length < md_size ) ? key_length : md_size; + memcpy( out_p, work, use_len ); + + key_length -= use_len; + out_p += use_len; + + for( i = 4; i > 0; i-- ) + if( ++counter[i - 1] != 0 ) + break; + } + + return( 0 ); +} + + +#if defined(POLARSSL_SELF_TEST) + +#include + +#define MAX_TESTS 6 + +size_t plen[MAX_TESTS] = + { 8, 8, 8, 8, 24, 9 }; + +unsigned char password[MAX_TESTS][32] = +{ + "password", + "password", + "password", + "password", + "passwordPASSWORDpassword", + "pass\0word", +}; + +size_t slen[MAX_TESTS] = + { 4, 4, 4, 4, 36, 5 }; + +unsigned char salt[MAX_TESTS][40] = +{ + "salt", + "salt", + "salt", + "salt", + "saltSALTsaltSALTsaltSALTsaltSALTsalt", + "sa\0lt", +}; + +unsigned long it_cnt[MAX_TESTS] = + { 1, 2, 4096, 16777216, 4096, 4096 }; + +unsigned long key_len[MAX_TESTS] = + { 20, 20, 20, 20, 25, 16 }; + + +unsigned char result_key[MAX_TESTS][32] = +{ + { 0x0c, 0x60, 0xc8, 0x0f, 0x96, 0x1f, 0x0e, 0x71, + 0xf3, 0xa9, 0xb5, 0x24, 0xaf, 0x60, 0x12, 0x06, + 0x2f, 0xe0, 0x37, 0xa6 }, + { 0xea, 0x6c, 0x01, 0x4d, 0xc7, 0x2d, 0x6f, 0x8c, + 0xcd, 0x1e, 0xd9, 0x2a, 0xce, 0x1d, 0x41, 0xf0, + 0xd8, 0xde, 0x89, 0x57 }, + { 0x4b, 0x00, 0x79, 0x01, 0xb7, 0x65, 0x48, 0x9a, + 0xbe, 0xad, 0x49, 0xd9, 0x26, 0xf7, 0x21, 0xd0, + 0x65, 0xa4, 0x29, 0xc1 }, + { 0xee, 0xfe, 0x3d, 0x61, 0xcd, 0x4d, 0xa4, 0xe4, + 0xe9, 0x94, 0x5b, 0x3d, 0x6b, 0xa2, 0x15, 0x8c, + 0x26, 0x34, 0xe9, 0x84 }, + { 0x3d, 0x2e, 0xec, 0x4f, 0xe4, 0x1c, 0x84, 0x9b, + 0x80, 0xc8, 0xd8, 0x36, 0x62, 0xc0, 0xe4, 0x4a, + 0x8b, 0x29, 0x1a, 0x96, 0x4c, 0xf2, 0xf0, 0x70, + 0x38 }, + { 0x56, 0xfa, 0x6a, 0xa7, 0x55, 0x48, 0x09, 0x9d, + 0xcc, 0x37, 0xd7, 0xf0, 0x34, 0x25, 0xe0, 0xc3 }, +}; + +int pbkdf2_self_test( int verbose ) +{ + md_context_t sha1_ctx; + const md_info_t *info_sha1; + int ret, i; + unsigned char key[64]; + + info_sha1 = md_info_from_type( POLARSSL_MD_SHA1 ); + if( info_sha1 == NULL ) + return( 1 ); + + if( ( ret = md_init_ctx( &sha1_ctx, info_sha1 ) ) != 0 ) + return( 1 ); + + for( i = 0; i < MAX_TESTS; i++ ) + { + printf( " PBKDF2 (SHA1) #%d: ", i ); + + ret = pbkdf2_hmac( &sha1_ctx, password[i], plen[i], salt[i], slen[i], + it_cnt[i], key_len[i], key ); + if( ret != 0 || + memcmp( result_key[i], key, key_len[i] ) != 0 ) + { + if( verbose != 0 ) + printf( "failed\n" ); + + return( 1 ); + } + + if( verbose != 0 ) + printf( "passed\n" ); + } + + printf( "\n" ); + + return( 0 ); +} + +#endif /* POLARSSL_SELF_TEST */ + +#endif /* POLARSSL_PBKDF2_C */ diff --git a/programs/test/selftest.c b/programs/test/selftest.c index ee31fdc8d8..8dddf34811 100644 --- a/programs/test/selftest.c +++ b/programs/test/selftest.c @@ -49,6 +49,7 @@ #include "polarssl/rsa.h" #include "polarssl/x509.h" #include "polarssl/xtea.h" +#include "polarssl/pbkdf2.h" int main( int argc, char *argv[] ) { @@ -149,6 +150,11 @@ int main( int argc, char *argv[] ) return( ret ); #endif +#if defined(POLARSSL_PBKDF2_C) + if( ( ret = pbkdf2_self_test( v ) ) != 0 ) + return( ret ); +#endif + #else printf( " POLARSSL_SELF_TEST not defined.\n" ); #endif diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index a1e311fc5b..18d5ad4255 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -52,6 +52,7 @@ add_test_suite(hmac_shax) add_test_suite(md) add_test_suite(mdx) add_test_suite(mpi) +add_test_suite(pbkdf2) add_test_suite(pkcs1_v21) add_test_suite(shax) add_test_suite(rsa) diff --git a/tests/Makefile b/tests/Makefile index 13342f8cc7..2ebb9f5766 100644 --- a/tests/Makefile +++ b/tests/Makefile @@ -33,7 +33,8 @@ APPS = test_suite_aes test_suite_arc4 \ test_suite_error test_suite_gcm.decrypt \ test_suite_gcm.decrypt test_suite_hmac_shax \ test_suite_md test_suite_mdx \ - test_suite_mpi test_suite_pkcs1_v21 \ + test_suite_mpi test_suite_pbkdf2 \ + test_suite_pkcs1_v21 \ test_suite_rsa test_suite_shax \ test_suite_x509parse test_suite_x509write \ test_suite_xtea test_suite_version @@ -154,6 +155,10 @@ test_suite_mpi: test_suite_mpi.c ../library/libpolarssl.a echo " CC $@.c" $(CC) $(CFLAGS) $(OFLAGS) $@.c $(LDFLAGS) -o $@ +test_suite_pbkdf2: test_suite_pbkdf2.c ../library/libpolarssl.a + echo " CC $@.c" + $(CC) $(CFLAGS) $(OFLAGS) $@.c $(LDFLAGS) -o $@ + test_suite_pkcs1_v21: test_suite_pkcs1_v21.c ../library/libpolarssl.a echo " CC $@.c" $(CC) $(CFLAGS) $(OFLAGS) $@.c $(LDFLAGS) -o $@ diff --git a/tests/suites/test_suite_pbkdf2.data b/tests/suites/test_suite_pbkdf2.data new file mode 100644 index 0000000000..1ac2be7826 --- /dev/null +++ b/tests/suites/test_suite_pbkdf2.data @@ -0,0 +1,14 @@ +PBKDF2 RFC 6070 Test Vector #1 (SHA1) +pbkdf2_hmac:POLARSSL_MD_SHA1:"70617373776f7264":"73616c74":1:20:"0c60c80f961f0e71f3a9b524af6012062fe037a6" + +PBKDF2 RFC 6070 Test Vector #2 (SHA1) +pbkdf2_hmac:POLARSSL_MD_SHA1:"70617373776f7264":"73616c74":2:20:"ea6c014dc72d6f8ccd1ed92ace1d41f0d8de8957" + +PBKDF2 RFC 6070 Test Vector #3 (SHA1) +pbkdf2_hmac:POLARSSL_MD_SHA1:"70617373776f7264":"73616c74":4096:20:"4b007901b765489abead49d926f721d065a429c1" + +PBKDF2 RFC 6070 Test Vector #5 (SHA1) +pbkdf2_hmac:POLARSSL_MD_SHA1:"70617373776f726450415353574f524470617373776f7264":"73616c7453414c5473616c7453414c5473616c7453414c5473616c7453414c5473616c74":4096:25:"3d2eec4fe41c849b80c8d83662c0e44a8b291a964cf2f07038" + +PBKDF2 RFC 6070 Test Vector #6 (SHA1) +pbkdf2_hmac:POLARSSL_MD_SHA1:"7061737300776f7264":"7361006c74":4096:16:"56fa6aa75548099dcc37d7f03425e0c3" diff --git a/tests/suites/test_suite_pbkdf2.function b/tests/suites/test_suite_pbkdf2.function new file mode 100644 index 0000000000..907f4787fe --- /dev/null +++ b/tests/suites/test_suite_pbkdf2.function @@ -0,0 +1,39 @@ +BEGIN_HEADER +#include +END_HEADER + +BEGIN_DEPENDENCIES +depends_on:POLARSSL_PBKDF2_C +END_DEPENDENCIES + +BEGIN_CASE +pbkdf2_hmac:hash:hex_password_string:hex_salt_string:it_cnt:key_len:result_key_string +{ + unsigned char pw_str[100]; + unsigned char salt_str[100]; + unsigned char dst_str[100]; + + md_context_t ctx; + const md_info_t *info; + + int pw_len, salt_len; + unsigned char key[100]; + + memset(pw_str, 0x00, 100); + memset(salt_str, 0x00, 100); + memset(dst_str, 0x00, 100); + + pw_len = unhexify( pw_str, {hex_password_string} ); + salt_len = unhexify( salt_str, {hex_salt_string} ); + + + info = md_info_from_type( {hash} ); + TEST_ASSERT( info != NULL ); + TEST_ASSERT( md_init_ctx( &ctx, info ) == 0 ); + TEST_ASSERT( pbkdf2_hmac( &ctx, pw_str, pw_len, salt_str, salt_len, + {it_cnt}, {key_len}, key ) == 0 ); + + hexify( dst_str, key, {key_len} ); + TEST_ASSERT( strcmp( (char *) dst_str, {result_key_string} ) == 0 ); +} +END_CASE