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