sechk_module Struct Reference

#include <sechecker.h>

List of all members.


Public Attributes

char * name
 Unique module name.
const char * brief_description
 Brief description of the module.
const char * detailed_description
 Detailed description of the module.
const char * opt_description
 Description of options, requirements, and dependencies.
sechk_result_tresult
 Results generated by this module.
apol_vector_toptions
 Vector (of type sechk_name_value_t) containing all user specified options for this module.
apol_vector_trequirements
 Vector (of type sechk_name_value_t) containing all conditions required by the module such as policy version or type.
apol_vector_tdependencies
 Vector (of type sechk_name_value_t) containing a list of modules which need to run before this module may access their results.
apol_vector_tfunctions
 Vector (of type sechk_fn_t) of all functions registered for this module.
unsigned char outputformat
 Default output format for the report.
bool selected
 This field is used by the library to indicate that the user or another module has selected this module to be run.
const char * severity
 The severity level of this module's results.
void * data
 The module's private data.
free_fn_t data_free
 Function to be used to free the private data.
const sechk_lib_tparent_lib
 Pointer to the module's parent library.

Member Data Documentation

char* sechk_module::name
 

Unique module name.

Definition at line 230 of file sechecker.h.

Referenced by attribs_wo_rules_get_list(), attribs_wo_rules_init(), attribs_wo_rules_print(), attribs_wo_rules_run(), attribs_wo_types_get_list(), attribs_wo_types_init(), attribs_wo_types_print(), attribs_wo_types_run(), domain_and_file_init(), domain_and_file_print(), domain_and_file_run(), domains_wo_roles_init(), domains_wo_roles_print(), domains_wo_roles_run(), find_assoc_types_get_list(), find_assoc_types_init(), find_assoc_types_print(), find_assoc_types_run(), find_domains_get_list(), find_domains_init(), find_domains_print(), find_domains_run(), find_file_types_get_list(), find_file_types_init(), find_file_types_print(), find_file_types_run(), find_net_domains_get_list(), find_net_domains_init(), find_net_domains_print(), find_net_domains_run(), find_netif_types_get_list(), find_netif_types_init(), find_netif_types_print(), find_netif_types_run(), find_node_types_get_list(), find_node_types_init(), find_node_types_print(), find_node_types_run(), find_port_types_get_list(), find_port_types_init(), find_port_types_print(), find_port_types_run(), imp_range_trans_init(), imp_range_trans_print(), imp_range_trans_run(), inc_dom_trans_init(), inc_dom_trans_print(), inc_dom_trans_run(), inc_mount_init(), inc_mount_print(), inc_mount_run(), inc_net_access_init(), inc_net_access_print(), inc_net_access_run(), main(), roles_wo_allow_get_list(), roles_wo_allow_init(), roles_wo_allow_print(), roles_wo_allow_run(), roles_wo_types_init(), roles_wo_types_print(), roles_wo_types_run(), roles_wo_users_get_list(), roles_wo_users_init(), roles_wo_users_print(), roles_wo_users_run(), sechk_lib_check_module_dependencies(), sechk_lib_check_module_requirements(), sechk_lib_get_module(), sechk_lib_get_module_idx(), sechk_lib_get_module_result(), sechk_lib_init_modules(), sechk_lib_new(), sechk_lib_print_modules_report(), sechk_lib_run_modules(), sechk_module_free(), sechk_print_list(), spurious_audit_init(), spurious_audit_print(), spurious_audit_run(), types_wo_allow_get_list(), types_wo_allow_init(), types_wo_allow_print(), types_wo_allow_run(), unreachable_doms_init(), unreachable_doms_print(), unreachable_doms_run(), users_wo_roles_init(), users_wo_roles_print(), users_wo_roles_run(), xx_init(), xx_print(), and xx_run().

const char* sechk_module::brief_description
 

Brief description of the module.

