pkcs5.h 3.4 KB

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