summaryrefslogtreecommitdiffstats
path: root/libpoldiff/src/level_internal.h
blob: 4a0f603757ed2dddf948eb832783d47621afe067 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/**
 *  @file
 *  Protected interface for computing semantic differences in levels,
 *  either from level declarations, user's default level, user's
 *  permitted range, or a range_transition's target range.
 *
 *  @author Jeremy A. Mowery jmowery@tresys.com
 *  @author Jason Tang jtang@tresys.com
 *
 *  Copyright (C) 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_LEVEL_INTERNAL_H
#define POLDIFF_LEVEL_INTERNAL_H

#ifdef	__cplusplus
extern "C"
{
#endif

	typedef struct poldiff_level_summary poldiff_level_summary_t;

	struct poldiff_level
	{
		char *name;
		poldiff_form_e form;
		apol_vector_t *added_cats;
		apol_vector_t *removed_cats;
		apol_vector_t *unmodified_cats;
	};

/**
 * Allocate and return a new poldiff_level_summary_t object.
 *
 * @return A new level summary.  The caller must call level_destroy()
 * afterwards.  On error, return NULL and set errno.
 */
	poldiff_level_summary_t *level_create(void);

/**
 * Deallocate all space associated with a poldiff_level_summary_t
 * object, including the pointer itself.  If the pointer is already
 * NULL then do nothing.
 *
 * @param ls Reference to a level summary to destroy.  The pointer
 * will be set to NULL afterwards.
 */
	void level_destroy(poldiff_level_summary_t ** ls);

/**
 * Reset the state of all level differences.
 * @param diff The policy difference structure containing the differences
 * to reset.
 * @return 0 on success and < 0 on error; if the call fails,
 * errno will be set and the user should call poldiff_destroy() on diff.
 */
	int level_reset(poldiff_t * diff);

/**
 * Get a vector of all levels from the given policy, sorted by name.
 *
 * @param diff Policy diff error handler.
 * @param policy The policy from which to get the items.
 *
 * @return a newly allocated vector of all levels.  The caller is
 * responsible for calling apol_vector_destroy() afterwards.  On
 * error, return NULL and set errno.
 */
	apol_vector_t *level_get_items(poldiff_t * diff, const apol_policy_t * policy);

/**
 * Compare two qpol_level_t objects, determining if they have the same
 * level name or not.
 *
 * @param x The level from the original policy.
 * @param y The level from the modified policy.
 * @param diff The policy difference structure associated with both
 * policies.
 *
 * @return < 0, 0, or > 0 if level x is respectively less than, equal
 * to, or greater than level y.
 */
	int level_comp(const void *x, const void *y, const poldiff_t * diff);

/**
 * Create, initialize, and insert a new semantic difference entry for
 * a level.
 *
 * @param diff The policy difference structure to which to add the entry.
 * @param form The form of the difference.
 * @param item Item for which the entry is being created.
 *
 * @return 0 on success and < 0 on error; if the call fails, set errno
 * and leave the policy difference structure unchanged.
 */
	int level_new_diff(poldiff_t * diff, poldiff_form_e form, const void *item);

/**
 * Compute the semantic difference of two levels for which the compare
 * callback returns 0.  If a difference is found then allocate,
 * initialize, and insert a new semantic difference entry for that
 * level.
 *
 * @param diff The policy difference structure associated with both
 * levels and to which to add an entry if needed.
 * @param x The level from the original policy.
 * @param y The level from the modified policy.
 *
 * @return 0 on success and < 0 on error; if the call fails, set errno
 * and leave the policy difference structure unchanged.
 */
	int level_deep_diff(poldiff_t * diff, const void *x, const void *y);

/*********************
 * The remainder are protected functions that operate upon a single
 * poldiff_level_t.  These are used by user's default level, user's
 * assigned range, etc.
 *********************/

/**
 * Allocate and return a poldiff_level_t object.  If the form is added
 * or removed, set that respective vector to be all of the categories
 * from the given level.
 *
 * @param level Level object to use as a template.
 * @param form Form of difference for the level.
 *
 * @return Initialized level, or NULL upon error.  Caller must call
 * level_free() upon the returned value.
 */
	poldiff_level_t *level_create_from_apol_mls_level(const apol_mls_level_t * level, poldiff_form_e form);

/**
 * Deallocate all space associated with a poldiff_level_t, including
 * the pointer itself.
 *
 * @param elem Pointer to a poldiff_level_t object.  If NULL then do
 * nothing.
 */
	void level_free(void *elem);

/**
 * Perform a deep diff of two levels.  This will first compare the
 * sensitivity names; if they match then it compares the vectors of
 * category names.  If the sensitivities do not match, then generate
 * two poldiff_level_ts, one for the original level and one for
 * modified level.  If they do match then create just one
 * poldiff_level_t and write it to orig_pl.
 *
 * @param diff Poldiff object, used for error reporting and for
 * sorting the categories to policy order.
 * @param level1 Original level.
 * @param level2 Modified level.
 * @param orig_pl Destination to where to write the poldiff_level_t,
 * if the sensitivites do not match or if the categories do not match.
 * @param mod_pl Destination to where to write the poldiff_level_t,
 * if the sensitivities do not match.
 *
 * @return 0 on success, < 0 on error.
 */
	int level_deep_diff_apol_mls_levels(poldiff_t * diff, const apol_mls_level_t * level1, const apol_mls_level_t * level2,
					    poldiff_level_t ** orig_pl, poldiff_level_t ** mod_pl);

/**
 * Calculate the differences between two sorted vectors of category
 * names.  Allocate the vectors added, removed, and unmodified; fill
 * them with appropriate category names.  The returned vectors'
 * categories will be sorted alphabetically.
 *
 * @param diff Error handler.
 * @param v1 First vector of category names, sorted alphabetically.
 * @param v2 Other vector of category names, sorted alphabetically.
 * @param added Reference to where to store added categories.  The
 * caller is responsible for calling apol_vector_destroy() upon the
 * value.  If no differences are found then this will be set to NULL.
 * @param removed Reference to where to store removed categories.  The
 * caller is responsible for calling apol_vector_destroy() upon the
 * value.  If no differences are found then this will be set to NULL.
 * @param unmodified Reference to where to store unmodified
 * categories.  The caller is responsible for calling
 * apol_vector_destroy() upon the value.  If no differences are found
 * then this will be set to NULL.
 *
 * @return Greater than zero if a difference was found, zero upon no
 * differences, less than zero on error.
 */
	int level_deep_diff_cats(poldiff_t * diff, const apol_vector_t * v1, const apol_vector_t * v2, apol_vector_t ** added,
				 apol_vector_t ** removed, apol_vector_t ** unmodified);

#ifdef	__cplusplus
}
#endif

#endif				       /* POLDIFF_LEVEL_INTERNAL_H */