iPXE
asn1.h
Go to the documentation of this file.
1#ifndef _IPXE_ASN1_H
2#define _IPXE_ASN1_H
3
4/** @file
5 *
6 * ASN.1 encoding
7 *
8 */
9
10FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
11FILE_SECBOOT ( PERMITTED );
12
13#include <stddef.h>
14#include <stdint.h>
15#include <stdarg.h>
16#include <assert.h>
17#include <time.h>
18#include <ipxe/tables.h>
19
20/** An ASN.1 object cursor */
21struct asn1_cursor {
22 /** Start of data */
23 const void *data;
24 /** Length of data */
25 size_t len;
26};
27
28/** An ASN.1 object builder */
29struct asn1_builder {
30 /** Data
31 *
32 * This is always dynamically allocated. If @c data is NULL
33 * while @len is non-zero, this indicates that a memory
34 * allocation error has occurred during the building process.
35 */
36 void *data;
37 /** Length of data */
38 size_t len;
39};
40
41/** Maximum (viable) length of ASN.1 length
42 *
43 * While in theory unlimited, this length is sufficient to contain a
44 * size_t.
45 */
46#define ASN1_MAX_LEN_LEN ( 1 + sizeof ( size_t ) )
47
48/** An ASN.1 header */
49struct asn1_builder_header {
50 /** Type */
51 uint8_t type;
52 /** Length (encoded) */
53 uint8_t length[ASN1_MAX_LEN_LEN];
54} __attribute__ (( packed ));
55
56/** ASN.1 end */
57#define ASN1_END 0x00
58
59/** ASN.1 boolean */
60#define ASN1_BOOLEAN 0x01
61
62/** ASN.1 integer */
63#define ASN1_INTEGER 0x02
64
65/** ASN.1 bit string */
66#define ASN1_BIT_STRING 0x03
67
68/** ASN.1 octet string */
69#define ASN1_OCTET_STRING 0x04
70
71/** ASN.1 null */
72#define ASN1_NULL 0x05
73
74/** ASN.1 object identifier */
75#define ASN1_OID 0x06
76
77/** ASN.1 enumeration */
78#define ASN1_ENUMERATED 0x0a
79
80/** ASN.1 UTF-8 string */
81#define ASN1_UTF8_STRING 0x0c
82
83/** ASN.1 UTC time */
84#define ASN1_UTC_TIME 0x17
85
86/** ASN.1 generalized time */
87#define ASN1_GENERALIZED_TIME 0x18
88
89/** ASN.1 sequence */
90#define ASN1_SEQUENCE 0x30
91
92/** ASN.1 set */
93#define ASN1_SET 0x31
94
95/** ASN.1 implicit tag */
96#define ASN1_IMPLICIT_TAG( number) ( 0x80 | (number) )
97
98/** ASN.1 explicit tag */
99#define ASN1_EXPLICIT_TAG( number) ( 0xa0 | (number) )
100
101/** ASN.1 "any tag" magic value */
102#define ASN1_ANY -1U
103
104/** Construct a short ASN.1 value */
105#define ASN1_SHORT( tag, ... ) \
106 (tag), VA_ARG_COUNT ( __VA_ARGS__ ), __VA_ARGS__
107
108/** Initial OID byte */
109#define ASN1_OID_INITIAL( first, second ) ( ( (first) * 40 ) + (second) )
110
111/** Single-byte OID value
112 *
113 * Valid for values up to 127
114 */
115#define ASN1_OID_SINGLE( value ) ( (value) & 0x7f )
116
117/** Double-byte OID value
118 *
119 * Valid for values up to 16383
120 */
121#define ASN1_OID_DOUBLE( value ) \
122 ( 0x80 | ( ( (value) >> 7 ) & 0x7f ) ), ASN1_OID_SINGLE ( (value) )
123
124/** Double-byte OID value
125 *
126 * Valid for values up to 2097151
127 */
128#define ASN1_OID_TRIPLE( value ) \
129 ( 0x80 | ( ( (value) >> 14 ) & 0x7f ) ), ASN1_OID_DOUBLE ( (value) )
130
131/** ASN.1 OID for ecPublicKey (1.2.840.10045.2.1) */
132#define ASN1_OID_ECPUBLICKEY \
133 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
134 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 2 ), \
135 ASN1_OID_SINGLE ( 1 )
136
137/** ASN.1 OID for prime256v1 (1.2.840.10045.3.1.7) */
138#define ASN1_OID_PRIME256V1 \
139 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
140 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 3 ), \
141 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 7 )
142
143/** ASN.1 OID for ecdsa-with-SHA224 (1.2.840.10045.4.3.1) */
144#define ASN1_OID_ECDSA_WITH_SHA224 \
145 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
146 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 4 ), \
147 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 1 )
148
149/** ASN.1 OID for ecdsa-with-SHA256 (1.2.840.10045.4.3.2) */
150#define ASN1_OID_ECDSA_WITH_SHA256 \
151 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
152 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 4 ), \
153 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 2 )
154
155/** ASN.1 OID for ecdsa-with-SHA384 (1.2.840.10045.4.3.3) */
156#define ASN1_OID_ECDSA_WITH_SHA384 \
157 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
158 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 4 ), \
159 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 3 )
160
161/** ASN.1 OID for ecdsa-with-SHA512 (1.2.840.10045.4.3.4) */
162#define ASN1_OID_ECDSA_WITH_SHA512 \
163 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
164 ASN1_OID_DOUBLE ( 10045 ), ASN1_OID_SINGLE ( 4 ), \
165 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 )
166
167/** ASN.1 OID for rsaEncryption (1.2.840.113549.1.1.1) */
168#define ASN1_OID_RSAENCRYPTION \
169 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
170 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
171 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 1 )
172
173/** ASN.1 OID for md5WithRSAEncryption (1.2.840.113549.1.1.4) */
174#define ASN1_OID_MD5WITHRSAENCRYPTION \
175 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
176 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
177 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 4 )
178
179/** ASN.1 OID for sha1WithRSAEncryption (1.2.840.113549.1.1.5) */
180#define ASN1_OID_SHA1WITHRSAENCRYPTION \
181 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
182 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
183 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 )
184
185/** ASN.1 OID for sha256WithRSAEncryption (1.2.840.113549.1.1.11) */
186#define ASN1_OID_SHA256WITHRSAENCRYPTION \
187 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
188 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
189 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 11 )
190
191/** ASN.1 OID for sha384WithRSAEncryption (1.2.840.113549.1.1.12) */
192#define ASN1_OID_SHA384WITHRSAENCRYPTION \
193 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
194 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
195 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 12 )
196
197/** ASN.1 OID for sha512WithRSAEncryption (1.2.840.113549.1.1.13) */
198#define ASN1_OID_SHA512WITHRSAENCRYPTION \
199 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
200 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
201 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 13 )
202
203/** ASN.1 OID for sha224WithRSAEncryption (1.2.840.113549.1.1.14) */
204#define ASN1_OID_SHA224WITHRSAENCRYPTION \
205 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
206 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
207 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 14 )
208
209/** ASN.1 OID for id-md4 (1.2.840.113549.2.4) */
210#define ASN1_OID_MD4 \
211 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
212 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 2 ), \
213 ASN1_OID_SINGLE ( 4 )
214
215/** ASN.1 OID for id-md5 (1.2.840.113549.2.5) */
216#define ASN1_OID_MD5 \
217 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
218 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 2 ), \
219 ASN1_OID_SINGLE ( 5 )
220
221/** ASN.1 OID for id-sha1 (1.3.14.3.2.26) */
222#define ASN1_OID_SHA1 \
223 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 14 ), \
224 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 2 ), \
225 ASN1_OID_SINGLE ( 26 )
226
227/** ASN.1 OID for id-x25519 (1.3.101.110) */
228#define ASN1_OID_X25519 \
229 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 101 ), \
230 ASN1_OID_SINGLE ( 110 )
231
232/** ASN.1 OID for secp384r1 (1.3.132.0.34) */
233#define ASN1_OID_SECP384R1 \
234 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_DOUBLE ( 132 ), \
235 ASN1_OID_SINGLE ( 0 ), ASN1_OID_SINGLE ( 34 )
236
237/** ASN.1 OID for id-aes128-cbc (2.16.840.1.101.3.4.1.2) */
238#define ASN1_OID_AES128_CBC \
239 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
240 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
241 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
242 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 2 )
243
244/** ASN.1 OID for id-aes128-gcm (2.16.840.1.101.3.4.1.6) */
245#define ASN1_OID_AES128_GCM \
246 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
247 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
248 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
249 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 6 )
250
251/** ASN.1 OID for id-aes192-cbc (2.16.840.1.101.3.4.1.22) */
252#define ASN1_OID_AES192_CBC \
253 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
254 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
255 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
256 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 22 )
257
258/** ASN.1 OID for id-aes192-gcm (2.16.840.1.101.3.4.1.26) */
259#define ASN1_OID_AES192_GCM \
260 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
261 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
262 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
263 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 26 )
264
265/** ASN.1 OID for id-aes256-cbc (2.16.840.1.101.3.4.1.42) */
266#define ASN1_OID_AES256_CBC \
267 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
268 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
269 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
270 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 42 )
271
272/** ASN.1 OID for id-aes256-gcm (2.16.840.1.101.3.4.1.46) */
273#define ASN1_OID_AES256_GCM \
274 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
275 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
276 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
277 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 46 )
278
279/** ASN.1 OID for id-sha256 (2.16.840.1.101.3.4.2.1) */
280#define ASN1_OID_SHA256 \
281 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
282 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
283 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
284 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 1 )
285
286/** ASN.1 OID for id-sha384 (2.16.840.1.101.3.4.2.2) */
287#define ASN1_OID_SHA384 \
288 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
289 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
290 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
291 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 2 )
292
293/** ASN.1 OID for id-sha512 (2.16.840.1.101.3.4.2.3) */
294#define ASN1_OID_SHA512 \
295 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
296 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
297 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
298 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 3 )
299
300/** ASN.1 OID for id-sha224 (2.16.840.1.101.3.4.2.4) */
301#define ASN1_OID_SHA224 \
302 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
303 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
304 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
305 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 4 )
306
307/** ASN.1 OID for id-sha512-224 (2.16.840.1.101.3.4.2.5) */
308#define ASN1_OID_SHA512_224 \
309 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
310 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
311 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
312 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 5 )
313
314/** ASN.1 OID for id-sha512-256 (2.16.840.1.101.3.4.2.6) */
315#define ASN1_OID_SHA512_256 \
316 ASN1_OID_INITIAL ( 2, 16 ), ASN1_OID_DOUBLE ( 840 ), \
317 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 101 ), \
318 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 4 ), \
319 ASN1_OID_SINGLE ( 2 ), ASN1_OID_SINGLE ( 6 )
320
321/** ASN.1 OID for commonName (2.5.4.3) */
322#define ASN1_OID_COMMON_NAME \
323 ASN1_OID_INITIAL ( 2, 5 ), ASN1_OID_SINGLE ( 4 ), \
324 ASN1_OID_SINGLE ( 3 )
325
326/** ASN.1 OID for id-ce-keyUsage (2.5.29.15) */
327#define ASN1_OID_KEYUSAGE \
328 ASN1_OID_INITIAL ( 2, 5 ), ASN1_OID_SINGLE ( 29 ), \
329 ASN1_OID_SINGLE ( 15 )
330
331/** ASN.1 OID for id-ce-basicConstraints (2.5.29.19) */
332#define ASN1_OID_BASICCONSTRAINTS \
333 ASN1_OID_INITIAL ( 2, 5 ), ASN1_OID_SINGLE ( 29 ), \
334 ASN1_OID_SINGLE ( 19 )
335
336/** ASN.1 OID for id-ce-extKeyUsage (2.5.29.37) */
337#define ASN1_OID_EXTKEYUSAGE \
338 ASN1_OID_INITIAL ( 2, 5 ), ASN1_OID_SINGLE ( 29 ), \
339 ASN1_OID_SINGLE ( 37 )
340
341/** ASN.1 OID for id-kp-codeSigning (1.3.6.1.5.5.7.3.3) */
342#define ASN1_OID_CODESIGNING \
343 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 6 ), \
344 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 ), \
345 ASN1_OID_SINGLE ( 5 ), ASN1_OID_SINGLE ( 7 ), \
346 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 3 )
347
348/** ASN.1 OID for id-signedData (1.2.840.113549.1.7.2) */
349#define ASN1_OID_SIGNEDDATA \
350 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
351 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
352 ASN1_OID_SINGLE ( 7 ), ASN1_OID_SINGLE ( 2 )
353
354/** ASN.1 OID for id-envelopedData (1.2.840.113549.1.7.3) */
355#define ASN1_OID_ENVELOPEDDATA \
356 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
357 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
358 ASN1_OID_SINGLE ( 7 ), ASN1_OID_SINGLE ( 3 )
359
360/** ASN.1 OID for id-authEnvelopedData (1.2.840.113549.1.9.16.1.23) */
361#define ASN1_OID_AUTHENVELOPEDDATA \
362 ASN1_OID_INITIAL ( 1, 2 ), ASN1_OID_DOUBLE ( 840 ), \
363 ASN1_OID_TRIPLE ( 113549 ), ASN1_OID_SINGLE ( 1 ), \
364 ASN1_OID_SINGLE ( 9 ), ASN1_OID_SINGLE ( 16 ), \
365 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 23 )
366
367/** ASN.1 OID for id-pe-authorityInfoAccess (1.3.6.1.5.5.7.1.1) */
368#define ASN1_OID_AUTHORITYINFOACCESS \
369 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 6 ), \
370 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 ), \
371 ASN1_OID_SINGLE ( 5 ), ASN1_OID_SINGLE ( 7 ), \
372 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 1 )
373
374/** ASN.1 OID for id-ad-ocsp (1.3.6.1.5.5.7.48.1) */
375#define ASN1_OID_OCSP \
376 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 6 ), \
377 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 ), \
378 ASN1_OID_SINGLE ( 5 ), ASN1_OID_SINGLE ( 7 ), \
379 ASN1_OID_SINGLE ( 48 ), ASN1_OID_SINGLE ( 1 )
380
381/** ASN.1 OID for id-pkix-ocsp-basic ( 1.3.6.1.5.5.7.48.1.1) */
382#define ASN1_OID_OCSP_BASIC \
383 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 6 ), \
384 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 ), \
385 ASN1_OID_SINGLE ( 5 ), ASN1_OID_SINGLE ( 7 ), \
386 ASN1_OID_SINGLE ( 48 ), ASN1_OID_SINGLE ( 1 ), \
387 ASN1_OID_SINGLE ( 1 )
388
389/** ASN.1 OID for id-kp-OCSPSigning (1.3.6.1.5.5.7.3.9) */
390#define ASN1_OID_OCSPSIGNING \
391 ASN1_OID_INITIAL ( 1, 3 ), ASN1_OID_SINGLE ( 6 ), \
392 ASN1_OID_SINGLE ( 1 ), ASN1_OID_SINGLE ( 5 ), \
393 ASN1_OID_SINGLE ( 5 ), ASN1_OID_SINGLE ( 7 ), \
394 ASN1_OID_SINGLE ( 3 ), ASN1_OID_SINGLE ( 9 )
395
396/** ASN.1 OID for id-ce-subjectAltName (2.5.29.17) */
397#define ASN1_OID_SUBJECTALTNAME \
398 ASN1_OID_INITIAL ( 2, 5 ), ASN1_OID_SINGLE ( 29 ), \
399 ASN1_OID_SINGLE ( 17 )
400
401/** Define an ASN.1 cursor for a static value */
402#define ASN1_CURSOR( value ) { \
403 .data = value, \
404 .len = sizeof ( value ), \
405 }
406
407/** An ASN.1 OID-identified algorithm */
408struct asn1_algorithm {
409 /** Name */
410 const char *name;
411 /** Object identifier */
412 struct asn1_cursor oid;
413 /** Public-key algorithm (if applicable) */
414 struct pubkey_algorithm *pubkey;
415 /** Digest algorithm (if applicable) */
416 struct digest_algorithm *digest;
417 /** Cipher algorithm (if applicable) */
418 struct cipher_algorithm *cipher;
419 /** Elliptic curve (if applicable) */
420 struct elliptic_curve *curve;
421 /**
422 * Parse algorithm parameters (optional)
423 *
424 * @v algorithm Algorithm
425 * @v param Parameters to parse (and potentially modify)
426 * @ret rc Return status code
427 */
428 int ( * parse ) ( struct asn1_algorithm *algorithm,
429 struct asn1_cursor *params );
430};
431
432/** ASN.1 OID-identified algorithms */
433#define ASN1_ALGORITHMS __table ( struct asn1_algorithm, "asn1_algorithms" )
434
435/** Declare an ASN.1 OID-identified algorithm */
436#define __asn1_algorithm __table_entry ( ASN1_ALGORITHMS, 01 )
437
438/* ASN.1 OID-identified algorithms */
439extern struct asn1_algorithm rsa_encryption_algorithm __asn1_algorithm;
440extern struct asn1_algorithm md5_with_rsa_encryption_algorithm __asn1_algorithm;
441extern struct asn1_algorithm
442sha1_with_rsa_encryption_algorithm __asn1_algorithm;
443extern struct asn1_algorithm
444sha256_with_rsa_encryption_algorithm __asn1_algorithm;
445extern struct asn1_algorithm
446sha384_with_rsa_encryption_algorithm __asn1_algorithm;
447extern struct asn1_algorithm
448sha512_with_rsa_encryption_algorithm __asn1_algorithm;
449extern struct asn1_algorithm
450sha224_with_rsa_encryption_algorithm __asn1_algorithm;
451extern struct asn1_algorithm oid_md4_algorithm __asn1_algorithm;
452extern struct asn1_algorithm oid_md5_algorithm __asn1_algorithm;
453extern struct asn1_algorithm oid_sha1_algorithm __asn1_algorithm;
454extern struct asn1_algorithm oid_sha256_algorithm __asn1_algorithm;
455extern struct asn1_algorithm oid_sha384_algorithm __asn1_algorithm;
456extern struct asn1_algorithm oid_sha512_algorithm __asn1_algorithm;
457extern struct asn1_algorithm oid_sha224_algorithm __asn1_algorithm;
458extern struct asn1_algorithm oid_sha512_224_algorithm __asn1_algorithm;
459extern struct asn1_algorithm oid_sha512_256_algorithm __asn1_algorithm;
460extern struct asn1_algorithm ecpubkey_algorithm __asn1_algorithm;
461
462/**
463 * Invalidate ASN.1 object cursor
464 *
465 * @v cursor ASN.1 object cursor
466 */
467static inline __attribute__ (( always_inline )) void
468asn1_invalidate_cursor ( struct asn1_cursor *cursor ) {
469 cursor->len = 0;
470}
471
472/**
473 * Extract ASN.1 type
474 *
475 * @v cursor ASN.1 object cursor
476 * @ret type Type, or ASN1_END if cursor is invalid
477 */
478static inline __attribute__ (( always_inline )) unsigned int
479asn1_type ( const struct asn1_cursor *cursor ) {
480 const uint8_t *type = cursor->data;
481
482 return ( ( cursor->len >= sizeof ( *type ) ) ? *type : ASN1_END );
483}
484
485/**
486 * Get cursor for built object
487 *
488 * @v builder ASN.1 object builder
489 * @ret cursor ASN.1 object cursor
490 */
491static inline __attribute__ (( always_inline )) struct asn1_cursor *
492asn1_built ( struct asn1_builder *builder ) {
493 union {
494 struct asn1_builder builder;
495 struct asn1_cursor cursor;
496 } *u = container_of ( builder, typeof ( *u ), builder );
497
498 /* Sanity check */
499 build_assert ( ( ( const void * ) &u->builder.data ) ==
500 &u->cursor.data );
501 build_assert ( &u->builder.len == &u->cursor.len );
502
503 return &u->cursor;
504}
505
506extern int asn1_enter ( struct asn1_cursor *cursor, unsigned int type );
507extern int asn1_skip_if_exists ( struct asn1_cursor *cursor,
508 unsigned int type );
509extern int asn1_skip ( struct asn1_cursor *cursor, unsigned int type );
510extern int asn1_shrink ( struct asn1_cursor *cursor, unsigned int type );
511extern int asn1_enter_any ( struct asn1_cursor *cursor );
512extern int asn1_skip_any ( struct asn1_cursor *cursor );
513extern int asn1_shrink_any ( struct asn1_cursor *cursor );
514extern int asn1_enter_bits ( struct asn1_cursor *cursor,
515 unsigned int *unused );
516extern int asn1_enter_unsigned ( struct asn1_cursor *cursor );
517extern int asn1_boolean ( const struct asn1_cursor *cursor );
518extern int asn1_integer ( const struct asn1_cursor *cursor, int *value );
519extern int asn1_compare ( const struct asn1_cursor *cursor1,
520 const struct asn1_cursor *cursor2 );
521extern int asn1_algorithm ( const struct asn1_cursor *cursor,
522 struct asn1_algorithm **algorithm,
523 struct asn1_cursor *params );
524extern int asn1_pubkey_algorithm ( const struct asn1_cursor *cursor,
525 struct asn1_algorithm **algorithm );
526extern int asn1_digest_algorithm ( const struct asn1_cursor *cursor,
527 struct asn1_algorithm **algorithm );
528extern int asn1_cipher_algorithm ( const struct asn1_cursor *cursor,
529 struct asn1_algorithm **algorithm,
530 struct asn1_cursor *params );
531extern int asn1_signature_algorithm ( const struct asn1_cursor *cursor,
532 struct asn1_algorithm **algorithm );
533extern int asn1_curve_algorithm ( const struct asn1_cursor *cursor,
534 struct asn1_algorithm *wrapper,
535 struct asn1_algorithm **algorithm );
536extern int asn1_check_algorithm ( const struct asn1_cursor *cursor,
537 struct asn1_algorithm *expected,
538 struct asn1_cursor *params );
539extern int asn1_parse_cbc ( struct asn1_algorithm *algorithm,
540 struct asn1_cursor *params );
541extern int asn1_parse_gcm ( struct asn1_algorithm *algorithm,
542 struct asn1_cursor *params );
543extern int asn1_generalized_time ( const struct asn1_cursor *cursor,
544 time_t *time );
545extern int asn1_grow ( struct asn1_builder *builder, size_t extra );
546extern int asn1_prepend_raw ( struct asn1_builder *builder, const void *data,
547 size_t len );
548extern int asn1_prepend ( struct asn1_builder *builder, unsigned int type,
549 const void *data, size_t len );
550extern int asn1_wrap ( struct asn1_builder *builder, unsigned int type );
551
552#endif /* _IPXE_ASN1_H */
typeof
typeof(acpi_finder=acpi_find)
ACPI table finder.
Definition acpi.c:48
value
pseudo_bit_t value[0x00020]
Definition arbel.h:2
uint8_t
unsigned char uint8_t
Definition stdint.h:10
asn1_cipher_algorithm
int asn1_cipher_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm **algorithm, struct asn1_cursor *params)
Parse ASN.1 OID-identified cipher algorithm.
Definition asn1.c:597
asn1_prepend
int asn1_prepend(struct asn1_builder *builder, unsigned int type, const void *data, size_t len)
Prepend data to ASN.1 builder.
Definition asn1.c:972
asn1_prepend_raw
int asn1_prepend_raw(struct asn1_builder *builder, const void *data, size_t len)
Prepend raw data to ASN.1 builder.
Definition asn1.c:949
asn1_enter_unsigned
int asn1_enter_unsigned(struct asn1_cursor *cursor)
Enter ASN.1 unsigned integer.
Definition asn1.c:369
asn1_built
static struct asn1_cursor * asn1_built(struct asn1_builder *builder)
Get cursor for built object.
Definition asn1.h:492
asn1_skip_any
int asn1_skip_any(struct asn1_cursor *cursor)
Skip ASN.1 object of any type.
Definition asn1.c:290
asn1_check_algorithm
int asn1_check_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm *expected, struct asn1_cursor *params)
Check ASN.1 OID-identified algorithm.
Definition asn1.c:705
asn1_generalized_time
int asn1_generalized_time(const struct asn1_cursor *cursor, time_t *time)
Parse ASN.1 GeneralizedTime.
Definition asn1.c:777
ASN1_END
#define ASN1_END
ASN.1 end.
Definition asn1.h:57
asn1_invalidate_cursor
static void asn1_invalidate_cursor(struct asn1_cursor *cursor)
Invalidate ASN.1 object cursor.
Definition asn1.h:468
ASN1_MAX_LEN_LEN
#define ASN1_MAX_LEN_LEN
Maximum (viable) length of ASN.1 length.
Definition asn1.h:46
asn1_boolean
int asn1_boolean(const struct asn1_cursor *cursor)
Parse value of ASN.1 boolean.
Definition asn1.c:392
__asn1_algorithm
#define __asn1_algorithm
Declare an ASN.1 OID-identified algorithm.
Definition asn1.h:436
asn1_digest_algorithm
int asn1_digest_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm **algorithm)
Parse ASN.1 OID-identified digest algorithm.
Definition asn1.c:570
asn1_curve_algorithm
int asn1_curve_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm *wrapper, struct asn1_algorithm **algorithm)
Parse ASN.1 OID-identified elliptic curve algorithm.
Definition asn1.c:659
asn1_grow
int asn1_grow(struct asn1_builder *builder, size_t extra)
Grow ASN.1 builder.
Definition asn1.c:916
asn1_enter
int asn1_enter(struct asn1_cursor *cursor, unsigned int type)
Enter ASN.1 object.
Definition asn1.c:169
asn1_enter_any
int asn1_enter_any(struct asn1_cursor *cursor)
Enter ASN.1 object of any type.
Definition asn1.c:280
asn1_parse_gcm
int asn1_parse_gcm(struct asn1_algorithm *algorithm, struct asn1_cursor *params)
asn1_parse_cbc
int asn1_parse_cbc(struct asn1_algorithm *algorithm, struct asn1_cursor *params)
Parse ASN.1 CBC cipher parameters.
Definition asn1.c:732
asn1_skip
int asn1_skip(struct asn1_cursor *cursor, unsigned int type)
Skip ASN.1 object.
Definition asn1.c:231
asn1_pubkey_algorithm
int asn1_pubkey_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm **algorithm)
Parse ASN.1 OID-identified public-key algorithm.
Definition asn1.c:544
asn1_enter_bits
int asn1_enter_bits(struct asn1_cursor *cursor, unsigned int *unused)
Enter ASN.1 bit string.
Definition asn1.c:311
asn1_shrink_any
int asn1_shrink_any(struct asn1_cursor *cursor)
Shrink ASN.1 object of any type.
Definition asn1.c:300
asn1_algorithm
int asn1_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm **algorithm, struct asn1_cursor *params)
Parse ASN.1 OID-identified algorithm.
Definition asn1.c:494
asn1_integer
int asn1_integer(const struct asn1_cursor *cursor, int *value)
Parse value of ASN.1 integer.
Definition asn1.c:416
asn1_compare
int asn1_compare(const struct asn1_cursor *cursor1, const struct asn1_cursor *cursor2)
Compare two ASN.1 objects.
Definition asn1.c:458
asn1_signature_algorithm
int asn1_signature_algorithm(const struct asn1_cursor *cursor, struct asn1_algorithm **algorithm)
Parse ASN.1 OID-identified signature algorithm.
Definition asn1.c:624
asn1_wrap
int asn1_wrap(struct asn1_builder *builder, unsigned int type)
Wrap ASN.1 builder.
Definition asn1.c:999
asn1_shrink
int asn1_shrink(struct asn1_cursor *cursor, unsigned int type)
Shrink ASN.1 cursor to fit object.
Definition asn1.c:254
asn1_type
static unsigned int asn1_type(const struct asn1_cursor *cursor)
Extract ASN.1 type.
Definition asn1.h:479
asn1_skip_if_exists
int asn1_skip_if_exists(struct asn1_cursor *cursor, unsigned int type)
Skip ASN.1 object if present.
Definition asn1.c:202
assert.h
Assertions.
build_assert
#define build_assert(condition)
Assert a condition at build time (after dead code elimination)
Definition assert.h:77
u
union @104331263140136355135267063077374276003064103115 u
len
ring len
Length.
Definition dwmac.h:226
type
uint32_t type
Operating system type.
Definition ena.h:1
data
uint8_t data[48]
Additional event data.
Definition ena.h:11
FILE_LICENCE
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:896
FILE_SECBOOT
#define FILE_SECBOOT(_status)
Declare a file's UEFI Secure Boot permission status.
Definition compiler.h:926
algorithm
u16 algorithm
Authentication algorithm (Open System or Shared Key)
Definition ieee80211.h:1
__attribute__
#define __attribute__(x)
Definition compiler.h:10
extra
uint8_t extra
Signature extra byte.
Definition smbios.h:6
time.h
Time source.
time_t
int64_t time_t
Seconds since the Epoch.
Definition time.h:19
unused
uint8_t unused
Unused.
Definition librm.h:5
container_of
#define container_of(ptr, type, field)
Get containing structure.
Definition stddef.h:36
asn1_algorithm
An ASN.1 OID-identified algorithm.
Definition asn1.h:408
asn1_algorithm::name
const char * name
Name.
Definition asn1.h:410
asn1_algorithm::parse
int(* parse)(struct asn1_algorithm *algorithm, struct asn1_cursor *params)
Parse algorithm parameters (optional)
Definition asn1.h:428
asn1_algorithm::oid
struct asn1_cursor oid
Object identifier.
Definition asn1.h:412
asn1_algorithm::cipher
struct cipher_algorithm * cipher
Cipher algorithm (if applicable)
Definition asn1.h:418
asn1_algorithm::digest
struct digest_algorithm * digest
Digest algorithm (if applicable)
Definition asn1.h:416
asn1_algorithm::pubkey
struct pubkey_algorithm * pubkey
Public-key algorithm (if applicable)
Definition asn1.h:414
asn1_algorithm::curve
struct elliptic_curve * curve
Elliptic curve (if applicable)
Definition asn1.h:420
asn1_builder_header
An ASN.1 header.
Definition asn1.h:49
asn1_builder_header::length
uint8_t length[ASN1_MAX_LEN_LEN]
Length (encoded)
Definition asn1.h:53
asn1_builder_header::type
uint8_t type
Type.
Definition asn1.h:51
asn1_builder
An ASN.1 object builder.
Definition asn1.h:29
asn1_builder::data
void * data
Data.
Definition asn1.h:36
asn1_builder::len
size_t len
Length of data.
Definition asn1.h:38
asn1_cursor
An ASN.1 object cursor.
Definition asn1.h:21
asn1_cursor::data
const void * data
Start of data.
Definition asn1.h:23
asn1_cursor::len
size_t len
Length of data.
Definition asn1.h:25
cipher_algorithm
A cipher algorithm.
Definition crypto.h:51
digest_algorithm
A message digest algorithm.
Definition crypto.h:19
elliptic_curve
An elliptic curve.
Definition crypto.h:178
pubkey_algorithm
A public key algorithm.
Definition crypto.h:122
tables.h
Linker tables.
Generated by doxygen 1.14.0