summaryrefslogtreecommitdiff
path: root/lib/libtasn1.h
blob: 5e30e33db921bcafa4a1d2cc0603f121a623a1a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
/*
 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation
 * Copyright (C) 2002 Fabio Fiorina
 *
 * This file is part of LIBTASN1.
 *
 * LIBTASN1 is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * LIBTASN1 is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with LIBTASN1; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 *
 */

#ifndef LIBTASN1_H
# define LIBTASN1_H

# ifndef ASN1_API
#  if defined ASN1_BUILDING && defined HAVE_VISIBILITY && HAVE_VISIBILITY
#   define ASN1_API __attribute__((__visibility__("default")))
#  elif defined ASN1_BUILDING && defined _MSC_VER && ! defined ASN1_STATIC
#   define ASN1_API __declspec(dllexport)
#  elif defined _MSC_VER && ! defined ASN1_STATIC
#   define ASN1_API __declspec(dllimport)
#  else
#   define ASN1_API
#  endif
# endif

#include <stdio.h>		/* for FILE* */
#include <sys/types.h>
#include <time.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define ASN1_VERSION "2.1"

  typedef int asn1_retCode;	/* type returned by libtasn1 functions */

  /*****************************************/
  /* Errors returned by libtasn1 functions */
  /*****************************************/
#define ASN1_SUCCESS			0
#define ASN1_FILE_NOT_FOUND		1
#define ASN1_ELEMENT_NOT_FOUND		2
#define ASN1_IDENTIFIER_NOT_FOUND	3
#define ASN1_DER_ERROR			4
#define ASN1_VALUE_NOT_FOUND		5
#define ASN1_GENERIC_ERROR		6
#define ASN1_VALUE_NOT_VALID		7
#define ASN1_TAG_ERROR			8
#define ASN1_TAG_IMPLICIT		9
#define ASN1_ERROR_TYPE_ANY		10
#define ASN1_SYNTAX_ERROR		11
#define ASN1_MEM_ERROR			12
#define ASN1_MEM_ALLOC_ERROR		13
#define ASN1_DER_OVERFLOW		14
#define ASN1_NAME_TOO_LONG		15
#define ASN1_ARRAY_ERROR		16
#define ASN1_ELEMENT_NOT_EMPTY		17

  /*************************************/
  /* Constants used in asn1_visit_tree */
  /*************************************/
#define ASN1_PRINT_NAME			1
#define ASN1_PRINT_NAME_TYPE		2
#define ASN1_PRINT_NAME_TYPE_VALUE	3
#define ASN1_PRINT_ALL			4

  /*****************************************/
  /* Constants returned by asn1_read_tag   */
  /*****************************************/
#define ASN1_CLASS_UNIVERSAL		0x00	/* old: 1 */
#define ASN1_CLASS_APPLICATION		0x40	/* old: 2 */
#define ASN1_CLASS_CONTEXT_SPECIFIC	0x80	/* old: 3 */
#define ASN1_CLASS_PRIVATE		0xC0	/* old: 4 */
#define ASN1_CLASS_STRUCTURED		0x20

  /*****************************************/
  /* Constants returned by asn1_read_tag   */
  /*****************************************/
#define ASN1_TAG_BOOLEAN		0x01
#define ASN1_TAG_INTEGER		0x02
#define ASN1_TAG_SEQUENCE		0x10
#define ASN1_TAG_SET			0x11
#define ASN1_TAG_OCTET_STRING		0x04
#define ASN1_TAG_BIT_STRING		0x03
#define ASN1_TAG_UTCTime		0x17
#define ASN1_TAG_GENERALIZEDTime	0x18
#define ASN1_TAG_OBJECT_ID		0x06
#define ASN1_TAG_ENUMERATED		0x0A
#define ASN1_TAG_NULL			0x05
#define ASN1_TAG_GENERALSTRING		0x1B

  /******************************************************/
  /* Structure definition used for the node of the tree */
  /* that represent an ASN.1 DEFINITION.                */
  /******************************************************/

#if !defined(ASN1_BUILDING)
  /* This structure is also in internal.h, but then contains more
     fields.  You cannot make any modifications to these fields
     without breaking ABI.  */
  struct node_asn_struct
  {
    char *name;			/* Node name */
    unsigned int type;		/* Node type */
    unsigned char *value;	/* Node value */
    int value_len;
    struct node_asn_struct *down;	/* Pointer to the son node */
    struct node_asn_struct *right;	/* Pointer to the brother node */
    struct node_asn_struct *left;	/* Pointer to the next list element */
  };
#endif

  typedef struct node_asn_struct node_asn;

  typedef node_asn *ASN1_TYPE;

#define ASN1_TYPE_EMPTY  NULL

  /*****************************************/
  /* For the on-disk format of ASN.1 trees */
  /*****************************************/
  struct static_struct_asn
  {
    const char *name;		/* Node name */
    unsigned int type;		/* Node type */
    const void *value;		/* Node value */
  };
  typedef struct static_struct_asn ASN1_ARRAY_TYPE;

  /***********************************/
  /*  Fixed constants                */
  /***********************************/

  /* maximum number of characters of a name */
  /* inside a file with ASN1 definitons     */
#define ASN1_MAX_NAME_SIZE 128

  /* maximum number of characters */
  /* of a description message     */
  /* (null character included)    */
