summaryrefslogtreecommitdiffstats
path: root/libapol/include/apol/condrule-query.h
diff options
context:
space:
mode:
Diffstat (limited to 'libapol/include/apol/condrule-query.h')
-rw-r--r--libapol/include/apol/condrule-query.h119
1 files changed, 119 insertions, 0 deletions
diff --git a/libapol/include/apol/condrule-query.h b/libapol/include/apol/condrule-query.h
new file mode 100644
index 0000000..16bbb14
--- /dev/null
+++ b/libapol/include/apol/condrule-query.h
@@ -0,0 +1,119 @@
+/**
+ * @file
+ *
+ * Routines to query conditional expressions and conditional rules of
+ * a policy.
+ *
+ * @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 APOL_CONDRULE_QUERY_H
+#define APOL_CONDRULE_QUERY_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#include "policy.h"
+#include "vector.h"
+#include <qpol/policy.h>
+
+ typedef struct apol_cond_query apol_cond_query_t;
+
+/**
+ * Execute a query against all conditional expressions within the
+ * policy.
+ *
+ * @param p Policy within which to look up expressions.
+ * @param c Structure containing parameters for query. If this is
+ * NULL then return all expressions.
+ * @param v Reference to a vector of qpol_cond_t. The vector will be
+ * allocated by this function. The caller must call
+ * apol_vector_destroy() afterwards. This will be set to NULL upon no
+ * results or upon error.
+ *
+ * @return 0 on success (including none found), negative on error.
+ */
+ extern int apol_cond_get_by_query(const apol_policy_t * p, apol_cond_query_t * c, apol_vector_t ** v);
+
+/**
+ * Allocate and return a new cond query structure. All fields are
+ * initialized, such that running this blank query results in
+ * returning all conditional expressions within the policy. The
+ * caller must call apol_cond_query_destroy() upon the return value
+ * afterwards.
+ *
+ * @return An initialized cond query structure, or NULL upon error.
+ */
+ extern apol_cond_query_t *apol_cond_query_create(void);
+
+/**
+ * Deallocate all memory associated with the referenced cond query,
+ * and then set it to NULL. This function does nothing if the query
+ * is already NULL.
+ *
+ * @param c Reference to a cond query structure to destroy.
+ */
+ extern void apol_cond_query_destroy(apol_cond_query_t ** c);
+
+/**
+ * Set a cond query to search only conditional expressions that use a
+ * certain boolean variable.
+ *
+ * @param p Policy handler, to report errors.
+ * @param c Cond rule query to set.
+ * @param name Limit query to expressions with this boolean, or NULL
+ * to unset this field.
+ *
+ * @return 0 on success, negative on error.
+ */
+ extern int apol_cond_query_set_bool(const apol_policy_t * p, apol_cond_query_t * c, const char *name);
+
+/**
+ * Set a cond query to use regular expression searching for all of its
+ * fields. Strings will be treated as regexes instead of literals.
+ *
+ * @param p Policy handler, to report errors.
+ * @param c Cond rule query to set.
+ * @param is_regex Non-zero to enable regex searching, 0 to disable.
+ *
+ * @return Always 0.
+ */
+ extern int apol_cond_query_set_regex(const apol_policy_t * p, apol_cond_query_t * c, int is_regex);
+
+/**
+ * Given a conditional node, allocate and return a string
+ * representation of its conditional expression.
+ *
+ * @param p Policy handler, to report errors.
+ * @param cond Conditional node whose expression to render.
+ *
+ * @return A newly malloc()'d string representation of conditonal
+ * expression, or NULL on failure. The caller is responsible for
+ * calling free() on the returned string.
+ */
+ extern char *apol_cond_expr_render(const apol_policy_t * p, const qpol_cond_t * cond);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif