match.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. /*
  2. * AppArmor security module
  3. *
  4. * This file contains AppArmor policy dfa matching engine definitions.
  5. *
  6. * Copyright (C) 1998-2008 Novell/SUSE
  7. * Copyright 2009-2012 Canonical Ltd.
  8. *
  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
  12. * License.
  13. */
  14. #ifndef __AA_MATCH_H
  15. #define __AA_MATCH_H
  16. #include <linux/kref.h>
  17. #define DFA_NOMATCH 0
  18. #define DFA_START 1
  19. /**
  20. * The format used for transition tables is based on the GNU flex table
  21. * file format (--tables-file option; see Table File Format in the flex
  22. * info pages and the flex sources for documentation). The magic number
  23. * used in the header is 0x1B5E783D instead of 0xF13C57B1 though, because
  24. * new tables have been defined and others YY_ID_CHK (check) and YY_ID_DEF
  25. * (default) tables are used slightly differently (see the apparmor-parser
  26. * package).
  27. *
  28. *
  29. * The data in the packed dfa is stored in network byte order, and the tables
  30. * are arranged for flexibility. We convert the table data to host native
  31. * byte order.
  32. *
  33. * The dfa begins with a table set header, and is followed by the actual
  34. * tables.
  35. */
  36. #define YYTH_MAGIC 0x1B5E783D
  37. struct table_set_header {
  38. u32 th_magic; /* YYTH_MAGIC */
  39. u32 th_hsize;
  40. u32 th_ssize;
  41. u16 th_flags;
  42. char th_version[];
  43. };
  44. /* The YYTD_ID are one less than flex table mappings. The flex id
  45. * has 1 subtracted at table load time, this allows us to directly use the
  46. * ID's as indexes.
  47. */
  48. #define YYTD_ID_ACCEPT 0
  49. #define YYTD_ID_BASE 1
  50. #define YYTD_ID_CHK 2
  51. #define YYTD_ID_DEF 3
  52. #define YYTD_ID_EC 4
  53. #define YYTD_ID_META 5
  54. #define YYTD_ID_ACCEPT2 6
  55. #define YYTD_ID_NXT 7
  56. #define YYTD_ID_TSIZE 8
  57. #define YYTD_ID_MAX 8
  58. #define YYTD_DATA8 1
  59. #define YYTD_DATA16 2
  60. #define YYTD_DATA32 4
  61. #define YYTD_DATA64 8
  62. /* ACCEPT & ACCEPT2 tables gets 6 dedicated flags, YYTD_DATAX define the
  63. * first flags
  64. */
  65. #define ACCEPT1_FLAGS(X) ((X) & 0x3f)
  66. #define ACCEPT2_FLAGS(X) ACCEPT1_FLAGS((X) >> YYTD_ID_ACCEPT2)
  67. #define TO_ACCEPT1_FLAG(X) ACCEPT1_FLAGS(X)
  68. #define TO_ACCEPT2_FLAG(X) (ACCEPT1_FLAGS(X) << YYTD_ID_ACCEPT2)
  69. #define DFA_FLAG_VERIFY_STATES 0x1000
  70. struct table_header {
  71. u16 td_id;
  72. u16 td_flags;
  73. u32 td_hilen;
  74. u32 td_lolen;
  75. char td_data[];
  76. };
  77. #define DEFAULT_TABLE(DFA) ((u16 *)((DFA)->tables[YYTD_ID_DEF]->td_data))
  78. #define BASE_TABLE(DFA) ((u32 *)((DFA)->tables[YYTD_ID_BASE]->td_data))
  79. #define NEXT_TABLE(DFA) ((u16 *)((DFA)->tables[YYTD_ID_NXT]->td_data))
  80. #define CHECK_TABLE(DFA) ((u16 *)((DFA)->tables[YYTD_ID_CHK]->td_data))
  81. #define EQUIV_TABLE(DFA) ((u8 *)((DFA)->tables[YYTD_ID_EC]->td_data))
  82. #define ACCEPT_TABLE(DFA) ((u32 *)((DFA)->tables[YYTD_ID_ACCEPT]->td_data))
  83. #define ACCEPT_TABLE2(DFA) ((u32 *)((DFA)->tables[YYTD_ID_ACCEPT2]->td_data))
  84. struct aa_dfa {
  85. struct kref count;
  86. u16 flags;
  87. struct table_header *tables[YYTD_ID_TSIZE];
  88. };
  89. extern struct aa_dfa *nulldfa;
  90. #define byte_to_byte(X) (X)
  91. #define UNPACK_ARRAY(TABLE, BLOB, LEN, TTYPE, BTYPE, NTOHX) \
  92. do { \
  93. typeof(LEN) __i; \
  94. TTYPE *__t = (TTYPE *) TABLE; \
  95. BTYPE *__b = (BTYPE *) BLOB; \
  96. for (__i = 0; __i < LEN; __i++) { \
  97. __t[__i] = NTOHX(__b[__i]); \
  98. } \
  99. } while (0)
  100. static inline size_t table_size(size_t len, size_t el_size)
  101. {
  102. return ALIGN(sizeof(struct table_header) + len * el_size, 8);
  103. }
  104. int aa_setup_dfa_engine(void);
  105. void aa_teardown_dfa_engine(void);
  106. struct aa_dfa *aa_dfa_unpack(void *blob, size_t size, int flags);
  107. unsigned int aa_dfa_match_len(struct aa_dfa *dfa, unsigned int start,
  108. const char *str, int len);
  109. unsigned int aa_dfa_match(struct aa_dfa *dfa, unsigned int start,
  110. const char *str);
  111. unsigned int aa_dfa_next(struct aa_dfa *dfa, unsigned int state,
  112. const char c);
  113. void aa_dfa_free_kref(struct kref *kref);
  114. /**
  115. * aa_get_dfa - increment refcount on dfa @p
  116. * @dfa: dfa (MAYBE NULL)
  117. *
  118. * Returns: pointer to @dfa if @dfa is NULL will return NULL
  119. * Requires: @dfa must be held with valid refcount when called
  120. */
  121. static inline struct aa_dfa *aa_get_dfa(struct aa_dfa *dfa)
  122. {
  123. if (dfa)
  124. kref_get(&(dfa->count));
  125. return dfa;
  126. }
  127. /**
  128. * aa_put_dfa - put a dfa refcount
  129. * @dfa: dfa to put refcount (MAYBE NULL)
  130. *
  131. * Requires: if @dfa != NULL that a valid refcount be held
  132. */
  133. static inline void aa_put_dfa(struct aa_dfa *dfa)
  134. {
  135. if (dfa)
  136. kref_put(&dfa->count, aa_dfa_free_kref);
  137. }
  138. #endif /* __AA_MATCH_H */