#define ASN1_MAX_ERROR_DESCRIPTION_SIZE 128

  /***********************************/
  /*  Functions definitions          */
  /***********************************/

  asn1_retCode asn1_parser2tree (const char *file_name,
				 ASN1_TYPE * definitions,
				 char *errorDescription) ASN1_API;

  asn1_retCode asn1_parser2array (const char *inputFileName,
				  const char *outputFileName,
				  const char *vectorName,
				  char *errorDescription) ASN1_API;

  asn1_retCode asn1_array2tree (const ASN1_ARRAY_TYPE * array,
				ASN1_TYPE * definitions,
				char *errorDescription) ASN1_API;

  void asn1_print_structure (FILE * out, ASN1_TYPE structure,
			     const char *name, int mode) ASN1_API;

  asn1_retCode asn1_create_element (ASN1_TYPE definitions,
				    const char *source_name,
				    ASN1_TYPE * element) ASN1_API;

  asn1_retCode asn1_delete_structure (ASN1_TYPE * structure) ASN1_API;

  asn1_retCode asn1_delete_element (ASN1_TYPE structure,
				    const char *element_name) ASN1_API;

  asn1_retCode asn1_write_value (ASN1_TYPE node_root, const char *name,
				 const void *ivalue, int len) ASN1_API;

  asn1_retCode asn1_read_value (ASN1_TYPE root, const char *name,
				void *ivalue, int *len) ASN1_API;

  asn1_retCode asn1_number_of_elements (ASN1_TYPE element, const char *name,
					int *num) ASN1_API;

  asn1_retCode asn1_der_coding (ASN1_TYPE element, const char *name,
				void *ider, int *len,
				char *ErrorDescription) ASN1_API;

  asn1_retCode asn1_der_decoding (ASN1_TYPE * element, const void *ider,
				  int len, char *errorDescription) ASN1_API;

  asn1_retCode asn1_der_decoding_element (ASN1_TYPE * structure,
					  const char *elementName,
					  const void *ider, int len,
					  char *errorDescription) ASN1_API;

  asn1_retCode asn1_der_decoding_startEnd (ASN1_TYPE element,
					   const void *ider, int len,
					   const char *name_element,
					   int *start, int *end) ASN1_API;

  asn1_retCode asn1_expand_any_defined_by (ASN1_TYPE definitions,
					   ASN1_TYPE * element) ASN1_API;

  asn1_retCode asn1_expand_octet_string (ASN1_TYPE definitions,
					 ASN1_TYPE * element,
					 const char *octetName,
					 const char *objectName) ASN1_API;

  asn1_retCode asn1_read_tag (ASN1_TYPE root, const char *name,
			      int *tagValue, int *classValue) ASN1_API;

  const char *asn1_find_structure_from_oid (ASN1_TYPE definitions,
					    const char *oidValue) ASN1_API;

  const char *asn1_check_version (const char *req_version) ASN1_API;

  const char *asn1_strerror (asn1_retCode error) ASN1_API;
  void asn1_perror (asn1_retCode error) ASN1_API;

  /* DER utility functions. */

  int asn1_get_tag_der (const unsigned char *der, int der_len,
			unsigned char *cls, int *len,
			unsigned long *tag) ASN1_API;

  void asn1_octet_der (const unsigned char *str, int str_len,
		       unsigned char *der, int *der_len) ASN1_API;

  asn1_retCode asn1_get_octet_der (const unsigned char *der, int der_len,
				   int *ret_len, unsigned char *str,
				   int str_size, int *str_len) ASN1_API;

  void asn1_bit_der (const unsigned char *str, int bit_len,
		     unsigned char *der, int *der_len) ASN1_API;

  asn1_retCode asn1_get_bit_der (const unsigned char *der, int der_len,
				 int *ret_len, unsigned char *str,
				 int str_size, int *bit_len) ASN1_API;

  signed long asn1_get_length_der (const unsigned char *der, int der_len,
				   int *len) ASN1_API;
  signed long asn1_get_length_ber (const unsigned char *ber, int ber_len,
				   int *len) ASN1_API;

  void asn1_length_der (unsigned long int len, unsigned char *ans,
			int *ans_len) ASN1_API;

  /* Other utility functions. */

  ASN1_TYPE asn1_find_node (ASN1_TYPE pointer, const char *name) ASN1_API;

  asn1_retCode asn1_copy_node (ASN1_TYPE dst, const char *dst_name,
			       ASN1_TYPE src, const char *src_name) ASN1_API;

  /* Deprecated stuff. */

#ifndef ASN1_DISABLE_DEPRECATED

#define LIBTASN1_VERSION ASN1_VERSION

#ifndef MAX_NAME_SIZE
# define MAX_NAME_SIZE ASN1_MAX_NAME_SIZE
#endif

#ifndef MAX_ERROR_DESCRIPTION_SIZE
# define MAX_ERROR_DESCRIPTION_SIZE ASN1_MAX_ERROR_DESCRIPTION_SIZE
#endif

#ifndef __attribute__
  /* This feature is available in gcc versions 2.5 and later.  */
# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
#  define __attribute__(Spec)	/* empty */
# endif
#endif

  /* Use asn1_strerror instead. */
  const char *libtasn1_strerror (asn1_retCode error)
    __attribute__ ((deprecated)) ASN1_API;

  /* Use asn1_perror instead. */
  void libtasn1_perror (asn1_retCode error)
    __attribute__ ((deprecated)) ASN1_API;

#endif

#ifdef __cplusplus
}
#endif

#endif				/* LIBTASN1_H */