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