Open SCAP Library
Data Structures | Functions
/home/pvrabec/project/openscap/openscap-0.8.1/src/SCE/sce_engine.c File Reference

Script Check Engine. More...

#include "alloc.h"
#include "common/_error.h"
#include "common/util.h"
#include "common/list.h"
#include "sce_engine_api.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <wait.h>
#include <unistd.h>
#include <sys/stat.h>
#include <assert.h>
#include <fcntl.h>
#include <sys/types.h>
#include <limits.h>

Data Structures

struct  sce_check_result
struct  sce_session
struct  sce_parameters

Functions

struct sce_check_resultsce_check_result_new (void)
void sce_check_result_free (struct sce_check_result *v)
void sce_check_result_set_href (struct sce_check_result *v, const char *href)
const char * sce_check_result_get_href (struct sce_check_result *v)
void sce_check_result_set_basename (struct sce_check_result *v, const char *base_name)
const char * sce_check_result_get_basename (struct sce_check_result *v)
void sce_check_result_set_details (struct sce_check_result *v, const char *details)
const char * sce_check_result_get_details (struct sce_check_result *v)
void sce_check_result_set_xccdf_result (struct sce_check_result *v, xccdf_test_result_type_t result)
xccdf_test_result_type_t sce_check_result_get_xccdf_result (struct sce_check_result *v)
void sce_check_result_export (struct sce_check_result *v, const char *target_file)
 Exports details (in XML form) of given check result to given file.
struct sce_sessionsce_session_new (void)
void sce_session_free (struct sce_session *s)
void sce_session_reset (struct sce_session *s)
 Removes all check results from the session.
void sce_session_add_check_result (struct sce_session *s, struct sce_check_result *result)
 Adds a check result to the session.
void sce_session_export_to_directory (struct sce_session *s, const char *directory)
struct sce_parameterssce_parameters_new (void)
void sce_parameters_free (struct sce_parameters *v)
void sce_parameters_set_xccdf_directory (struct sce_parameters *v, const char *value)
const char * sce_parameters_get_xccdf_directory (struct sce_parameters *v)
void sce_parameters_set_session (struct sce_parameters *v, struct sce_session *value)
 Sets SCE session to use for check results storage.
struct sce_sessionsce_parameters_get_session (struct sce_parameters *v)
void sce_parameters_allocate_session (struct sce_parameters *v)
 Just a convenience shortcut of setting a session to a newly allocated session.
xccdf_test_result_type_t sce_engine_eval_rule (struct xccdf_policy *policy, const char *rule_id, const char *id, const char *href, struct xccdf_value_binding_iterator *it, void *usr)
 Internal rule evaluation callback, don't use directly.
bool xccdf_policy_model_register_engine_sce (struct xccdf_policy_model *model, struct sce_parameters *parameters)
 Registers SCE to given policy model.

Detailed Description

Script Check Engine.


Function Documentation

xccdf_test_result_type_t sce_engine_eval_rule ( struct xccdf_policy policy,
const char *  rule_id,
const char *  id,
const char *  href,
struct xccdf_value_binding_iterator *  it,
void *  usr 
)

Internal rule evaluation callback, don't use directly.

See also:
xccdf_policy_model_register_engine_sce
void sce_parameters_allocate_session ( struct sce_parameters v)

Just a convenience shortcut of setting a session to a newly allocated session.

The session gets automatically freed when sce_parameters are freed, don't deallocate it!

void sce_parameters_set_session ( struct sce_parameters v,
struct sce_session value 
)

Sets SCE session to use for check results storage.

Parameters:
v
valueSCE session to use (sce_parameters take ownership of it, don't deallocate it!)
void sce_session_add_check_result ( struct sce_session s,
struct sce_check_result result 
)

Adds a check result to the session.

Parameters:
ssession to add the check result to
resultresult to be added (the session takes ownership of it, don't deallocate it!)
bool xccdf_policy_model_register_engine_sce ( struct xccdf_policy_model model,
struct sce_parameters sce_parameters 
)

Registers SCE to given policy model.

Parameters:
modelmodel to register SCE to
sce_parametersvarious parameters to be used with SCE (you are responsible to deallocate them!)