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 57#ifndef OPENSSL_HEADER_PKCS8_H 58#define OPENSSL_HEADER_PKCS8_H 59 60#include <openssl/base.h> 61 62#include <stdio.h> 63 64#include <openssl/x509.h> 65 66#if defined(__cplusplus) 67extern "C" { 68#endif 69 70 71/* PKCS8_encrypt_pbe serializes and encrypts a PKCS8_PRIV_KEY_INFO with PBES1 as 72 * defined in PKCS #5. Only pbeWithSHAAnd128BitRC4, 73 * pbeWithSHAAnd3-KeyTripleDES-CBC and pbeWithSHA1And40BitRC2, defined in PKCS 74 * #12, are supported. The |pass_raw_len| bytes pointed to by |pass_raw| are 75 * used as the password. Note that any conversions from the password as 76 * supplied in a text string (such as those specified in B.1 of PKCS #12) must 77 * be performed by the caller. 78 * 79 * If |salt| is NULL, a random salt of |salt_len| bytes is generated. If 80 * |salt_len| is zero, a default salt length is used instead. 81 * 82 * The resulting structure is stored in an X509_SIG which must be freed by the 83 * caller. 84 * 85 * TODO(davidben): Really? An X509_SIG? OpenSSL probably did that because it has 86 * the same structure as EncryptedPrivateKeyInfo. */ 87OPENSSL_EXPORT X509_SIG *PKCS8_encrypt_pbe(int pbe_nid, 88 const uint8_t *pass_raw, 89 size_t pass_raw_len, 90 uint8_t *salt, size_t salt_len, 91 int iterations, 92 PKCS8_PRIV_KEY_INFO *p8inf); 93 94/* PKCS8_decrypt_pbe decrypts and decodes a PKCS8_PRIV_KEY_INFO with PBES1 as 95 * defined in PKCS #5. Only pbeWithSHAAnd128BitRC4, 96 * pbeWithSHAAnd3-KeyTripleDES-CBC and pbeWithSHA1And40BitRC2, defined in PKCS 97 * #12, are supported. The |pass_raw_len| bytes pointed to by |pass_raw| are 98 * used as the password. Note that any conversions from the password as 99 * supplied in a text string (such as those specified in B.1 of PKCS #12) must 100 * be performed by the caller. 101 * 102 * The resulting structure must be freed by the caller. */ 103OPENSSL_EXPORT PKCS8_PRIV_KEY_INFO *PKCS8_decrypt_pbe(X509_SIG *pkcs8, 104 const uint8_t *pass_raw, 105 size_t pass_raw_len); 106 107 108/* Deprecated functions. */ 109 110/* PKCS8_encrypt calls PKCS8_encrypt_pbe after treating |pass| as an ASCII 111 * string, appending U+0000, and converting to UCS-2. (So the empty password 112 * encodes as two NUL bytes.) The |cipher| argument is ignored. */ 113OPENSSL_EXPORT X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 114 const char *pass, int pass_len, 115 uint8_t *salt, size_t salt_len, 116 int iterations, 117 PKCS8_PRIV_KEY_INFO *p8inf); 118 119/* PKCS8_decrypt calls PKCS8_decrypt_pbe after treating |pass| as an ASCII 120 * string, appending U+0000, and converting to UCS-2. (So the empty password 121 * encodes as two NUL bytes.) */ 122OPENSSL_EXPORT PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *pkcs8, 123 const char *pass, 124 int pass_len); 125 126/* PKCS12_get_key_and_certs parses a PKCS#12 structure from |in|, authenticates 127 * and decrypts it using |password|, sets |*out_key| to the included private 128 * key and appends the included certificates to |out_certs|. It returns one on 129 * success and zero on error. The caller takes ownership of the outputs. */ 130OPENSSL_EXPORT int PKCS12_get_key_and_certs(EVP_PKEY **out_key, 131 STACK_OF(X509) *out_certs, 132 CBS *in, const char *password); 133 134 135/* Deprecated functions. */ 136 137/* PKCS12_PBE_add does nothing. It exists for compatibility with OpenSSL. */ 138OPENSSL_EXPORT void PKCS12_PBE_add(); 139 140/* d2i_PKCS12 is a dummy function that copies |*ber_bytes| into a 141 * |PKCS12| structure. The |out_p12| argument must be NULL. On exit, 142 * |*ber_bytes| will be advanced by |ber_len|. It returns a fresh |PKCS12| 143 * structure or NULL on error. 144 * 145 * Note: unlike other d2i functions, |d2i_PKCS12| will always consume |ber_len| 146 * bytes.*/ 147OPENSSL_EXPORT PKCS12 *d2i_PKCS12(PKCS12 **out_p12, const uint8_t **ber_bytes, 148 size_t ber_len); 149 150/* d2i_PKCS12_bio acts like |d2i_PKCS12| but reads from a |BIO|. */ 151OPENSSL_EXPORT PKCS12* d2i_PKCS12_bio(BIO *bio, PKCS12 **out_p12); 152 153/* d2i_PKCS12_fp acts like |d2i_PKCS12| but reads from a |FILE|. */ 154OPENSSL_EXPORT PKCS12* d2i_PKCS12_fp(FILE *fp, PKCS12 **out_p12); 155 156/* PKCS12_parse calls |PKCS12_get_key_and_certs| on the ASN.1 data stored in 157 * |p12|. The |out_pkey| and |out_cert| arguments must not be NULL and, on 158 * successful exit, the private key and first certificate will be stored in 159 * them. The |out_ca_certs| argument may be NULL but, if not, then any extra 160 * certificates will be appended to |*out_ca_certs|. If |*out_ca_certs| is NULL 161 * then it will be set to a freshly allocated stack containing the extra certs. 162 * 163 * It returns one on success and zero on error. */ 164OPENSSL_EXPORT int PKCS12_parse(const PKCS12 *p12, const char *password, 165 EVP_PKEY **out_pkey, X509 **out_cert, 166 STACK_OF(X509) **out_ca_certs); 167 168/* PKCS12_free frees |p12| and its contents. */ 169OPENSSL_EXPORT void PKCS12_free(PKCS12 *p12); 170 171#if defined(__cplusplus) 172} /* extern C */ 173#endif 174 175#define PKCS8_F_PKCS8_encrypt 100 176#define PKCS8_F_EVP_PKEY2PKCS8 101 177#define PKCS8_F_EVP_PKCS82PKEY 102 178#define PKCS8_F_PKCS5_pbe_set0_algor 103 179#define PKCS8_F_pbe_crypt 104 180#define PKCS8_F_pkcs12_item_decrypt_d2i 105 181#define PKCS8_F_PKCS5_pbe_set 106 182#define PKCS8_F_pkcs12_key_gen_uni 107 183#define PKCS8_F_pkcs12_key_gen_asc 108 184#define PKCS8_F_pkcs12_pbe_keyivgen 109 185#define PKCS8_F_pbe_cipher_init 110 186#define PKCS8_F_pkcs12_item_i2d_encrypt 111 187#define PKCS8_F_PKCS5_pbe2_set_iv 112 188#define PKCS8_F_PKCS5_pbkdf2_set 113 189#define PKCS8_F_pkcs12_key_gen_raw 114 190#define PKCS8_F_PKCS8_decrypt 115 191#define PKCS8_F_PKCS8_encrypt_pbe 116 192#define PKCS8_F_PKCS12_parse 117 193#define PKCS8_F_PKCS12_handle_content_info 118 194#define PKCS8_F_PKCS12_handle_content_infos 119 195#define PKCS8_F_PKCS12_get_key_and_certs 120 196#define PKCS8_R_ERROR_SETTING_CIPHER_PARAMS 100 197#define PKCS8_R_PRIVATE_KEY_ENCODE_ERROR 101 198#define PKCS8_R_UNKNOWN_ALGORITHM 102 199#define PKCS8_R_UNKNOWN_CIPHER 103 200#define PKCS8_R_UNKNOWN_DIGEST 104 201#define PKCS8_R_ENCODE_ERROR 105 202#define PKCS8_R_DECODE_ERROR 106 203#define PKCS8_R_ENCRYPT_ERROR 107 204#define PKCS8_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM 108 205#define PKCS8_R_PRIVATE_KEY_DECODE_ERROR 109 206#define PKCS8_R_UNKNOWN_CIPHER_ALGORITHM 110 207#define PKCS8_R_KEYGEN_FAILURE 111 208#define PKCS8_R_TOO_LONG 112 209#define PKCS8_R_CRYPT_ERROR 113 210#define PKCS8_R_METHOD_NOT_SUPPORTED 114 211#define PKCS8_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 115 212#define PKCS8_R_KEY_GEN_ERROR 116 213#define PKCS8_R_BAD_PKCS12_DATA 117 214#define PKCS8_R_PKCS12_PUBLIC_KEY_INTEGRITY_NOT_SUPPORTED 118 215#define PKCS8_R_BAD_PKCS12_VERSION 119 216#define PKCS8_R_PKCS12_TOO_DEEPLY_NESTED 120 217#define PKCS8_R_MULTIPLE_PRIVATE_KEYS_IN_PKCS12 121 218#define PKCS8_R_UNKNOWN_HASH 122 219#define PKCS8_R_BAD_MAC 123 220#define PKCS8_R_MISSING_MAC 124 221#define PKCS8_R_INCORRECT_PASSWORD 125 222 223#endif /* OPENSSL_HEADER_PKCS8_H */ 224