866c2809559e190dbffcef34c1759db361174494
[strongswan.git] / src / libstrongswan / asn1 / asn1.h
1 /*
2 * Copyright (C) 2006 Martin Will
3 * Copyright (C) 2000-2008 Andreas Steffen
4 *
5 * Hochschule fuer Technik Rapperswil
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * for more details.
16 */
17
18 /**
19 * @defgroup asn1i asn1
20 * @{ @ingroup asn1
21 */
22
23 #ifndef ASN1_H_
24 #define ASN1_H_
25
26 #include <stdarg.h>
27
28 #include <library.h>
29
30 /**
31 * Definition of some primitive ASN1 types
32 */
33 typedef enum {
34 ASN1_EOC = 0x00,
35 ASN1_BOOLEAN = 0x01,
36 ASN1_INTEGER = 0x02,
37 ASN1_BIT_STRING = 0x03,
38 ASN1_OCTET_STRING = 0x04,
39 ASN1_NULL = 0x05,
40 ASN1_OID = 0x06,
41 ASN1_ENUMERATED = 0x0A,
42 ASN1_UTF8STRING = 0x0C,
43 ASN1_NUMERICSTRING = 0x12,
44 ASN1_PRINTABLESTRING = 0x13,
45 ASN1_T61STRING = 0x14,
46 ASN1_VIDEOTEXSTRING = 0x15,
47 ASN1_IA5STRING = 0x16,
48 ASN1_UTCTIME = 0x17,
49 ASN1_GENERALIZEDTIME = 0x18,
50 ASN1_GRAPHICSTRING = 0x19,
51 ASN1_VISIBLESTRING = 0x1A,
52 ASN1_GENERALSTRING = 0x1B,
53 ASN1_UNIVERSALSTRING = 0x1C,
54 ASN1_BMPSTRING = 0x1E,
55
56 ASN1_CONSTRUCTED = 0x20,
57
58 ASN1_SEQUENCE = 0x30,
59 ASN1_SET = 0x31,
60
61 ASN1_CONTEXT_S_0 = 0x80,
62 ASN1_CONTEXT_S_1 = 0x81,
63 ASN1_CONTEXT_S_2 = 0x82,
64 ASN1_CONTEXT_S_3 = 0x83,
65 ASN1_CONTEXT_S_4 = 0x84,
66 ASN1_CONTEXT_S_5 = 0x85,
67 ASN1_CONTEXT_S_6 = 0x86,
68 ASN1_CONTEXT_S_7 = 0x87,
69 ASN1_CONTEXT_S_8 = 0x88,
70
71 ASN1_CONTEXT_C_0 = 0xA0,
72 ASN1_CONTEXT_C_1 = 0xA1,
73 ASN1_CONTEXT_C_2 = 0xA2,
74 ASN1_CONTEXT_C_3 = 0xA3,
75 ASN1_CONTEXT_C_4 = 0xA4,
76 ASN1_CONTEXT_C_5 = 0xA5,
77
78 ASN1_INVALID = 0x100,
79 } asn1_t;
80
81 #define ASN1_INVALID_LENGTH 0xffffffff
82
83 /**
84 * Some common prefabricated ASN.1 constants
85 */
86 extern const chunk_t ASN1_INTEGER_0;
87 extern const chunk_t ASN1_INTEGER_1;
88 extern const chunk_t ASN1_INTEGER_2;
89
90
91 /** Some ASN.1 analysis functions */
92
93 /**
94 * Build an algorithmIdentifier from a known OID.
95 *
96 * @param oid known OID index
97 * @return body of the corresponding OID, allocated
98 */
99 chunk_t asn1_algorithmIdentifier(int oid);
100
101 /**
102 * Converts an ASN.1 OID into a known OID index
103 *
104 * @param object body of an OID
105 * @return index into the oid_names[] table or OID_UNKNOWN
106 */
107 int asn1_known_oid(chunk_t object);
108
109 /**
110 * Converts a known OID index to an ASN.1 OID
111 *
112 * @param n index into the oid_names[] table
113 * @return allocated OID chunk, chunk_empty if index out of range
114 */
115 chunk_t asn1_build_known_oid(int n);
116
117 /**
118 * Returns the length of an ASN.1 object
119 * The blob pointer is advanced past the tag length fields
120 *
121 * @param blob pointer to an ASN.1 coded blob
122 * @return length of ASN.1 object
123 */
124 size_t asn1_length(chunk_t *blob);
125
126 /**
127 * Unwrap the inner content of an ASN.1 type/length wrapped object.
128 *
129 * @param blob blob to parse header from, moved behind parsed content
130 * @param content inner content
131 * @return parsed type, ASN1_INVALID if length parsing failed
132 */
133 int asn1_unwrap(chunk_t *blob, chunk_t *content);
134
135 /**
136 * Parses an ASN.1 algorithmIdentifier object
137 *
138 * @param blob ASN.1 coded blob
139 * @param level0 top-most level offset
140 * @param params returns optional [ASN.1 coded] parameters
141 * @return known OID index or OID_UNKNOWN
142 */
143 int asn1_parse_algorithmIdentifier(chunk_t blob, int level0, chunk_t *params);
144
145 /**
146 * Parse the top-most level of an ASN.1 object
147 *
148 * @param object ASN.1 coded object
149 * @param type Expected ASN.1 type
150 * @param level0 top-most level offset
151 * @param name descriptive name of object
152 * @return TRUE if parsing successful
153 */
154 bool asn1_parse_simple_object(chunk_t *object, asn1_t type, u_int level0,
155 const char* name);
156
157 /**
158 * Print the value of an ASN.1 simple object
159 *
160 * @param object ASN.1 object to be printed
161 * @param type asn1_t type
162 * @param private ASN.1 data is confidential (use debug level 4)
163 */
164 void asn1_debug_simple_object(chunk_t object, asn1_t type, bool private);
165
166 /**
167 * Converts an ASN.1 UTCTIME or GENERALIZEDTIME string to time_t
168 *
169 * @param utctime body of an ASN.1 coded time object
170 * @param type ASN1_UTCTIME or ASN1_GENERALIZEDTIME
171 * @return time_t in UTC
172 */
173 time_t asn1_to_time(const chunk_t *utctime, asn1_t type);
174
175 /**
176 * Converts time_t to an ASN.1 UTCTIME or GENERALIZEDTIME string
177 *
178 * @param time time_t in UTC
179 * @param type ASN1_UTCTIME or ASN1_GENERALIZEDTIME
180 * @return body of an ASN.1 code time object
181 */
182 chunk_t asn1_from_time(const time_t *time, asn1_t type);
183
184 /**
185 * Parse an ASN.1 UTCTIME or GENERALIZEDTIME object
186 *
187 * @param blob ASN.1 coded time object
188 * @param level0 top-most level offset
189 * @return time_t in UTC
190 */
191 time_t asn1_parse_time(chunk_t blob, int level0);
192
193 /**
194 * Determines if a binary blob is ASN.1 coded
195 *
196 * @param blob blob to be tested
197 * @return TRUE if blob is ASN.1 coded (SEQUENCE or SET)
198 */
199 bool is_asn1(chunk_t blob);
200
201 /**
202 * Determines if a character string can be coded as PRINTABLESTRING
203 *
204 * @param str character string to be tested
205 * @return TRUE if no special characters are contained
206 */
207 bool asn1_is_printablestring(chunk_t str);
208
209
210 /** some ASN.1 synthesis functions */
211
212 /**
213 * Build an empty ASN.1 object with tag and length fields already filled in
214 *
215 * @param object returned object - memory is allocated by function
216 * @param type ASN.1 type to be created
217 * @param datalen size of the body to be created
218 * @return points to the first position in the body
219 */
220 u_char* asn1_build_object(chunk_t *object, asn1_t type, size_t datalen);
221
222 /**
223 * Build a simple ASN.1 object
224 *
225 * @param tag ASN.1 type to be created
226 * @param content content of the ASN.1 object
227 * @return chunk containing the ASN.1 coded object
228 */
229 chunk_t asn1_simple_object(asn1_t tag, chunk_t content);
230
231 /**
232 * Build an ASN.1 BITSTRING object
233 *
234 * @param mode 'c' for copy or 'm' for move
235 * @param content content of the BITSTRING
236 * @return chunk containing the ASN.1 coded BITSTRING
237 */
238 chunk_t asn1_bitstring(const char *mode, chunk_t content);
239
240 /**
241 * Build an ASN.1 INTEGER object
242 *
243 * @param mode 'c' for copy or 'm' for move
244 * @param content content of the INTEGER
245 * @return chunk containing the ASN.1 coded INTEGER
246 */
247 chunk_t asn1_integer(const char *mode, chunk_t content);
248
249 /**
250 * Build an ASN.1 object from a variable number of individual chunks
251 *
252 * The mode string specifies the number of chunks, and how to handle each of
253 * them with a single character: 'c' for copy (allocate new chunk), 'm' for move
254 * (free given chunk) or 's' for sensitive-copy (clear given chunk, then free).
255 *
256 * @param type ASN.1 type to be created
257 * @param mode for each list member: 'c', 'm' or 's'
258 * @return chunk containing the ASN.1 coded object
259 */
260 chunk_t asn1_wrap(asn1_t type, const char *mode, ...);
261
262 #endif /** ASN1_H_ @}*/