Loading...
Searching...
No Matches
sce_engine_api.h
/*
* Copyright 2012 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:
* "Martin Preisler" <mpreisle@redhat.com>
*/
#pragma once
#ifndef SCE_ENGINE_API_H_
#define SCE_ENGINE_API_H_
#include <xccdf_benchmark.h>
#include <xccdf_policy.h>
#include "oscap_export.h"
OSCAP_API struct sce_check_result* sce_check_result_new(void);
OSCAP_API void sce_check_result_free(struct sce_check_result* v);
OSCAP_API void sce_check_result_set_href(struct sce_check_result* v, const char* href);
OSCAP_API const char* sce_check_result_get_href(struct sce_check_result* v);
OSCAP_API void sce_check_result_set_basename(struct sce_check_result* v, const char* basename);
OSCAP_API const char* sce_check_result_get_basename(struct sce_check_result* v);
OSCAP_API void sce_check_result_set_stdout(struct sce_check_result* v, const char* details);
OSCAP_API const char* sce_check_result_get_stdout(struct sce_check_result* v);
OSCAP_API void sce_check_result_set_stderr(struct sce_check_result* v, const char* details);
OSCAP_API const char* sce_check_result_get_stderr(struct sce_check_result* v);
OSCAP_API void sce_check_result_set_exit_code(struct sce_check_result* v, int exit_code);
OSCAP_API int sce_check_result_get_exit_code(struct sce_check_result* v);
OSCAP_API void sce_check_result_reset_environment_variables(struct sce_check_result* v);
OSCAP_API void sce_check_result_add_environment_variable(struct sce_check_result* v, const char* var);
OSCAP_API void sce_check_result_set_xccdf_result(struct sce_check_result* v, xccdf_test_result_type_t result);
OSCAP_API xccdf_test_result_type_t sce_check_result_get_xccdf_result(struct sce_check_result* v);
OSCAP_API void sce_check_result_export(struct sce_check_result* v, const char* target_file);
OSCAP_API struct sce_session* sce_session_new(void);
OSCAP_API void sce_session_free(struct sce_session* s);
OSCAP_API void sce_session_reset(struct sce_session* s);
OSCAP_API void sce_session_add_check_result(struct sce_session* s, struct sce_check_result* result);
struct sce_check_result_iterator;
OSCAP_API struct sce_check_result *sce_check_result_iterator_next(struct sce_check_result_iterator *it);
OSCAP_API bool sce_check_result_iterator_has_more(struct sce_check_result_iterator *it);
OSCAP_API void sce_check_result_iterator_free(struct sce_check_result_iterator *it);
OSCAP_API void sce_check_result_iterator_reset(struct sce_check_result_iterator *it);
OSCAP_API struct sce_check_result_iterator *sce_session_get_check_results(struct sce_session* s);
OSCAP_API void sce_session_export_to_directory(struct sce_session* s, const char* directory);
OSCAP_API struct sce_parameters* sce_parameters_new(void);
OSCAP_API void sce_parameters_free(struct sce_parameters* v);
OSCAP_API void sce_parameters_set_xccdf_directory(struct sce_parameters* v, const char* value);
OSCAP_API const char* sce_parameters_get_xccdf_directory(struct sce_parameters* v);
OSCAP_API void sce_parameters_set_session(struct sce_parameters* v, struct sce_session* value);
OSCAP_API struct sce_session* sce_parameters_get_session(struct sce_parameters* v);
OSCAP_API void sce_parameters_allocate_session(struct sce_parameters* v);
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 *value_binding_it,
struct xccdf_check_import_iterator *check_import_it,
void *usr);
OSCAP_API bool xccdf_policy_model_register_engine_sce(struct xccdf_policy_model * model, struct sce_parameters *sce_parameters);
#endif
xccdf_test_result_type_t
xccdf_test_result_type_t
Test result.
Definition xccdf_benchmark.h:170
xccdf_policy_model_register_engine_sce
bool xccdf_policy_model_register_engine_sce(struct xccdf_policy_model *model, struct sce_parameters *parameters)
Registers SCE to given policy model.
Definition sce_engine.c:728
sce_engine_eval_rule
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 *value_binding_it, struct xccdf_check_import_iterator *check_import_it, void *usr)
Internal rule evaluation callback, don't use directly.
Definition sce_engine.c:368
sce_parameters_set_xccdf_directory
void sce_parameters_set_xccdf_directory(struct sce_parameters *v, const char *value)
Sets the directory that contains XCCDF that will reference SCE checks.
Definition sce_engine.c:298
sce_check_result_iterator
Iterator over collections of sce_check_results.
sce_check_result
Definition sce_engine.c:68
sce_check_result::sce_check_result_set_stdout
OSCAP_API void sce_check_result_set_stdout(struct sce_check_result *v, const char *details)
Sets stdout that was captured while script was evaluating.
Definition sce_engine.c:128
sce_check_result::sce_check_result_add_environment_variable
OSCAP_API void sce_check_result_add_environment_variable(struct sce_check_result *v, const char *var)
Adds an environment variable entry to list of environment variables that were passed to the script.
Definition sce_engine.c:166
sce_check_result::sce_check_result_set_xccdf_result
OSCAP_API void sce_check_result_set_xccdf_result(struct sce_check_result *v, xccdf_test_result_type_t result)
Sets the final xccdf result (after exit code to xccdf mapping takes place).
Definition sce_engine.c:171
sce_check_result::sce_check_result_set_exit_code
OSCAP_API void sce_check_result_set_exit_code(struct sce_check_result *v, int exit_code)
Sets exit code with which the script ended execution after evaluation.
Definition sce_engine.c:150
sce_check_result::sce_check_result_export
OSCAP_API 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.
Definition sce_engine.c:181
sce_check_result::sce_check_result_set_href
OSCAP_API void sce_check_result_set_href(struct sce_check_result *v, const char *href)
Sets the href used to execute the check that yielded given check result.
Definition sce_engine.c:106
sce_check_result::sce_check_result_reset_environment_variables
OSCAP_API void sce_check_result_reset_environment_variables(struct sce_check_result *v)
Clears the list of passed environment variables.
Definition sce_engine.c:160
sce_check_result::sce_check_result_set_basename
OSCAP_API void sce_check_result_set_basename(struct sce_check_result *v, const char *basename)
Sets basename of the script that was used for check evaluation.
Definition sce_engine.c:117
sce_check_result::sce_check_result_set_stderr
OSCAP_API void sce_check_result_set_stderr(struct sce_check_result *v, const char *details)
Sets stderr that was captured while script was evaluating.
Definition sce_engine.c:139
sce_parameters
Definition sce_engine.c:273
sce_parameters::sce_parameters_set_session
OSCAP_API void sce_parameters_set_session(struct sce_parameters *v, struct sce_session *value)
Sets SCE session to use for check results storage.
Definition sce_engine.c:311
sce_session
Definition sce_engine.c:218
sce_session::sce_session_add_check_result
OSCAP_API void sce_session_add_check_result(struct sce_session *s, struct sce_check_result *result)
Adds a check result to the session.
Definition sce_engine.c:245
sce_session::sce_session_reset
OSCAP_API void sce_session_reset(struct sce_session *s)
Removes all check results from the session.
Definition sce_engine.c:239
xccdf_check_import_iterator
Check import iterator.
xccdf_policy_model
XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...
Definition xccdf_policy_priv.h:38
xccdf_policy
XCCDF policy structure is abstract (class) structure of Profile element from benchmark.
Definition xccdf_policy_priv.h:58
xccdf_benchmark.h
Open-scap XCCDF library interface.
xccdf_policy.h
Open-scap XCCDF Policy library interface.