2 * AppArmor security module
4 * This file contains AppArmor dfa based regular expression matching engine
6 * Copyright (C) 1998-2008 Novell/SUSE
7 * Copyright 2009-2012 Canonical Ltd.
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as
11 * published by the Free Software Foundation, version 2 of the
15 #include <linux/errno.h>
16 #include <linux/kernel.h>
18 #include <linux/slab.h>
19 #include <linux/vmalloc.h>
20 #include <linux/err.h>
21 #include <linux/kref.h>
23 #include "include/lib.h"
24 #include "include/match.h"
26 #define base_idx(X) ((X) & 0xffffff)
28 static char nulldfa_src
[] = {
31 struct aa_dfa
*nulldfa
;
33 static char stacksplitdfa_src
[] = {
34 #include "stacksplitdfa.in"
36 struct aa_dfa
*stacksplitdfa
;
38 int aa_setup_dfa_engine(void)
42 nulldfa
= aa_dfa_unpack(nulldfa_src
, sizeof(nulldfa_src
),
43 TO_ACCEPT1_FLAG(YYTD_DATA32
) |
44 TO_ACCEPT2_FLAG(YYTD_DATA32
));
45 if (IS_ERR(nulldfa
)) {
46 error
= PTR_ERR(nulldfa
);
51 stacksplitdfa
= aa_dfa_unpack(stacksplitdfa_src
,
52 sizeof(stacksplitdfa_src
),
53 TO_ACCEPT1_FLAG(YYTD_DATA32
) |
54 TO_ACCEPT2_FLAG(YYTD_DATA32
));
55 if (IS_ERR(stacksplitdfa
)) {
58 error
= PTR_ERR(stacksplitdfa
);
66 void aa_teardown_dfa_engine(void)
68 aa_put_dfa(stacksplitdfa
);
73 * unpack_table - unpack a dfa table (one of accept, default, base, next check)
74 * @blob: data to unpack (NOT NULL)
75 * @bsize: size of blob
77 * Returns: pointer to table else NULL on failure
79 * NOTE: must be freed by kvfree (not kfree)
81 static struct table_header
*unpack_table(char *blob
, size_t bsize
)
83 struct table_header
*table
= NULL
;
84 struct table_header th
;
87 if (bsize
< sizeof(struct table_header
))
90 /* loaded td_id's start at 1, subtract 1 now to avoid doing
91 * it every time we use td_id as an index
93 th
.td_id
= be16_to_cpu(*(__be16
*) (blob
)) - 1;
94 if (th
.td_id
> YYTD_ID_MAX
)
96 th
.td_flags
= be16_to_cpu(*(__be16
*) (blob
+ 2));
97 th
.td_lolen
= be32_to_cpu(*(__be32
*) (blob
+ 8));
98 blob
+= sizeof(struct table_header
);
100 if (!(th
.td_flags
== YYTD_DATA16
|| th
.td_flags
== YYTD_DATA32
||
101 th
.td_flags
== YYTD_DATA8
))
104 tsize
= table_size(th
.td_lolen
, th
.td_flags
);
108 table
= kvzalloc(tsize
, GFP_KERNEL
);
110 table
->td_id
= th
.td_id
;
111 table
->td_flags
= th
.td_flags
;
112 table
->td_lolen
= th
.td_lolen
;
113 if (th
.td_flags
== YYTD_DATA8
)
114 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
115 u8
, u8
, byte_to_byte
);
116 else if (th
.td_flags
== YYTD_DATA16
)
117 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
118 u16
, __be16
, be16_to_cpu
);
119 else if (th
.td_flags
== YYTD_DATA32
)
120 UNPACK_ARRAY(table
->td_data
, blob
, th
.td_lolen
,
121 u32
, __be32
, be32_to_cpu
);
124 /* if table was vmalloced make sure the page tables are synced
125 * before it is used, as it goes live to all cpus.
127 if (is_vmalloc_addr(table
))
139 * verify_table_headers - verify that the tables headers are as expected
140 * @tables - array of dfa tables to check (NOT NULL)
141 * @flags: flags controlling what type of accept table are acceptable
143 * Assumes dfa has gone through the first pass verification done by unpacking
144 * NOTE: this does not valid accept table values
146 * Returns: %0 else error code on failure to verify
148 static int verify_table_headers(struct table_header
**tables
, int flags
)
150 size_t state_count
, trans_count
;
153 /* check that required tables exist */
154 if (!(tables
[YYTD_ID_DEF
] && tables
[YYTD_ID_BASE
] &&
155 tables
[YYTD_ID_NXT
] && tables
[YYTD_ID_CHK
]))
158 /* accept.size == default.size == base.size */
159 state_count
= tables
[YYTD_ID_BASE
]->td_lolen
;
160 if (ACCEPT1_FLAGS(flags
)) {
161 if (!tables
[YYTD_ID_ACCEPT
])
163 if (state_count
!= tables
[YYTD_ID_ACCEPT
]->td_lolen
)
166 if (ACCEPT2_FLAGS(flags
)) {
167 if (!tables
[YYTD_ID_ACCEPT2
])
169 if (state_count
!= tables
[YYTD_ID_ACCEPT2
]->td_lolen
)
172 if (state_count
!= tables
[YYTD_ID_DEF
]->td_lolen
)
175 /* next.size == chk.size */
176 trans_count
= tables
[YYTD_ID_NXT
]->td_lolen
;
177 if (trans_count
!= tables
[YYTD_ID_CHK
]->td_lolen
)
180 /* if equivalence classes then its table size must be 256 */
181 if (tables
[YYTD_ID_EC
] && tables
[YYTD_ID_EC
]->td_lolen
!= 256)
190 * verify_dfa - verify that transitions and states in the tables are in bounds.
191 * @dfa: dfa to test (NOT NULL)
193 * Assumes dfa has gone through the first pass verification done by unpacking
194 * NOTE: this does not valid accept table values
196 * Returns: %0 else error code on failure to verify
198 static int verify_dfa(struct aa_dfa
*dfa
)
200 size_t i
, state_count
, trans_count
;
203 state_count
= dfa
->tables
[YYTD_ID_BASE
]->td_lolen
;
204 trans_count
= dfa
->tables
[YYTD_ID_NXT
]->td_lolen
;
205 for (i
= 0; i
< state_count
; i
++) {
206 if (!(BASE_TABLE(dfa
)[i
] & MATCH_FLAG_DIFF_ENCODE
) &&
207 (DEFAULT_TABLE(dfa
)[i
] >= state_count
))
209 if (base_idx(BASE_TABLE(dfa
)[i
]) + 255 >= trans_count
) {
210 pr_err("AppArmor DFA next/check upper bounds error\n");
215 for (i
= 0; i
< trans_count
; i
++) {
216 if (NEXT_TABLE(dfa
)[i
] >= state_count
)
218 if (CHECK_TABLE(dfa
)[i
] >= state_count
)
222 /* Now that all the other tables are verified, verify diffencoding */
223 for (i
= 0; i
< state_count
; i
++) {
227 (BASE_TABLE(dfa
)[j
] & MATCH_FLAG_DIFF_ENCODE
) &&
228 !(BASE_TABLE(dfa
)[j
] & MARK_DIFF_ENCODE
);
230 k
= DEFAULT_TABLE(dfa
)[j
];
234 break; /* already verified */
235 BASE_TABLE(dfa
)[j
] |= MARK_DIFF_ENCODE
;
245 * dfa_free - free a dfa allocated by aa_dfa_unpack
246 * @dfa: the dfa to free (MAYBE NULL)
248 * Requires: reference count to dfa == 0
250 static void dfa_free(struct aa_dfa
*dfa
)
255 for (i
= 0; i
< ARRAY_SIZE(dfa
->tables
); i
++) {
256 kvfree(dfa
->tables
[i
]);
257 dfa
->tables
[i
] = NULL
;
264 * aa_dfa_free_kref - free aa_dfa by kref (called by aa_put_dfa)
265 * @kr: kref callback for freeing of a dfa (NOT NULL)
267 void aa_dfa_free_kref(struct kref
*kref
)
269 struct aa_dfa
*dfa
= container_of(kref
, struct aa_dfa
, count
);
274 * aa_dfa_unpack - unpack the binary tables of a serialized dfa
275 * @blob: aligned serialized stream of data to unpack (NOT NULL)
276 * @size: size of data to unpack
277 * @flags: flags controlling what type of accept tables are acceptable
279 * Unpack a dfa that has been serialized. To find information on the dfa
280 * format look in Documentation/admin-guide/LSM/apparmor.rst
281 * Assumes the dfa @blob stream has been aligned on a 8 byte boundary
283 * Returns: an unpacked dfa ready for matching or ERR_PTR on failure
285 struct aa_dfa
*aa_dfa_unpack(void *blob
, size_t size
, int flags
)
290 struct table_header
*table
= NULL
;
291 struct aa_dfa
*dfa
= kzalloc(sizeof(struct aa_dfa
), GFP_KERNEL
);
295 kref_init(&dfa
->count
);
299 /* get dfa table set header */
300 if (size
< sizeof(struct table_set_header
))
303 if (ntohl(*(__be32
*) data
) != YYTH_MAGIC
)
306 hsize
= ntohl(*(__be32
*) (data
+ 4));
310 dfa
->flags
= ntohs(*(__be16
*) (data
+ 12));
311 if (dfa
->flags
!= 0 && dfa
->flags
!= YYTH_FLAG_DIFF_ENCODE
)
318 table
= unpack_table(data
, size
);
322 switch (table
->td_id
) {
324 if (!(table
->td_flags
& ACCEPT1_FLAGS(flags
)))
327 case YYTD_ID_ACCEPT2
:
328 if (!(table
->td_flags
& ACCEPT2_FLAGS(flags
)))
332 if (table
->td_flags
!= YYTD_DATA32
)
338 if (table
->td_flags
!= YYTD_DATA16
)
342 if (table
->td_flags
!= YYTD_DATA8
)
348 /* check for duplicate table entry */
349 if (dfa
->tables
[table
->td_id
])
351 dfa
->tables
[table
->td_id
] = table
;
352 data
+= table_size(table
->td_lolen
, table
->td_flags
);
353 size
-= table_size(table
->td_lolen
, table
->td_flags
);
356 error
= verify_table_headers(dfa
->tables
, flags
);
360 if (flags
& DFA_FLAG_VERIFY_STATES
) {
361 error
= verify_dfa(dfa
);
371 return ERR_PTR(error
);
374 #define match_char(state, def, base, next, check, C) \
376 u32 b = (base)[(state)]; \
377 unsigned int pos = base_idx(b) + (C); \
378 if ((check)[pos] != (state)) { \
379 (state) = (def)[(state)]; \
380 if (b & MATCH_FLAG_DIFF_ENCODE) \
384 (state) = (next)[pos]; \
389 * aa_dfa_match_len - traverse @dfa to find state @str stops at
390 * @dfa: the dfa to match @str against (NOT NULL)
391 * @start: the state of the dfa to start matching in
392 * @str: the string of bytes to match against the dfa (NOT NULL)
393 * @len: length of the string of bytes to match
395 * aa_dfa_match_len will match @str against the dfa and return the state it
396 * finished matching in. The final state can be used to look up the accepting
397 * label, or as the start state of a continuing match.
399 * This function will happily match again the 0 byte and only finishes
400 * when @len input is consumed.
402 * Returns: final state reached after input is consumed
404 unsigned int aa_dfa_match_len(struct aa_dfa
*dfa
, unsigned int start
,
405 const char *str
, int len
)
407 u16
*def
= DEFAULT_TABLE(dfa
);
408 u32
*base
= BASE_TABLE(dfa
);
409 u16
*next
= NEXT_TABLE(dfa
);
410 u16
*check
= CHECK_TABLE(dfa
);
411 unsigned int state
= start
;
416 /* current state is <state>, matching character *str */
417 if (dfa
->tables
[YYTD_ID_EC
]) {
418 /* Equivalence class table defined */
419 u8
*equiv
= EQUIV_TABLE(dfa
);
421 match_char(state
, def
, base
, next
, check
,
424 /* default is direct to next state */
426 match_char(state
, def
, base
, next
, check
, (u8
) *str
++);
433 * aa_dfa_match - traverse @dfa to find state @str stops at
434 * @dfa: the dfa to match @str against (NOT NULL)
435 * @start: the state of the dfa to start matching in
436 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
438 * aa_dfa_match will match @str against the dfa and return the state it
439 * finished matching in. The final state can be used to look up the accepting
440 * label, or as the start state of a continuing match.
442 * Returns: final state reached after input is consumed
444 unsigned int aa_dfa_match(struct aa_dfa
*dfa
, unsigned int start
,
447 u16
*def
= DEFAULT_TABLE(dfa
);
448 u32
*base
= BASE_TABLE(dfa
);
449 u16
*next
= NEXT_TABLE(dfa
);
450 u16
*check
= CHECK_TABLE(dfa
);
451 unsigned int state
= start
;
456 /* current state is <state>, matching character *str */
457 if (dfa
->tables
[YYTD_ID_EC
]) {
458 /* Equivalence class table defined */
459 u8
*equiv
= EQUIV_TABLE(dfa
);
460 /* default is direct to next state */
462 match_char(state
, def
, base
, next
, check
,
465 /* default is direct to next state */
467 match_char(state
, def
, base
, next
, check
, (u8
) *str
++);
474 * aa_dfa_next - step one character to the next state in the dfa
475 * @dfa: the dfa to traverse (NOT NULL)
476 * @state: the state to start in
477 * @c: the input character to transition on
479 * aa_dfa_match will step through the dfa by one input character @c
481 * Returns: state reach after input @c
483 unsigned int aa_dfa_next(struct aa_dfa
*dfa
, unsigned int state
,
486 u16
*def
= DEFAULT_TABLE(dfa
);
487 u32
*base
= BASE_TABLE(dfa
);
488 u16
*next
= NEXT_TABLE(dfa
);
489 u16
*check
= CHECK_TABLE(dfa
);
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 match_char(state
, def
, base
, next
, check
, equiv
[(u8
) c
]);
497 match_char(state
, def
, base
, next
, check
, (u8
) c
);
503 * aa_dfa_match_until - traverse @dfa until accept state or end of input
504 * @dfa: the dfa to match @str against (NOT NULL)
505 * @start: the state of the dfa to start matching in
506 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
507 * @retpos: first character in str after match OR end of string
509 * aa_dfa_match will match @str against the dfa and return the state it
510 * finished matching in. The final state can be used to look up the accepting
511 * label, or as the start state of a continuing match.
513 * Returns: final state reached after input is consumed
515 unsigned int aa_dfa_match_until(struct aa_dfa
*dfa
, unsigned int start
,
516 const char *str
, const char **retpos
)
518 u16
*def
= DEFAULT_TABLE(dfa
);
519 u32
*base
= BASE_TABLE(dfa
);
520 u16
*next
= NEXT_TABLE(dfa
);
521 u16
*check
= CHECK_TABLE(dfa
);
522 u32
*accept
= ACCEPT_TABLE(dfa
);
523 unsigned int state
= start
, pos
;
528 /* current state is <state>, matching character *str */
529 if (dfa
->tables
[YYTD_ID_EC
]) {
530 /* Equivalence class table defined */
531 u8
*equiv
= EQUIV_TABLE(dfa
);
532 /* default is direct to next state */
534 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
535 if (check
[pos
] == state
)
543 /* default is direct to next state */
545 pos
= base_idx(base
[state
]) + (u8
) *str
++;
546 if (check
[pos
] == state
)
560 * aa_dfa_matchn_until - traverse @dfa until accept or @n bytes consumed
561 * @dfa: the dfa to match @str against (NOT NULL)
562 * @start: the state of the dfa to start matching in
563 * @str: the string of bytes to match against the dfa (NOT NULL)
564 * @n: length of the string of bytes to match
565 * @retpos: first character in str after match OR str + n
567 * aa_dfa_match_len will match @str against the dfa and return the state it
568 * finished matching in. The final state can be used to look up the accepting
569 * label, or as the start state of a continuing match.
571 * This function will happily match again the 0 byte and only finishes
572 * when @n input is consumed.
574 * Returns: final state reached after input is consumed
576 unsigned int aa_dfa_matchn_until(struct aa_dfa
*dfa
, unsigned int start
,
577 const char *str
, int n
, const char **retpos
)
579 u16
*def
= DEFAULT_TABLE(dfa
);
580 u32
*base
= BASE_TABLE(dfa
);
581 u16
*next
= NEXT_TABLE(dfa
);
582 u16
*check
= CHECK_TABLE(dfa
);
583 u32
*accept
= ACCEPT_TABLE(dfa
);
584 unsigned int state
= start
, pos
;
590 /* current state is <state>, matching character *str */
591 if (dfa
->tables
[YYTD_ID_EC
]) {
592 /* Equivalence class table defined */
593 u8
*equiv
= EQUIV_TABLE(dfa
);
594 /* default is direct to next state */
596 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
597 if (check
[pos
] == state
)
605 /* default is direct to next state */
607 pos
= base_idx(base
[state
]) + (u8
) *str
++;
608 if (check
[pos
] == state
)
621 #define inc_wb_pos(wb) \
623 wb->pos = (wb->pos + 1) & (wb->size - 1); \
624 wb->len = (wb->len + 1) & (wb->size - 1); \
627 /* For DFAs that don't support extended tagging of states */
628 static bool is_loop(struct match_workbuf
*wb
, unsigned int state
,
629 unsigned int *adjust
)
631 unsigned int pos
= wb
->pos
;
634 if (wb
->history
[pos
] < state
)
637 for (i
= 0; i
<= wb
->len
; i
++) {
638 if (wb
->history
[pos
] == state
) {
651 static unsigned int leftmatch_fb(struct aa_dfa
*dfa
, unsigned int start
,
652 const char *str
, struct match_workbuf
*wb
,
655 u16
*def
= DEFAULT_TABLE(dfa
);
656 u32
*base
= BASE_TABLE(dfa
);
657 u16
*next
= NEXT_TABLE(dfa
);
658 u16
*check
= CHECK_TABLE(dfa
);
659 unsigned int state
= start
, pos
;
670 /* current state is <state>, matching character *str */
671 if (dfa
->tables
[YYTD_ID_EC
]) {
672 /* Equivalence class table defined */
673 u8
*equiv
= EQUIV_TABLE(dfa
);
674 /* default is direct to next state */
678 wb
->history
[wb
->pos
] = state
;
679 pos
= base_idx(base
[state
]) + equiv
[(u8
) *str
++];
680 if (check
[pos
] == state
)
684 if (is_loop(wb
, state
, &adjust
)) {
685 state
= aa_dfa_match(dfa
, state
, str
);
693 /* default is direct to next state */
697 wb
->history
[wb
->pos
] = state
;
698 pos
= base_idx(base
[state
]) + (u8
) *str
++;
699 if (check
[pos
] == state
)
703 if (is_loop(wb
, state
, &adjust
)) {
704 state
= aa_dfa_match(dfa
, state
, str
);
720 * aa_dfa_leftmatch - traverse @dfa to find state @str stops at
721 * @dfa: the dfa to match @str against (NOT NULL)
722 * @start: the state of the dfa to start matching in
723 * @str: the null terminated string of bytes to match against the dfa (NOT NULL)
724 * @count: current count of longest left.
726 * aa_dfa_match will match @str against the dfa and return the state it
727 * finished matching in. The final state can be used to look up the accepting
728 * label, or as the start state of a continuing match.
730 * Returns: final state reached after input is consumed
732 unsigned int aa_dfa_leftmatch(struct aa_dfa
*dfa
, unsigned int start
,
733 const char *str
, unsigned int *count
)
737 /* TODO: match for extended state dfas */
739 return leftmatch_fb(dfa
, start
, str
, &wb
, count
);