• Main Page
  • Related Pages
  • Modules
  • Data Structures
  • Files
  • File List
  • Globals

/home/pvrabec/project/openscap/openscap-0.7.1/src/OVAL/public/oval_system_characteristics.h

Go to the documentation of this file.
00001 
00016 /*
00017  * Copyright 2009-2010 Red Hat Inc., Durham, North Carolina.
00018  * All Rights Reserved.
00019  *
00020  * This library is free software; you can redistribute it and/or
00021  * modify it under the terms of the GNU Lesser General Public
00022  * License as published by the Free Software Foundation; either
00023  * version 2.1 of the License, or (at your option) any later version.
00024  *
00025  * This library is distributed in the hope that it will be useful,
00026  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00027  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00028  * Lesser General Public License for more details.
00029  *
00030  * You should have received a copy of the GNU Lesser General Public
00031  * License along with this library; if not, write to the Free Software
00032  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00033  *
00034  * Authors:
00035  *      "David Niemoller" <David.Niemoller@g2-inc.com>
00036  */
00037 
00038 
00039 #ifndef OVAL_SYSTEM_CHARACTERISTICS
00040 #define OVAL_SYSTEM_CHARACTERISTICS
00041 
00042 #include "oval_types.h"
00043 #include "oval_definitions.h"
00044 
00046 typedef enum {
00047         SYSCHAR_FLAG_UNKNOWN = 0,
00048         SYSCHAR_FLAG_ERROR = 1,
00049         SYSCHAR_FLAG_COMPLETE = 2,
00050         SYSCHAR_FLAG_INCOMPLETE = 3,
00051         SYSCHAR_FLAG_DOES_NOT_EXIST = 4,
00052         SYSCHAR_FLAG_NOT_COLLECTED = 5,
00053         SYSCHAR_FLAG_NOT_APPLICABLE = 6
00054 } oval_syschar_collection_flag_t;
00055 
00057 typedef enum {
00058         SYSCHAR_STATUS_UNKNOWN = 0,
00059         SYSCHAR_STATUS_ERROR = 1,
00060         SYSCHAR_STATUS_EXISTS = 2,
00061         SYSCHAR_STATUS_DOES_NOT_EXIST = 3,
00062         SYSCHAR_STATUS_NOT_COLLECTED = 4
00063 } oval_syschar_status_t;
00064 
00066 typedef enum {
00067         OVAL_MESSAGE_LEVEL_NONE = 0,
00068         OVAL_MESSAGE_LEVEL_DEBUG = 1,
00069         OVAL_MESSAGE_LEVEL_INFO = 2,
00070         OVAL_MESSAGE_LEVEL_WARNING = 3,
00071         OVAL_MESSAGE_LEVEL_ERROR = 4,
00072         OVAL_MESSAGE_LEVEL_FATAL = 5
00073 } oval_message_level_t;
00074 
00075 const char *oval_syschar_collection_flag_get_text(oval_syschar_collection_flag_t flag);
00076 const char *oval_syschar_status_get_text(oval_syschar_status_t status);
00077 const char *oval_message_level_text(oval_message_level_t);
00078 
00079 
00080 
00081 
00082 
00083 
00090 struct oval_syschar_model;
00091 
00098 struct oval_sysinfo;
00102 struct oval_sysinfo_iterator;
00103 
00118 struct oval_syschar;
00123 struct oval_syschar_iterator;
00124 
00131 struct oval_sysint;
00136 struct oval_sysint_iterator;
00137 
00147 struct oval_sysitem;
00152 struct oval_sysitem_iterator;
00153 
00157 struct oval_sysent;
00162 struct oval_sysent_iterator;
00163 
00168 struct oval_message;
00172 struct oval_message_iterator;
00173 
00178 struct oval_variable_binding;
00182 struct oval_variable_binding_iterator;
00183 
00184 
00185 
00186 
00187 
00194 struct oval_syschar_model *oval_syschar_model_new(struct oval_definition_model *definition_model);
00195 
00204 int oval_syschar_model_import(struct oval_syschar_model *model, const char *file);
00210 struct oval_syschar_model *oval_syschar_model_clone(struct oval_syschar_model *);
00215 int oval_syschar_model_export(struct oval_syschar_model *, const char *file);
00221 void oval_syschar_model_free(struct oval_syschar_model *model);
00222 
00227 void oval_syschar_model_set_generator(struct oval_syschar_model *model, struct oval_generator *generator);
00233 int oval_syschar_model_bind_variable_model(struct oval_syschar_model *, struct oval_variable_model *);
00237 void oval_syschar_model_set_sysinfo(struct oval_syschar_model *model, struct oval_sysinfo *sysinfo);
00241 void oval_syschar_model_add_variable_binding(struct oval_syschar_model *model, struct oval_variable_binding *binding);
00248 void oval_syschar_model_lock(struct oval_syschar_model *syschar_model);
00255 struct oval_generator *oval_syschar_model_get_generator(struct oval_syschar_model *model);
00261 struct oval_definition_model *oval_syschar_model_get_definition_model(struct oval_syschar_model *model);
00267 struct oval_syschar_iterator *oval_syschar_model_get_syschars(struct oval_syschar_model *model);
00273 struct oval_sysinfo *oval_syschar_model_get_sysinfo(struct oval_syschar_model *model);
00281 struct oval_syschar *oval_syschar_model_get_syschar(struct oval_syschar_model *model, const char *object_id);
00286 int oval_syschar_model_compute_variable(struct oval_syschar_model *, struct oval_variable *);
00287 oval_syschar_collection_flag_t oval_variable_get_collection_flag(struct oval_variable *);
00291 struct oval_sysitem *oval_syschar_model_get_sysitem(struct oval_syschar_model *, const char *);
00297 bool oval_syschar_model_is_locked(struct oval_syschar_model *syschar_model);
00313 bool oval_syschar_model_is_valid(struct oval_syschar_model *syschar_model);
00324 struct oval_sysinfo *oval_sysinfo_new(struct oval_syschar_model *);
00329 struct oval_sysinfo *oval_sysinfo_clone(struct oval_syschar_model *new_model, struct oval_sysinfo *old_sysinfo);
00333 void oval_sysinfo_free(struct oval_sysinfo *);
00334 
00342 void oval_sysinfo_set_os_name(struct oval_sysinfo *, char *);
00346 void oval_sysinfo_set_os_version(struct oval_sysinfo *, char *);
00350 void oval_sysinfo_set_os_architecture(struct oval_sysinfo *, char *);
00354 void oval_sysinfo_set_primary_host_name(struct oval_sysinfo *, char *);
00358 void oval_sysinfo_add_interface(struct oval_sysinfo *, struct oval_sysint *);
00369 char *oval_sysinfo_get_os_name(struct oval_sysinfo *);
00370 
00375 char *oval_sysinfo_get_os_version(struct oval_sysinfo *);
00376 
00381 char *oval_sysinfo_get_os_architecture(struct oval_sysinfo *);
00382 
00387 char *oval_sysinfo_get_primary_host_name(struct oval_sysinfo *);
00388 
00393 struct oval_sysint_iterator *oval_sysinfo_get_interfaces(struct oval_sysinfo *);
00399 bool oval_sysinfo_is_locked(struct oval_sysinfo *sysinfo);
00409 bool oval_sysinfo_iterator_has_more(struct oval_sysinfo_iterator *);
00413 struct oval_sysinfo *oval_sysinfo_iterator_next(struct oval_sysinfo_iterator *);
00417 void oval_sysinfo_iterator_free(struct oval_sysinfo_iterator *);
00428 bool oval_sysinfo_is_valid(struct oval_sysinfo *sysinfo);
00439 struct oval_syschar *oval_syschar_new(struct oval_syschar_model *, struct oval_object *);
00444 struct oval_syschar *oval_syschar_clone(struct oval_syschar_model *new_model, struct oval_syschar *old_syschar);
00448 void oval_syschar_free(struct oval_syschar *);
00449 
00457 void oval_syschar_add_variable_binding(struct oval_syschar *, struct oval_variable_binding *);
00461 void oval_syschar_set_flag(struct oval_syschar *model, oval_syschar_collection_flag_t flag);
00465 void oval_syschar_set_object(struct oval_syschar *, struct oval_object *);
00469 void oval_syschar_add_sysitem(struct oval_syschar *, struct oval_sysitem *);
00473 void oval_syschar_add_message(struct oval_syschar *syschar, struct oval_message *message);
00477 void oval_syschar_add_new_message(struct oval_syschar *syschar, char *text, oval_message_level_t level);
00488 oval_syschar_collection_flag_t oval_syschar_get_flag(struct oval_syschar *);
00489 
00494 struct oval_message_iterator *oval_syschar_get_messages(struct oval_syschar *);
00495 
00500 struct oval_object *oval_syschar_get_object(struct oval_syschar *);
00501 
00506 struct oval_variable_binding_iterator *oval_syschar_get_variable_bindings(struct oval_syschar *);
00507 
00512 struct oval_sysitem_iterator *oval_syschar_get_sysitem(struct oval_syschar *);
00518 bool oval_syschar_is_locked(struct oval_syschar *syschar);
00528 bool oval_syschar_iterator_has_more(struct oval_syschar_iterator *);
00532 struct oval_syschar *oval_syschar_iterator_next(struct oval_syschar_iterator *);
00536 void oval_syschar_iterator_free(struct oval_syschar_iterator *);
00551 bool oval_syschar_is_valid(struct oval_syschar *syschar);
00562 struct oval_sysint *oval_sysint_new(struct oval_syschar_model *);
00567 struct oval_sysint *oval_sysint_clone(struct oval_syschar_model *new_model, struct oval_sysint *old_sysint);
00571 void oval_sysint_free(struct oval_sysint *);
00572 
00580 void oval_sysint_set_name(struct oval_sysint *, char *);
00584 void oval_sysint_set_ip_address(struct oval_sysint *, char *);
00588 void oval_sysint_set_mac_address(struct oval_sysint *, char *);
00599 char *oval_sysint_get_name(struct oval_sysint *);
00600 
00605 char *oval_sysint_get_ip_address(struct oval_sysint *);
00606 
00611 char *oval_sysint_get_mac_address(struct oval_sysint *);
00617 bool oval_sysint_is_locked(struct oval_sysint *sysint);
00627 bool oval_sysint_iterator_has_more(struct oval_sysint_iterator *);
00631 struct oval_sysint *oval_sysint_iterator_next(struct oval_sysint_iterator *);
00635 void oval_sysint_iterator_free(struct oval_sysint_iterator *);
00646 bool oval_sysint_is_valid(struct oval_sysint *sysint);
00657 struct oval_sysitem *oval_sysitem_new(struct oval_syschar_model *, const char *id);
00662 struct oval_sysitem *oval_sysitem_clone(struct oval_syschar_model *new_model, struct oval_sysitem *old_data);
00666 void oval_sysitem_free(struct oval_sysitem *);
00667 
00675 void oval_sysitem_set_status(struct oval_sysitem *, oval_syschar_status_t);
00679 void oval_sysitem_set_subtype(struct oval_sysitem *sysitem, oval_subtype_t subtype);
00683 void oval_sysitem_add_message(struct oval_sysitem *, struct oval_message *);
00687 void oval_sysitem_add_item(struct oval_sysitem *, struct oval_sysent *);
00698 char *oval_sysitem_get_id(struct oval_sysitem *);
00703 oval_syschar_status_t oval_sysitem_get_status(struct oval_sysitem *);
00708 struct oval_sysent_iterator *oval_sysitem_get_items(struct oval_sysitem *);
00713 struct oval_message_iterator *oval_sysitem_get_messages(struct oval_sysitem *);
00718 oval_subtype_t oval_sysitem_get_subtype(struct oval_sysitem *);
00724 bool oval_sysitem_is_locked(struct oval_sysitem *sysitem);
00734 bool oval_sysitem_iterator_has_more(struct oval_sysitem_iterator *);
00738 struct oval_sysitem *oval_sysitem_iterator_next(struct oval_sysitem_iterator *);
00742 void oval_sysitem_iterator_free(struct oval_sysitem_iterator *);
00755 bool oval_sysitem_is_valid(struct oval_sysitem *sysitem);
00766 struct oval_sysent *oval_sysent_new(struct oval_syschar_model *);
00771 struct oval_sysent *oval_sysent_clone(struct oval_syschar_model *new_model, struct oval_sysent *old_item);
00775 void oval_sysent_free(struct oval_sysent *);
00783 void oval_sysent_set_name(struct oval_sysent *sysent, char *name);
00787 void oval_sysent_set_value(struct oval_sysent *sysent, char *value);
00791 void oval_sysent_set_status(struct oval_sysent *sysent, oval_syschar_status_t status);
00795 void oval_sysent_set_datatype(struct oval_sysent *sysent, oval_datatype_t type);
00799 void oval_sysent_set_mask(struct oval_sysent *sysent, int mask);
00810 char *oval_sysent_get_name(struct oval_sysent *);
00811 
00816 char *oval_sysent_get_value(struct oval_sysent *);
00817 
00822 oval_syschar_status_t oval_sysent_get_status(struct oval_sysent *);
00823 
00828 oval_datatype_t oval_sysent_get_datatype(struct oval_sysent *);
00829 
00834 int oval_sysent_get_mask(struct oval_sysent *);
00840 bool oval_sysent_is_locked(struct oval_sysent *sysent);
00850 bool oval_sysent_iterator_has_more(struct oval_sysent_iterator *);
00854 struct oval_sysent *oval_sysent_iterator_next(struct oval_sysent_iterator *);
00858 void oval_sysent_iterator_free(struct oval_sysent_iterator *);
00869 bool oval_sysent_is_valid(struct oval_sysent *sysent);
00879 struct oval_message *oval_message_new(void);
00884 struct oval_message *oval_message_clone(struct oval_message *old_message);
00888 void oval_message_free(struct oval_message *);
00889 
00897 void oval_message_set_text(struct oval_message *, char *);
00901 void oval_message_set_level(struct oval_message *, oval_message_level_t);
00912 char *oval_message_get_text(struct oval_message *message);
00917 oval_message_level_t oval_message_get_level(struct oval_message *message);
00923 bool oval_message_is_locked(struct oval_message *message);
00933 bool oval_message_iterator_has_more(struct oval_message_iterator *oc_message);
00937 struct oval_message *oval_message_iterator_next(struct oval_message_iterator *oc_message);
00941 void oval_message_iterator_free(struct oval_message_iterator *oc_message);
00952 bool oval_message_is_valid(struct oval_message *message);
00953 
00954 
00955 
00956 
00957 
00961 struct oval_variable_binding *oval_variable_binding_new(struct oval_variable *, char *);
00966 struct oval_variable_binding *oval_variable_binding_clone(struct oval_variable_binding *,
00967                                                           struct oval_definition_model *);
00971 void oval_variable_binding_free(struct oval_variable_binding *);
00972 
00980 void oval_variable_binding_set_variable(struct oval_variable_binding *, struct oval_variable *);
00984 void oval_variable_binding_add_value(struct oval_variable_binding *, char *);
00995 struct oval_variable *oval_variable_binding_get_variable(struct oval_variable_binding *);
01000 struct oval_string_iterator *oval_variable_binding_get_values(struct oval_variable_binding *);
01010 bool oval_variable_binding_iterator_has_more(struct oval_variable_binding_iterator *);
01014 struct oval_variable_binding *oval_variable_binding_iterator_next(struct oval_variable_binding_iterator *);
01018 void oval_variable_binding_iterator_free(struct oval_variable_binding_iterator *);
01025 #endif

Generated on Fri Mar 11 2011 for Open SCAP Library by  doxygen 1.7.1