crypto/include/internal/asn1_int.h

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