Files
file	probe-api.c
	Probe API implmentation.

Data Structures
struct	_oresults

struct	probe_elmatr_t

Macros
#define	PROBE_API_H

#define	probe_item_getent(item, name, n) probe_obj_getent (item, name, n)

#define	PROBE_EINVAL 1
	Invalid type/value/format.

#define	PROBE_ENOELM 2
	Missing element OBSOLETE: use ENOENT.

#define	PROBE_ENOVAL 3
	Missing value.

#define	PROBE_ENOATTR 4
	Missing attribute.

#define	PROBE_EINIT 5
	Initialization failed.

#define	PROBE_ENOMEM 6
	No memory.

#define	PROBE_EOPNOTSUPP 7
	Not supported.

#define	PROBE_ERANGE 8
	Out of range.

#define	PROBE_EDOM 9
	Out of domain.

#define	PROBE_EFAULT 10
	Memory fault/NULL value.

#define	PROBE_EACCESS 11
	Operation not permitted.

#define	PROBE_ESETEVAL 12
	Set evaluation failed.

#define	PROBE_ENOENT 13
	Missing entity.

#define	PROBE_ENOOBJ 14
	Missing object.

#define	PROBE_ECONNABORTED 15
	Evaluation aborted.

#define	PROBE_ESYSTEM 253
	System call failure.

#define	PROBE_EFATAL 254
	Unrecoverable error.

#define	PROBE_EUNKNOWN 255
	Unknown/Unexpected error.

#define	PROBECMD_STE_FETCH 1
	State fetch command code.

#define	PROBECMD_OBJ_EVAL 2
	Object eval command code.

#define	PROBECMD_RESET 3
	Reset command code.

#define	PROBE_ENT_AREF(ent, dst, attr_name, invalid_exp)

#define	PROBE_ENT_STRVAL(ent, dst, dstlen, invalid_exp, zerolen_exp)

#define	PROBE_ENT_I32VAL(ent, dst, invalid_exp, nil_exp)

Typedefs
typedef struct probe_ctx	probe_ctx

Functions
probe_rcache_t *	OSCAP_GSYM (pcache)

probe_ncache_t *	OSCAP_GSYM (ncache)

struct id_desc_t	OSCAP_GSYM (id_desc)

probe_option_t *	OSCAP_GSYM (probe_optdef)

size_t	OSCAP_GSYM (probe_optdef_count)

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 entities.

SEXP_t *	probe_item_new (const char name, SEXP_t attrs)
	Create a new item with just a name and optional attributes argument.

SEXP_t *	probe_item_attr_add (SEXP_t item, const char name, SEXP_t *val)
	Add a new attribute to an item.

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.

int	probe_item_setstatus (SEXP_t *obj, oval_syschar_status_t status)
	Set item's status.

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.

void	probe_item_resetidctr (struct id_desc_t *id_desc)
	Reset the item id generator.

bool	probe_item_filtered (const SEXP_t item, const SEXP_t filters)

SEXP_t *	probe_attr_creat (const char name, const SEXP_t val,...)
	Create a new list of attributes.

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 entities.

SEXP_t *	probe_obj_new (const char name, SEXP_t attrs)
	Create a new object with just a name and optional attributes argument.

SEXP_t *	probe_obj_getent (const SEXP_t obj, const char name, uint32_t n)
	Get an entity from an object.

SEXP_t *	probe_obj_getentval (const SEXP_t obj, const char name, uint32_t n)
	Get the value of an object's entity.

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.

oval_schema_version_t	probe_obj_get_platform_schema_version (const SEXP_t *obj)

SEXP_t *	probe_obj_getattrval (const SEXP_t obj, const char name)
	Get the value of an object's attribute.

bool	probe_obj_attrexists (const SEXP_t obj, const char name)
	Check whether the specified attribute exists.

int	probe_obj_setstatus (SEXP_t *obj, oval_syschar_status_t status)
	Set objects's status.

char *	probe_obj_getname (const SEXP_t *obj)
	Get the name of an object.

size_t	probe_obj_getname_r (const SEXP_t obj, char buffer, size_t buflen)
	Get the name of an object.

SEXP_t *	probe_cobj_new (oval_syschar_collection_flag_t flag, SEXP_t msg_list, SEXP_t item_list, SEXP_t *mask_list)

