pkcs5.h 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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: Apache-2.0
  11. *
  12. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  13. * not use this file except in compliance with the License.
  14. * You may obtain a copy of the License at
  15. *
  16. * http://www.apache.org/licenses/LICENSE-2.0
  17. *
  18. * Unless required by applicable law or agreed to in writing, software
  19. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  20. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21. * See the License for the specific language governing permissions and
  22. * limitations under the License.
  23. *
  24. * This file is part of mbed TLS (https://tls.mbed.org)
  25. */
  26. #ifndef MBEDTLS_PKCS5_H
  27. #define MBEDTLS_PKCS5_H
  28. #include "asn1.h"
  29. #include "md.h"
  30. #include <stddef.h>
  31. #include <stdint.h>
  32. #define MBEDTLS_ERR_PKCS5_BAD_INPUT_DATA -0x2f80 /**< Bad input parameters to function. */
  33. #define MBEDTLS_ERR_PKCS5_INVALID_FORMAT -0x2f00 /**< Unexpected ASN.1 data. */
  34. #define MBEDTLS_ERR_PKCS5_FEATURE_UNAVAILABLE -0x2e80 /**< Requested encryption or digest alg not available. */
  35. #define MBEDTLS_ERR_PKCS5_PASSWORD_MISMATCH -0x2e00 /**< Given private key password does not allow for correct decryption. */
  36. #define MBEDTLS_PKCS5_DECRYPT 0
  37. #define MBEDTLS_PKCS5_ENCRYPT 1
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /**
  42. * \brief PKCS#5 PBES2 function
  43. *
  44. * \param pbe_params the ASN.1 algorithm parameters
  45. * \param mode either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
  46. * \param pwd password to use when generating key
  47. * \param pwdlen length of password
  48. * \param data data to process
  49. * \param datalen length of data
  50. * \param output output buffer
  51. *
  52. * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
  53. */
  54. int mbedtls_pkcs5_pbes2( const mbedtls_asn1_buf *pbe_params, int mode,
  55. const unsigned char *pwd, size_t pwdlen,
  56. const unsigned char *data, size_t datalen,
  57. unsigned char *output );
  58. /**
  59. * \brief PKCS#5 PBKDF2 using HMAC
  60. *
  61. * \param ctx Generic HMAC context
  62. * \param password Password to use when generating key
  63. * \param plen Length of password
  64. * \param salt Salt to use when generating key
  65. * \param slen Length of salt
  66. * \param iteration_count Iteration count
  67. * \param key_length Length of generated key in bytes
  68. * \param output Generated key. Must be at least as big as key_length
  69. *
  70. * \returns 0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
  71. */
  72. int mbedtls_pkcs5_pbkdf2_hmac( mbedtls_md_context_t *ctx, const unsigned char *password,
  73. size_t plen, const unsigned char *salt, size_t slen,
  74. unsigned int iteration_count,
  75. uint32_t key_length, unsigned char *output );
  76. /**
  77. * \brief Checkup routine
  78. *
  79. * \return 0 if successful, or 1 if the test failed
  80. */
  81. int mbedtls_pkcs5_self_test( int verbose );
  82. #ifdef __cplusplus
  83. }
  84. #endif
  85. #endif /* pkcs5.h */