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