1 /* Written by Dr Stephen N Henson (steve (at) openssl.org) for the OpenSSL 2 * project 1999. 3 */ 4 /* ==================================================================== 5 * Copyright (c) 1999 The OpenSSL Project. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * 19 * 3. All advertising materials mentioning features or use of this 20 * software must display the following acknowledgment: 21 * "This product includes software developed by the OpenSSL Project 22 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 23 * 24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25 * endorse or promote products derived from this software without 26 * prior written permission. For written permission, please contact 27 * licensing (at) OpenSSL.org. 28 * 29 * 5. Products derived from this software may not be called "OpenSSL" 30 * nor may "OpenSSL" appear in their names without prior written 31 * permission of the OpenSSL Project. 32 * 33 * 6. Redistributions of any form whatsoever must retain the following 34 * acknowledgment: 35 * "This product includes software developed by the OpenSSL Project 36 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 37 * 38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49 * OF THE POSSIBILITY OF SUCH DAMAGE. 50 * ==================================================================== 51 * 52 * This product includes cryptographic software written by Eric Young 53 * (eay (at) cryptsoft.com). This product includes software written by Tim 54 * Hudson (tjh (at) cryptsoft.com). */ 55 56 #ifndef OPENSSL_HEADER_PKCS8_INTERNAL_H 57 #define OPENSSL_HEADER_PKCS8_INTERNAL_H 58 59 #include <openssl/base.h> 60 61 #if defined(__cplusplus) 62 extern "C" { 63 #endif 64 65 66 // pkcs8_pbe_decrypt decrypts |in| using the PBE scheme described by 67 // |algorithm|, which should be a serialized AlgorithmIdentifier structure. On 68 // success, it sets |*out| to a newly-allocated buffer containing the decrypted 69 // result and returns one. Otherwise, it returns zero. 70 int pkcs8_pbe_decrypt(uint8_t **out, size_t *out_len, CBS *algorithm, 71 const char *pass, size_t pass_len, const uint8_t *in, 72 size_t in_len); 73 74 #define PKCS12_KEY_ID 1 75 #define PKCS12_IV_ID 2 76 #define PKCS12_MAC_ID 3 77 78 // pkcs12_key_gen runs the PKCS#12 key derivation function as specified in 79 // RFC 7292, appendix B. On success, it writes the resulting |out_len| bytes of 80 // key material to |out| and returns one. Otherwise, it returns zero. |id| 81 // should be one of the |PKCS12_*_ID| values. 82 int pkcs12_key_gen(const char *pass, size_t pass_len, const uint8_t *salt, 83 size_t salt_len, uint8_t id, unsigned iterations, 84 size_t out_len, uint8_t *out, const EVP_MD *md); 85 86 // pkcs12_pbe_encrypt_init configures |ctx| for encrypting with a PBES1 scheme 87 // defined in PKCS#12. It writes the corresponding AlgorithmIdentifier to |out|. 88 int pkcs12_pbe_encrypt_init(CBB *out, EVP_CIPHER_CTX *ctx, int alg, 89 unsigned iterations, const char *pass, 90 size_t pass_len, const uint8_t *salt, 91 size_t salt_len); 92 93 struct pbe_suite { 94 int pbe_nid; 95 uint8_t oid[10]; 96 uint8_t oid_len; 97 const EVP_CIPHER *(*cipher_func)(void); 98 const EVP_MD *(*md_func)(void); 99 // decrypt_init initialize |ctx| for decrypting. The password is specified by 100 // |pass| and |pass_len|. |param| contains the serialized parameters field of 101 // the AlgorithmIdentifier. 102 // 103 // It returns one on success and zero on error. 104 int (*decrypt_init)(const struct pbe_suite *suite, EVP_CIPHER_CTX *ctx, 105 const char *pass, size_t pass_len, CBS *param); 106 }; 107 108 #define PKCS5_DEFAULT_ITERATIONS 2048 109 #define PKCS5_SALT_LEN 8 110 111 int PKCS5_pbe2_decrypt_init(const struct pbe_suite *suite, EVP_CIPHER_CTX *ctx, 112 const char *pass, size_t pass_len, CBS *param); 113 114 // PKCS5_pbe2_encrypt_init configures |ctx| for encrypting with PKCS #5 PBES2, 115 // as defined in RFC 2998, with the specified parameters. It writes the 116 // corresponding AlgorithmIdentifier to |out|. 117 int PKCS5_pbe2_encrypt_init(CBB *out, EVP_CIPHER_CTX *ctx, 118 const EVP_CIPHER *cipher, unsigned iterations, 119 const char *pass, size_t pass_len, 120 const uint8_t *salt, size_t salt_len); 121 122 // pkcs12_iterations_acceptable returns one if |iterations| is a reasonable 123 // number of PBKDF2 iterations and zero otherwise. 124 int pkcs12_iterations_acceptable(uint64_t iterations); 125 126 127 #if defined(__cplusplus) 128 } // extern C 129 #endif 130 131 #endif // OPENSSL_HEADER_PKCS8_INTERNAL_H 132
