Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | Download | RSS feed

  1. /**
  2.  * \file pkcs5.h
  3.  *
  4.  * \brief PKCS#5 functions
  5.  *
  6.  * \author Mathias Olsson <mathias@kompetensum.com>
  7.  */
  8. /*
  9.  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  10.  *  SPDX-License-Identifier: GPL-2.0
  11.  *
  12.  *  This program is free software; you can redistribute it and/or modify
  13.  *  it under the terms of the GNU General Public License as published by
  14.  *  the Free Software Foundation; either version 2 of the License, or
  15.  *  (at your option) any later version.
  16.  *
  17.  *  This program is distributed in the hope that it will be useful,
  18.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20.  *  GNU General Public License for more details.
  21.  *
  22.  *  You should have received a copy of the GNU General Public License along
  23.  *  with this program; if not, write to the Free Software Foundation, Inc.,
  24.  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  25.  *
  26.  *  This file is part of mbed TLS (https://tls.mbed.org)
  27.  */
  28. #ifndef MBEDTLS_PKCS5_H
  29. #define MBEDTLS_PKCS5_H
  30.  
  31. #if !defined(MBEDTLS_CONFIG_FILE)
  32. #include "config.h"
  33. #else
  34. #include MBEDTLS_CONFIG_FILE
  35. #endif
  36.  
  37. #include "asn1.h"
  38. #include "md.h"
  39.  
  40. #include <stddef.h>
  41. #include <stdint.h>
  42.  
  43. #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA                  -0x2f80  /**< Bad input parameters to function. */
  44. #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT                  -0x2f00  /**< Unexpected ASN.1 data. */
  45. #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE             -0x2e80  /**< Requested encryption or digest alg not available. */
  46. #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH               -0x2e00  /**< Given private key password does not allow for correct decryption. */
  47.  
  48. #define MBEDTLS_PKCS5_DECRYPT      0
  49. #define MBEDTLS_PKCS5_ENCRYPT      1
  50.  
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54.  
  55. #if defined(MBEDTLS_ASN1_PARSE_C)
  56.  
  57. /**
  58.  * \brief          PKCS#5 PBES2 function
  59.  *
  60.  * \param pbe_params the ASN.1 algorithm parameters
  61.  * \param mode       either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
  62.  * \param pwd        password to use when generating key
  63.  * \param pwdlen     length of password
  64.  * \param data       data to process
  65.  * \param datalen    length of data
  66.  * \param output     output buffer
  67.  *
  68.  * \returns        0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
  69.  */
  70. int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode,
  71.                  const unsigned char *pwd,  size_t pwdlen,
  72.                  const unsigned char *data, size_t datalen,
  73.                  unsigned char *output );
  74.  
  75. #endif /* MBEDTLS_ASN1_PARSE_C */
  76.  
  77. /**
  78.  * \brief          PKCS#5 PBKDF2 using HMAC
  79.  *
  80.  * \param ctx      Generic HMAC context
  81.  * \param password Password to use when generating key
  82.  * \param plen     Length of password
  83.  * \param salt     Salt to use when generating key
  84.  * \param slen     Length of salt
  85.  * \param iteration_count       Iteration count
  86.  * \param key_length            Length of generated key in bytes
  87.  * \param output   Generated key. Must be at least as big as key_length
  88.  *
  89.  * \returns        0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
  90.  */
  91. int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password,
  92.                        size_t plen, const unsigned char *salt, size_t slen,
  93.                        unsigned int iteration_count,
  94.                        uint32_t key_length, unsigned char *output );
  95.  
  96. #if defined(MBEDTLS_SELF_TEST)
  97.  
  98. /**
  99.  * \brief          Checkup routine
  100.  *
  101.  * \return         0 if successful, or 1 if the test failed
  102.  */
  103. int mbedtls_pkcs5_self_test( int verbose );
  104.  
  105. #endif /* MBEDTLS_SELF_TEST */
  106.  
  107. #ifdef __cplusplus
  108. }
  109. #endif
  110.  
  111. #endif /* pkcs5.h */
  112.