Open SCAP Library
oscap.h
Go to the documentation of this file.
1 /*
2  * Copyright 2009,2010,2011 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors:
20  * Lukas Kuklinek <lkuklinek@redhat.com>
21  * Peter Vrabec <pvrabec@redhat.com>
22  */
23 
33 #ifndef OSCAP_H_
34 #define OSCAP_H_
35 #include <stdbool.h>
36 
37 #include "oscap_text.h"
38 #include "oscap_reference.h"
39 #include "oscap_export.h"
40 
44 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
45 # define OSCAP_DEPRECATED(func) func __attribute__ ((deprecated))
46 #elif defined(_MSC_VER)
47 # define OSCAP_DEPRECATED(func) __declspec(deprecated) func
48 #else
49 # pragma message("WARNING: You need to implement OSCAP_DEPRECATED for this compiler---in order to get deprecation warnings.")
50 # define OSCAP_DEPRECATED(func) func
51 #endif
52 
62 OSCAP_API void oscap_init(void);
63 
71 OSCAP_API void oscap_cleanup(void);
72 
74 OSCAP_API const char *oscap_get_version(void);
75 
76 
83 typedef enum oscap_document_type {
101  // If you are adding a new enum here, make sure you add support for it
102  // to utils/oscap-info.c!
104 
113 OSCAP_API const char *oscap_document_type_to_string(oscap_document_type_t type);
114 
115 typedef int (*xml_reporter)(const char *file, int line, const char *msg, void *arg);
116 
129 OSCAP_API int oscap_apply_xslt(const char *xmlfile, const char *xsltfile, const char *outfile, const char **params);
130 
134 OSCAP_API const char * oscap_path_to_schemas(void);
135 
139 OSCAP_API const char * oscap_path_to_cpe(void);
140 
141 /************************************************************/
146 #endif
OSCAP_DOCUMENT_XCCDF_TAILORING
@ OSCAP_DOCUMENT_XCCDF_TAILORING
XCCDF tailoring file.
Definition: oscap.h:98
oscap_get_version
const OSCAP_API char * oscap_get_version(void)
Get version of the OpenSCAP library.
Definition: oscapxml.c:126
OSCAP_DOCUMENT_XCCDF
@ OSCAP_DOCUMENT_XCCDF
XCCDF benchmark file.
Definition: oscap.h:91
oscap_document_type_t
enum oscap_document_type oscap_document_type_t
SCAP document type identifiers.
OSCAP_DOCUMENT_OVAL_RESULTS
@ OSCAP_DOCUMENT_OVAL_RESULTS
OVAL results file.
Definition: oscap.h:89
OSCAP_DOCUMENT_OVAL_DEFINITIONS
@ OSCAP_DOCUMENT_OVAL_DEFINITIONS
OVAL Definitions file.
Definition: oscap.h:86
OSCAP_DOCUMENT_SCE_RESULT
@ OSCAP_DOCUMENT_SCE_RESULT
SCE result file.
Definition: oscap.h:95
OSCAP_DOCUMENT_OVAL_VARIABLES
@ OSCAP_DOCUMENT_OVAL_VARIABLES
OVAL Variables.
Definition: oscap.h:87
OSCAP_DOCUMENT_CPE_DICTIONARY
@ OSCAP_DOCUMENT_CPE_DICTIONARY
CPE dictionary file.
Definition: oscap.h:93
oscap_cleanup
OSCAP_API void oscap_cleanup(void)
Release library internal caches.
Definition: oscapxml.c:119
oscap_path_to_cpe
const OSCAP_API char * oscap_path_to_cpe(void)
Function returns path used to locate OpenSCAP Default CPE files.
Definition: oscapxml.c:108
oscap_document_type_to_string
const OSCAP_API char * oscap_document_type_to_string(oscap_document_type_t type)
Convert oscap_document_type_t constant to human readable (english) representation.
Definition: oscapxml.c:136
oscap_init
OSCAP_API void oscap_init(void)
Initialize OpenSCAP library.
Definition: oscapxml.c:112
OSCAP_DOCUMENT_OVAL_SYSCHAR
@ OSCAP_DOCUMENT_OVAL_SYSCHAR
OVAL system characteristics file.
Definition: oscap.h:88
OSCAP_DOCUMENT_CPE_LANGUAGE
@ OSCAP_DOCUMENT_CPE_LANGUAGE
CPE language file.
Definition: oscap.h:92
OSCAP_DOCUMENT_SDS
@ OSCAP_DOCUMENT_SDS
Source Data Stream file.
Definition: oscap.h:96
OSCAP_DOCUMENT_ARF
@ OSCAP_DOCUMENT_ARF
Result Data Stream file.
Definition: oscap.h:97
oscap_apply_xslt
OSCAP_API int oscap_apply_xslt(const char *xmlfile, const char *xsltfile, const char *outfile, const char **params)
Apply a XSLT stylesheet to a XML file.
Definition: oscapxml.c:128
oscap_path_to_schemas
const OSCAP_API char * oscap_path_to_schemas(void)
Function returns path used to locate OpenSCAP XML schemas.
Definition: oscapxml.c:99
oscap_document_type
oscap_document_type
SCAP document type identifiers.
Definition: oscap.h:84
OSCAP_DOCUMENT_CVE_FEED
@ OSCAP_DOCUMENT_CVE_FEED
CVE NVD feed.
Definition: oscap.h:94
OSCAP_DOCUMENT_CVRF_FEED
@ OSCAP_DOCUMENT_CVRF_FEED
CVRF feed.
Definition: oscap.h:100
oscap_text.h
OSCAP_DOCUMENT_OCIL
@ OSCAP_DOCUMENT_OCIL
OCIL Definitions file.
Definition: oscap.h:99
OSCAP_DOCUMENT_UNKNOWN
@ OSCAP_DOCUMENT_UNKNOWN
The type is unknown.
Definition: oscap.h:85
OSCAP_DOCUMENT_OVAL_DIRECTIVES
@ OSCAP_DOCUMENT_OVAL_DIRECTIVES
OVAL directives file.
Definition: oscap.h:90