Loading...
Searching...
No Matches
oval_system_characteristics.h
Go to the documentation of this file.
/*
* Copyright 2009--2014 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Authors:
* "David Niemoller" <David.Niemoller@g2-inc.com>
* Šimon Lukašík
*/
#ifndef OVAL_SYSTEM_CHARACTERISTICS
#define OVAL_SYSTEM_CHARACTERISTICS
#include "oscap.h"
#include "oscap_source.h"
#include "oval_types.h"
#include "oval_definitions.h"
#include "oscap_export.h"
typedef enum {
SYSCHAR_FLAG_UNKNOWN = 0,
SYSCHAR_FLAG_ERROR = 1,
SYSCHAR_FLAG_COMPLETE = 2,
SYSCHAR_FLAG_INCOMPLETE = 3,
SYSCHAR_FLAG_DOES_NOT_EXIST = 4,
SYSCHAR_FLAG_NOT_COLLECTED = 5,
SYSCHAR_FLAG_NOT_APPLICABLE = 6
} oval_syschar_collection_flag_t;
typedef enum {
SYSCHAR_STATUS_UNKNOWN = 0,
SYSCHAR_STATUS_ERROR = 1,
SYSCHAR_STATUS_EXISTS = 2,
SYSCHAR_STATUS_DOES_NOT_EXIST = 3,
SYSCHAR_STATUS_NOT_COLLECTED = 4
} oval_syschar_status_t;
typedef enum {
OVAL_MESSAGE_LEVEL_NONE = 0,
OVAL_MESSAGE_LEVEL_DEBUG = 1,
OVAL_MESSAGE_LEVEL_INFO = 2,
OVAL_MESSAGE_LEVEL_WARNING = 3,
OVAL_MESSAGE_LEVEL_ERROR = 4,
OVAL_MESSAGE_LEVEL_FATAL = 5
} oval_message_level_t;
OSCAP_API const char *oval_syschar_collection_flag_get_text(oval_syschar_collection_flag_t flag);
OSCAP_API const char *oval_syschar_status_get_text(oval_syschar_status_t status);
OSCAP_API const char *oval_message_level_text(oval_message_level_t);
struct oval_syschar_model;
struct oval_sysinfo;
struct oval_sysinfo_iterator;
struct oval_syschar;
struct oval_syschar_iterator;
struct oval_sysint;
struct oval_sysint_iterator;
struct oval_sysitem;
struct oval_sysitem_iterator;
struct oval_sysent;
struct oval_sysent_iterator;
struct oval_message;
struct oval_message_iterator;
struct oval_variable_binding;
struct oval_variable_binding_iterator;
OSCAP_API struct oval_syschar_model *oval_syschar_model_new(struct oval_definition_model *definition_model);
OSCAP_API int oval_syschar_model_import_source(struct oval_syschar_model *model, struct oscap_source *source);
OSCAP_API struct oval_syschar_model *oval_syschar_model_clone(struct oval_syschar_model *);
OSCAP_API int oval_syschar_model_export(struct oval_syschar_model *, const char *file);
OSCAP_API void oval_syschar_model_free(struct oval_syschar_model *model);
OSCAP_API void oval_syschar_model_set_generator(struct oval_syschar_model *model, struct oval_generator *generator);
OSCAP_API int oval_syschar_model_bind_variable_model(struct oval_syschar_model *, struct oval_variable_model *);
OSCAP_API void oval_syschar_model_set_sysinfo(struct oval_syschar_model *model, struct oval_sysinfo *sysinfo);
OSCAP_API struct oval_generator *oval_syschar_model_get_generator(struct oval_syschar_model *model);
OSCAP_API struct oval_definition_model *oval_syschar_model_get_definition_model(struct oval_syschar_model *model);
OSCAP_API struct oval_syschar_iterator *oval_syschar_model_get_syschars(struct oval_syschar_model *model);
OSCAP_API struct oval_sysinfo *oval_syschar_model_get_sysinfo(struct oval_syschar_model *model);
OSCAP_API struct oval_syschar *oval_syschar_model_get_syschar(struct oval_syschar_model *model, const char *object_id);
OSCAP_API int oval_syschar_model_compute_variable(struct oval_syschar_model *, struct oval_variable *);
OSCAP_API oval_syschar_collection_flag_t oval_variable_get_collection_flag(struct oval_variable *);
OSCAP_API struct oval_sysitem *oval_syschar_model_get_sysitem(struct oval_syschar_model *, const char *);
OSCAP_API struct oval_sysinfo *oval_sysinfo_new(struct oval_syschar_model *);
OSCAP_API struct oval_sysinfo *oval_sysinfo_clone(struct oval_syschar_model *new_model, struct oval_sysinfo *old_sysinfo);
OSCAP_API void oval_sysinfo_free(struct oval_sysinfo *);
OSCAP_API void oval_sysinfo_set_os_name(struct oval_sysinfo *, char *);
OSCAP_API void oval_sysinfo_set_os_version(struct oval_sysinfo *, char *);
OSCAP_API void oval_sysinfo_set_os_architecture(struct oval_sysinfo *, char *);
OSCAP_API void oval_sysinfo_set_primary_host_name(struct oval_sysinfo *, char *);
OSCAP_API void oval_sysinfo_add_interface(struct oval_sysinfo *, struct oval_sysint *);
OSCAP_API char *oval_sysinfo_get_os_name(struct oval_sysinfo *);
OSCAP_API char *oval_sysinfo_get_os_version(struct oval_sysinfo *);
OSCAP_API char *oval_sysinfo_get_os_architecture(struct oval_sysinfo *);
OSCAP_API char *oval_sysinfo_get_primary_host_name(struct oval_sysinfo *);
OSCAP_API struct oval_sysint_iterator *oval_sysinfo_get_interfaces(struct oval_sysinfo *);
OSCAP_API bool oval_sysinfo_iterator_has_more(struct oval_sysinfo_iterator *);
OSCAP_API struct oval_sysinfo *oval_sysinfo_iterator_next(struct oval_sysinfo_iterator *);
OSCAP_API void oval_sysinfo_iterator_free(struct oval_sysinfo_iterator *);
OSCAP_API struct oval_syschar *oval_syschar_new(struct oval_syschar_model *, struct oval_object *);
OSCAP_API struct oval_syschar *oval_syschar_clone(struct oval_syschar_model *new_model, struct oval_syschar *old_syschar);
OSCAP_API void oval_syschar_free(struct oval_syschar *);
OSCAP_API void oval_syschar_add_variable_binding(struct oval_syschar *, struct oval_variable_binding *);
OSCAP_API void oval_syschar_set_flag(struct oval_syschar *model, oval_syschar_collection_flag_t flag);
OSCAP_API void oval_syschar_set_object(struct oval_syschar *, struct oval_object *);
OSCAP_API int oval_syschar_get_variable_instance(const struct oval_syschar *syschar);
OSCAP_API void oval_syschar_set_variable_instance(struct oval_syschar *syschar, int variable_instance_in);
OSCAP_API void oval_syschar_add_sysitem(struct oval_syschar *, struct oval_sysitem *);
OSCAP_API void oval_syschar_add_message(struct oval_syschar *syschar, struct oval_message *message);
OSCAP_API void oval_syschar_add_new_message(struct oval_syschar *syschar, char *text, oval_message_level_t level);
OSCAP_API oval_syschar_collection_flag_t oval_syschar_get_flag(struct oval_syschar *);
OSCAP_API struct oval_message_iterator *oval_syschar_get_messages(struct oval_syschar *);
OSCAP_API struct oval_object *oval_syschar_get_object(struct oval_syschar *);
OSCAP_API struct oval_variable_binding_iterator *oval_syschar_get_variable_bindings(struct oval_syschar *);
OSCAP_API struct oval_sysitem_iterator *oval_syschar_get_sysitem(struct oval_syschar *);
OSCAP_API bool oval_syschar_iterator_has_more(struct oval_syschar_iterator *);
OSCAP_API struct oval_syschar *oval_syschar_iterator_next(struct oval_syschar_iterator *);
OSCAP_API void oval_syschar_iterator_free(struct oval_syschar_iterator *);
OSCAP_API struct oval_sysint *oval_sysint_new(struct oval_syschar_model *);
OSCAP_API struct oval_sysint *oval_sysint_clone(struct oval_syschar_model *new_model, struct oval_sysint *old_sysint);
OSCAP_API void oval_sysint_free(struct oval_sysint *);
OSCAP_API void oval_sysint_set_name(struct oval_sysint *, char *);
OSCAP_API void oval_sysint_set_ip_address(struct oval_sysint *, char *);
OSCAP_API void oval_sysint_set_mac_address(struct oval_sysint *, char *);
OSCAP_API char *oval_sysint_get_name(struct oval_sysint *);
OSCAP_API char *oval_sysint_get_ip_address(struct oval_sysint *);
OSCAP_API char *oval_sysint_get_mac_address(struct oval_sysint *);
OSCAP_API bool oval_sysint_iterator_has_more(struct oval_sysint_iterator *);
OSCAP_API struct oval_sysint *oval_sysint_iterator_next(struct oval_sysint_iterator *);
OSCAP_API void oval_sysint_iterator_free(struct oval_sysint_iterator *);
OSCAP_API struct oval_sysitem *oval_sysitem_new(struct oval_syschar_model *, const char *id);
OSCAP_API struct oval_sysitem *oval_sysitem_clone(struct oval_syschar_model *new_model, struct oval_sysitem *old_data);
OSCAP_API void oval_sysitem_free(struct oval_sysitem *);
OSCAP_API void oval_sysitem_set_status(struct oval_sysitem *, oval_syschar_status_t);
OSCAP_API void oval_sysitem_set_subtype(struct oval_sysitem *sysitem, oval_subtype_t subtype);
OSCAP_API void oval_sysitem_add_message(struct oval_sysitem *, struct oval_message *);
OSCAP_API void oval_sysitem_add_sysent(struct oval_sysitem *, struct oval_sysent *);
OSCAP_API char *oval_sysitem_get_id(struct oval_sysitem *);
OSCAP_API oval_syschar_status_t oval_sysitem_get_status(struct oval_sysitem *);
OSCAP_API struct oval_sysent_iterator *oval_sysitem_get_sysents(struct oval_sysitem *);
OSCAP_API struct oval_message_iterator *oval_sysitem_get_messages(struct oval_sysitem *);
OSCAP_API oval_subtype_t oval_sysitem_get_subtype(struct oval_sysitem *);
OSCAP_API bool oval_sysitem_iterator_has_more(struct oval_sysitem_iterator *);
OSCAP_API struct oval_sysitem *oval_sysitem_iterator_next(struct oval_sysitem_iterator *);
OSCAP_API void oval_sysitem_iterator_free(struct oval_sysitem_iterator *);
OSCAP_API struct oval_sysent *oval_sysent_new(struct oval_syschar_model *);
OSCAP_API struct oval_sysent *oval_sysent_clone(struct oval_syschar_model *new_model, struct oval_sysent *old_item);
OSCAP_API void oval_sysent_free(struct oval_sysent *);
OSCAP_API void oval_sysent_set_name(struct oval_sysent *sysent, char *name);
OSCAP_API void oval_sysent_set_value(struct oval_sysent *sysent, char *value);
OSCAP_API void oval_sysent_add_record_field(struct oval_sysent *, struct oval_record_field *);
OSCAP_API void oval_sysent_set_status(struct oval_sysent *sysent, oval_syschar_status_t status);
OSCAP_API void oval_sysent_set_datatype(struct oval_sysent *sysent, oval_datatype_t type);
OSCAP_API void oval_sysent_set_mask(struct oval_sysent *sysent, int mask);
OSCAP_API char *oval_sysent_get_name(struct oval_sysent *);
OSCAP_API char *oval_sysent_get_value(struct oval_sysent *);
OSCAP_API struct oval_record_field_iterator *oval_sysent_get_record_fields(struct oval_sysent *);
OSCAP_API oval_syschar_status_t oval_sysent_get_status(struct oval_sysent *);
OSCAP_API oval_datatype_t oval_sysent_get_datatype(struct oval_sysent *);
OSCAP_API int oval_sysent_get_mask(struct oval_sysent *);
OSCAP_API bool oval_sysent_iterator_has_more(struct oval_sysent_iterator *);
OSCAP_API struct oval_sysent *oval_sysent_iterator_next(struct oval_sysent_iterator *);
OSCAP_API void oval_sysent_iterator_free(struct oval_sysent_iterator *);
OSCAP_API void oval_record_field_set_status(struct oval_record_field *, oval_syschar_status_t);
OSCAP_API oval_syschar_status_t oval_record_field_get_status(struct oval_record_field *);
OSCAP_API struct oval_message *oval_message_new(void);
OSCAP_API struct oval_message *oval_message_clone(struct oval_message *old_message);
OSCAP_API void oval_message_free(struct oval_message *);
OSCAP_API void oval_message_set_text(struct oval_message *, char *);
OSCAP_API void oval_message_set_level(struct oval_message *, oval_message_level_t);
OSCAP_API char *oval_message_get_text(struct oval_message *message);
OSCAP_API oval_message_level_t oval_message_get_level(struct oval_message *message);
OSCAP_API bool oval_message_iterator_has_more(struct oval_message_iterator *oc_message);
OSCAP_API struct oval_message *oval_message_iterator_next(struct oval_message_iterator *oc_message);
OSCAP_API void oval_message_iterator_free(struct oval_message_iterator *oc_message);
OSCAP_API struct oval_variable_binding *oval_variable_binding_new(struct oval_variable *, char *);
OSCAP_API struct oval_variable_binding *oval_variable_binding_clone(struct oval_variable_binding *,
struct oval_definition_model *);
OSCAP_API void oval_variable_binding_free(struct oval_variable_binding *);
OSCAP_API void oval_variable_binding_set_variable(struct oval_variable_binding *, struct oval_variable *);
OSCAP_API void oval_variable_binding_add_value(struct oval_variable_binding *, char *);
OSCAP_API struct oval_variable *oval_variable_binding_get_variable(struct oval_variable_binding *);
OSCAP_API struct oval_string_iterator *oval_variable_binding_get_values(struct oval_variable_binding *);
OSCAP_API bool oval_variable_binding_iterator_has_more(struct oval_variable_binding_iterator *);
OSCAP_API struct oval_variable_binding *oval_variable_binding_iterator_next(struct oval_variable_binding_iterator *);
OSCAP_API void oval_variable_binding_iterator_free(struct oval_variable_binding_iterator *);
#endif
oval_datatype_t
oval_datatype_t
Datatypes.
Definition oval_definitions.h:149
oval_syschar_model::oval_syschar_model_import_source
OSCAP_API int oval_syschar_model_import_source(struct oval_syschar_model *model, struct oscap_source *source)
Import the content from the oscap_source into an oval_syschar_model.
Definition oval_sysModel.c:233
oval_message::oval_message_clone
OSCAP_API struct oval_message * oval_message_clone(struct oval_message *old_message)
Definition oval_message.c:62
oval_sysitem::oval_sysitem_clone
OSCAP_API struct oval_sysitem * oval_sysitem_clone(struct oval_syschar_model *new_model, struct oval_sysitem *old_data)
Definition oval_sysItem.c:76
oval_syschar::oval_syschar_get_variable_instance
OSCAP_API int oval_syschar_get_variable_instance(const struct oval_syschar *syschar)
Gets the variable_instance attribute of the syschar.
Definition oval_syschar.c:379
oval_sysinfo::oval_sysinfo_get_os_architecture
OSCAP_API char * oval_sysinfo_get_os_architecture(struct oval_sysinfo *)
Get operating system architecture.
Definition oval_sysInfo.c:174
oval_syschar_model::oval_syschar_model_free
OSCAP_API void oval_syschar_model_free(struct oval_syschar_model *model)
Free memory allocated to a specified syschar model.
Definition oval_sysModel.c:139
oval_sysent::oval_sysent_get_name
OSCAP_API char * oval_sysent_get_name(struct oval_sysent *)
Get system data item name.
Definition oval_sysEnt.c:130
oval_sysinfo::oval_sysinfo_get_os_version
OSCAP_API char * oval_sysinfo_get_os_version(struct oval_sysinfo *)
Get operating system version.
Definition oval_sysInfo.c:161
oval_syschar_model::oval_syschar_model_bind_variable_model
OSCAP_API int oval_syschar_model_bind_variable_model(struct oval_syschar_model *, struct oval_variable_model *)
Bind a variable model to the definitions bound to the syschar model.
Definition oval_sysModel.c:271
oval_syschar_collection_flag_t
oval_syschar_collection_flag_t
System characteristics result flag.
Definition oval_system_characteristics.h:50
oval_syschar::oval_syschar_get_flag
OSCAP_API oval_syschar_collection_flag_t oval_syschar_get_flag(struct oval_syschar *)
Get system characteristic flag.
Definition oval_syschar.c:58
oval_sysinfo::oval_sysinfo_clone
OSCAP_API struct oval_sysinfo * oval_sysinfo_clone(struct oval_syschar_model *new_model, struct oval_sysinfo *old_sysinfo)
Definition oval_sysInfo.c:71
oval_sysint::oval_sysint_get_ip_address
OSCAP_API char * oval_sysint_get_ip_address(struct oval_sysint *)
Get interface IP address.
Definition oval_sysInterface.c:84
oval_syschar_model::oval_syschar_model_new
OSCAP_API struct oval_syschar_model * oval_syschar_model_new(struct oval_definition_model *definition_model)
Create new oval_syschar_model.
Definition oval_sysModel.c:69
oval_sysinfo::oval_sysinfo_get_os_name
OSCAP_API char * oval_sysinfo_get_os_name(struct oval_sysinfo *)
Get operating system name.
Definition oval_sysInfo.c:145
oval_variable_binding::oval_variable_binding_clone
OSCAP_API struct oval_variable_binding * oval_variable_binding_clone(struct oval_variable_binding *, struct oval_definition_model *)
Definition oval_variableBinding.c:120
oval_message_level_t
oval_message_level_t
Message level.
Definition oval_system_characteristics.h:70
oval_sysinfo::oval_sysinfo_get_primary_host_name
OSCAP_API char * oval_sysinfo_get_primary_host_name(struct oval_sysinfo *)
Get primary host name of the tested machine.
Definition oval_sysInfo.c:187
oval_message::oval_message_get_level
OSCAP_API oval_message_level_t oval_message_get_level(struct oval_message *message)
Get OVAL message level.
Definition oval_message.c:110
oval_sysitem::oval_sysitem_get_id
OSCAP_API char * oval_sysitem_get_id(struct oval_sysitem *)
Get system data ID.
Definition oval_sysItem.c:149
oval_sysent::oval_sysent_clone
OSCAP_API struct oval_sysent * oval_sysent_clone(struct oval_syschar_model *new_model, struct oval_sysent *old_item)
Definition oval_sysEnt.c:74
oval_sysint::oval_sysint_clone
OSCAP_API struct oval_sysint * oval_sysint_clone(struct oval_syschar_model *new_model, struct oval_sysint *old_sysint)
Definition oval_sysInterface.c:125
oval_syschar_status_t
oval_syschar_status_t
System characteristics status.
Definition oval_system_characteristics.h:61
oval_syschar::oval_syschar_clone
OSCAP_API struct oval_syschar * oval_syschar_clone(struct oval_syschar_model *new_model, struct oval_syschar *old_syschar)
Definition oval_syschar.c:166
oval_sysent::oval_sysent_get_value
OSCAP_API char * oval_sysent_get_value(struct oval_sysent *)
Get system data item value.
Definition oval_sysEnt.c:144
oval_message::oval_message_get_text
OSCAP_API char * oval_message_get_text(struct oval_message *message)
Get OVAL message text.
Definition oval_message.c:102
oval_sysint::oval_sysint_get_name
OSCAP_API char * oval_sysint_get_name(struct oval_sysint *)
Get interface name.
Definition oval_sysInterface.c:69
oval_sysint::oval_sysint_get_mac_address
OSCAP_API char * oval_sysint_get_mac_address(struct oval_sysint *)
Get interface MAC address.
Definition oval_sysInterface.c:99
oval_syschar::oval_syschar_set_variable_instance
OSCAP_API void oval_syschar_set_variable_instance(struct oval_syschar *syschar, int variable_instance_in)
Sets the variable_instance attribute of the syschar.
Definition oval_syschar.c:385
oval_syschar_model::oval_syschar_model_clone
OSCAP_API struct oval_syschar_model * oval_syschar_model_clone(struct oval_syschar_model *)
Copy an oval_syschar_model.
Definition oval_sysModel.c:119
oval_sysitem::oval_sysitem_get_status
OSCAP_API oval_syschar_status_t oval_sysitem_get_status(struct oval_sysitem *)
Get system data status.
Definition oval_sysItem.c:179
oval_syschar_model::oval_syschar_model_export
OSCAP_API int oval_syschar_model_export(struct oval_syschar_model *, const char *file)
Export system characteristics into file.
Definition oval_sysModel.c:401
oval_subtype_t
oval_subtype_t
Unknown subtypes.
Definition oval_types.h:127
oscap.h
General OpenScap functions and types.
oval_definitions.h
oval_types.h
oscap_source
Definition oscap_source.c:66
oval_definition_model
Oval definition model.
Definition oval_defModel.c:53
oval_generator
Definition oval_generator.c:47
oval_message_iterator
oval_message
OVAL message.
Definition oval_message.c:45
oval_object
An Oval_object instance describes a set of items to look for on an instrumented host platform.
Definition oval_object.c:45
oval_record_field_iterator
oval_record_field
Definition oval_recordField.c:35
oval_string_iterator
oval_syschar_iterator
oval_syschar_model
OVAL System Characteristics model.
Definition oval_sysModel.c:56
oval_syschar
Characteristics bound to an Oval_object.
Definition oval_syschar.c:47
oval_sysent_iterator
oval_sysent
Definition oval_sysEnt.c:48
oval_sysinfo_iterator
oval_sysinfo
General instrumented host description.
Definition oval_sysInfo.c:45
oval_sysint_iterator
oval_sysint
Network interface description.
Definition oval_sysInterface.c:45
oval_sysitem_iterator
oval_sysitem
Each instance of Oval_sysitem represents one item.
Definition oval_sysItem.c:45
oval_variable_binding_iterator
oval_variable_binding
Binding of an value to an OVAL variable.
Definition oval_variableBinding.c:45
oval_variable_model
The OVAL variable model facilitates access to external variable value bindings used to to constrain t...
Definition oval_varModel.c:56
oval_variable
An oval variable resolves an oval_value stream which specifies constraints for oval_object s and ova...
Definition oval_variable.c:50