src/third_party/boringssl/src/crypto/evp/internal.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.] */
  56
  57 #ifndef OPENSSL_HEADER_EVP_INTERNAL_H
  58 #define OPENSSL_HEADER_EVP_INTERNAL_H
  59
  60 #include <openssl/base.h>
  61
  62 #if defined(__cplusplus)
  63 extern "C" {
  64 #endif
  65
  66
  67 /* These values are flags for EVP_PKEY_ASN1_METHOD.flags. */
  68
  69 /* ASN1_PKEY_SIGPARAM_NULL controls whether the default behavior of
  70  * EVP_DigestSignAlgorithm writes an explicit NULL parameter in the
  71  * AlgorithmIdentifier. */
  72 #define ASN1_PKEY_SIGPARAM_NULL 0x1
  73
  74 /* evp_digest_sign_algorithm_result_t is the return value of the
  75  * digest_sign_algorithm function in EVP_PKEY_ASN1_METHOD. */
  76 typedef enum {
  77   /* EVP_DIGEST_SIGN_ALGORITHM_ERROR signals an error. */
  78   EVP_DIGEST_SIGN_ALGORITHM_ERROR = 0,
  79   /* EVP_DIGEST_SIGN_ALGORITHM_SUCCESS signals that the parameters were
  80    * serialized in the AlgorithmIdentifier. */
  81   EVP_DIGEST_SIGN_ALGORITHM_SUCCESS = 1,
  82   /* EVP_DIGEST_SIGN_ALGORITHM_DEFAULT signals that the parameters are
  83    * serialized using the default behavior. */
  84   EVP_DIGEST_SIGN_ALGORITHM_DEFAULT = 2,
  85 } evp_digest_sign_algorithm_result_t;
  86
  87 struct evp_pkey_asn1_method_st {
  88   int pkey_id;
  89   int pkey_base_id;
  90   unsigned long pkey_flags;
  91
  92   char *pem_str;
  93   char *info;
  94
  95   int (*pub_decode)(EVP_PKEY *pk, X509_PUBKEY *pub);
  96   int (*pub_encode)(X509_PUBKEY *pub, const EVP_PKEY *pk);
  97   int (*pub_cmp)(const EVP_PKEY *a, const EVP_PKEY *b);
  98   int (*pub_print)(BIO *out, const EVP_PKEY *pkey, int indent, ASN1_PCTX *pctx);
  99
 100   int (*priv_decode)(EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf);
 101   int (*priv_encode)(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk);
 102   int (*priv_print)(BIO *out, const EVP_PKEY *pkey, int indent,
 103                     ASN1_PCTX *pctx);
 104
 105   /* pkey_opaque returns 1 if the |pk| is opaque. Opaque keys are backed by
 106    * custom implementations which do not expose key material and parameters.*/
 107   int (*pkey_opaque)(const EVP_PKEY *pk);
 108
 109   int (*pkey_size)(const EVP_PKEY *pk);
 110   int (*pkey_bits)(const EVP_PKEY *pk);
 111
 112   int (*param_decode)(EVP_PKEY *pkey, const unsigned char **pder, int derlen);
 113   int (*param_encode)(const EVP_PKEY *pkey, unsigned char **pder);
 114   int (*param_missing)(const EVP_PKEY *pk);
 115   int (*param_copy)(EVP_PKEY *to, const EVP_PKEY *from);
 116   int (*param_cmp)(const EVP_PKEY *a, const EVP_PKEY *b);
 117   int (*param_print)(BIO *out, const EVP_PKEY *pkey, int indent,
 118                      ASN1_PCTX *pctx);
 119   int (*sig_print)(BIO *out, const X509_ALGOR *sigalg, const ASN1_STRING *sig,
 120                    int indent, ASN1_PCTX *pctx);
 121
 122
 123   void (*pkey_free)(EVP_PKEY *pkey);
 124   int (*pkey_ctrl)(EVP_PKEY *pkey, int op, long arg1, void *arg2);
 125
 126   /* Legacy functions for old PEM */
 127
 128   int (*old_priv_decode)(EVP_PKEY *pkey, const unsigned char **pder,
 129                          int derlen);
 130   int (*old_priv_encode)(const EVP_PKEY *pkey, unsigned char **pder);
 131
 132   /* Converting parameters to/from AlgorithmIdentifier (X509_ALGOR). */
 133   int (*digest_verify_init_from_algorithm)(EVP_MD_CTX *ctx,
 134                                            X509_ALGOR *algor,
 135                                            EVP_PKEY *pkey);
 136   evp_digest_sign_algorithm_result_t (*digest_sign_algorithm)(
 137       EVP_MD_CTX *ctx,
 138       X509_ALGOR *algor);
 139
 140 } /* EVP_PKEY_ASN1_METHOD */;
 141
 142
 143 typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx);
 144
 145 #define EVP_PKEY_OP_UNDEFINED 0
 146 #define EVP_PKEY_OP_PARAMGEN (1 << 1)
 147 #define EVP_PKEY_OP_KEYGEN (1 << 2)
 148 #define EVP_PKEY_OP_SIGN (1 << 3)
 149 #define EVP_PKEY_OP_VERIFY (1 << 4)
 150 #define EVP_PKEY_OP_VERIFYRECOVER (1 << 5)
 151 #define EVP_PKEY_OP_SIGNCTX (1 << 6)
 152 #define EVP_PKEY_OP_VERIFYCTX (1 << 7)
 153 #define EVP_PKEY_OP_ENCRYPT (1 << 8)
 154 #define EVP_PKEY_OP_DECRYPT (1 << 9)
 155 #define EVP_PKEY_OP_DERIVE (1 << 10)
 156
 157 #define EVP_PKEY_OP_TYPE_SIG                                           \
 158   (EVP_PKEY_OP_SIGN | EVP_PKEY_OP_VERIFY | EVP_PKEY_OP_VERIFYRECOVER | \
 159    EVP_PKEY_OP_SIGNCTX | EVP_PKEY_OP_VERIFYCTX)
 160
 161 #define EVP_PKEY_OP_TYPE_CRYPT (EVP_PKEY_OP_ENCRYPT | EVP_PKEY_OP_DECRYPT)
 162
 163 #define EVP_PKEY_OP_TYPE_NOGEN \
 164   (EVP_PKEY_OP_SIG | EVP_PKEY_OP_CRYPT | EVP_PKEY_OP_DERIVE)
 165
 166 #define EVP_PKEY_OP_TYPE_GEN (EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN)
 167
 168 #define EVP_PKEY_CTRL_MD 1
 169 #define EVP_PKEY_CTRL_GET_MD 2
 170 #define EVP_PKEY_CTRL_RSA_PADDING (EVP_PKEY_ALG_CTRL + 1)
 171 #define EVP_PKEY_CTRL_GET_RSA_PADDING (EVP_PKEY_ALG_CTRL + 2)
 172 #define EVP_PKEY_CTRL_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 3)
 173 #define EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 4)
 174 #define EVP_PKEY_CTRL_RSA_KEYGEN_BITS (EVP_PKEY_ALG_CTRL + 5)
 175 #define EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP (EVP_PKEY_ALG_CTRL + 6)
 176 #define EVP_PKEY_CTRL_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 7)
 177 #define EVP_PKEY_CTRL_GET_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 8)
 178 #define EVP_PKEY_CTRL_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 9)
 179 #define EVP_PKEY_CTRL_GET_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 10)
 180 #define EVP_PKEY_CTRL_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 11)
 181 #define EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 12)
 182
 183 struct evp_pkey_ctx_st {
 184   /* Method associated with this operation */
 185   const EVP_PKEY_METHOD *pmeth;
 186   /* Engine that implements this method or NULL if builtin */
 187   ENGINE *engine;
 188   /* Key: may be NULL */
 189   EVP_PKEY *pkey;
 190   /* Peer key for key agreement, may be NULL */
 191   EVP_PKEY *peerkey;
 192   /* operation contains one of the |EVP_PKEY_OP_*| values. */
 193   int operation;
 194   /* Algorithm specific data */
 195   void *data;
 196   /* Application specific data */
 197   void *app_data;
 198 } /* EVP_PKEY_CTX */;
 199
 200 struct evp_pkey_method_st {
 201   int pkey_id;
 202   int flags;
 203
 204   int (*init)(EVP_PKEY_CTX *ctx);
 205   int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src);
 206   void (*cleanup)(EVP_PKEY_CTX *ctx);
 207
 208   int (*paramgen_init)(EVP_PKEY_CTX *ctx);
 209   int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
 210
 211   int (*keygen_init)(EVP_PKEY_CTX *ctx);
 212   int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey);
 213
 214   int (*sign_init)(EVP_PKEY_CTX *ctx);
 215   int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 216               const unsigned char *tbs, size_t tbslen);
 217
 218   int (*verify_init)(EVP_PKEY_CTX *ctx);
 219   int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen,
 220                 const unsigned char *tbs, size_t tbslen);
 221
 222   int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
 223   int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 224                  EVP_MD_CTX *mctx);
 225
 226   int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx);
 227   int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig, int siglen,
 228                    EVP_MD_CTX *mctx);
 229
 230   int (*encrypt_init)(EVP_PKEY_CTX *ctx);
 231   int (*encrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 232                  const unsigned char *in, size_t inlen);
 233
 234   int (*decrypt_init)(EVP_PKEY_CTX *ctx);
 235   int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,
 236                  const unsigned char *in, size_t inlen);
 237
 238   int (*derive_init)(EVP_PKEY_CTX *ctx);
 239   int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
 240
 241   int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2);
 242   int (*ctrl_str)(EVP_PKEY_CTX *ctx, const char *type, const char *value);
 243 } /* EVP_PKEY_METHOD */;
 244
 245
 246 #if defined(__cplusplus)
 247 }  /* extern C */
 248 #endif
 249
 250 #endif  /* OPENSSL_HEADER_EVP_INTERNAL_H */