Open SCAP Library
scap_ds.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright 2012--2014 Red Hat Inc., Durham, North Carolina.
12  * All Rights Reserved.
13  *
14  * This library is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU Lesser General Public
16  * License as published by the Free Software Foundation; either
17  * version 2.1 of the License, or (at your option) any later version.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  *
28  * Authors:
29  * Martin Preisler <mpreisle@redhat.com>
30  */
31 
32 #ifndef OPENSCAP_DS_H
33 #define OPENSCAP_DS_H
34 
35 #include "oscap.h"
36 #include "oscap_export.h"
37 
53 OSCAP_API int ds_sds_compose_from_xccdf(const char* xccdf_file, const char* target_datastream);
54 
71 OSCAP_API int ds_sds_compose_add_component(const char *target_datastream, const char *datastream_id, const char *new_component, bool extended);
72 
95 OSCAP_API int ds_rds_create(const char* sds_file, const char* xccdf_result_file,
96  const char** oval_result_files, const char* target_file);
97 
114 struct ds_stream_index;
115 
117 OSCAP_API struct ds_stream_index* ds_stream_index_new(void);
119 OSCAP_API void ds_stream_index_free(struct ds_stream_index* s);
120 
126 OSCAP_API const char* ds_stream_index_get_id(struct ds_stream_index* s);
127 
133 OSCAP_API const char* ds_stream_index_get_timestamp(struct ds_stream_index* s);
134 
140 OSCAP_API const char* ds_stream_index_get_version(struct ds_stream_index* s);
141 
148 
155 
162 
180 struct ds_sds_index;
181 
183 OSCAP_API struct ds_sds_index* ds_sds_index_new(void);
185 OSCAP_API void ds_sds_index_free(struct ds_sds_index* s);
186 
192 OSCAP_API struct ds_stream_index* ds_sds_index_get_stream(struct ds_sds_index* s, const char* stream_id);
193 
200 
213 OSCAP_API int ds_sds_index_select_checklist(struct ds_sds_index* s,
214  const char** datastream_id, const char** component_id);
215 
233  const char *benchmark_id, const char **datastream_id, const char **component_ref_id);
234 
240 
242 OSCAP_API struct ds_stream_index *ds_stream_index_iterator_next(struct ds_stream_index_iterator *it);
244 OSCAP_API bool ds_stream_index_iterator_has_more(struct ds_stream_index_iterator *it);
246 OSCAP_API void ds_stream_index_iterator_free(struct ds_stream_index_iterator *it);
247 
252 
253 OSCAP_API struct rds_report_request_index* rds_report_request_index_new(void);
254 OSCAP_API void rds_report_request_index_free(struct rds_report_request_index* s);
255 OSCAP_API const char* rds_report_request_index_get_id(struct rds_report_request_index* s);
256 
260 struct rds_asset_index;
261 
265 struct rds_report_index;
266 
267 OSCAP_API struct rds_asset_index* rds_asset_index_new(void);
268 OSCAP_API void rds_asset_index_free(struct rds_asset_index* s);
269 OSCAP_API const char* rds_asset_index_get_id(struct rds_asset_index* s);
270 OSCAP_API void rds_asset_index_add_report_ref(struct rds_asset_index* s, struct rds_report_index* report);
271 OSCAP_API struct rds_report_index_iterator* rds_asset_index_get_reports(struct rds_asset_index* s);
272 
273 OSCAP_API struct rds_report_index* rds_report_index_new(void);
274 OSCAP_API void rds_report_index_free(struct rds_report_index* s);
275 OSCAP_API const char* rds_report_index_get_id(struct rds_report_index* s);
276 OSCAP_API void rds_report_index_set_request(struct rds_report_index* s, struct rds_report_request_index *request);
277 OSCAP_API struct rds_report_request_index *rds_report_index_get_request(struct rds_report_index* s);
278 
284 
286 OSCAP_API struct rds_report_request_index *rds_report_request_index_iterator_next(struct rds_report_request_index_iterator *it);
288 OSCAP_API bool rds_report_request_index_iterator_has_more(struct rds_report_request_index_iterator *it);
290 OSCAP_API void rds_report_request_index_iterator_free(struct rds_report_request_index_iterator *it);
291 
297 
299 OSCAP_API struct rds_asset_index *rds_asset_index_iterator_next(struct rds_asset_index_iterator *it);
301 OSCAP_API bool rds_asset_index_iterator_has_more(struct rds_asset_index_iterator *it);
303 OSCAP_API void rds_asset_index_iterator_free(struct rds_asset_index_iterator *it);
304 
310 
312 OSCAP_API struct rds_report_index *rds_report_index_iterator_next(struct rds_report_index_iterator *it);
314 OSCAP_API bool rds_report_index_iterator_has_more(struct rds_report_index_iterator *it);
316 OSCAP_API void rds_report_index_iterator_free(struct rds_report_index_iterator *it);
317 
326 struct rds_index;
327 
329 OSCAP_API struct rds_index* rds_index_new(void);
331 OSCAP_API void rds_index_free(struct rds_index *s);
332 
334 OSCAP_API struct rds_report_request_index_iterator *rds_index_get_report_requests(struct rds_index *s);
336 OSCAP_API struct rds_asset_index_iterator *rds_index_get_assets(struct rds_index *s);
338 OSCAP_API struct rds_report_index_iterator *rds_index_get_reports(struct rds_index *s);
339 
341 OSCAP_API struct rds_report_request_index *rds_index_get_report_request(struct rds_index *rds, const char *id);
343 OSCAP_API struct rds_asset_index *rds_index_get_asset(struct rds_index *rds, const char *id);
345 OSCAP_API struct rds_report_index *rds_index_get_report(struct rds_index *rds, const char *id);
347 OSCAP_API int rds_index_select_report(struct rds_index *s, const char **report_id);
348 
349 /************************************************************/
352 #endif
OSCAP_API struct oscap_string_iterator * ds_stream_index_get_checklists(struct ds_stream_index *s)
Retrieves iterator over all components inside the <checklists> element.
Definition: sds_index.c:105
OSCAP_API int ds_rds_create(const char *sds_file, const char *xccdf_result_file, const char **oval_result_files, const char *target_file)
takes given source data stream and XCCDF result file and makes a result data stream
Definition: rds.c:865
OSCAP_API int ds_sds_compose_from_xccdf(const char *xccdf_file, const char *target_datastream)
takes given xccdf file and constructs a source datastream
Definition: sds.c:1311
OSCAP_API struct oscap_string_iterator * ds_stream_index_get_checks(struct ds_stream_index *s)
Retrieves iterator over all components inside the <checks> element.
Definition: sds_index.c:100
OSCAP_API int ds_sds_index_select_checklist(struct ds_sds_index *s, const char **datastream_id, const char **component_id)
chooses datastream and checklist id combination given the IDs
Definition: sds_index.c:403
OSCAP_API const char * ds_stream_index_get_id(struct ds_stream_index *s)
Gets ID of the <data-stream> element the index represents.
Definition: sds_index.c:85
OSCAP_API struct ds_stream_index * ds_sds_index_get_stream(struct ds_sds_index *s, const char *stream_id)
retrieves a stream index by data-stream ID
Definition: sds_index.c:241
OSCAP_API struct ds_stream_index_iterator * ds_sds_index_get_streams(struct ds_sds_index *s)
retrieves all streams indexed inside this structure
Definition: sds_index.c:261
OSCAP_API int ds_sds_index_select_checklist_by_benchmark_id(struct ds_sds_index *s, const char *benchmark_id, const char **datastream_id, const char **component_ref_id)
chooses datastream and checklist component ref ID combination, given benchmark ID
Definition: sds_index.c:451
OSCAP_API int ds_sds_compose_add_component(const char *target_datastream, const char *datastream_id, const char *new_component, bool extended)
append a new given component to the existing source datastream
Definition: sds.c:1174
OSCAP_API struct oscap_string_iterator * ds_stream_index_get_dictionaries(struct ds_stream_index *s)
Retrieves iterator over all components inside the <dictionaries> element.
Definition: sds_index.c:110
OSCAP_API const char * ds_stream_index_get_timestamp(struct ds_stream_index *s)
Timestamp of creation OR modification of the <data-stream> element the index represents.
Definition: sds_index.c:90
OSCAP_API const char * ds_stream_index_get_version(struct ds_stream_index *s)
scap-version of the the <data-stream> element the index represents.
Definition: sds_index.c:95
General OpenScap functions and types.
Retrieves iterator over all components inside the <extended-components> element.
Definition: sds_index.c:209
Contains information about one particular "<data-stream>" element in the datastream collection (also ...
Definition: sds_index.c:38
String iterator.
Definition: rds_asset_index.c:39
Represents <asset-report-collection> element - the root element of each result datastream in Asset Re...
Definition: rds_index.c:40
Definition: rds_report_index.c:37
Definition: rds_report_request_index.c:37