summaryrefslogtreecommitdiffstats
path: root/libpoldiff/include/poldiff/rbac_diff.h
blob: 200beb34f4670907269f545d61a2700f639246c9 (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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
/**
 *  @file
 *  Public interface for computing semantic differences in role
 *  allow rules and role_transition rules.
 *
 *  @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_RBAC_DIFF_H
#define POLDIFF_RBAC_DIFF_H

#ifdef	__cplusplus
extern "C"
{
#endif

#include <apol/vector.h>
#include <poldiff/poldiff.h>

	typedef struct poldiff_role_allow poldiff_role_allow_t;
	typedef struct poldiff_role_trans poldiff_role_trans_t;

/**
 *  Get an array of statistics for the number of differences of each
 *  form for role allow 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_role_allow_get_stats(const poldiff_t * diff, size_t stats[5]);

/**
 *  Get the vector of role allow differences from the policy difference
 *  structure.
 *
 *  @param diff The policy difference structure from which to get the
 *  differences.
 *
 *  @return A vector of elements of type poldiff_role_allow_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_role_allow_vector(const poldiff_t * diff);

/**
 *  Obtain a newly allocated string representation of a difference in
 *  a role allow rule.
 *
 *  @param diff The policy difference structure associated with the rule.
 *  @param role_allow The role from which to generate the string.
 *
 *  @return A string representation of the rule difference; the caller is
 *  responsible for free()ing this string.  On error, return NULL and
 *  set errno.
 */
	extern char *poldiff_role_allow_to_string(const poldiff_t * diff, const void *role_allow);

/**
 *  Get the name of the source role from a role allow diff.
 *
 *  @param role_allow The rule allow from which to get the source role name.
 *
 *  @return Name of the source role on success and NULL on failure; if the
 *  call fails, errno will be set.  The caller should not free the
 *  returned string.
 */
	extern const char *poldiff_role_allow_get_name(const poldiff_role_allow_t * role_allow);

/**
 *  Get the form of difference from a role allow diff.
 *
 *  @param role_allow The role allow rule from which to get the difference form.
 *
 *  @return The form of difference (one of POLDIFF_FORM_*) or
 *  POLDIFF_FORM_NONE on error.  If the call fails, errno will be set.
 */
	extern poldiff_form_e poldiff_role_allow_get_form(const void *role_allow);

/**
 *  Get a vector of roles unmodified by the role allow rule.  The
 *  vector will be non-empty only if the form is
 *  POLDIFF_FORM_MODIFIED.
 *
 *  @param role_allow The role allow diff from which to get the roles
 *  vector.
 *
 *  @return A vector of role names (type char *) that are in both
 *  policies.  If no roles are common to both policies then the size
 *  of the returned vector will be 0.  The caller must not destroy
 *  this vector.  The caller must not destroy this vector.
 */
	extern const apol_vector_t *poldiff_role_allow_get_unmodified_roles(const poldiff_role_allow_t * role_allow);

/**
 *  Get a vector of roles added to the role allow rule.  If the role
 *  allow was added by the modified policy then this vector will hold
 *  all of the roles.
 *
 *  @param role_allow The role allow diff from which to get the roles
 *  vector.
 *
 *  @return A vector of role names (type char *) that are allowed to
 *  the role in the modified policy.  If no roles were added the size
 *  of the returned vector will be 0.  The caller must not destroy
 *  this vector.
 */
	extern const apol_vector_t *poldiff_role_allow_get_added_roles(const poldiff_role_allow_t * role_allow);

/**
 *  Get a vector of roles removed from the role allow rule.  If the
 *  role allow was removed by the modified policy then this vector
 *  will hold all of the roles.
 *
 *  @param role_allow The role allow diff from which to get the roles
 *  vector.
 *
 *  @return A vector of role names (type char *) that are allowed to
 *  the role in the original policy.  If no roles were removed the
 *  size of the returned vector will be 0.  The caller must not
 *  destroy this vector.
 */
	extern const apol_vector_t *poldiff_role_allow_get_removed_roles(const poldiff_role_allow_t * role_allow);

/**
 *  Get an array of statistics for the number of differences of each
 *  form for role_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_role_trans_get_stats(const poldiff_t * diff, size_t stats[5]);

/**
 *  Get the vector of role_transition differences from the policy difference
 *  structure.
 *
 *  @param diff The policy difference structure from which to get the
 *  differences.
 *
 *  @return A vector of elements of type poldiff_role_trans_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_role_trans_vector(const poldiff_t * diff);

/**
 *  Obtain a newly allocated string representation of a difference in
 *  a role_transition rule.
 *
 *  @param diff The policy difference structure associated with the rule.
 *  @param role_trans The rule from which to generate the string.
 *
 *  @return A string representation of the rule difference; the caller is
 *  responsible for free()ing this string.  On error, return NULL and
 *  set errno.
 */
	extern char *poldiff_role_trans_to_string(const poldiff_t * diff, const void *role_trans);

/**
 *  Get the name of the source role from a role_transition difference.
 *
 *  @param role_trans The rule from which to get the source role.
 *
 *  @return Name of the source role on success and NULL on failure;
 *  if the call fails, errno will be set. The caller should not free the
 *  returned string.
 */
	extern const char *poldiff_role_trans_get_source_role(const poldiff_role_trans_t * role_trans);

/**
 *  Get the name of the target type from a role_transition difference.
 *
 *  @param role_trans The rule from which to get the target type.
 *
 *  @return Name of the target type on success and NULL on failure;
 *  if the call fails, errno will be set. The caller should not free the
 *  returned string.
 */
	extern const char *poldiff_role_trans_get_target_type(const poldiff_role_trans_t * role_trans);

/**
 *  Get the form of difference from a role_transition diff.
 *
 *  @param role_trans The role_transition rule from which to get the
 *  difference form.
 *
 *  @return The form of difference (one of POLDIFF_FORM_*) or
 *  POLDIFF_FORM_NONE on error.  If the call fails, errno will be set.
 */
	extern poldiff_form_e poldiff_role_trans_get_form(const void *role_trans);

/**
 *  Get the original default type from a role_transition diff. Note that
 *  if this rule was added (form POLDIFF_FORM_ADDED or POLDIFF_FORM_ADD_TYPE)
 *  then the return value will be NULL.
 *
 *  @param role_trans The role_transition rule from which to get the
 *  original default role.
 *
 *  @return Name of the original default role. If there was no original role or
 *  upon error then return NULL. The caller should not free the returned
 *  string.
 */
	extern const char *poldiff_role_trans_get_original_default(const poldiff_role_trans_t * role_trans);

/**
 *  Get the modified default type from a role_transition diff. Note that if
 *  this rule was removed (form POLDIFF_FORM_REMOVED or
 *  POLDIFF_FORM_REMOVE_TYPE) then the return value will be NULL.
 *
 *  @param role_trans The role_transition rule from which to get the
 *  modified default role.
 *
 *  @return Name of the modified default role. If there was no modified role or
 *  upon error then return NULL. The caller should not free the returned
 *  string.
 */
	extern const char *poldiff_role_trans_get_modified_default(const poldiff_role_trans_t * role_trans);

#ifdef	__cplusplus
}
#endif

#endif				       /* POLDIFF_RBAC_DIFF_H */