Definition at line 232 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_print_list(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

const char* sechk_module::detailed_description
 

Detailed description of the module.

This should include a listing of of all steps performed by the module's checks.

Definition at line 235 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), main(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_lib_print_modules_report(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

const char* sechk_module::opt_description
 

Description of options, requirements, and dependencies.

Definition at line 237 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), main(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

sechk_result_t* sechk_module::result
 

Results generated by this module.

Definition at line 239 of file sechecker.h.

Referenced by attribs_wo_rules_get_list(), attribs_wo_rules_print(), attribs_wo_rules_run(), attribs_wo_types_get_list(), attribs_wo_types_print(), attribs_wo_types_run(), domain_and_file_print(), domain_and_file_run(), domains_wo_roles_print(), domains_wo_roles_run(), find_assoc_types_get_list(), find_assoc_types_print(), find_assoc_types_run(), find_domains_get_list(), find_domains_print(), find_domains_run(), find_file_types_get_list(), find_file_types_print(), find_file_types_run(), find_net_domains_get_list(), find_net_domains_print(), find_net_domains_run(), find_netif_types_get_list(), find_netif_types_print(), find_netif_types_run(), find_node_types_get_list(), find_node_types_print(), find_node_types_run(), find_port_types_get_list(), find_port_types_print(), find_port_types_run(), imp_range_trans_print(), imp_range_trans_run(), inc_dom_trans_print(), inc_dom_trans_run(), inc_mount_print(), inc_mount_run(), inc_net_access_print(), inc_net_access_run(), roles_wo_allow_get_list(), roles_wo_allow_print(), roles_wo_allow_run(), roles_wo_types_print(), roles_wo_types_run(), roles_wo_users_get_list(), roles_wo_users_print(), roles_wo_users_run(), sechk_lib_get_module_result(), sechk_module_free(), spurious_audit_print(), spurious_audit_run(), types_wo_allow_get_list(), types_wo_allow_print(), types_wo_allow_run(), unreachable_doms_print(), unreachable_doms_run(), users_wo_roles_print(), users_wo_roles_run(), xx_print(), and xx_run().

apol_vector_t* sechk_module::options
 

Vector (of type sechk_name_value_t) containing all user specified options for this module.

Definition at line 242 of file sechecker.h.

Referenced by find_domains_init(), find_domains_register(), find_file_types_init(), find_file_types_register(), find_net_domains_init(), find_net_domains_register(), sechk_lib_module_clear_option(), sechk_lib_process_xml_node(), sechk_module_free(), sechk_module_new(), xx_init(), and xx_register().

apol_vector_t* sechk_module::requirements
 

Vector (of type sechk_name_value_t) containing all conditions required by the module such as policy version or type.

See profile documentation for a complete listing of possible requirements.

Definition at line 246 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_domains_register(), find_file_types_register(), imp_range_trans_register(), inc_dom_trans_register(), sechk_lib_check_module_requirements(), sechk_module_free(), sechk_module_new(), unreachable_doms_register(), and xx_register().

apol_vector_t* sechk_module::dependencies
 

Vector (of type sechk_name_value_t) containing a list of modules which need to run before this module may access their results.

Definition at line 249 of file sechecker.h.

Referenced by domain_and_file_register(), domain_and_file_run(), domains_wo_roles_register(), inc_dom_trans_register(), inc_net_access_register(), inc_net_access_run(), sechk_lib_check_module_dependencies(), sechk_module_free(), sechk_module_new(), unreachable_doms_register(), unreachable_doms_run(), and xx_register().

apol_vector_t* sechk_module::functions
 

Vector (of type sechk_fn_t) of all functions registered for this module.

All modules are required to have at least three: init, run, and print.

Definition at line 252 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_lib_get_module_function(), sechk_module_free(), sechk_module_new(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

unsigned char sechk_module::outputformat
 

Default output format for the report.

Definition at line 254 of file sechecker.h.

Referenced by attribs_wo_rules_print(), attribs_wo_types_print(), domain_and_file_print(), domains_wo_roles_print(), find_assoc_types_print(), find_domains_print(), find_file_types_print(), find_net_domains_print(), find_netif_types_print(), find_node_types_print(), find_port_types_print(), imp_range_trans_print(), inc_dom_trans_print(), inc_mount_print(), inc_net_access_print(), roles_wo_allow_print(), roles_wo_types_print(), roles_wo_users_print(), sechk_lib_load_profile(), sechk_lib_print_modules_report(), sechk_lib_process_xml_node(), sechk_lib_set_outputformat(), spurious_audit_print(), types_wo_allow_print(), unreachable_doms_print(), users_wo_roles_print(), and xx_print().

bool sechk_module::selected
 

This field is used by the library to indicate that the user or another module has selected this module to be run.

Definition at line 257 of file sechecker.h.

Referenced by main(), sechk_lib_check_module_dependencies(), sechk_lib_check_module_requirements(), sechk_lib_init_modules(), sechk_lib_load_profile(), sechk_lib_print_modules_report(), sechk_lib_process_xml_node(), and sechk_lib_run_modules().

const char* sechk_module::severity
 

The severity level of this module's results.

One of SECHK_SEV_* above.

Definition at line 259 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_lib_print_modules_report(), sechk_lib_run_modules(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

void* sechk_module::data
 

The module's private data.

This includes data generated when processing options and from reading its dependencies' results.

Definition at line 262 of file sechecker.h.

Referenced by attribs_wo_rules_init(), attribs_wo_types_init(), domain_and_file_init(), domains_wo_roles_init(), find_assoc_types_init(), find_domains_init(), find_domains_print(), find_domains_run(), find_file_types_init(), find_file_types_print(), find_file_types_run(), find_net_domains_init(), find_net_domains_print(), find_net_domains_run(), imp_range_trans_init(), inc_dom_trans_init(), inc_mount_init(), inc_net_access_init(), roles_wo_allow_init(), roles_wo_types_init(), roles_wo_users_init(), sechk_module_free(), spurious_audit_init(), types_wo_allow_init(), unreachable_doms_init(), unreachable_doms_print(), unreachable_doms_run(), users_wo_roles_init(), xx_init(), xx_print(), and xx_run().

free_fn_t sechk_module::data_free
 

Function to be used to free the private data.

Definition at line 264 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domains_wo_roles_register(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_mount_register(), inc_net_access_register(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_module_free(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), users_wo_roles_register(), and xx_register().

const sechk_lib_t* sechk_module::parent_lib
 

Pointer to the module's parent library.

Definition at line 266 of file sechecker.h.

Referenced by attribs_wo_rules_register(), attribs_wo_types_register(), domain_and_file_register(), domain_and_file_run(), domains_wo_roles_register(), domains_wo_roles_run(), find_assoc_types_register(), find_domains_register(), find_file_types_register(), find_file_types_run(), find_net_domains_register(), find_netif_types_register(), find_node_types_register(), find_port_types_register(), imp_range_trans_register(), inc_dom_trans_register(), inc_dom_trans_run(), inc_mount_register(), inc_net_access_register(), inc_net_access_run(), roles_wo_allow_register(), roles_wo_types_register(), roles_wo_users_register(), sechk_lib_module_clear_option(), spurious_audit_register(), types_wo_allow_register(), unreachable_doms_register(), unreachable_doms_run(), users_wo_roles_register(), and xx_register().


The documentation for this struct was generated from the following file: