1 /* Decoder for ASN.1 BER/DER/CER encoded bytestream
3 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
12 #include <linux/export.h>
13 #include <linux/kernel.h>
14 #include <linux/errno.h>
15 #include <linux/asn1_decoder.h>
16 #include <linux/asn1_ber_bytecode.h>
18 static const unsigned char asn1_op_lengths
[ASN1_OP__NR
] = {
20 [ASN1_OP_MATCH
] = 1 + 1,
21 [ASN1_OP_MATCH_OR_SKIP
] = 1 + 1,
22 [ASN1_OP_MATCH_ACT
] = 1 + 1 + 1,
23 [ASN1_OP_MATCH_ACT_OR_SKIP
] = 1 + 1 + 1,
24 [ASN1_OP_MATCH_JUMP
] = 1 + 1 + 1,
25 [ASN1_OP_MATCH_JUMP_OR_SKIP
] = 1 + 1 + 1,
26 [ASN1_OP_MATCH_ANY
] = 1,
27 [ASN1_OP_MATCH_ANY_OR_SKIP
] = 1,
28 [ASN1_OP_MATCH_ANY_ACT
] = 1 + 1,
29 [ASN1_OP_MATCH_ANY_ACT_OR_SKIP
] = 1 + 1,
30 [ASN1_OP_COND_MATCH_OR_SKIP
] = 1 + 1,
31 [ASN1_OP_COND_MATCH_ACT_OR_SKIP
] = 1 + 1 + 1,
32 [ASN1_OP_COND_MATCH_JUMP_OR_SKIP
] = 1 + 1 + 1,
33 [ASN1_OP_COND_MATCH_ANY
] = 1,
34 [ASN1_OP_COND_MATCH_ANY_OR_SKIP
] = 1,
35 [ASN1_OP_COND_MATCH_ANY_ACT
] = 1 + 1,
36 [ASN1_OP_COND_MATCH_ANY_ACT_OR_SKIP
] = 1 + 1,
37 [ASN1_OP_COND_FAIL
] = 1,
38 [ASN1_OP_COMPLETE
] = 1,
39 [ASN1_OP_ACT
] = 1 + 1,
40 [ASN1_OP_MAYBE_ACT
] = 1 + 1,
42 [ASN1_OP_END_SEQ
] = 1,
43 [ASN1_OP_END_SEQ_OF
] = 1 + 1,
44 [ASN1_OP_END_SET
] = 1,
45 [ASN1_OP_END_SET_OF
] = 1 + 1,
46 [ASN1_OP_END_SEQ_ACT
] = 1 + 1,
47 [ASN1_OP_END_SEQ_OF_ACT
] = 1 + 1 + 1,
48 [ASN1_OP_END_SET_ACT
] = 1 + 1,
49 [ASN1_OP_END_SET_OF_ACT
] = 1 + 1 + 1,
53 * Find the length of an indefinite length object
54 * @data: The data buffer
55 * @datalen: The end of the innermost containing element in the buffer
56 * @_dp: The data parse cursor (updated before returning)
57 * @_len: Where to return the size of the element.
58 * @_errmsg: Where to return a pointer to an error message on error
60 static int asn1_find_indefinite_length(const unsigned char *data
, size_t datalen
,
61 size_t *_dp
, size_t *_len
,
64 unsigned char tag
, tmp
;
65 size_t dp
= *_dp
, len
, n
;
69 if (unlikely(datalen
- dp
< 2)) {
72 goto data_overrun_error
;
75 /* Extract a tag from the data */
77 if (tag
== ASN1_EOC
) {
78 /* It appears to be an EOC. */
81 if (--indef_level
<= 0) {
89 if (unlikely((tag
& 0x1f) == ASN1_LONG_TAG
)) {
91 if (unlikely(datalen
- dp
< 2))
92 goto data_overrun_error
;
97 /* Extract the length */
102 if (unlikely(len
== ASN1_INDEFINITE_LENGTH
)) {
103 /* Indefinite length */
104 if (unlikely((tag
& ASN1_CONS_BIT
) == ASN1_PRIM
<< 5))
105 goto indefinite_len_primitive
;
111 if (unlikely(n
> sizeof(len
) - 1))
112 goto length_too_long
;
113 if (unlikely(n
> datalen
- dp
))
114 goto data_overrun_error
;
121 if (len
> datalen
- dp
)
122 goto data_overrun_error
;
127 *_errmsg
= "Unsupported length";
129 indefinite_len_primitive
:
130 *_errmsg
= "Indefinite len primitive not permitted";
133 *_errmsg
= "Invalid length EOC";
136 *_errmsg
= "Data overrun error";
139 *_errmsg
= "Missing EOC in indefinite len cons";
146 * asn1_ber_decoder - Decoder BER/DER/CER ASN.1 according to pattern
147 * @decoder: The decoder definition (produced by asn1_compiler)
148 * @context: The caller's context (to be passed to the action functions)
149 * @data: The encoded data
150 * @datalen: The size of the encoded data
152 * Decode BER/DER/CER encoded ASN.1 data according to a bytecode pattern
153 * produced by asn1_compiler. Action functions are called on marked tags to
154 * allow the caller to retrieve significant data.
158 * To keep down the amount of stack used by this function, the following limits
161 * (1) This won't handle datalen > 65535 without increasing the size of the
162 * cons stack elements and length_too_long checking.
164 * (2) The stack of constructed types is 10 deep. If the depth of non-leaf
165 * constructed types exceeds this, the decode will fail.
167 * (3) The SET type (not the SET OF type) isn't really supported as tracking
168 * what members of the set have been seen is a pain.
170 int asn1_ber_decoder(const struct asn1_decoder
*decoder
,
172 const unsigned char *data
,
175 const unsigned char *machine
= decoder
->machine
;
176 const asn1_action_t
*actions
= decoder
->actions
;
177 size_t machlen
= decoder
->machlen
;
179 unsigned char tag
= 0, csp
= 0, jsp
= 0, optag
= 0, hdr
= 0;
181 size_t pc
= 0, dp
= 0, tdp
= 0, len
= 0;
184 unsigned char flags
= 0;
185 #define FLAG_INDEFINITE_LENGTH 0x01
186 #define FLAG_MATCHED 0x02
187 #define FLAG_LAST_MATCHED 0x04 /* Last tag matched */
188 #define FLAG_CONS 0x20 /* Corresponds to CONS bit in the opcode tag
189 * - ie. whether or not we are going to parse
193 #define NR_CONS_STACK 10
194 unsigned short cons_dp_stack
[NR_CONS_STACK
];
195 unsigned short cons_datalen_stack
[NR_CONS_STACK
];
196 unsigned char cons_hdrlen_stack
[NR_CONS_STACK
];
197 #define NR_JUMP_STACK 10
198 unsigned char jump_stack
[NR_JUMP_STACK
];
204 pr_debug("next_op: pc=\e[32m%zu\e[m/%zu dp=\e[33m%zu\e[m/%zu C=%d J=%d\n",
205 pc
, machlen
, dp
, datalen
, csp
, jsp
);
206 if (unlikely(pc
>= machlen
))
207 goto machine_overrun_error
;
209 if (unlikely(pc
+ asn1_op_lengths
[op
] > machlen
))
210 goto machine_overrun_error
;
212 /* If this command is meant to match a tag, then do that before
213 * evaluating the command.
215 if (op
<= ASN1_OP__MATCHES_TAG
) {
218 /* Skip conditional matches if possible */
219 if ((op
& ASN1_OP_MATCH__COND
&& flags
& FLAG_MATCHED
) ||
220 (op
& ASN1_OP_MATCH__SKIP
&& dp
== datalen
)) {
221 flags
&= ~FLAG_LAST_MATCHED
;
222 pc
+= asn1_op_lengths
[op
];
229 /* Extract a tag from the data */
230 if (unlikely(datalen
- dp
< 2))
231 goto data_overrun_error
;
233 if (unlikely((tag
& 0x1f) == ASN1_LONG_TAG
))
234 goto long_tag_not_supported
;
236 if (op
& ASN1_OP_MATCH__ANY
) {
237 pr_debug("- any %02x\n", tag
);
239 /* Extract the tag from the machine
240 * - Either CONS or PRIM are permitted in the data if
241 * CONS is not set in the op stream, otherwise CONS
244 optag
= machine
[pc
+ 1];
245 flags
|= optag
& FLAG_CONS
;
247 /* Determine whether the tag matched */
249 tmp
&= ~(optag
& ASN1_CONS_BIT
);
250 pr_debug("- match? %02x %02x %02x\n", tag
, optag
, tmp
);
252 /* All odd-numbered tags are MATCH_OR_SKIP. */
253 if (op
& ASN1_OP_MATCH__SKIP
) {
254 pc
+= asn1_op_lengths
[op
];
261 flags
|= FLAG_MATCHED
;
265 if (unlikely(len
== ASN1_INDEFINITE_LENGTH
)) {
266 /* Indefinite length */
267 if (unlikely(!(tag
& ASN1_CONS_BIT
)))
268 goto indefinite_len_primitive
;
269 flags
|= FLAG_INDEFINITE_LENGTH
;
270 if (unlikely(2 > datalen
- dp
))
271 goto data_overrun_error
;
275 goto length_too_long
;
276 if (unlikely(n
> datalen
- dp
))
277 goto data_overrun_error
;
279 for (len
= 0; n
> 0; n
--) {
283 if (unlikely(len
> datalen
- dp
))
284 goto data_overrun_error
;
287 if (unlikely(len
> datalen
- dp
))
288 goto data_overrun_error
;
291 if (flags
& FLAG_CONS
) {
292 /* For expected compound forms, we stack the positions
293 * of the start and end of the data.
295 if (unlikely(csp
>= NR_CONS_STACK
))
296 goto cons_stack_overflow
;
297 cons_dp_stack
[csp
] = dp
;
298 cons_hdrlen_stack
[csp
] = hdr
;
299 if (!(flags
& FLAG_INDEFINITE_LENGTH
)) {
300 cons_datalen_stack
[csp
] = datalen
;
303 cons_datalen_stack
[csp
] = 0;
308 pr_debug("- TAG: %02x %zu%s\n",
309 tag
, len
, flags
& FLAG_CONS
? " CONS" : "");
313 /* Decide how to handle the operation */
316 case ASN1_OP_MATCH_OR_SKIP
:
317 case ASN1_OP_MATCH_ACT
:
318 case ASN1_OP_MATCH_ACT_OR_SKIP
:
319 case ASN1_OP_MATCH_ANY
:
320 case ASN1_OP_MATCH_ANY_OR_SKIP
:
321 case ASN1_OP_MATCH_ANY_ACT
:
322 case ASN1_OP_MATCH_ANY_ACT_OR_SKIP
:
323 case ASN1_OP_COND_MATCH_OR_SKIP
:
324 case ASN1_OP_COND_MATCH_ACT_OR_SKIP
:
325 case ASN1_OP_COND_MATCH_ANY
:
326 case ASN1_OP_COND_MATCH_ANY_OR_SKIP
:
327 case ASN1_OP_COND_MATCH_ANY_ACT
:
328 case ASN1_OP_COND_MATCH_ANY_ACT_OR_SKIP
:
330 if (!(flags
& FLAG_CONS
)) {
331 if (flags
& FLAG_INDEFINITE_LENGTH
) {
334 ret
= asn1_find_indefinite_length(
335 data
, datalen
, &tmp
, &len
, &errmsg
);
339 pr_debug("- LEAF: %zu\n", len
);
342 if (op
& ASN1_OP_MATCH__ACT
) {
345 if (op
& ASN1_OP_MATCH__ANY
)
346 act
= machine
[pc
+ 1];
348 act
= machine
[pc
+ 2];
349 ret
= actions
[act
](context
, hdr
, tag
, data
+ dp
, len
);
354 if (!(flags
& FLAG_CONS
))
356 pc
+= asn1_op_lengths
[op
];
359 case ASN1_OP_MATCH_JUMP
:
360 case ASN1_OP_MATCH_JUMP_OR_SKIP
:
361 case ASN1_OP_COND_MATCH_JUMP_OR_SKIP
:
362 pr_debug("- MATCH_JUMP\n");
363 if (unlikely(jsp
== NR_JUMP_STACK
))
364 goto jump_stack_overflow
;
365 jump_stack
[jsp
++] = pc
+ asn1_op_lengths
[op
];
366 pc
= machine
[pc
+ 2];
369 case ASN1_OP_COND_FAIL
:
370 if (unlikely(!(flags
& FLAG_MATCHED
)))
372 pc
+= asn1_op_lengths
[op
];
375 case ASN1_OP_COMPLETE
:
376 if (unlikely(jsp
!= 0 || csp
!= 0)) {
377 pr_err("ASN.1 decoder error: Stacks not empty at completion (%u, %u)\n",
383 case ASN1_OP_END_SET
:
384 case ASN1_OP_END_SET_ACT
:
385 if (unlikely(!(flags
& FLAG_MATCHED
)))
387 case ASN1_OP_END_SEQ
:
388 case ASN1_OP_END_SET_OF
:
389 case ASN1_OP_END_SEQ_OF
:
390 case ASN1_OP_END_SEQ_ACT
:
391 case ASN1_OP_END_SET_OF_ACT
:
392 case ASN1_OP_END_SEQ_OF_ACT
:
393 if (unlikely(csp
<= 0))
394 goto cons_stack_underflow
;
396 tdp
= cons_dp_stack
[csp
];
397 hdr
= cons_hdrlen_stack
[csp
];
399 datalen
= cons_datalen_stack
[csp
];
400 pr_debug("- end cons t=%zu dp=%zu l=%zu/%zu\n",
401 tdp
, dp
, len
, datalen
);
403 /* Indefinite length - check for the EOC. */
405 if (unlikely(datalen
- dp
< 2))
406 goto data_overrun_error
;
407 if (data
[dp
++] != 0) {
408 if (op
& ASN1_OP_END__OF
) {
411 pc
= machine
[pc
+ 1];
412 pr_debug("- continue\n");
421 if (dp
< len
&& (op
& ASN1_OP_END__OF
)) {
424 pc
= machine
[pc
+ 1];
425 pr_debug("- continue\n");
429 goto cons_length_error
;
431 pr_debug("- cons len l=%zu d=%zu\n", len
, dp
- tdp
);
434 if (op
& ASN1_OP_END__ACT
) {
436 if (op
& ASN1_OP_END__OF
)
437 act
= machine
[pc
+ 2];
439 act
= machine
[pc
+ 1];
440 ret
= actions
[act
](context
, hdr
, 0, data
+ tdp
, len
);
444 pc
+= asn1_op_lengths
[op
];
447 case ASN1_OP_MAYBE_ACT
:
448 if (!(flags
& FLAG_LAST_MATCHED
)) {
449 pc
+= asn1_op_lengths
[op
];
453 ret
= actions
[machine
[pc
+ 1]](context
, hdr
, tag
, data
+ tdp
, len
);
456 pc
+= asn1_op_lengths
[op
];
460 if (unlikely(jsp
<= 0))
461 goto jump_stack_underflow
;
462 pc
= jump_stack
[--jsp
];
463 flags
|= FLAG_MATCHED
| FLAG_LAST_MATCHED
;
470 /* Shouldn't reach here */
471 pr_err("ASN.1 decoder error: Found reserved opcode (%u) pc=%zu\n",
476 errmsg
= "Data overrun error";
478 machine_overrun_error
:
479 errmsg
= "Machine overrun error";
481 jump_stack_underflow
:
482 errmsg
= "Jump stack underflow";
485 errmsg
= "Jump stack overflow";
487 cons_stack_underflow
:
488 errmsg
= "Cons stack underflow";
491 errmsg
= "Cons stack overflow";
494 errmsg
= "Cons length error";
497 errmsg
= "Missing EOC in indefinite len cons";
500 errmsg
= "Invalid length EOC";
503 errmsg
= "Unsupported length";
505 indefinite_len_primitive
:
506 errmsg
= "Indefinite len primitive not permitted";
509 errmsg
= "Unexpected tag";
511 long_tag_not_supported
:
512 errmsg
= "Long tag not supported";
514 pr_debug("\nASN1: %s [m=%zu d=%zu ot=%02x t=%02x l=%zu]\n",
515 errmsg
, pc
, dp
, optag
, tag
, len
);
518 EXPORT_SYMBOL_GPL(asn1_ber_decoder
);