1 /* Written by Dr Stephen N Henson (steve@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@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@cryptsoft.com). This product includes software written by Tim 54 * Hudson (tjh@cryptsoft.com). */ 55 56 #ifndef OPENSSL_HEADER_PKCS8_INTERNAL_H 57 #define OPENSSL_HEADER_PKCS8_INTERNAL_H 58 59 #include <openssl/base.h> 60 #include <openssl/stack.h> 61 62 #if defined(__cplusplus) 63 extern "C" { 64 #endif 65 66 67 struct pkcs8_priv_key_info_st { 68 ASN1_INTEGER *version; 69 X509_ALGOR *pkeyalg; 70 ASN1_OCTET_STRING *pkey; 71 STACK_OF(X509_ATTRIBUTE) *attributes; 72 }; 73 74 // pkcs8_pbe_decrypt decrypts |in| using the PBE scheme described by 75 // |algorithm|, which should be a serialized AlgorithmIdentifier structure. On 76 // success, it sets |*out| to a newly-allocated buffer containing the decrypted 77 // result and returns one. Otherwise, it returns zero. 78 int pkcs8_pbe_decrypt(uint8_t **out, size_t *out_len, CBS *algorithm, 79 const char *pass, size_t pass_len, const uint8_t *in, 80 size_t in_len); 81 82 #define PKCS12_KEY_ID 1 83 #define PKCS12_IV_ID 2 84 #define PKCS12_MAC_ID 3 85 86 // pkcs12_key_gen runs the PKCS#12 key derivation function as specified in 87 // RFC 7292, appendix B. On success, it writes the resulting |out_len| bytes of 88 // key material to |out| and returns one. Otherwise, it returns zero. |id| 89 // should be one of the |PKCS12_*_ID| values. 90 int pkcs12_key_gen(const char *pass, size_t pass_len, const uint8_t *salt, 91 size_t salt_len, uint8_t id, uint32_t iterations, 92 size_t out_len, uint8_t *out, const EVP_MD *md); 93 94 // pkcs12_pbe_encrypt_init configures |ctx| for encrypting with a PBES1 scheme 95 // defined in PKCS#12. It writes the corresponding AlgorithmIdentifier to |out|. 96 int pkcs12_pbe_encrypt_init(CBB *out, EVP_CIPHER_CTX *ctx, int alg, 97 uint32_t iterations, const char *pass, 98 size_t pass_len, const uint8_t *salt, 99 size_t salt_len); 100 101 struct pbe_suite { 102 int pbe_nid; 103 uint8_t oid[10]; 104 uint8_t oid_len; 105 const EVP_CIPHER *(*cipher_func)(void); 106 const EVP_MD *(*md_func)(void); 107 // decrypt_init initialize |ctx| for decrypting. The password is specified by 108 // |pass| and |pass_len|. |param| contains the serialized parameters field of 109 // the AlgorithmIdentifier. 110 // 111 // It returns one on success and zero on error. 112 int (*decrypt_init)(const struct pbe_suite *suite, EVP_CIPHER_CTX *ctx, 113 const char *pass, size_t pass_len, CBS *param); 114 }; 115 116 #define PKCS5_SALT_LEN 8 117 118 int PKCS5_pbe2_decrypt_init(const struct pbe_suite *suite, EVP_CIPHER_CTX *ctx, 119 const char *pass, size_t pass_len, CBS *param); 120 121 // PKCS5_pbe2_encrypt_init configures |ctx| for encrypting with PKCS #5 PBES2, 122 // as defined in RFC 2998, with the specified parameters. It writes the 123 // corresponding AlgorithmIdentifier to |out|. 124 int PKCS5_pbe2_encrypt_init(CBB *out, EVP_CIPHER_CTX *ctx, 125 const EVP_CIPHER *cipher, uint32_t iterations, 126 const char *pass, size_t pass_len, 127 const uint8_t *salt, size_t salt_len); 128 129 // pkcs12_iterations_acceptable returns one if |iterations| is a reasonable 130 // number of PBKDF2 iterations and zero otherwise. 131 int pkcs12_iterations_acceptable(uint64_t iterations); 132 133 134 #if defined(__cplusplus) 135 } // extern C 136 #endif 137 138 #endif // OPENSSL_HEADER_PKCS8_INTERNAL_H 139