Open SCAP Library
/home/pvrabec/project/openscap/openscap-0.8.0/src/OVAL/probes/public/probe-api.h
Go to the documentation of this file.
00001 
00035 /*
00036  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
00037  * All Rights Reserved.
00038  *
00039  * This library is free software; you can redistribute it and/or
00040  * modify it under the terms of the GNU Lesser General Public
00041  * License as published by the Free Software Foundation; either
00042  * version 2.1 of the License, or (at your option) any later version.
00043  *
00044  * This library is distributed in the hope that it will be useful, 
00045  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00046  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00047  * Lesser General Public License for more details.
00048  *
00049  * You should have received a copy of the GNU Lesser General Public
00050  * License along with this library; if not, write to the Free Software 
00051  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00052  *
00053  * Authors:
00054  *      Daniel Kopecek <dkopecek@redhat.com>
00055  */
00056 
00057 #pragma once
00058 #ifndef PROBE_API_H
00059 #define PROBE_API_H
00060 
00061 #include <seap.h>
00062 #include <stdarg.h>
00063 #include <stdint.h>
00064 #include <stdbool.h>
00065 #include <pthread.h>
00066 #include <oval_definitions.h>
00067 #include <oval_system_characteristics.h>
00068 #include <oval_results.h>
00069 #include <oval_types.h>
00070 
00071 /*
00072  * items
00073  */
00074 
00079 SEXP_t *probe_item_build(const char *fmt, ...);
00080 
00081 /* SEXP_t *probe_item_creat (const char *name, SEXP_t *attrs, ...); */
00093 SEXP_t *probe_item_creat(const char *name, SEXP_t * attrs, ...);
00094 
00100 SEXP_t *probe_item_new(const char *name, SEXP_t * attrs);
00101 
00109 SEXP_t *probe_item_attr_add(SEXP_t * item, const char *name, SEXP_t * val);
00110 
00119 SEXP_t *probe_item_ent_add(SEXP_t * item, const char *name, SEXP_t * attrs, SEXP_t * val);
00120 
00126 int probe_item_setstatus(SEXP_t * obj, oval_syschar_status_t status);
00127 
00135 int probe_itement_setstatus(SEXP_t * obj, const char *name, uint32_t n, oval_syschar_status_t status);
00136 
00140 struct id_desc_t;
00141 
00147 SEXP_t *probe_item_newid(struct id_desc_t *id_desc);
00148 
00153 void probe_item_resetidctr(struct id_desc_t *id_desc);
00154 
00155 #define probe_item_getent(item, name, n) probe_obj_getent (item, name, n)
00156 
00157 /*
00158  * attributes
00159  */
00160 
00168 SEXP_t *probe_attr_creat(const char *name, const SEXP_t * val, ...);
00169 
00170 /*
00171  * objects
00172  */
00173 
00178 SEXP_t *probe_obj_build(const char *fmt, ...);
00179 
00191 SEXP_t *probe_obj_creat(const char *name, SEXP_t * attrs, ...);
00192 
00199 SEXP_t *probe_obj_new(const char *name, SEXP_t * attrs);
00200 
00207 SEXP_t *probe_obj_getent(const SEXP_t * obj, const char *name, uint32_t n);
00208 
00216 SEXP_t *probe_obj_getentval(const SEXP_t * obj, const char *name, uint32_t n);
00217 
00227 int probe_obj_getentvals(const SEXP_t * obj, const char *name, uint32_t n, SEXP_t ** res);
00228 
00234 SEXP_t *probe_obj_getattrval(const SEXP_t * obj, const char *name);
00235 
00241 bool probe_obj_attrexists(const SEXP_t * obj, const char *name);
00242 
00248 int probe_obj_setstatus(SEXP_t * obj, oval_syschar_status_t status);
00249 
00257 int probe_objent_setstatus(SEXP_t * obj, const char *name, uint32_t n, oval_syschar_status_t status);
00258 
00263 char *probe_obj_getname(const SEXP_t * obj);
00264 
00272 size_t probe_obj_getname_r(const SEXP_t * obj, char *buffer, size_t buflen);
00273 
00274 /*
00275  * collected objects
00276  */
00277 
00278 SEXP_t *probe_cobj_new(oval_syschar_collection_flag_t flag, SEXP_t *msg_list, SEXP_t *item_list);
00279 int probe_cobj_add_msg(SEXP_t *cobj, const SEXP_t *msg);
00280 SEXP_t *probe_cobj_get_msgs(const SEXP_t *cobj);
00281 int probe_cobj_add_item(SEXP_t *cobj, const SEXP_t *item);
00282 SEXP_t *probe_cobj_get_items(const SEXP_t *cobj);
00283 void probe_cobj_set_flag(SEXP_t *cobj, oval_syschar_collection_flag_t flag);
00284 oval_syschar_collection_flag_t probe_cobj_get_flag(const SEXP_t *cobj);
00285 oval_syschar_collection_flag_t probe_cobj_combine_flags(oval_syschar_collection_flag_t f1,
00286                                                         oval_syschar_collection_flag_t f2,
00287                                                         oval_setobject_operation_t op);
00288 oval_syschar_collection_flag_t probe_cobj_compute_flag(SEXP_t *cobj);
00289 
00290 /*
00291  * messages
00292  */
00293 
00299 SEXP_t *probe_msg_creat(oval_message_level_t level, char *message);
00300 
00307 SEXP_t *probe_msg_creatf(oval_message_level_t level, const char *fmt, ...) __attribute__((format(printf, 2, 3), nonnull(2)));
00308 
00309 /*
00310  * entities
00311  */
00312 
00321 SEXP_t *probe_ent_creat(const char *name, SEXP_t * attrs, SEXP_t * val, ...);
00322 
00330 SEXP_t *probe_ent_creat1(const char *name, SEXP_t * attrs, SEXP_t * val);
00331 
00339 SEXP_t *probe_ent_attr_add(SEXP_t * ent, const char *name, SEXP_t * val);
00340 
00346 SEXP_t *probe_ent_getval(const SEXP_t * ent);
00347 
00355 int probe_ent_getvals(const SEXP_t * ent, SEXP_t ** res);
00356 
00362 SEXP_t *probe_ent_getattrval(const SEXP_t * ent, const char *name);
00363 
00369 bool probe_ent_attrexists(const SEXP_t * ent, const char *name);
00370 
00376 int probe_ent_setdatatype(SEXP_t * ent, oval_datatype_t type);
00377 
00382 oval_datatype_t probe_ent_getdatatype(const SEXP_t * ent);
00383 
00389 int probe_ent_setmask(SEXP_t * ent, bool mask);
00390 
00395 bool probe_ent_getmask(const SEXP_t * ent);
00396 
00402 int probe_ent_setstatus(SEXP_t * ent, oval_syschar_status_t status);
00403 
00408 oval_syschar_status_t probe_ent_getstatus(const SEXP_t * ent);
00409 
00414 char *probe_ent_getname(const SEXP_t * ent);
00415 
00423 size_t probe_ent_getname_r(const SEXP_t * ent, char *buffer, size_t buflen);
00424 
00429 void probe_free(SEXP_t * obj);
00430 
00437 void probe_filebehaviors_canonicalize(SEXP_t **behaviors);
00438 
00445 void probe_tfc54behaviors_canonicalize(SEXP_t **behaviors);
00446 
00447 #define PROBE_EINVAL     1      
00448 #define PROBE_ENOELM     2      
00449 #define PROBE_ENOVAL     3      
00450 #define PROBE_ENOATTR    4      
00451 #define PROBE_EINIT      5      
00452 #define PROBE_ENOMEM     6      
00453 #define PROBE_EOPNOTSUPP 7      
00454 #define PROBE_ERANGE     8      
00455 #define PROBE_EDOM       9      
00456 #define PROBE_EFAULT    10      
00457 #define PROBE_EACCESS   11      
00458 #define PROBE_ESETEVAL  12      
00459 #define PROBE_ENOENT    13      
00460 #define PROBE_ENOOBJ    14      
00461 #define PROBE_ECONNABORTED 15   
00462 #define PROBE_ESYSTEM  253      
00463 #define PROBE_EFATAL   254      
00464 #define PROBE_EUNKNOWN 255      
00466 #define PROBECMD_STE_FETCH 1 
00467 #define PROBECMD_OBJ_EVAL  2 
00468 #define PROBECMD_RESET     3 
00470 void *probe_init(void) __attribute__ ((unused));
00471 void probe_fini(void *) __attribute__ ((unused));
00472 
00473 typedef struct probe_ctx probe_ctx;
00474 
00475 int probe_main(probe_ctx *, void *) __attribute__ ((nonnull(1)));
00476 
00477 #define PROBE_VARREF_HANDLING 0
00478 #define PROBE_RESULT_CACHING  1
00479 
00480 int probe_setoption(int option, ...);
00481 
00482 bool probe_item_filtered(const SEXP_t *item, const SEXP_t *filters);
00483 
00484 int probe_result_additem(SEXP_t *result, SEXP_t *item);
00485 
00493 int probe_item_collect(probe_ctx *ctx, SEXP_t *item);
00494 
00501 SEXP_t *probe_ctx_getobject(probe_ctx *ctx);
00502 
00508 SEXP_t *probe_ctx_getresult(probe_ctx *ctx);
00509 
00510 typedef struct {
00511         oval_datatype_t type;
00512         void           *value;
00513 } probe_elmatr_t;
00514 
00515 SEXP_t *probe_item_create(oval_subtype_t item_subtype, probe_elmatr_t *item_attributes[], ...);
00516 
00517 #define PROBE_ENT_AREF(ent, dst, attr_name, invalid_exp)                \
00518         do {                                                            \
00519                 if (((dst) = probe_ent_getattrval(ent, attr_name)) == NULL) { \
00520                         _F("Attribute `%s' is missing!\n", attr_name);  \
00521                         invalid_exp                                     \
00522                 }                                                       \
00523         } while(0)
00524 
00525 #define PROBE_ENT_STRVAL(ent, dst, dstlen, invalid_exp, zerolen_exp)    \
00526         do {                                                    \
00527                 SEXP_t *___r;                                   \
00528                                                                 \
00529                 if ((___r = probe_ent_getval(ent)) == NULL) {   \
00530                         _W("Entity has no value!\n");           \
00531                         invalid_exp                             \
00532                 } else {                                        \
00533                         if (!SEXP_stringp(___r)) {              \
00534                                 _F("Invalid type\n");           \
00535                                 SEXP_free(___r);                \
00536                                 invalid_exp                     \
00537                         }                                       \
00538                         if (SEXP_string_length(___r) == 0) {    \
00539                                 SEXP_free(___r);                \
00540                                 zerolen_exp                     \
00541                         } else {                                \
00542                                 SEXP_string_cstr_r(___r, dst, dstlen); \
00543                                 SEXP_free(___r);                \
00544                         }                                       \
00545                 }                                               \
00546         } while (0)
00547 
00548 #define PROBE_ENT_I32VAL(ent, dst, invalid_exp, nil_exp)        \
00549         do {                                                    \
00550                 SEXP_t *___r;                                   \
00551                                                                 \
00552                 if ((___r = probe_ent_getval(ent)) == NULL) {   \
00553                         _W("Entity has no value!\n");           \
00554                         nil_exp;                                \
00555                 } else {                                        \
00556                         if (!SEXP_numberp(___r)) {              \
00557                                 _F("Invalid type\n");           \
00558                                 SEXP_free(___r);                \
00559                                 invalid_exp;                    \
00560                         } else {                                \
00561                                 dst = SEXP_number_geti_32(___r);        \
00562                                 SEXP_free(___r);                        \
00563                         }                                               \
00564                 }                                                       \
00565         } while (0)
00566 
00567 #endif                          /* PROBE_API_H */
00568 
00569 oval_operation_t probe_ent_getoperation(SEXP_t *entity, oval_operation_t op);
00570 
00571 int probe_item_add_msg(SEXP_t *item, oval_message_level_t msglvl, char *msgfmt, ...);