crypto/include/internal/asn1_int.h

   1 /*
   2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
   3  * 2015.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 /* Internal ASN1 structures and functions: not for application use */
  60
  61 /* ASN1 public key method structure */
  62
  63 struct evp_pkey_asn1_method_st {
  64     int pkey_id;
  65     int pkey_base_id;
  66     unsigned long pkey_flags;
  67     char *pem_str;
  68     char *info;
  69     int (*pub_decode) (EVP_PKEY *pk, X509_PUBKEY *pub);
  70     int (*pub_encode) (X509_PUBKEY *pub, const EVP_PKEY *pk);
  71     int (*pub_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
  72     int (*pub_print) (BIO *out, const EVP_PKEY *pkey, int indent,
  73                       ASN1_PCTX *pctx);
  74     int (*priv_decode) (EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf);
  75     int (*priv_encode) (PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk);
  76     int (*priv_print) (BIO *out, const EVP_PKEY *pkey, int indent,
  77                        ASN1_PCTX *pctx);
  78     int (*pkey_size) (const EVP_PKEY *pk);
  79     int (*pkey_bits) (const EVP_PKEY *pk);
  80     int (*pkey_security_bits) (const EVP_PKEY *pk);
  81     int (*param_decode) (EVP_PKEY *pkey,
  82                          const unsigned char **pder, int derlen);
  83     int (*param_encode) (const EVP_PKEY *pkey, unsigned char **pder);
  84     int (*param_missing) (const EVP_PKEY *pk);
  85     int (*param_copy) (EVP_PKEY *to, const EVP_PKEY *from);
  86     int (*param_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
  87     int (*param_print) (BIO *out, const EVP_PKEY *pkey, int indent,
  88                         ASN1_PCTX *pctx);
  89     int (*sig_print) (BIO *out,
  90                       const X509_ALGOR *sigalg, const ASN1_STRING *sig,
  91                       int indent, ASN1_PCTX *pctx);
  92     void (*pkey_free) (EVP_PKEY *pkey);
  93     int (*pkey_ctrl) (EVP_PKEY *pkey, int op, long arg1, void *arg2);
  94     /* Legacy functions for old PEM */
  95     int (*old_priv_decode) (EVP_PKEY *pkey,
  96                             const unsigned char **pder, int derlen);
  97     int (*old_priv_encode) (const EVP_PKEY *pkey, unsigned char **pder);
  98     /* Custom ASN1 signature verification */
  99     int (*item_verify) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
 100                         X509_ALGOR *a, ASN1_BIT_STRING *sig, EVP_PKEY *pkey);
 101     int (*item_sign) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
 102                       X509_ALGOR *alg1, X509_ALGOR *alg2,
 103                       ASN1_BIT_STRING *sig);
 104 } /* EVP_PKEY_ASN1_METHOD */ ;
 105
 106 DEFINE_STACK_OF_CONST(EVP_PKEY_ASN1_METHOD)
 107
 108 extern const EVP_PKEY_ASN1_METHOD cmac_asn1_meth;
 109 extern const EVP_PKEY_ASN1_METHOD dh_asn1_meth;
 110 extern const EVP_PKEY_ASN1_METHOD dhx_asn1_meth;
 111 extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meths[];
 112 extern const EVP_PKEY_ASN1_METHOD eckey_asn1_meth;
 113 extern const EVP_PKEY_ASN1_METHOD hmac_asn1_meth;
 114 extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[];
 115
 116 /*
 117  * These are used internally in the ASN1_OBJECT to keep track of whether the
 118  * names and data need to be free()ed
 119  */
 120 # define ASN1_OBJECT_FLAG_DYNAMIC         0x01/* internal use */
 121 # define ASN1_OBJECT_FLAG_CRITICAL        0x02/* critical x509v3 object id */
 122 # define ASN1_OBJECT_FLAG_DYNAMIC_STRINGS 0x04/* internal use */
 123 # define ASN1_OBJECT_FLAG_DYNAMIC_DATA    0x08/* internal use */
 124 struct asn1_object_st {
 125     const char *sn, *ln;
 126     int nid;
 127     int length;
 128     const unsigned char *data;  /* data remains const after init */
 129     int flags;                  /* Should we free this one */
 130 };
 131
 132 /* ASN1 print context structure */
 133
 134 struct asn1_pctx_st {
 135     unsigned long flags;
 136     unsigned long nm_flags;
 137     unsigned long cert_flags;
 138     unsigned long oid_flags;
 139     unsigned long str_flags;
 140 } /* ASN1_PCTX */ ;