Fix unintended sign extension
[openssl.git] / crypto / asn1 / asn1_locl.h
1 /* asn1t.h */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2006.
5  */
6 /* ====================================================================
7  * Copyright (c) 2006 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 int asn1_utctime_to_tm(struct tm *tm, const ASN1_UTCTIME *d);
63 int asn1_generalizedtime_to_tm(struct tm *tm, const ASN1_GENERALIZEDTIME *d);
64
65 /* ASN1 print context structure */
66
67 struct asn1_pctx_st {
68     unsigned long flags;
69     unsigned long nm_flags;
70     unsigned long cert_flags;
71     unsigned long oid_flags;
72     unsigned long str_flags;
73 } /* ASN1_PCTX */ ;
74
75 /* ASN1 scan context structure */
76
77 struct asn1_sctx_st {
78     /* The ASN1_ITEM associated with this field */
79     const ASN1_ITEM *it;
80     /* If ASN1_TEMPLATE associated with this field */
81     const ASN1_TEMPLATE *tt;
82     /* Various flags associated with field and context */
83     unsigned long flags;
84     /* If SEQUENCE OF or SET OF, field index */
85     int skidx;
86     /* ASN1 depth of field */
87     int depth;
88     /* Structure and field name */
89     const char *sname, *fname;
90     /* If a primitive type the type of underlying field */
91     int prim_type;
92     /* The field value itself */
93     ASN1_VALUE **field;
94     /* Callback to pass information to */
95     int (*scan_cb) (ASN1_SCTX *ctx);
96     /* Context specific application data */
97     void *app_data;
98 } /* ASN1_SCTX */ ;
99
100 /* ASN1 public key method structure */
101
102 struct evp_pkey_asn1_method_st {
103     int pkey_id;
104     int pkey_base_id;
105     unsigned long pkey_flags;
106     char *pem_str;
107     char *info;
108     int (*pub_decode) (EVP_PKEY *pk, X509_PUBKEY *pub);
109     int (*pub_encode) (X509_PUBKEY *pub, const EVP_PKEY *pk);
110     int (*pub_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
111     int (*pub_print) (BIO *out, const EVP_PKEY *pkey, int indent,
112                       ASN1_PCTX *pctx);
113     int (*priv_decode) (EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf);
114     int (*priv_encode) (PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk);
115     int (*priv_print) (BIO *out, const EVP_PKEY *pkey, int indent,
116                        ASN1_PCTX *pctx);
117     int (*pkey_size) (const EVP_PKEY *pk);
118     int (*pkey_bits) (const EVP_PKEY *pk);
119     int (*pkey_security_bits) (const EVP_PKEY *pk);
120     int (*param_decode) (EVP_PKEY *pkey,
121                          const unsigned char **pder, int derlen);
122     int (*param_encode) (const EVP_PKEY *pkey, unsigned char **pder);
123     int (*param_missing) (const EVP_PKEY *pk);
124     int (*param_copy) (EVP_PKEY *to, const EVP_PKEY *from);
125     int (*param_cmp) (const EVP_PKEY *a, const EVP_PKEY *b);
126     int (*param_print) (BIO *out, const EVP_PKEY *pkey, int indent,
127                         ASN1_PCTX *pctx);
128     int (*sig_print) (BIO *out,
129                       const X509_ALGOR *sigalg, const ASN1_STRING *sig,
130                       int indent, ASN1_PCTX *pctx);
131     void (*pkey_free) (EVP_PKEY *pkey);
132     int (*pkey_ctrl) (EVP_PKEY *pkey, int op, long arg1, void *arg2);
133     /* Legacy functions for old PEM */
134     int (*old_priv_decode) (EVP_PKEY *pkey,
135                             const unsigned char **pder, int derlen);
136     int (*old_priv_encode) (const EVP_PKEY *pkey, unsigned char **pder);
137     /* Custom ASN1 signature verification */
138     int (*item_verify) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
139                         X509_ALGOR *a, ASN1_BIT_STRING *sig, EVP_PKEY *pkey);
140     int (*item_sign) (EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
141                       X509_ALGOR *alg1, X509_ALGOR *alg2,
142                       ASN1_BIT_STRING *sig);
143 } /* EVP_PKEY_ASN1_METHOD */ ;
144
145 /*
146  * Method to handle CRL access. In general a CRL could be very large (several
147  * Mb) and can consume large amounts of resources if stored in memory by
148  * multiple processes. This method allows general CRL operations to be
149  * redirected to more efficient callbacks: for example a CRL entry database.
150  */
151
152 #define X509_CRL_METHOD_DYNAMIC         1
153
154 struct x509_crl_method_st {
155     int flags;
156     int (*crl_init) (X509_CRL *crl);
157     int (*crl_free) (X509_CRL *crl);
158     int (*crl_lookup) (X509_CRL *crl, X509_REVOKED **ret,
159                        ASN1_INTEGER *ser, X509_NAME *issuer);
160     int (*crl_verify) (X509_CRL *crl, EVP_PKEY *pk);
161 };