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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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"

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;

const char *oval_syschar_collection_flag_get_text(oval_syschar_collection_flag_t flag);
const char *oval_syschar_status_get_text(oval_syschar_status_t status);
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;





struct oval_syschar_model *oval_syschar_model_new(struct oval_definition_model *definition_model);

int oval_syschar_model_import_source(struct oval_syschar_model *model, struct oscap_source *source);

OSCAP_DEPRECATED(int oval_syschar_model_import(struct oval_syschar_model *model, const char *file));
struct oval_syschar_model *oval_syschar_model_clone(struct oval_syschar_model *);
int oval_syschar_model_export(struct oval_syschar_model *, const char *file);
void oval_syschar_model_free(struct oval_syschar_model *model);

void oval_syschar_model_set_generator(struct oval_syschar_model *model, struct oval_generator *generator);
int oval_syschar_model_bind_variable_model(struct oval_syschar_model *, struct oval_variable_model *);
void oval_syschar_model_set_sysinfo(struct oval_syschar_model *model, struct oval_sysinfo *sysinfo);
struct oval_generator *oval_syschar_model_get_generator(struct oval_syschar_model *model);
struct oval_definition_model *oval_syschar_model_get_definition_model(struct oval_syschar_model *model);
struct oval_syschar_iterator *oval_syschar_model_get_syschars(struct oval_syschar_model *model);
struct oval_sysinfo *oval_syschar_model_get_sysinfo(struct oval_syschar_model *model);
struct oval_syschar *oval_syschar_model_get_syschar(struct oval_syschar_model *model, const char *object_id);
int oval_syschar_model_compute_variable(struct oval_syschar_model *, struct oval_variable *);
oval_syschar_collection_flag_t oval_variable_get_collection_flag(struct oval_variable *);
struct oval_sysitem *oval_syschar_model_get_sysitem(struct oval_syschar_model *, const char *);
struct oval_sysinfo *oval_sysinfo_new(struct oval_syschar_model *);
struct oval_sysinfo *oval_sysinfo_clone(struct oval_syschar_model *new_model, struct oval_sysinfo *old_sysinfo);
void oval_sysinfo_free(struct oval_sysinfo *);

void oval_sysinfo_set_os_name(struct oval_sysinfo *, char *);
void oval_sysinfo_set_os_version(struct oval_sysinfo *, char *);
void oval_sysinfo_set_os_architecture(struct oval_sysinfo *, char *);
void oval_sysinfo_set_primary_host_name(struct oval_sysinfo *, char *);
void oval_sysinfo_add_interface(struct oval_sysinfo *, struct oval_sysint *);
char *oval_sysinfo_get_os_name(struct oval_sysinfo *);

char *oval_sysinfo_get_os_version(struct oval_sysinfo *);

char *oval_sysinfo_get_os_architecture(struct oval_sysinfo *);

char *oval_sysinfo_get_primary_host_name(struct oval_sysinfo *);

struct oval_sysint_iterator *oval_sysinfo_get_interfaces(struct oval_sysinfo *);
bool oval_sysinfo_iterator_has_more(struct oval_sysinfo_iterator *);
struct oval_sysinfo *oval_sysinfo_iterator_next(struct oval_sysinfo_iterator *);
void oval_sysinfo_iterator_free(struct oval_sysinfo_iterator *);
struct oval_syschar *oval_syschar_new(struct oval_syschar_model *, struct oval_object *);
struct oval_syschar *oval_syschar_clone(struct oval_syschar_model *new_model, struct oval_syschar *old_syschar);
void oval_syschar_free(struct oval_syschar *);

void oval_syschar_add_variable_binding(struct oval_syschar *, struct oval_variable_binding *);
void oval_syschar_set_flag(struct oval_syschar *model, oval_syschar_collection_flag_t flag);
void oval_syschar_set_object(struct oval_syschar *, struct oval_object *);
int oval_syschar_get_variable_instance(const struct oval_syschar *syschar);
void oval_syschar_set_variable_instance(struct oval_syschar *syschar, int variable_instance_in);
void oval_syschar_add_sysitem(struct oval_syschar *, struct oval_sysitem *);
void oval_syschar_add_message(struct oval_syschar *syschar, struct oval_message *message);
void oval_syschar_add_new_message(struct oval_syschar *syschar, char *text, oval_message_level_t level);
oval_syschar_collection_flag_t oval_syschar_get_flag(struct oval_syschar *);

struct oval_message_iterator *oval_syschar_get_messages(struct oval_syschar *);

struct oval_object *oval_syschar_get_object(struct oval_syschar *);

struct oval_variable_binding_iterator *oval_syschar_get_variable_bindings(struct oval_syschar *);

struct oval_sysitem_iterator *oval_syschar_get_sysitem(struct oval_syschar *);
bool oval_syschar_iterator_has_more(struct oval_syschar_iterator *);
struct oval_syschar *oval_syschar_iterator_next(struct oval_syschar_iterator *);
void oval_syschar_iterator_free(struct oval_syschar_iterator *);
struct oval_sysint *oval_sysint_new(struct oval_syschar_model *);
struct oval_sysint *oval_sysint_clone(struct oval_syschar_model *new_model, struct oval_sysint *old_sysint);
void oval_sysint_free(struct oval_sysint *);

