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