diff options
Diffstat (limited to 'libpoldiff/include/poldiff/terule_diff.h')
| -rw-r--r-- | libpoldiff/include/poldiff/terule_diff.h | 262 |
1 files changed, 262 insertions, 0 deletions
diff --git a/libpoldiff/include/poldiff/terule_diff.h b/libpoldiff/include/poldiff/terule_diff.h new file mode 100644 index 0000000..6d09e9d --- /dev/null +++ b/libpoldiff/include/poldiff/terule_diff.h @@ -0,0 +1,262 @@ +/** + * @file + * Public interface for computing semantic differences in te rules + * (type_transition, type_change, type_member). + * + * @author Jeremy A. Mowery jmowery@tresys.com + * @author Jason Tang jtang@tresys.com + * + * Copyright (C) 2006-2007 Tresys Technology, LLC + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef POLDIFF_TERULE_DIFF_H +#define POLDIFF_TERULE_DIFF_H + +#ifdef __cplusplus +extern "C" +{ +#endif + +#include <apol/vector.h> +#include <poldiff/poldiff.h> + + typedef struct poldiff_terule poldiff_terule_t; + +/** + * Get an array of statistics for the number of differences of each + * form for TE type_change rules. + * + * @param diff The policy difference structure from which to get the + * stats. + * @param stats Array into which to write the numbers (array must be + * pre-allocated). The order of the values written to the array is + * as follows: number of items of form POLDIFF_FORM_ADDED, number of + * POLDIFF_FORM_REMOVED, number of POLDIFF_FORM_MODIFIED, number of + * POLDIFF_FORM_ADD_TYPE, and number of POLDIFF_FORM_REMOVE_TYPE. + */ + extern void poldiff_terule_get_stats_change(const poldiff_t * diff, size_t stats[5]); + +/** + * Get an array of statistics for the number of differences of each + * form for TE type_member rules. + * + * @param diff The policy difference structure from which to get the + * stats. + * @param stats Array into which to write the numbers (array must be + * pre-allocated). The order of the values written to the array is + * as follows: number of items of form POLDIFF_FORM_ADDED, number of + * POLDIFF_FORM_REMOVED, number of POLDIFF_FORM_MODIFIED, number of + * POLDIFF_FORM_ADD_TYPE, and number of POLDIFF_FORM_REMOVE_TYPE. + */ + extern void poldiff_terule_get_stats_member(const poldiff_t * diff, size_t stats[5]); + +/** + * Get an array of statistics for the number of differences of each + * form for TE type_transition rules. + * + * @param diff The policy difference structure from which to get the + * stats. + * @param stats Array into which to write the numbers (array must be + * pre-allocated). The order of the values written to the array is + * as follows: number of items of form POLDIFF_FORM_ADDED, number of + * POLDIFF_FORM_REMOVED, number of POLDIFF_FORM_MODIFIED, number of + * POLDIFF_FORM_ADD_TYPE, and number of POLDIFF_FORM_REMOVE_TYPE. + */ + extern void poldiff_terule_get_stats_trans(const poldiff_t * diff, size_t stats[5]); + +/** + * Get the vector of te rule differences from the te rule difference + * summary for just type_change rules. + * + * @param diff The policy difference structure associated with the te + * rule difference summary. + * + * @return A vector of elements of type poldiff_terule_t, or NULL on + * error. The caller should <b>not</b> destroy the vector returned. + * If the call fails, errno will be set. + */ + extern const apol_vector_t *poldiff_get_terule_vector_change(const poldiff_t * diff); + +/** + * Get the vector of te rule differences from the te rule difference + * summary for just type_member rules. + * + * @param diff The policy difference structure associated with the te + * rule difference summary. + * + * @return A vector of elements of type poldiff_terule_t, or NULL on + * error. The caller should <b>not</b> destroy the vector returned. + * If the call fails, errno will be set. + */ + extern const apol_vector_t *poldiff_get_terule_vector_member(const poldiff_t * diff); + +/** + * Get the vector of te rule differences from the te rule difference + * summary for just type_transition rules. + * + * @param diff The policy difference structure associated with the te + * rule difference summary. + * + * @return A vector of elements of type poldiff_terule_t, or NULL on + * error. The caller should <b>not</b> destroy the vector returned. + * If the call fails, errno will be set. + */ + extern const apol_vector_t *poldiff_get_terule_vector_trans(const poldiff_t * diff); + +/** + * Obtain a newly allocated string representation of a difference in + * a te rule. + * + * @param diff The policy difference structure associated with the te + * rule. + * @param terule The te rule from which to generate the string. + * + * @return A string representation of te rule difference; the caller + * is responsible for free()ing this string. On error, return NULL + * and set errno. + */ + extern char *poldiff_terule_to_string(const poldiff_t * diff, const void *terule); + +/** + * Get the form of difference from a te rule diff. + * + * @param terule The te rule from which to get the difference form. + * + * @return The form of difference (one of POLDIFF_FORM_*) or + * POLDIFF_FORM_NONE on error. + */ + extern poldiff_form_e poldiff_terule_get_form(const void *terule); + +/** + * Get the type of rule this is from a te rule diff. + * + * @param avrule The av rule from which to get the rule type. + * + * @return One of QPOL_RULE_TYPE_TRANS etc, suitable for printing via + * apol_rule_type_to_str(). + */ + extern uint32_t poldiff_terule_get_rule_type(const poldiff_terule_t * terule); + +/** + * Get the source type from a te rule diff. + * + * @param terule The te rule from which to get the type. + * + * @return A string for the type. <b>Do not free() this string.</b> + */ + extern const char *poldiff_terule_get_source_type(const poldiff_terule_t * terule); + +/** + * Get the target type from a te rule diff. + * + * @param terule The te rule from which to get the type. + * + * @return A string for the type. <b>Do not free() this string.</b> + */ + extern const char *poldiff_terule_get_target_type(const poldiff_terule_t * terule); + +/** + * Get the object class from a te rule diff. + * + * @param terule The te rule from which to get the class. + * + * @return A string for the class. <b>Do not free() this string.</b> + */ + extern const char *poldiff_terule_get_object_class(const poldiff_terule_t * terule); + +/** + * Get the conditional expression from a te rule diff. Note that + * this really returns a qpol_cond_t and an apol_policy_t, which may + * then be used in other routines such as apol_cond_expr_render(). + * + * @param diff The policy difference structure from which to get the + * stats. + * @param terule The te rule from which to get the conditional. + * @param cond Reference to the rule's conditional pointer, or NULL + * if the rule is not conditional. The caller must not free() this + * pointer. + * @param which_list Reference to which list the rule belongs, either + * 1 if in the true branch, 0 if in false. If the rule is not + * conditional then this value will be set to 1. + * @param p Reference to the policy from which the conditional + * originated, or NULL if the rule is not conditional. The caller + * must not destroy this pointer. + */ + extern void poldiff_terule_get_cond(const poldiff_t * diff, const poldiff_terule_t * terule, + const qpol_cond_t ** cond, uint32_t * which_list, const apol_policy_t ** p); + +/** + * Get the original default type for this type rule. Note that if + * this rule was added (form POLDIFF_FORM_ADDED or + * POLDIFF_FORM_ADD_TYPE) then the return value will be NULL. + * + * @param terule The te rule diff from which to get the original + * default type. + * + * @return Original default type. If there was no original type or + * upon error then return NULL. <b>Do not free() this string.</b> + */ + extern const char *poldiff_terule_get_original_default(const poldiff_terule_t * terule); + +/** + * Get the modified default type for this type rule. Note that if + * this rule was removed (form POLDIFF_FORM_REMOVED or + * POLDIFF_FORM_REMOVE_TYPE) then the return value will be NULL. + * + * @param terule The te rule diff from which to get the modified + * default type. + * + * @return Modified default type. If there was no modified type or + * upon error then return NULL. <b>Do not free() this string.</b> + */ + extern const char *poldiff_terule_get_modified_default(const poldiff_terule_t * terule); + +/** + * Get a vector of line numbers (of type unsigned long) for this te rule + * difference from the original policy. Note that if the form is + * POLDIFF_FORM_ADDED or POLDIFF_FORM_ADD_TYPE then this will return NULL. + * Also, if the original policy is a binary policy or line numbers are not yet + * enabled then this returns NULL. + * @see poldiff_enable_line_numbers() to enable line numbers. + * + * @param terule The te rule diff from which to get line numbers. + * + * @return A vector of line numbers (type unsigned long) for the rule + * in the original policy, or NULL if no numbers are available. + */ + extern apol_vector_t *poldiff_terule_get_orig_line_numbers(const poldiff_terule_t * terule); + +/** + * Get a vector of line numbers (of type unsigned long) for this te rule + * difference from the modified policy. Note that if the form is + * POLDIFF_FORM_REMOVED or POLDIFF_FORM_REMOVE_TYPE then this will return + * NULL. Also, if the modified policy is a binary policy or line numbers are + * not yet enabled then this returns NULL. + * @see poldiff_enable_line_numbers() to enable line numbers. + * + * @param terule The te rule diff from which to get line numbers. + * + * @return A vector of line numbers (type unsigned long) for the rule + * in the modified policy, or NULL if no numbers are available. + */ + extern apol_vector_t *poldiff_terule_get_mod_line_numbers(const poldiff_terule_t * terule); + +#ifdef __cplusplus +} +#endif + +#endif /* POLDIFF_TERULE_DIFF_H */ |