void oval_sysint_set_name(struct oval_sysint *, char *);
void oval_sysint_set_ip_address(struct oval_sysint *, char *);
void oval_sysint_set_mac_address(struct oval_sysint *, char *);
char *oval_sysint_get_name(struct oval_sysint *);

char *oval_sysint_get_ip_address(struct oval_sysint *);

char *oval_sysint_get_mac_address(struct oval_sysint *);
bool oval_sysint_iterator_has_more(struct oval_sysint_iterator *);
struct oval_sysint *oval_sysint_iterator_next(struct oval_sysint_iterator *);
void oval_sysint_iterator_free(struct oval_sysint_iterator *);
struct oval_sysitem *oval_sysitem_new(struct oval_syschar_model *, const char *id);
struct oval_sysitem *oval_sysitem_clone(struct oval_syschar_model *new_model, struct oval_sysitem *old_data);
void oval_sysitem_free(struct oval_sysitem *);

void oval_sysitem_set_status(struct oval_sysitem *, oval_syschar_status_t);
void oval_sysitem_set_subtype(struct oval_sysitem *sysitem, oval_subtype_t subtype);
void oval_sysitem_add_message(struct oval_sysitem *, struct oval_message *);
void oval_sysitem_add_sysent(struct oval_sysitem *, struct oval_sysent *);
char *oval_sysitem_get_id(struct oval_sysitem *);
oval_syschar_status_t oval_sysitem_get_status(struct oval_sysitem *);
struct oval_sysent_iterator *oval_sysitem_get_sysents(struct oval_sysitem *);
struct oval_message_iterator *oval_sysitem_get_messages(struct oval_sysitem *);
oval_subtype_t oval_sysitem_get_subtype(struct oval_sysitem *);
bool oval_sysitem_iterator_has_more(struct oval_sysitem_iterator *);
struct oval_sysitem *oval_sysitem_iterator_next(struct oval_sysitem_iterator *);
void oval_sysitem_iterator_free(struct oval_sysitem_iterator *);
struct oval_sysent *oval_sysent_new(struct oval_syschar_model *);
struct oval_sysent *oval_sysent_clone(struct oval_syschar_model *new_model, struct oval_sysent *old_item);
void oval_sysent_free(struct oval_sysent *);
void oval_sysent_set_name(struct oval_sysent *sysent, char *name);
void oval_sysent_set_value(struct oval_sysent *sysent, char *value);
void oval_sysent_add_record_field(struct oval_sysent *, struct oval_record_field *);
void oval_sysent_set_status(struct oval_sysent *sysent, oval_syschar_status_t status);
void oval_sysent_set_datatype(struct oval_sysent *sysent, oval_datatype_t type);
void oval_sysent_set_mask(struct oval_sysent *sysent, int mask);
char *oval_sysent_get_name(struct oval_sysent *);

char *oval_sysent_get_value(struct oval_sysent *);

struct oval_record_field_iterator *oval_sysent_get_record_fields(struct oval_sysent *);

oval_syschar_status_t oval_sysent_get_status(struct oval_sysent *);

oval_datatype_t oval_sysent_get_datatype(struct oval_sysent *);

int oval_sysent_get_mask(struct oval_sysent *);
bool oval_sysent_iterator_has_more(struct oval_sysent_iterator *);
struct oval_sysent *oval_sysent_iterator_next(struct oval_sysent_iterator *);
void oval_sysent_iterator_free(struct oval_sysent_iterator *);
void oval_record_field_set_status(struct oval_record_field *, oval_syschar_status_t);
oval_syschar_status_t oval_record_field_get_status(struct oval_record_field *);
struct oval_message *oval_message_new(void);
struct oval_message *oval_message_clone(struct oval_message *old_message);
void oval_message_free(struct oval_message *);

void oval_message_set_text(struct oval_message *, char *);
void oval_message_set_level(struct oval_message *, oval_message_level_t);
char *oval_message_get_text(struct oval_message *message);
oval_message_level_t oval_message_get_level(struct oval_message *message);
bool oval_message_iterator_has_more(struct oval_message_iterator *oc_message);
struct oval_message *oval_message_iterator_next(struct oval_message_iterator *oc_message);
void oval_message_iterator_free(struct oval_message_iterator *oc_message);
struct oval_variable_binding *oval_variable_binding_new(struct oval_variable *, char *);
struct oval_variable_binding *oval_variable_binding_clone(struct oval_variable_binding *,
                                                          struct oval_definition_model *);
void oval_variable_binding_free(struct oval_variable_binding *);

void oval_variable_binding_set_variable(struct oval_variable_binding *, struct oval_variable *);
void oval_variable_binding_add_value(struct oval_variable_binding *, char *);
struct oval_variable *oval_variable_binding_get_variable(struct oval_variable_binding *);
struct oval_string_iterator *oval_variable_binding_get_values(struct oval_variable_binding *);
bool oval_variable_binding_iterator_has_more(struct oval_variable_binding_iterator *);
struct oval_variable_binding *oval_variable_binding_iterator_next(struct oval_variable_binding_iterator *);
void oval_variable_binding_iterator_free(struct oval_variable_binding_iterator *);
#endif