pkcs12.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. /**
  2. * \file pkcs12.h
  3. *
  4. * \brief PKCS#12 Personal Information Exchange Syntax
  5. */
  6. /*
  7. * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  8. * SPDX-License-Identifier: Apache-2.0
  9. *
  10. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  11. * not use this file except in compliance with the License.
  12. * You may obtain a copy of the License at
  13. *
  14. * http://www.apache.org/licenses/LICENSE-2.0
  15. *
  16. * Unless required by applicable law or agreed to in writing, software
  17. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  18. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19. * See the License for the specific language governing permissions and
  20. * limitations under the License.
  21. *
  22. * This file is part of mbed TLS (https://tls.mbed.org)
  23. */
  24. #ifndef MBEDTLS_PKCS12_H
  25. #define MBEDTLS_PKCS12_H
  26. #include "md.h"
  27. #include "cipher.h"
  28. #include "asn1.h"
  29. #include <stddef.h>
  30. #define MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA -0x1F80 /**< Bad input parameters to function. */
  31. #define MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE -0x1F00 /**< Feature not available, e.g. unsupported encryption scheme. */
  32. #define MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT -0x1E80 /**< PBE ASN.1 data not as expected. */
  33. #define MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH -0x1E00 /**< Given private key password does not allow for correct decryption. */
  34. #define MBEDTLS_PKCS12_DERIVE_KEY 1 /**< encryption/decryption key */
  35. #define MBEDTLS_PKCS12_DERIVE_IV 2 /**< initialization vector */
  36. #define MBEDTLS_PKCS12_DERIVE_MAC_KEY 3 /**< integrity / MAC key */
  37. #define MBEDTLS_PKCS12_PBE_DECRYPT 0
  38. #define MBEDTLS_PKCS12_PBE_ENCRYPT 1
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42. /**
  43. * \brief PKCS12 Password Based function (encryption / decryption)
  44. * for pbeWithSHAAnd128BitRC4
  45. *
  46. * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure
  47. * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT
  48. * \param pwd the password used (may be NULL if no password is used)
  49. * \param pwdlen length of the password (may be 0)
  50. * \param input the input data
  51. * \param len data length
  52. * \param output the output buffer
  53. *
  54. * \return 0 if successful, or a MBEDTLS_ERR_XXX code
  55. */
  56. int mbedtls_pkcs12_pbe_sha1_rc4_128( mbedtls_asn1_buf *pbe_params, int mode,
  57. const unsigned char *pwd, size_t pwdlen,
  58. const unsigned char *input, size_t len,
  59. unsigned char *output );
  60. /**
  61. * \brief PKCS12 Password Based function (encryption / decryption)
  62. * for cipher-based and mbedtls_md-based PBE's
  63. *
  64. * \param pbe_params an ASN1 buffer containing the pkcs-12PbeParams structure
  65. * \param mode either MBEDTLS_PKCS12_PBE_ENCRYPT or MBEDTLS_PKCS12_PBE_DECRYPT
  66. * \param cipher_type the cipher used
  67. * \param md_type the mbedtls_md used
  68. * \param pwd the password used (may be NULL if no password is used)
  69. * \param pwdlen length of the password (may be 0)
  70. * \param input the input data
  71. * \param len data length
  72. * \param output the output buffer
  73. *
  74. * \return 0 if successful, or a MBEDTLS_ERR_XXX code
  75. */
  76. int mbedtls_pkcs12_pbe( mbedtls_asn1_buf *pbe_params, int mode,
  77. mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type,
  78. const unsigned char *pwd, size_t pwdlen,
  79. const unsigned char *input, size_t len,
  80. unsigned char *output );
  81. /**
  82. * \brief The PKCS#12 derivation function uses a password and a salt
  83. * to produce pseudo-random bits for a particular "purpose".
  84. *
  85. * Depending on the given id, this function can produce an
  86. * encryption/decryption key, an nitialization vector or an
  87. * integrity key.
  88. *
  89. * \param data buffer to store the derived data in
  90. * \param datalen length to fill
  91. * \param pwd password to use (may be NULL if no password is used)
  92. * \param pwdlen length of the password (may be 0)
  93. * \param salt salt buffer to use
  94. * \param saltlen length of the salt
  95. * \param mbedtls_md mbedtls_md type to use during the derivation
  96. * \param id id that describes the purpose (can be MBEDTLS_PKCS12_DERIVE_KEY,
  97. * MBEDTLS_PKCS12_DERIVE_IV or MBEDTLS_PKCS12_DERIVE_MAC_KEY)
  98. * \param iterations number of iterations
  99. *
  100. * \return 0 if successful, or a MD, BIGNUM type error.
  101. */
  102. int mbedtls_pkcs12_derivation( unsigned char *data, size_t datalen,
  103. const unsigned char *pwd, size_t pwdlen,
  104. const unsigned char *salt, size_t saltlen,
  105. mbedtls_md_type_t mbedtls_md, int id, int iterations );
  106. #ifdef __cplusplus
  107. }
  108. #endif
  109. #endif /* pkcs12.h */