/usr/include/openscap/cce.h is in libopenscap-dev 0.8.0-4build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /**
* @addtogroup CCE
* @{
*
* @file cce.h
*/
/*
* Copyright 2008-2009 Red Hat Inc., Durham, North Carolina.
* All Rights Reserved.
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors:
* Lukas Kuklinek <lkuklinek@redhat.com>
* Riley C. Porter <Riley.Porter@g2-inc.com>
*/
#include <stdbool.h>
#include "oscap.h"
#ifndef _CCE_H
#define _CCE_H
/**
* @struct cce
* Structure holding CCE entries.
*/
struct cce;
/**
* @struct cce_entry
* Structure holding single CCE entry data.
*/
struct cce_entry;
/**
* @struct cce_reference
* Structure holding a CCE reference.
*/
struct cce_reference;
/************************************************************/
/**
* @name Getters
* Return value is pointer to structure's member. Do not free unless you null the pointer in the structure.
* Use remove function otherwise.
* @{
* */
/**
* Get an iterator to the contents of the CCE.
* @memberof cce
*/
struct cce_entry_iterator *cce_get_entries(const struct cce *cce);
/**
* Get an CCE entry by ID.
* @memberof cce
* @retval NULL if given entry does not exist
*/
struct cce_entry *cce_get_entry(const struct cce *cce, const char *id);
/**
* Get CCE entry ID.
* @memberof cce_entry
*/
const char *cce_entry_get_id(const struct cce_entry *cce);
/**
* Get CCE entry desription.
* @memberof cce_entry
*/
const char *cce_entry_get_description(const struct cce_entry *cce);
/**
* Get an iterator to CCE entry's parameters.
* @memberof cce_entry
*/
struct oscap_string_iterator *cce_entry_get_params(const struct cce_entry *cce);
/**
* Get an iterator to CCE entry's technical mechanisms.
* @memberof cce_entry
*/
struct oscap_string_iterator *cce_entry_get_tech_mechs(const struct cce_entry *cce);
/**
* Get an iterator to CCE entry's references.
* @memberof cce_entry
*/
struct cce_reference_iterator *cce_entry_get_references(const struct cce_entry *cce);
/**
* Get source of CCE reference.
* @memberof cce_reference
*/
const char *cce_reference_get_source(const struct cce_reference *ref);
/**
* Get contents of CCE reference.
* @memberof cce_reference
*/
const char *cce_reference_get_value(const struct cce_reference *ref);
/************************************************************/
/** @} End of Getters group */
/************************************************************/
/**
* @name Iterators
* @{
* */
/**
* @struct cce_reference_iterator
* Iterator over CCE references.
* @see oscap_iterator
*/
struct cce_reference_iterator;
/// @memberof cce_reference_iterator
struct cce_reference *cce_reference_iterator_next(struct cce_reference_iterator *it);
/// @memberof cce_reference_iterator
bool cce_reference_iterator_has_more(struct cce_reference_iterator *it);
/// @memberof cce_reference_iterator
void cce_reference_iterator_free(struct cce_reference_iterator *it);
/// @memberof cce_reference_iterator
void cce_reference_iterator_reset(struct cce_reference_iterator *it);
/**
* @struct cce_entry_iterator
* Iterator over CCE entries.
* @see oscap_iterator
*/
struct cce_entry_iterator;
/// @memberof cce_entry_iterator
struct cce_entry *cce_entry_iterator_next(struct cce_entry_iterator *it);
/// @memberof cce_entry_iterator
bool cce_entry_iterator_has_more(struct cce_entry_iterator *it);
/// @memberof cce_entry_iterator
void cce_entry_iterator_free(struct cce_entry_iterator *it);
/// @memberof cce_entry_iterator
void cce_entry_iterator_reset(struct cce_entry_iterator *it);
/************************************************************/
/** @} End of Iterators group */
/**
* Create a new CCE structure from XML file.
* @memberof cce
* @param fname XML file name to porcess
* @retval NULL on failure
*/
struct cce *cce_new(const char *fname);
/**
* CCE structure destructor.
* Deinitializes CCE structure and releases used resources.
* @memberof cce
* @param cce pointer to target structure
*/
void cce_free(struct cce *cce);
/************************************************************/
/**
* @name Evaluators
* @{
* */
/**
* Vlaidate CCE XML file.
*
* @param filename file to be validated
* @return result of validation (true / false)
*/
bool cce_validate(const char *filename);
/**
* Get supported version of CCE XML
* @return version of XML file format
* @memberof cce
*/
const char * cce_supported(void);
/************************************************************/
/** @} End of Evaluators group */
/** @} */
#endif
|