src/third_party/boringssl/src/include/openssl/pkcs8.h

   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 <openssl/x509.h>
  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 as
  70  * defined in PKCS #5. Only pbeWithSHAAnd128BitRC4 and
  71  * pbeWithSHAAnd3-KeyTripleDES-CBC, defined in PKCS #12, are supported. The
  72  * |pass_raw_len| bytes pointed to by |pass_raw| are used as the password. Note
  73  * that any conversions from the password as supplied in a text string (such as
  74  * those specified in B.1 of PKCS #12) must be performed by the caller.
  75  *
  76  * If |salt| is NULL, a random salt of |salt_len| bytes is generated. If
  77  * |salt_len| is zero, a default salt length is used instead.
  78  *
  79  * The resulting structure is stored in an X509_SIG which must be freed by the
  80  * caller.
  81  *
  82  * TODO(davidben): Really? An X509_SIG? OpenSSL probably did that because it has
  83  * the same structure as EncryptedPrivateKeyInfo. */
  84 OPENSSL_EXPORT X509_SIG *PKCS8_encrypt_pbe(int pbe_nid,
  85                                            const uint8_t *pass_raw,
  86                                            size_t pass_raw_len,
  87                                            uint8_t *salt, size_t salt_len,
  88                                            int iterations,
  89                                            PKCS8_PRIV_KEY_INFO *p8inf);
  90
  91 /* PKCS8_decrypt_pbe decrypts and decodes a PKCS8_PRIV_KEY_INFO with PBES1 as
  92  * defined in PKCS #5. Only pbeWithSHAAnd128BitRC4 and
  93  * pbeWithSHAAnd3-KeyTripleDES-CBC, defined in PKCS #12, are supported. The
  94  * |pass_raw_len| bytes pointed to by |pass_raw| are used as the password. Note
  95  * that any conversions from the password as supplied in a text string (such as
  96  * those specified in B.1 of PKCS #12) must be performed by the caller.
  97  *
  98  * The resulting structure must be freed by the caller. */
  99 OPENSSL_EXPORT PKCS8_PRIV_KEY_INFO *PKCS8_decrypt_pbe(X509_SIG *pkcs8,
 100                                                       const uint8_t *pass_raw,
 101                                                       size_t pass_raw_len);
 102
 103
 104 /* Deprecated functions. */
 105
 106 /* PKCS8_encrypt calls PKCS8_encrypt_pbe after treating |pass| as an ASCII
 107  * string, appending U+0000, and converting to UCS-2. (So the empty password
 108  * encodes as two NUL bytes.) The |cipher| argument is ignored. */
 109 OPENSSL_EXPORT X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
 110                                        const char *pass, int pass_len,
 111                                        uint8_t *salt, size_t salt_len,
 112                                        int iterations,
 113                                        PKCS8_PRIV_KEY_INFO *p8inf);
 114
 115 /* PKCS8_decrypt calls PKCS8_decrypt_pbe after treating |pass| as an ASCII
 116  * string, appending U+0000, and converting to UCS-2. (So the empty password
 117  * encodes as two NUL bytes.) */
 118 OPENSSL_EXPORT PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *pkcs8,
 119                                                   const char *pass,
 120                                                   int pass_len);
 121
 122
 123 #if defined(__cplusplus)
 124 }  /* extern C */
 125 #endif
 126
 127 #define PKCS8_F_PKCS8_encrypt 100
 128 #define PKCS8_F_EVP_PKEY2PKCS8 101
 129 #define PKCS8_F_EVP_PKCS82PKEY 102
 130 #define PKCS8_F_PKCS5_pbe_set0_algor 103
 131 #define PKCS8_F_pbe_crypt 104
 132 #define PKCS8_F_pkcs12_item_decrypt_d2i 105
 133 #define PKCS8_F_PKCS5_pbe_set 106
 134 #define PKCS8_F_pkcs12_key_gen_uni 107
 135 #define PKCS8_F_pkcs12_key_gen_asc 108
 136 #define PKCS8_F_pkcs12_pbe_keyivgen 109
 137 #define PKCS8_F_pbe_cipher_init 110
 138 #define PKCS8_F_pkcs12_item_i2d_encrypt 111
 139 #define PKCS8_F_PKCS5_pbe2_set_iv 112
 140 #define PKCS8_F_PKCS5_pbkdf2_set 113
 141 #define PKCS8_F_pkcs12_key_gen_raw 114
 142 #define PKCS8_F_PKCS8_decrypt 115
 143 #define PKCS8_F_PKCS8_encrypt_pbe 116
 144 #define PKCS8_R_ERROR_SETTING_CIPHER_PARAMS 100
 145 #define PKCS8_R_PRIVATE_KEY_ENCODE_ERROR 101
 146 #define PKCS8_R_UNKNOWN_ALGORITHM 102
 147 #define PKCS8_R_UNKNOWN_CIPHER 103
 148 #define PKCS8_R_UNKNOWN_DIGEST 104
 149 #define PKCS8_R_ENCODE_ERROR 105
 150 #define PKCS8_R_DECODE_ERROR 106
 151 #define PKCS8_R_ENCRYPT_ERROR 107
 152 #define PKCS8_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM 108
 153 #define PKCS8_R_PRIVATE_KEY_DECODE_ERROR 109
 154 #define PKCS8_R_UNKNOWN_CIPHER_ALGORITHM 110
 155 #define PKCS8_R_KEYGEN_FAILURE 111
 156 #define PKCS8_R_TOO_LONG 112
 157 #define PKCS8_R_CRYPT_ERROR 113
 158 #define PKCS8_R_METHOD_NOT_SUPPORTED 114
 159 #define PKCS8_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 115
 160 #define PKCS8_R_KEY_GEN_ERROR 116
 161
 162 #endif  /* OPENSSL_HEADER_PKCS8_H */