int	probe_cobj_add_msg (SEXP_t cobj, const SEXP_t msg)

SEXP_t *	probe_cobj_get_msgs (const SEXP_t *cobj)

SEXP_t *	probe_cobj_get_mask (const SEXP_t *cobj)

int	probe_cobj_add_item (SEXP_t cobj, const SEXP_t item)

SEXP_t *	probe_cobj_get_items (const SEXP_t *cobj)

void	probe_cobj_set_flag (SEXP_t *cobj, oval_syschar_collection_flag_t flag)

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)

oval_syschar_collection_flag_t	probe_cobj_compute_flag (SEXP_t *cobj)

SEXP_t *	probe_msg_creat (oval_message_level_t level, char *message)
	Create a new message that can be added to a collected object.

SEXP_t *	probe_msg_creatf (oval_message_level_t level, const char *fmt,...) __attribute__((format(printf
	Create a new message that can be added to a collected object.

SEXP_t *	probe_ent_creat (const char name, SEXP_t attrs, SEXP_t *val,...)
	Create a new list of entities.

SEXP_t *	probe_ent_creat1 (const char name, SEXP_t attrs, SEXP_t *val)
	Create a new entity.

SEXP_t *	probe_ent_attr_add (SEXP_t ent, const char name, SEXP_t *val)
	Add a new attribute to an entity.

int	probe_ent_getvals (const SEXP_t ent, SEXP_t *res)
	Get the list of values of an entity.

SEXP_t *	probe_ent_getval (const SEXP_t *ent)
	Get the value of an entity.

SEXP_t *	probe_ent_getattrval (const SEXP_t ent, const char name)
	Get the value of an entity's attribute.

bool	probe_ent_attrexists (const SEXP_t ent, const char name)
	Check whether the specified attribute exists.

int	probe_ent_setdatatype (SEXP_t *ent, oval_datatype_t type)
	Set the OVAL data type of an entity.

oval_datatype_t	probe_ent_getdatatype (const SEXP_t *ent)
	Get the OVAL data type of an entity.

int	probe_ent_setmask (SEXP_t *ent, bool mask)
	Set entity's mask.

bool	probe_ent_getmask (const SEXP_t *ent)
	Get entity's mask.

int	probe_ent_setstatus (SEXP_t *ent, oval_syschar_status_t status)
	Set entity's status.

oval_syschar_status_t	probe_ent_getstatus (const SEXP_t *ent)
	Get entity status.

char *	probe_ent_getname (const SEXP_t *ent)
	Get the name of an entity.

size_t	probe_ent_getname_r (const SEXP_t ent, char buffer, size_t buflen)
	Get the name of an entity.

void	probe_free (SEXP_t *obj)
	Free the memory allocated by the probe_* functions.

void	probe_filebehaviors_canonicalize (SEXP_t **behaviors)
	Set all of the missing attributes of the 'behaviors' entity to default values.

void	probe_tfc54behaviors_canonicalize (SEXP_t **behaviors)
	Set all of the missing attributes of the 'behaviors' entity to default values.

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.

oval_operation_t	probe_ent_getoperation (SEXP_t *entity, oval_operation_t default_op)

int	probe_item_add_msg (SEXP_t item, oval_message_level_t msglvl, char msgfmt,...)

SEXP_t *	probe_entval_from_cstr (oval_datatype_t type, const char *value, size_t vallen)

SEXP_t *	probe_ent_from_cstr (const char name, oval_datatype_t type, const char value, size_t vallen)

SEXP_t *	probe_obj_getmask (SEXP_t *obj)
	Get object entity mask.

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.

oval_result_t	probe_ent_cmp_binary (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two binary values.

oval_result_t	probe_ent_cmp_bool (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two boolean values.

oval_result_t	probe_ent_cmp_evr (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two epoch-version-release values.

oval_result_t	probe_ent_cmp_debian_evr (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two Debian epoch-version-release values.

oval_result_t	probe_ent_cmp_filesetrev (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two values.

oval_result_t	probe_ent_cmp_float (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two floating point values.

oval_result_t	probe_ent_cmp_int (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two integer values.

oval_result_t	probe_ent_cmp_ios (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two ios values.

oval_result_t	probe_ent_cmp_version (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two version values.

oval_result_t	probe_ent_cmp_string (SEXP_t val1, SEXP_t val2, oval_operation_t op)
	Compare two string values.

oval_result_t	probe_entste_cmp (SEXP_t ent_ste, SEXP_t ent_itm)
	Compare state entity's content with a item entity's value.

oval_result_t	probe_entobj_cmp (SEXP_t ent_obj, SEXP_t val)
	Compare object entity's content with a value.

oval_result_t	probe_ent_result_bychk (SEXP_t *res_lst, oval_check_t check)
	Compute the overall result.

oval_result_t	probe_ent_result_byopr (SEXP_t *res_lst, oval_operator_t operator)
	Compute the overall result.

OSCAP_API SEXP_t	nonnull (2)))

OSCAP_API int	probe_item_collect (probe_ctx ctx, SEXP_t item)
	Collect generated item (i.e.

OSCAP_API SEXP_t *	probe_ctx_getobject (probe_ctx *ctx)
	Return reference to the input object.

OSCAP_API SEXP_t *	probe_ctx_getresult (probe_ctx *ctx)
	Return reference to the output object (aka collected object).

Detailed Description

This file contains functions for manipulating with the S-exp representation of OVAL objects and items.

Currently object and items have the same structure and the API distinction is just formal. However, the structure can diverge in the future and the API functions for manipulating with items should be used only with items and vice versa. The most recent description of the object and item structure can be found in this file and should be used as the main source of information for implementing new API functions. In the following text, the term ‘element’ referers to the general structure which is used to represent the various components of an OVAL document, particularly the OVAL objects, items and entities.

structure

The basic structure of an element looks like this:

(foo_object bar)

foo_object is the element name and bar is the value of the element. There can be 0 to n values. In case the element has some attributes set the structure changes to:

((foo_object :attr1 val1) bar)

where attr1 is the name of the attribute and val1 is the attribute's value. The colon in the attribute name signals that the attribute has a value.

Macro Definition Documentation

◆ PROBE_ENT_AREF

#define PROBE_ENT_AREF	(	ent,
		dst,
		attr_name,
		invalid_exp )

Value:

        do {                                                            \
                if (((dst) = probe_ent_getattrval(ent, attr_name)) == NULL) { \
                        dE("Attribute `%s' is missing!", attr_name);    \
                        invalid_exp                                     \
                }                                                       \
        } while(0)

◆ PROBE_ENT_I32VAL

#define PROBE_ENT_I32VAL	(	ent,
		dst,
		invalid_exp,
		nil_exp )

Value:

        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)

◆ PROBE_ENT_STRVAL

#define PROBE_ENT_STRVAL	(	ent,
		dst,
		dstlen,
		invalid_exp,
		zerolen_exp )

Value:

        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)

Function Documentation

◆ probe_attr_creat()

OSCAP_API SEXP_t * probe_attr_creat	(	const char *	name,
		const SEXP_t *	val,
			... )

Create a new list of attributes.

This function increments its val argument's reference count.

Parameters

name	the name of the attribute
val	the value of the attribute
...	there can be an arbitrary number of name - value pairs

◆ probe_ctx_getobject()

OSCAP_API SEXP_t * probe_ctx_getobject ( probe_ctx * ctx )

Return reference to the input object.

The reference counter is NOT incremented by this operation (i.e. don't call SEXP_free on the return value of this function). Implementation of this function is placed in the ‘’ file.

◆ probe_ctx_getresult()

OSCAP_API SEXP_t * probe_ctx_getresult ( probe_ctx * ctx )

Return reference to the output object (aka collected object).

Reference counter is NOT incremented (see the description of probe_ctx_getobject above).

◆ probe_ent_attr_add()

OSCAP_API SEXP_t * probe_ent_attr_add	(	SEXP_t *	ent,
		const char *	name,
		SEXP_t *	val )

Add a new attribute to an entity.

This function increments its val argument's reference count.

Parameters

ent	the entity to be modified
name	name of the new attribute
val	value of the new attribute

◆ probe_ent_attrexists()

OSCAP_API bool probe_ent_attrexists	(	const SEXP_t *	ent,
		const char *	name )

Check whether the specified attribute exists.

Parameters

ent	the queried entity
name	the name of the attribute