ea3d20ae3840e15bfe9c4cf68bceb2bda1effbab
[openssl.git] / crypto / asn1 / asn1_locl.h
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 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 scan context structure */
65
66 struct asn1_sctx_st {
67     /* The ASN1_ITEM associated with this field */
68     const ASN1_ITEM *it;
69     /* If ASN1_TEMPLATE associated with this field */
70     const ASN1_TEMPLATE *tt;
71     /* Various flags associated with field and context */
72     unsigned long flags;
73     /* If SEQUENCE OF or SET OF, field index */
74     int skidx;
75     /* ASN1 depth of field */
76     int depth;
77     /* Structure and field name */
78     const char *sname, *fname;
79     /* If a primitive type the type of underlying field */
80     int prim_type;
81     /* The field value itself */
82     ASN1_VALUE **field;
83     /* Callback to pass information to */
84     int (*scan_cb) (ASN1_SCTX *ctx);
85     /* Context specific application data */
86     void *app_data;
87 } /* ASN1_SCTX */ ;
88
89 typedef struct mime_param_st MIME_PARAM;
90 DEFINE_STACK_OF(MIME_PARAM)
91 typedef struct mime_header_st MIME_HEADER;
92 DEFINE_STACK_OF(MIME_HEADER)
93
94 /* Month values for printing out times */
95 extern const char *_asn1_mon[12];
96
97 int asn1_get_choice_selector(ASN1_VALUE **pval, const ASN1_ITEM *it);
98 int asn1_set_choice_selector(ASN1_VALUE **pval, int value,
99                              const ASN1_ITEM *it);
100
101 ASN1_VALUE **asn1_get_field_ptr(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt);
102
103 const ASN1_TEMPLATE *asn1_do_adb(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt,
104                                  int nullerr);
105
106 int asn1_do_lock(ASN1_VALUE **pval, int op, const ASN1_ITEM *it);
107
108 void asn1_enc_init(ASN1_VALUE **pval, const ASN1_ITEM *it);
109 void asn1_enc_free(ASN1_VALUE **pval, const ASN1_ITEM *it);
110 int asn1_enc_restore(int *len, unsigned char **out, ASN1_VALUE **pval,
111                      const ASN1_ITEM *it);
112 int asn1_enc_save(ASN1_VALUE **pval, const unsigned char *in, int inlen,
113                   const ASN1_ITEM *it);
114
115 void asn1_primitive_free(ASN1_VALUE **pval, const ASN1_ITEM *it);
116 void asn1_template_free(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt);
117
118 ASN1_OBJECT *c2i_ASN1_OBJECT(ASN1_OBJECT **a, const unsigned char **pp,
119                              long length);
120 int i2c_ASN1_BIT_STRING(ASN1_BIT_STRING *a, unsigned char **pp);
121 ASN1_BIT_STRING *c2i_ASN1_BIT_STRING(ASN1_BIT_STRING **a,
122                                      const unsigned char **pp, long length);
123 int i2c_ASN1_INTEGER(ASN1_INTEGER *a, unsigned char **pp);
124 ASN1_INTEGER *c2i_ASN1_INTEGER(ASN1_INTEGER **a, const unsigned char **pp,
125                                long length);