1 // SPDX-License-Identifier: GPL-2.0-only
3 * AppArmor security module
5 * This file contains AppArmor dfa based regular expression matching engine
7 * Copyright (C) 1998-2008 Novell/SUSE
8 * Copyright 2009-2012 Canonical Ltd.
11 #include <linux/errno.h>
12 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/err.h>
17 #include <linux/kref.h>
19 #include "include/lib.h"
20 #include "include/match.h"
22 #define base_idx(X) ((X) & 0xffffff)
24 static char nulldfa_src
[] = {
27 struct aa_dfa
*nulldfa
;
29 static char stacksplitdfa_src
[] = {
30 #include "stacksplitdfa.in"
32 struct aa_dfa
*stacksplitdfa
;
34 int aa_setup_dfa_engine(void)
38 nulldfa
= aa_dfa_unpack(nulldfa_src
, sizeof(nulldfa_src
),
39 TO_ACCEPT1_FLAG(YYTD_DATA32
) |
40 TO_ACCEPT2_FLAG(YYTD_DATA32
));
41 if (IS_ERR(nulldfa
)) {
42 error
= PTR_ERR(nulldfa
);
47 stacksplitdfa
= aa_dfa_unpack(stacksplitdfa_src
,
48 sizeof(stacksplitdfa_src
),
49 TO_ACCEPT1_FLAG(YYTD_DATA32
) |
50 TO_ACCEPT2_FLAG(YYTD_DATA32
));
51 if (IS_ERR(stacksplitdfa
)) {
54 error
= PTR_ERR(stacksplitdfa
);
62 void aa_teardown_dfa_engine(void)
64 aa_put_dfa(stacksplitdfa
);
69 * unpack_table - unpack a dfa table (one of accept, default, base, next check)
70 * @blob: data to unpack (NOT NULL)
71 * @bsize: size of blob
73 * Returns: pointer to table else NULL on failure
75 * NOTE: must be freed by kvfree (not kfree)
77 static struct table_header
*unpack_table(char *blob
, size_t bsize
)
79 struct table_header
*table
= NULL
;
80 struct table_header th
;
83 if (bsize
< sizeof(struct table_header
))
86 /* loaded td_id's start at 1, subtract 1 now to avoid doing
87 * it every time we use td_id as an index
89 th
.td_id
= be16_to_cpu(*(__be16
*) (blob
)) - 1;
90 if (th
.td_id
> YYTD_ID_MAX
)
92 th
.td_flags
= be16_to_cpu(*(__be16
*) (blob
+ 2));
93 th
.td_lolen
= be32_to_cpu(*(__be32
*) (blob
+ 8));
94 blob
+= sizeof(struct table_header
);
96 if (!(th
.td_flags
== YYTD_DATA16
|| th
.td_flags
== YYTD_DATA32
||
97 th
.td_flags
== YYTD_DATA8
))
100 /* if we have a table it must have some entries */
101 if (th
.td_lolen
== 0)
103 tsize
= table_size(th
.td_lolen
, th
.td_flags
);
107 table
= kvzalloc(tsize
, GFP_KERNEL
);
109 table
->td_id
= th
.td_id
;
110 table
->td_flags
= th
.td_flags
;
111 table
->td_lolen
= th
.td_lolen
;
112 if (th
.td_flags
== YYTD_DATA8
)
113 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
114 u8
, u8
, byte_to_byte
);
115 else if (th
.td_flags
== YYTD_DATA16
)
116 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
117 u16
, __be16
, be16_to_cpu
);
118 else if (th
.td_flags
== YYTD_DATA32
)
119 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
120 u32
, __be32
, be32_to_cpu
);
123 /* if table was vmalloced make sure the page tables are synced
124 * before it is used, as it goes live to all cpus.
126 if (is_vmalloc_addr(table
))
138 * verify_table_headers - verify that the tables headers are as expected
139 * @tables - array of dfa tables to check (NOT NULL)
140 * @flags: flags controlling what type of accept table are acceptable
142 * Assumes dfa has gone through the first pass verification done by unpacking
143 * NOTE: this does not valid accept table values
145 * Returns: %0 else error code on failure to verify
147 static int verify_table_headers(struct table_header
**tables
, int flags
)
149 size_t state_count
, trans_count
;
152 /* check that required tables exist */
153 if (!(tables
[YYTD_ID_DEF
] && tables
[YYTD_ID_BASE
] &&
154 tables
[YYTD_ID_NXT
] && tables
[YYTD_ID_CHK
]))
157 /* accept.size == default.size == base.size */
158 state_count
= tables
[YYTD_ID_BASE
]->td_lolen
;
159 if (ACCEPT1_FLAGS(flags
)) {
160 if (!tables
[YYTD_ID_ACCEPT
])
162 if (state_count
!= tables
[YYTD_ID_ACCEPT
]->td_lolen
)
165 if (ACCEPT2_FLAGS(flags
)) {
166 if (!tables
[YYTD_ID_ACCEPT2
])
168 if (state_count
!= tables
[YYTD_ID_ACCEPT2
]->td_lolen
)
171 if (state_count
!= tables
[YYTD_ID_DEF
]->td_lolen
)
174 /* next.size == chk.size */
175 trans_count
= tables
[YYTD_ID_NXT
]->td_lolen
;
176 if (trans_count
!= tables
[YYTD_ID_CHK
]->td_lolen
)
179 /* if equivalence classes then its table size must be 256 */
180 if (tables
[YYTD_ID_EC
] && tables
[YYTD_ID_EC
]->td_lolen
!= 256)
189 * verify_dfa - verify that transitions and states in the tables are in bounds.
190 * @dfa: dfa to test (NOT NULL)
192 * Assumes dfa has gone through the first pass verification done by unpacking
193 * NOTE: this does not valid accept table values
195 * Returns: %0 else error code on failure to verify
197 static int verify_dfa(struct aa_dfa
*dfa
)
199 size_t i
, state_count
, trans_count
;
202 state_count
= dfa
->tables
[YYTD_ID_BASE
]->td_lolen
;
203 trans_count
= dfa
->tables
[YYTD_ID_NXT
]->td_lolen
;
204 if (state_count
== 0)
206 for (i
= 0; i
< state_count
; i
++) {
207 if (!(BASE_TABLE(dfa
)[i
] & MATCH_FLAG_DIFF_ENCODE
) &&
208 (DEFAULT_TABLE(dfa
)[i
] >= state_count
))
210 if (BASE_TABLE(dfa
)[i
] & MATCH_FLAGS_INVALID
) {
211 pr_err("AppArmor DFA state with invalid match flags");
214 if ((BASE_TABLE(dfa
)[i
] & MATCH_FLAG_DIFF_ENCODE
)) {
215 if (!(dfa
->flags
& YYTH_FLAG_DIFF_ENCODE
)) {
216 pr_err("AppArmor DFA diff encoded transition state without header flag");
220 if ((BASE_TABLE(dfa
)[i
] & MATCH_FLAG_OOB_TRANSITION
)) {
221 if (base_idx(BASE_TABLE(dfa
)[i
]) < dfa
->max_oob
) {
222 pr_err("AppArmor DFA out of bad transition out of range");
225 if (!(dfa
->flags
& YYTH_FLAG_OOB_TRANS
)) {
226 pr_err("AppArmor DFA out of bad transition state without header flag");
230 if (base_idx(BASE_TABLE(dfa
)[i
]) + 255 >= trans_count
) {
231 pr_err("AppArmor DFA next/check upper bounds error\n");
236 for (i
= 0; i
< trans_count
; i
++) {
237 if (NEXT_TABLE(dfa
)[i
] >= state_count
)
239 if (CHECK_TABLE(dfa
)[i
] >= state_count
)
243 /* Now that all the other tables are verified, verify diffencoding */
244 for (i
= 0; i
< state_count
; i
++) {
248 (BASE_TABLE(dfa
)[j
] & MATCH_FLAG_DIFF_ENCODE
) &&
249 !(BASE_TABLE(dfa
)[j
] & MARK_DIFF_ENCODE
);
251 k
= DEFAULT_TABLE(dfa
)[j
];
255 break; /* already verified */
256 BASE_TABLE(dfa
)[j
] |= MARK_DIFF_ENCODE
;
266 * dfa_free - free a dfa allocated by aa_dfa_unpack
267 * @dfa: the dfa to free (MAYBE NULL)
269 * Requires: reference count to dfa == 0
271 static void dfa_free(struct aa_dfa
*dfa
)
276 for (i
= 0; i
< ARRAY_SIZE(dfa
->tables
); i
++) {
277 kvfree(dfa
->tables
[i
]);
278 dfa
->tables
[i
] = NULL
;
285 * aa_dfa_free_kref - free aa_dfa by kref (called by aa_put_dfa)
286 * @kr: kref callback for freeing of a dfa (NOT NULL)
288 void aa_dfa_free_kref(struct kref
*kref
)
290 struct aa_dfa
*dfa
= container_of(kref
, struct aa_dfa
, count
);
295 * aa_dfa_unpack - unpack the binary tables of a serialized dfa
296 * @blob: aligned serialized stream of data to unpack (NOT NULL)
297 * @size: size of data to unpack
298 * @flags: flags controlling what type of accept tables are acceptable
300 * Unpack a dfa that has been serialized. To find information on the dfa
301 * format look in Documentation/admin-guide/LSM/apparmor.rst
302 * Assumes the dfa @blob stream has been aligned on a 8 byte boundary
304 * Returns: an unpacked dfa ready for matching or ERR_PTR on failure
306 struct aa_dfa
*aa_dfa_unpack(void *blob
, size_t size
, int flags
)
311 struct table_header
*table
= NULL
;
312 struct aa_dfa
*dfa
= kzalloc(sizeof(struct aa_dfa
), GFP_KERNEL
);
316 kref_init(&dfa
->count
);
320 /* get dfa table set header */
321 if (size
< sizeof(struct table_set_header
))
324 if (ntohl(*(__be32
*) data
) != YYTH_MAGIC
)
327 hsize
= ntohl(*(__be32
*) (data
+ 4));
331 dfa
->flags
= ntohs(*(__be16
*) (data
+ 12));
332 if (dfa
->flags
& ~(YYTH_FLAGS
))
336 * TODO: needed for dfa to support more than 1 oob
337 * if (dfa->flags & YYTH_FLAGS_OOB_TRANS) {
338 * if (hsize < 16 + 4)
340 * dfa->max_oob = ntol(*(__be32 *) (data + 16));
341 * if (dfa->max <= MAX_OOB_SUPPORTED) {
342 * pr_err("AppArmor DFA OOB greater than supported\n");
353 table
= unpack_table(data
, size
);
357 switch (table
->td_id
) {
359 if (!(table
->td_flags
& ACCEPT1_FLAGS(flags
)))
362 case YYTD_ID_ACCEPT2
:
363 if (!(table
->td_flags
& ACCEPT2_FLAGS(flags
)))
367 if (table
->td_flags
!= YYTD_DATA32
)
373 if (table
->td_flags
!= YYTD_DATA16
)
377 if (table
->td_flags
!= YYTD_DATA8
)
383 /* check for duplicate table entry */
384 if (dfa
->tables
[table
->td_id
])
386 dfa
->tables
[table
->td_id
] = table
;
387 data
+= table_size(table
->td_lolen
, table
->td_flags
);
388 size
-= table_size(table
->td_lolen
, table
->td_flags
);
391 error
= verify_table_headers(dfa
->tables
, flags
);
395 if (flags
& DFA_FLAG_VERIFY_STATES
) {
396 error
= verify_dfa(dfa
);
406 return ERR_PTR(error
);
409 #define match_char(state, def, base, next, check, C) \
411 u32 b = (base)[(state)]; \
412 unsigned int pos = base_idx(b) + (C); \
413 if ((check)[pos] != (state)) { \
414 (state) = (def)[(state)]; \
415 if (b & MATCH_FLAG_DIFF_ENCODE) \
419 (state) = (next)[pos]; \
424 * aa_dfa_match_len - traverse @dfa to find state @str stops at
425 * @dfa: the dfa to match @str against (NOT NULL)
426 * @start: the state of the dfa to start matching in
427 * @str: the string of bytes to match against the dfa (NOT NULL)
428 * @len: length of the string of bytes to match
430 * aa_dfa_match_len will match @str against the dfa and return the state it
431 * finished matching in. The final state can be used to look up the accepting
432 * label, or as the start state of a continuing match.
434 * This function will happily match again the 0 byte and only finishes
435 * when @len input is consumed.
437 * Returns: final state reached after input is consumed
439 unsigned int aa_dfa_match_len(struct aa_dfa
*dfa
, unsigned int start
,
440 const char *str
, int len
)
442 u16
*def
= DEFAULT_TABLE(dfa
);
443 u32
*base
= BASE_TABLE(dfa
);
444 u16
*next
= NEXT_TABLE(dfa
);
445 u16
*check
= CHECK_TABLE(dfa
);
446 unsigned int state
= start
;
451 /* current state is <state>, matching character *str */
452 if (dfa
->tables
[YYTD_ID_EC
]) {
453 /* Equivalence class table defined */
454 u8
*equiv
= EQUIV_TABLE(dfa
);
456 match_char(state
, def
, base
, next
, check
,
459 /* default is direct to next state */
461 match_char(state
, def
, base
, next
, check
, (u8
) *str
++);
468 * aa_dfa_match - traverse @dfa to find state @str stops at
469 * @dfa: the dfa to match @str against (NOT NULL)
470 * @start: the state of the dfa to start matching in
471 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
473 * aa_dfa_match will match @str against the dfa and return the state it
474 * finished matching in. The final state can be used to look up the accepting
475 * label, or as the start state of a continuing match.
477 * Returns: final state reached after input is consumed
479 unsigned int aa_dfa_match(struct aa_dfa
*dfa
, unsigned int start
,
482 u16
*def
= DEFAULT_TABLE(dfa
);
483 u32
*base
= BASE_TABLE(dfa
);
484 u16
*next
= NEXT_TABLE(dfa
);
485 u16
*check
= CHECK_TABLE(dfa
);
486 unsigned int state
= start
;
491 /* current state is <state>, matching character *str */
492 if (dfa
->tables
[YYTD_ID_EC
]) {
493 /* Equivalence class table defined */
494 u8
*equiv
= EQUIV_TABLE(dfa
);
495 /* default is direct to next state */
497 match_char(state
, def
, base
, next
, check
,
500 /* default is direct to next state */
502 match_char(state
, def
, base
, next
, check
, (u8
) *str
++);
509 * aa_dfa_next - step one character to the next state in the dfa
510 * @dfa: the dfa to traverse (NOT NULL)
511 * @state: the state to start in
512 * @c: the input character to transition on
514 * aa_dfa_match will step through the dfa by one input character @c
516 * Returns: state reach after input @c
518 unsigned int aa_dfa_next(struct aa_dfa
*dfa
, unsigned int state
,
521 u16
*def
= DEFAULT_TABLE(dfa
);
522 u32
*base
= BASE_TABLE(dfa
);
523 u16
*next
= NEXT_TABLE(dfa
);
524 u16
*check
= CHECK_TABLE(dfa
);
526 /* current state is <state>, matching character *str */
527 if (dfa
->tables
[YYTD_ID_EC
]) {
528 /* Equivalence class table defined */
529 u8
*equiv
= EQUIV_TABLE(dfa
);
530 match_char(state
, def
, base
, next
, check
, equiv
[(u8
) c
]);
532 match_char(state
, def
, base
, next
, check
, (u8
) c
);
537 unsigned int aa_dfa_outofband_transition(struct aa_dfa
*dfa
, unsigned int state
)
539 u16
*def
= DEFAULT_TABLE(dfa
);
540 u32
*base
= BASE_TABLE(dfa
);
541 u16
*next
= NEXT_TABLE(dfa
);
542 u16
*check
= CHECK_TABLE(dfa
);
543 u32 b
= (base
)[(state
)];
545 if (!(b
& MATCH_FLAG_OOB_TRANSITION
))
548 /* No Equivalence class remapping for outofband transitions */
549 match_char(state
, def
, base
, next
, check
, -1);
555 * aa_dfa_match_until - traverse @dfa until accept state or end of input
556 * @dfa: the dfa to match @str against (NOT NULL)
557 * @start: the state of the dfa to start matching in
558 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
559 * @retpos: first character in str after match OR end of string
561 * aa_dfa_match will match @str against the dfa and return the state it
562 * finished matching in. The final state can be used to look up the accepting
563 * label, or as the start state of a continuing match.
565 * Returns: final state reached after input is consumed
567 unsigned int aa_dfa_match_until(struct aa_dfa
*dfa
, unsigned int start
,
568 const char *str
, const char **retpos
)
570 u16
*def
= DEFAULT_TABLE(dfa
);
571 u32
*base
= BASE_TABLE(dfa
);
572 u16
*next
= NEXT_TABLE(dfa
);
573 u16
*check
= CHECK_TABLE(dfa
);
574 u32
*accept
= ACCEPT_TABLE(dfa
);
575 unsigned int state
= start
, pos
;
580 /* current state is <state>, matching character *str */
581 if (dfa
->tables
[YYTD_ID_EC
]) {
582 /* Equivalence class table defined */
583 u8
*equiv
= EQUIV_TABLE(dfa
);
584 /* default is direct to next state */
586 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
587 if (check
[pos
] == state
)
595 /* default is direct to next state */
597 pos
= base_idx(base
[state
]) + (u8
) *str
++;
598 if (check
[pos
] == state
)
612 * aa_dfa_matchn_until - traverse @dfa until accept or @n bytes consumed
613 * @dfa: the dfa to match @str against (NOT NULL)
614 * @start: the state of the dfa to start matching in
615 * @str: the string of bytes to match against the dfa (NOT NULL)
616 * @n: length of the string of bytes to match
617 * @retpos: first character in str after match OR str + n
619 * aa_dfa_match_len will match @str against the dfa and return the state it
620 * finished matching in. The final state can be used to look up the accepting
621 * label, or as the start state of a continuing match.
623 * This function will happily match again the 0 byte and only finishes
624 * when @n input is consumed.
626 * Returns: final state reached after input is consumed
628 unsigned int aa_dfa_matchn_until(struct aa_dfa
*dfa
, unsigned int start
,
629 const char *str
, int n
, const char **retpos
)
631 u16
*def
= DEFAULT_TABLE(dfa
);
632 u32
*base
= BASE_TABLE(dfa
);
633 u16
*next
= NEXT_TABLE(dfa
);
634 u16
*check
= CHECK_TABLE(dfa
);
635 u32
*accept
= ACCEPT_TABLE(dfa
);
636 unsigned int state
= start
, pos
;
642 /* current state is <state>, matching character *str */
643 if (dfa
->tables
[YYTD_ID_EC
]) {
644 /* Equivalence class table defined */
645 u8
*equiv
= EQUIV_TABLE(dfa
);
646 /* default is direct to next state */
648 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
649 if (check
[pos
] == state
)
657 /* default is direct to next state */
659 pos
= base_idx(base
[state
]) + (u8
) *str
++;
660 if (check
[pos
] == state
)
673 #define inc_wb_pos(wb) \
675 wb->pos = (wb->pos + 1) & (WB_HISTORY_SIZE - 1); \
676 wb->len = (wb->len + 1) & (WB_HISTORY_SIZE - 1); \
679 /* For DFAs that don't support extended tagging of states */
680 static bool is_loop(struct match_workbuf
*wb
, unsigned int state
,
681 unsigned int *adjust
)
683 unsigned int pos
= wb
->pos
;
686 if (wb
->history
[pos
] < state
)
689 for (i
= 0; i
<= wb
->len
; i
++) {
690 if (wb
->history
[pos
] == state
) {
695 pos
= WB_HISTORY_SIZE
;
703 static unsigned int leftmatch_fb(struct aa_dfa
*dfa
, unsigned int start
,
704 const char *str
, struct match_workbuf
*wb
,
707 u16
*def
= DEFAULT_TABLE(dfa
);
708 u32
*base
= BASE_TABLE(dfa
);
709 u16
*next
= NEXT_TABLE(dfa
);
710 u16
*check
= CHECK_TABLE(dfa
);
711 unsigned int state
= start
, pos
;
722 /* current state is <state>, matching character *str */
723 if (dfa
->tables
[YYTD_ID_EC
]) {
724 /* Equivalence class table defined */
725 u8
*equiv
= EQUIV_TABLE(dfa
);
726 /* default is direct to next state */
730 wb
->history
[wb
->pos
] = state
;
731 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
732 if (check
[pos
] == state
)
736 if (is_loop(wb
, state
, &adjust
)) {
737 state
= aa_dfa_match(dfa
, state
, str
);
745 /* default is direct to next state */
749 wb
->history
[wb
->pos
] = state
;
750 pos
= base_idx(base
[state
]) + (u8
) *str
++;
751 if (check
[pos
] == state
)
755 if (is_loop(wb
, state
, &adjust
)) {
756 state
= aa_dfa_match(dfa
, state
, str
);
772 * aa_dfa_leftmatch - traverse @dfa to find state @str stops at
773 * @dfa: the dfa to match @str against (NOT NULL)
774 * @start: the state of the dfa to start matching in
775 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
776 * @count: current count of longest left.
778 * aa_dfa_match will match @str against the dfa and return the state it
779 * finished matching in. The final state can be used to look up the accepting
780 * label, or as the start state of a continuing match.
782 * Returns: final state reached after input is consumed
784 unsigned int aa_dfa_leftmatch(struct aa_dfa
*dfa
, unsigned int start
,
785 const char *str
, unsigned int *count
)
789 /* TODO: match for extended state dfas */
791 return leftmatch_fb(dfa
, start
, str
, &wb
, count
);