Loading...
Searching...
No Matches
probe-api.h
Go to the documentation of this file.
/*
* Copyright 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Authors:
* Daniel Kopecek <dkopecek@redhat.com>
*/
#pragma once
#ifndef PROBE_API_H
#define PROBE_API_H
#include <stdarg.h>
#include <stdint.h>
#include <stdbool.h>
#include <pthread.h>
#include <oval_definitions.h>
#include <oval_system_characteristics.h>
#include <oval_results.h>
#include <oval_types.h>
#include "sexp-types.h"
#include "oscap_export.h"
#include "list.h"
/*
* items
*/
OSCAP_API SEXP_t *probe_item_creat(const char *name, SEXP_t * attrs, ...);
OSCAP_API SEXP_t *probe_item_new(const char *name, SEXP_t * attrs);
OSCAP_API SEXP_t *probe_item_attr_add(SEXP_t * item, const char *name, SEXP_t * val);
OSCAP_API SEXP_t *probe_item_ent_add(SEXP_t * item, const char *name, SEXP_t * attrs, SEXP_t * val);
OSCAP_API int probe_item_setstatus(SEXP_t * obj, oval_syschar_status_t status);
OSCAP_API int probe_itement_setstatus(SEXP_t * obj, const char *name, uint32_t n, oval_syschar_status_t status);
struct id_desc_t;
OSCAP_API void probe_item_resetidctr(struct id_desc_t *id_desc);
#define probe_item_getent(item, name, n) probe_obj_getent (item, name, n)
/*
* attributes
*/
OSCAP_API SEXP_t *probe_attr_creat(const char *name, const SEXP_t * val, ...);
/*
* objects
*/
OSCAP_API SEXP_t *probe_obj_creat(const char *name, SEXP_t * attrs, ...);
OSCAP_API SEXP_t *probe_obj_new(const char *name, SEXP_t * attrs);
OSCAP_API SEXP_t *probe_obj_getent(const SEXP_t * obj, const char *name, uint32_t n);
OSCAP_API SEXP_t *probe_obj_getentval(const SEXP_t * obj, const char *name, uint32_t n);
OSCAP_API int probe_obj_getentvals(const SEXP_t * obj, const char *name, uint32_t n, SEXP_t ** res);
OSCAP_API SEXP_t *probe_obj_getattrval(const SEXP_t * obj, const char *name);
OSCAP_API bool probe_obj_attrexists(const SEXP_t * obj, const char *name);
OSCAP_API int probe_obj_setstatus(SEXP_t * obj, oval_syschar_status_t status);
OSCAP_API char *probe_obj_getname(const SEXP_t * obj);
OSCAP_API size_t probe_obj_getname_r(const SEXP_t * obj, char *buffer, size_t buflen);
/*
* collected objects
*/
OSCAP_API SEXP_t *probe_cobj_new(oval_syschar_collection_flag_t flag, SEXP_t *msg_list, SEXP_t *item_list, SEXP_t *mask_list);
OSCAP_API int probe_cobj_add_msg(SEXP_t *cobj, const SEXP_t *msg);
OSCAP_API SEXP_t *probe_cobj_get_msgs(const SEXP_t *cobj);
OSCAP_API SEXP_t *probe_cobj_get_mask(const SEXP_t *cobj);
OSCAP_API int probe_cobj_add_item(SEXP_t *cobj, const SEXP_t *item);
OSCAP_API SEXP_t *probe_cobj_get_items(const SEXP_t *cobj);
OSCAP_API void probe_cobj_set_flag(SEXP_t *cobj, oval_syschar_collection_flag_t flag);
OSCAP_API oval_syschar_collection_flag_t probe_cobj_get_flag(const SEXP_t *cobj);
oval_syschar_collection_flag_t probe_cobj_combine_flags(oval_syschar_collection_flag_t f1,
oval_syschar_collection_flag_t f2,
oval_setobject_operation_t op);
OSCAP_API oval_syschar_collection_flag_t probe_cobj_compute_flag(SEXP_t *cobj);
/*
* messages
*/
OSCAP_API SEXP_t *probe_msg_creat(oval_message_level_t level, char *message);
OSCAP_API SEXP_t *probe_msg_creatf(oval_message_level_t level, const char *fmt, ...) __attribute__((format(printf, 2, 3), nonnull(2)));
/*
* entities
*/
OSCAP_API SEXP_t *probe_ent_creat(const char *name, SEXP_t * attrs, SEXP_t * val, ...);
OSCAP_API SEXP_t *probe_ent_creat1(const char *name, SEXP_t * attrs, SEXP_t * val);
OSCAP_API SEXP_t *probe_ent_attr_add(SEXP_t * ent, const char *name, SEXP_t * val);
OSCAP_API SEXP_t *probe_ent_getval(const SEXP_t * ent);
OSCAP_API int probe_ent_getvals(const SEXP_t * ent, SEXP_t ** res);
OSCAP_API SEXP_t *probe_ent_getattrval(const SEXP_t * ent, const char *name);
OSCAP_API bool probe_ent_attrexists(const SEXP_t * ent, const char *name);
OSCAP_API int probe_ent_setdatatype(SEXP_t * ent, oval_datatype_t type);
OSCAP_API oval_datatype_t probe_ent_getdatatype(const SEXP_t * ent);
OSCAP_API int probe_ent_setmask(SEXP_t * ent, bool mask);
OSCAP_API bool probe_ent_getmask(const SEXP_t * ent);
OSCAP_API int probe_ent_setstatus(SEXP_t * ent, oval_syschar_status_t status);
OSCAP_API oval_syschar_status_t probe_ent_getstatus(const SEXP_t * ent);
OSCAP_API char *probe_ent_getname(const SEXP_t * ent);
OSCAP_API size_t probe_ent_getname_r(const SEXP_t * ent, char *buffer, size_t buflen);
OSCAP_API void probe_free(SEXP_t * obj);
OSCAP_API void probe_filebehaviors_canonicalize(SEXP_t **behaviors);
OSCAP_API void probe_tfc54behaviors_canonicalize(SEXP_t **behaviors);
#define PROBE_EINVAL 1
#define PROBE_ENOELM 2
#define PROBE_ENOVAL 3
#define PROBE_ENOATTR 4
#define PROBE_EINIT 5
#define PROBE_ENOMEM 6
#define PROBE_EOPNOTSUPP 7
#define PROBE_ERANGE 8
#define PROBE_EDOM 9
#define PROBE_EFAULT 10
#define PROBE_EACCESS 11
#define PROBE_ESETEVAL 12
#define PROBE_ENOENT 13
#define PROBE_ENOOBJ 14
#define PROBE_ECONNABORTED 15
#define PROBE_ESYSTEM 253
#define PROBE_EFATAL 254
#define PROBE_EUNKNOWN 255
#define PROBECMD_STE_FETCH 1
#define PROBECMD_OBJ_EVAL 2
#define PROBECMD_RESET 3
typedef struct probe_ctx probe_ctx;
OSCAP_API bool probe_item_filtered(const SEXP_t *item, const SEXP_t *filters);
OSCAP_API int probe_item_collect(probe_ctx *ctx, SEXP_t *item);
OSCAP_API SEXP_t *probe_ctx_getobject(probe_ctx *ctx);
OSCAP_API SEXP_t *probe_ctx_getresult(probe_ctx *ctx);
typedef struct {
oval_datatype_t type;
void *value;
} probe_elmatr_t;
OSCAP_API SEXP_t *probe_item_create(oval_subtype_t item_subtype, probe_elmatr_t *item_attributes[], ...);
#define PROBE_ENT_AREF(ent, dst, attr_name, invalid_exp) \
do { \
if (((dst) = probe_ent_getattrval(ent, attr_name)) == NULL) { \
dE("Attribute `%s' is missing!", attr_name); \
invalid_exp \
} \
} while(0)
#define PROBE_ENT_STRVAL(ent, dst, dstlen, invalid_exp, zerolen_exp) \
do { \
SEXP_t *___r; \
\
if ((___r = probe_ent_getval(ent)) == NULL) { \
invalid_exp \
} else { \
if (!SEXP_stringp(___r)) { \
SEXP_free(___r); \
invalid_exp \
} \
else if (SEXP_string_length(___r) == 0) { \
SEXP_free(___r); \
zerolen_exp \
} else { \
SEXP_string_cstr_r(___r, dst, dstlen); \
SEXP_free(___r); \
} \
} \
} while (0)
#define PROBE_ENT_I32VAL(ent, dst, invalid_exp, nil_exp) \
do { \
SEXP_t *___r; \
\
if ((___r = probe_ent_getval(ent)) == NULL) { \
nil_exp; \
} else { \
if (!SEXP_numberp(___r)) { \
SEXP_free(___r); \
invalid_exp; \
} else { \
dst = SEXP_number_geti_32(___r); \
SEXP_free(___r); \
} \
} \
} while (0)
#endif /* PROBE_API_H */
OSCAP_API oval_operation_t probe_ent_getoperation(SEXP_t *entity, oval_operation_t op);
OSCAP_API int probe_item_add_msg(SEXP_t *item, oval_message_level_t msglvl, char *msgfmt, ...);
OSCAP_API SEXP_t *probe_entval_from_cstr(oval_datatype_t type, const char *value, size_t vallen);
OSCAP_API SEXP_t *probe_ent_from_cstr(const char *name, oval_datatype_t type, const char *value, size_t vallen);
OSCAP_API oval_schema_version_t probe_obj_get_platform_schema_version(const SEXP_t *obj);
OSCAP_API SEXP_t *probe_obj_getmask(SEXP_t *obj);
OSCAP_API bool probe_path_is_blocked(const char *path, struct oscap_list *blocked_paths);
oval_operation_t
oval_operation_t
Operations.
Definition oval_definitions.h:84
oval_setobject_operation_t
oval_setobject_operation_t
Set operations.
Definition oval_definitions.h:184
oval_datatype_t
oval_datatype_t
Datatypes.
Definition oval_definitions.h:149
oval_syschar_collection_flag_t
oval_syschar_collection_flag_t
System characteristics result flag.
Definition oval_system_characteristics.h:50
oval_message_level_t
oval_message_level_t
Message level.
Definition oval_system_characteristics.h:70
oval_syschar_status_t
oval_syschar_status_t
System characteristics status.
Definition oval_system_characteristics.h:61
oval_subtype_t
oval_subtype_t
Unknown subtypes.
Definition oval_types.h:127
probe_ent_setdatatype
int probe_ent_setdatatype(SEXP_t *ent, oval_datatype_t type)
Set the OVAL data type of an entity.
Definition probe-api.c:1124
probe_obj_getentval
SEXP_t * probe_obj_getentval(const SEXP_t *obj, const char *name, uint32_t n)
Get the value of an object's entity.
Definition probe-api.c:454
probe_itement_setstatus
int probe_itement_setstatus(SEXP_t *obj, const char *name, uint32_t n, oval_syschar_status_t status)
Set status of an item's entity.
Definition probe-api.c:206
probe_ent_attr_add
SEXP_t * probe_ent_attr_add(SEXP_t *ent, const char *name, SEXP_t *val)
Add a new attribute to an entity.
Definition probe-api.c:1025
probe_ent_creat1
SEXP_t * probe_ent_creat1(const char *name, SEXP_t *attrs, SEXP_t *val)
Create a new entity.
Definition probe-api.c:997
probe_ent_creat
SEXP_t * probe_ent_creat(const char *name, SEXP_t *attrs, SEXP_t *val,...)
Create a new list of entities.
Definition probe-api.c:973
probe_ent_setmask
int probe_ent_setmask(SEXP_t *ent, bool mask)
Set entity's mask.
Definition probe-api.c:1196
probe_attr_creat
SEXP_t * probe_attr_creat(const char *name, const SEXP_t *val,...)
Create a new list of attributes.
Definition probe-api.c:311
probe_ent_getdatatype
oval_datatype_t probe_ent_getdatatype(const SEXP_t *ent)
Get the OVAL data type of an entity.
Definition probe-api.c:1170
probe_obj_getattrval
SEXP_t * probe_obj_getattrval(const SEXP_t *obj, const char *name)
Get the value of an object's attribute.
Definition probe-api.c:501
probe_obj_getname
char * probe_obj_getname(const SEXP_t *obj)
Get the name of an object.
Definition probe-api.c:604
probe_item_creat
SEXP_t * probe_item_creat(const char *name, SEXP_t *attrs,...)
Create a new item consisting of a name, optional attributes argument and an arbitrary number of entit...
Definition probe-api.c:67
probe_ent_getvals
int probe_ent_getvals(const SEXP_t *ent, SEXP_t **res)
Get the list of values of an entity.
Definition probe-api.c:1030
probe_tfc54behaviors_canonicalize
void probe_tfc54behaviors_canonicalize(SEXP_t **behaviors)
Set all of the missing attributes of the 'behaviors' entity to default values.
Definition probe-api.c:1364
probe_ent_getname
char * probe_ent_getname(const SEXP_t *ent)
Get the name of an entity.
Definition probe-api.c:1235
probe_ent_getstatus
oval_syschar_status_t probe_ent_getstatus(const SEXP_t *ent)
Get entity status.
Definition probe-api.c:1218
probe_item_new
SEXP_t * probe_item_new(const char *name, SEXP_t *attrs)
Create a new item with just a name and optional attributes argument.
Definition probe-api.c:111
probe_obj_getname_r
size_t probe_obj_getname_r(const SEXP_t *obj, char *buffer, size_t buflen)
Get the name of an object.
Definition probe-api.c:609
probe_item_resetidctr
void probe_item_resetidctr(struct id_desc_t *id_desc)
Reset the item id generator.
Definition probe-api.c:222
probe_ent_getval
SEXP_t * probe_ent_getval(const SEXP_t *ent)
Get the value of an entity.
Definition probe-api.c:1049
probe_ent_getname_r
size_t probe_ent_getname_r(const SEXP_t *ent, char *buffer, size_t buflen)
Get the name of an entity.
Definition probe-api.c:1279
probe_ctx_getresult
OSCAP_API SEXP_t * probe_ctx_getresult(probe_ctx *ctx)
Collect generated item (i.e.
Definition probe.c:36
probe_ent_attrexists
bool probe_ent_attrexists(const SEXP_t *ent, const char *name)
Check whether the specified attribute exists.
Definition probe-api.c:1119
probe_free
void probe_free(SEXP_t *obj)
Free the memory allocated by the probe_* functions.
Definition probe-api.c:1323
probe_ent_setstatus
int probe_ent_setstatus(SEXP_t *ent, oval_syschar_status_t status)
Set entity's status.
Definition probe-api.c:1208
probe_obj_getentvals
int probe_obj_getentvals(const SEXP_t *obj, const char *name, uint32_t n, SEXP_t **res)
Get the list of values of an object's entity.
Definition probe-api.c:466
probe_item_create
SEXP_t * probe_item_create(oval_subtype_t item_subtype, probe_elmatr_t *item_attributes[],...)
The order of (value_name, value_type, *value) argument tuples passed as e.g.
Definition probe-api.c:1411
probe_item_attr_add
SEXP_t * probe_item_attr_add(SEXP_t *item, const char *name, SEXP_t *val)
Add a new attribute to an item.
Definition probe-api.c:137
probe_path_is_blocked
bool probe_path_is_blocked(const char *path, struct oscap_list *blocked_paths)
Check if the given path matches any of the paths in the blocked paths list.
Definition probe-api.c:1798
probe_item_setstatus
int probe_item_setstatus(SEXP_t *obj, oval_syschar_status_t status)
Set item's status.
Definition probe-api.c:194
probe_obj_setstatus
int probe_obj_setstatus(SEXP_t *obj, oval_syschar_status_t status)
Set objects's status.
Definition probe-api.c:594
probe_obj_creat
SEXP_t * probe_obj_creat(const char *name, SEXP_t *attrs,...)
Create a new object consisting of a name, optional attributes argument and an arbitrary number of ent...
Definition probe-api.c:344
probe_msg_creat
SEXP_t * probe_msg_creat(oval_message_level_t level, char *message)
Create a new message that can be added to a collected object.
Definition probe-api.c:918
probe_obj_getmask
SEXP_t * probe_obj_getmask(SEXP_t *obj)
Get object entity mask.
Definition probe-api.c:1765
probe_obj_new
SEXP_t * probe_obj_new(const char *name, SEXP_t *attrs)
Create a new object with just a name and optional attributes argument.
Definition probe-api.c:387
probe_item_ent_add
SEXP_t * probe_item_ent_add(SEXP_t *item, const char *name, SEXP_t *attrs, SEXP_t *val)
Add a new entity to an item.
Definition probe-api.c:183
probe_filebehaviors_canonicalize
void probe_filebehaviors_canonicalize(SEXP_t **behaviors)
Set all of the missing attributes of the 'behaviors' entity to default values.
Definition probe-api.c:1328
probe_msg_creatf
SEXP_t * probe_msg_creatf(oval_message_level_t level, const char *fmt,...)
Create a new message that can be added to a collected object.
Definition probe-api.c:932
probe_ent_getmask
bool probe_ent_getmask(const SEXP_t *ent)
Get entity's mask.
Definition probe-api.c:1202
probe_ent_getattrval
SEXP_t * probe_ent_getattrval(const SEXP_t *ent, const char *name)
Get the value of an entity's attribute.
Definition probe-api.c:1074
probe_obj_getent
SEXP_t * probe_obj_getent(const SEXP_t *obj, const char *name, uint32_t n)
Get an entity from an object.
Definition probe-api.c:411
probe_obj_attrexists
bool probe_obj_attrexists(const SEXP_t *obj, const char *name)
Check whether the specified attribute exists.
Definition probe-api.c:547
oval_definitions.h
oval_results.h
oval_system_characteristics.h
oval_types.h
id_desc_t
Holds information for item ids generation.
Definition _probe-api.h:44
oscap_list
Definition list.h:53
oval_schema_version_t
Definition oval_schema_version.h:41
probe_ctx
Definition probe.h:90
probe_ctx::filters
SEXP_t * filters
object filters (OVAL 5.8 and higher)
Definition probe.h:93
probe_elmatr_t
Definition probe-api.h:472