ssg package

Subpackages

• ssg.entities package
  • Submodules
    • ssg.entities.common module
      • SelectionHandler
      • Templatable
      • XCCDFEntity
      • add_sub_element()
      • derive_id_from_file_name()
      • dump_yaml_preferably_in_original_order()
      • extract_reference_from_product_specific_label()
      • make_items_product_specific()
    • ssg.entities.profile module
      • ProfileWithInlinePolicies
      • ResolvableProfile
    • ssg.entities.profile_base module
      • Profile
      • noop_rule_filterfunc()
      • rule_filter_from_def()
  • Module contents
• ssg.ext package
  • Subpackages
    • ssg.ext.boolean package
      • Submodules
      • Module contents
  • Module contents
• ssg.oval_object_model package
  • Subpackages
    • ssg.oval_object_model.oval_entities package
      • Submodules
      • Module contents
  • Submodules
    • ssg.oval_object_model.general module
      • ExceptionEmptyNote
      • Notes
      • OVALBaseObject
      • OVALComponent
      • OVALEntity
      • OVALEntityProperty
      • get_product_name()
      • is_product_name_in()
      • load_notes()
      • load_oval_entity_property()
      • load_property_and_notes_of_oval_entity()
      • required_attribute()
    • ssg.oval_object_model.oval_container module
      • ExceptionDuplicateOVALEntity
      • OVALContainer
      • add_oval_component()
    • ssg.oval_object_model.oval_definition_references module
      • OVALDefinitionReference
    • ssg.oval_object_model.oval_document module
      • MissingOVALComponent
      • OVALDocument
      • load_oval_document()
      • selection_of_oval_components_generator()
    • ssg.oval_object_model.oval_shorthand module
      • OVALShorthand
  • Module contents

Submodules

• ssg.ansible module
  • add_minimum_version()
  • remove_too_many_blank_lines()
  • remove_trailing_whitespace()
• ssg.boolean_expression module
  • Algebra
  • Function
    • Function.as_id()
    • Function.is_and()
    • Function.is_not()
    • Function.is_or()
  • Symbol
    • Symbol.arg
    • Symbol.as_dict()
    • Symbol.as_id()
    • Symbol.get_base_of_parametrized_name()
    • Symbol.has_version_specs()
    • Symbol.is_parametrized()
    • Symbol.name
• ssg.build_cpe module
  • CPEALCheckFactRef
    • CPEALCheckFactRef.cpe_id_is_parametrized()
    • CPEALCheckFactRef.enrich_with_cpe_info()
    • CPEALCheckFactRef.get_base_name_of_parametrized_cpe_id()
    • CPEALCheckFactRef.ns
    • CPEALCheckFactRef.prefix
    • CPEALCheckFactRef.to_ansible_conditional()
    • CPEALCheckFactRef.to_bash_conditional()
    • CPEALCheckFactRef.to_xml_element()
  • CPEALLogicalTest
    • CPEALLogicalTest.enrich_with_cpe_info()
    • CPEALLogicalTest.ns
    • CPEALLogicalTest.prefix
    • CPEALLogicalTest.to_ansible_conditional()
    • CPEALLogicalTest.to_bash_conditional()
    • CPEALLogicalTest.to_xml_element()
  • CPEDoesNotExist
  • CPEItem
    • CPEItem.KEYS
    • CPEItem.MANDATORY_KEYS
    • CPEItem.cpe_oval_def_id
    • CPEItem.cpe_oval_short_def_id
    • CPEItem.create_resolved_cpe_item_for_fact_ref()
    • CPEItem.from_yaml()
    • CPEItem.is_cpe_name()
    • CPEItem.ns
    • CPEItem.prefix
    • CPEItem.set_conditional()
    • CPEItem.set_cpe_oval_def_id()
    • CPEItem.set_template_variables()
    • CPEItem.to_xml_element()
  • CPEList
    • CPEList.add()
    • CPEList.ns
    • CPEList.prefix
    • CPEList.to_file()
    • CPEList.to_xml_element()
    • CPEList.translate_cpe_oval_def_ids()
  • ProductCPEs
    • ProductCPEs.add_cpe_item()
    • ProductCPEs.add_resolved_cpe_items_from_platform()
    • ProductCPEs.get_cpe()
    • ProductCPEs.get_cpe_for_fact_ref()
    • ProductCPEs.get_cpe_name()
    • ProductCPEs.get_product_cpe_names()
    • ProductCPEs.load_content_cpes()
    • ProductCPEs.load_cpes_from_directory_tree()
    • ProductCPEs.load_cpes_from_list()
    • ProductCPEs.load_product_cpes()
    • ProductCPEs.load_product_cpes_from_list()
  • extract_env_obj()
  • extract_referred_nodes()
  • extract_subelement()
  • get_linked_cpe_oval_document()
• ssg.build_derivatives module
  • add_cpe_item_to_dictionary()
  • add_cpes()
  • add_element_to()
  • add_notice()
  • add_oval_components_to_oval_xml()
  • add_oval_definition_to_cpe_oval()
  • get_cpe_item()
  • get_cpe_oval_root()
  • profile_handling()
  • remove_cce_reference()
  • remove_idents()
  • replace_platform()
• ssg.build_guides module
  • build_index()
  • builder()
  • fill_queue()
  • generate_for_input_content()
  • get_benchmark_profile_pairs()
  • get_output_guide_paths()
  • get_path_args()
• ssg.build_ovals module
  • OVALBuildException
  • OVALBuilder
    • OVALBuilder.get_oval_document_from_shorthands()
    • OVALBuilder.product_name
  • expand_shorthand()
• ssg.build_profile module
  • RuleStats
  • XCCDFBenchmark
    • XCCDFBenchmark.console_print()
    • XCCDFBenchmark.get_all_profile_stats()
    • XCCDFBenchmark.get_profile_stats()
    • XCCDFBenchmark.show_all_profile_stats()
    • XCCDFBenchmark.show_profile_stats()
  • get_cis_uri()
  • make_name_to_profile_mapping()
• ssg.build_remediations module
  • AnacondaRemediation
  • AnsibleRemediation
    • AnsibleRemediation.from_snippet_and_rule()
    • AnsibleRemediation.get_references()
    • AnsibleRemediation.inject_package_facts_task()
    • AnsibleRemediation.parse_from_file_with_jinja()
    • AnsibleRemediation.update()
    • AnsibleRemediation.update_tags_from_config()
    • AnsibleRemediation.update_tags_from_rule()
    • AnsibleRemediation.update_when_from_rule()
  • BashRemediation
    • BashRemediation.parse_from_file_with_jinja()
  • BlueprintRemediation
  • IgnitionRemediation
  • KickstartRemediation
  • KubernetesRemediation
  • PuppetRemediation
  • Remediation
    • Remediation.associate_rule()
    • Remediation.expand_env_yaml_from_rule()
    • Remediation.get_inherited_conditionals()
    • Remediation.get_inherited_cpe_platform_names()
    • Remediation.get_rule_specific_conditionals()
    • Remediation.get_rule_specific_cpe_platform_names()
    • Remediation.get_stripped_conditionals()
    • Remediation.parse_from_file_with_jinja()
  • RemediationObject
  • expand_xccdf_subs()
  • get_rule_dir_remediations()
  • is_supported_filename()
  • load_compiled_remediations()
  • parse_from_file_with_jinja()
  • parse_from_file_without_jinja()
  • process()
  • split_remediation_content_and_metadata()
  • write_fix_to_file()
• ssg.build_renumber module
  • FileLinker
    • FileLinker.CHECK_NAMESPACE
    • FileLinker.CHECK_SYSTEM
    • FileLinker.add_missing_check_exports()
    • FileLinker.get_related_checks()
    • FileLinker.link_xccdf()
    • FileLinker.save_linked_tree()
  • OCILFileLinker
    • OCILFileLinker.CHECK_NAMESPACE
    • OCILFileLinker.CHECK_SYSTEM
    • OCILFileLinker.link()
  • OVALFileLinker
    • OVALFileLinker.CHECK_NAMESPACE
    • OVALFileLinker.CHECK_SYSTEM
    • OVALFileLinker.add_missing_check_exports()
    • OVALFileLinker.build_ovals_dir
    • OVALFileLinker.link()
    • OVALFileLinker.save_linked_tree()
    • OVALFileLinker.save_oval_document_for_each_xccdf_rule()
  • check_and_correct_xccdf_to_oval_data_export_matching_constraints()
  • create_xccdf_id_to_cce_id_mapping()
  • rules_with_ids_generator()
  • verify_correct_form_of_referenced_cce_identifiers()
• ssg.build_sce module
  • checks()
  • collect_sce_checks()
  • load_sce_and_metadata()
  • load_sce_and_metadata_parsed()
• ssg.build_stig module
  • get_description_root()
  • get_severity()
  • map_versions_to_rule_ids()
  • parse_srgs()
• ssg.build_yaml module
  • Benchmark
    • Benchmark.GENERIC_FILENAME
    • Benchmark.KEYS
    • Benchmark.MANDATORY_KEYS
    • Benchmark.add_group()
    • Benchmark.add_profiles_from_dir()
    • Benchmark.add_rule()
    • Benchmark.add_value()
    • Benchmark.drop_rules_not_included_in_a_profile()
    • Benchmark.from_yaml()
    • Benchmark.get_benchmark_xml_for_profiles()
    • Benchmark.get_components_not_included_in_a_profiles()
    • Benchmark.get_not_used_cpe_platforms()
    • Benchmark.get_rules_selected_in_all_profiles()
    • Benchmark.get_used_cpe_platforms()
    • Benchmark.get_variables_of_rules()
    • Benchmark.load_entities()
    • Benchmark.process_input_dict()
    • Benchmark.represent_as_dict()
    • Benchmark.to_file()
    • Benchmark.to_xccdf()
    • Benchmark.to_xml_element()
    • Benchmark.unselect_empty_groups()
  • BuildLoader
    • BuildLoader.export_group_to_file()
    • BuildLoader.load_components()
  • DirectoryLoader
    • DirectoryLoader.load_benchmark_or_group()
    • DirectoryLoader.process_directory_tree()
    • DirectoryLoader.process_directory_trees()
    • DirectoryLoader.save_all_entities()
    • DirectoryLoader.save_entities()
  • Group
    • Group.GENERIC_FILENAME
    • Group.KEYS
    • Group.MANDATORY_KEYS
    • Group.add_group()
    • Group.add_rule()
    • Group.add_value()
    • Group.contains_rules()
    • Group.contains_variables()
    • Group.get_not_included_components()
    • Group.get_used_cpe_platforms()
    • Group.load_entities()
    • Group.process_input_dict()
    • Group.remove_rules_with_ids_not_listed()
    • Group.represent_as_dict()
    • Group.to_xml_element()
  • LinearLoader
    • LinearLoader.add_fixes_to_rules()
    • LinearLoader.export_benchmark_to_file()
    • LinearLoader.export_benchmark_to_xml()
    • LinearLoader.export_ocil_to_file()
    • LinearLoader.export_ocil_to_xml()
    • LinearLoader.find_first_groups_ids()
    • LinearLoader.get_benchmark_xml()
    • LinearLoader.get_benchmark_xml_by_profile()
    • LinearLoader.load_benchmark()
    • LinearLoader.load_compiled_content()
    • LinearLoader.load_entities_by_id()
  • Platform
    • Platform.KEYS
    • Platform.MANDATORY_KEYS
    • Platform.from_text()
    • Platform.from_yaml()
    • Platform.get_fact_refs()
    • Platform.get_remediation_conditional()
    • Platform.get_xml()
    • Platform.ns
    • Platform.prefix
    • Platform.to_xml_element()
    • Platform.update_conditional_from_cpe_items()
  • Rule
    • Rule.GENERIC_FILENAME
    • Rule.ID_LABEL
    • Rule.KEYS
    • Rule.MANDATORY_KEYS
    • Rule.PRODUCT_REFERENCES
    • Rule.add_control_reference()
    • Rule.add_fixes()
    • Rule.add_stig_references()
    • Rule.find_policy_specific_content()
    • Rule.from_yaml()
    • Rule.get_template_context()
    • Rule.load_policy_specific_content()
    • Rule.make_refs_and_identifiers_product_specific()
    • Rule.merge_control_references()
    • Rule.normalize()
    • Rule.read_policy_specific_content()
    • Rule.read_policy_specific_content_file()
    • Rule.to_ocil()
    • Rule.to_xml_element()
    • Rule.triage_policy_specific_content()
    • Rule.validate_identifiers()
    • Rule.validate_references()
  • Value
    • Value.KEYS
    • Value.MANDATORY_KEYS
    • Value.from_yaml()
    • Value.process_input_dict()
    • Value.to_xml_element()
  • add_benchmark_metadata()
  • add_nondata_subelements()
  • add_platform_if_not_defined()
  • add_reference_elements()
  • add_reference_title_elements()
  • add_warning_elements()
  • check_warnings()
  • noop_rule_filterfunc()
  • reorder_according_to_ordering()
  • rule_filter_from_def()
• ssg.cce module
  • CCEFile
    • CCEFile.absolute_path
    • CCEFile.line_isnt_cce()
    • CCEFile.line_to_cce()
    • CCEFile.random_cce()
    • CCEFile.read_cces()
    • CCEFile.remove_cce_from_file()
  • RedhatCCEFile
    • RedhatCCEFile.absolute_path
  • SLE12CCEFile
    • SLE12CCEFile.absolute_path
  • SLE15CCEFile
    • SLE15CCEFile.absolute_path
  • is_cce_format_valid()
  • is_cce_value_valid()
• ssg.checks module
  • get_content_ref_if_exists_and_not_remote()
  • get_oval_contents()
  • get_oval_path()
  • is_content_href_remote()
  • set_applicable_platforms()
• ssg.components module
  • Component
  • get_rule_to_components_mapping()
  • group_component_mapping()
  • load()
  • package_component_mapping()
  • rule_component_mapping()
  • template_component_mapping()
• ssg.constants module
  • OvalNamespaces
    • OvalNamespaces.definition
    • OvalNamespaces.independent
    • OvalNamespaces.linux
    • OvalNamespaces.oval
  • Reference
    • Reference.id
    • Reference.name
    • Reference.regex_with_groups
    • Reference.url
• ssg.content_diff module
  • StandardContentDiffer
    • StandardContentDiffer.compare_check_file_names()
    • StandardContentDiffer.compare_check_ids()
    • StandardContentDiffer.compare_checks()
    • StandardContentDiffer.compare_ocils()
    • StandardContentDiffer.compare_ovals()
    • StandardContentDiffer.compare_platforms()
    • StandardContentDiffer.compare_remediations()
    • StandardContentDiffer.compare_rule()
    • StandardContentDiffer.compare_rule_texts()
    • StandardContentDiffer.compare_rules()
    • StandardContentDiffer.generate_diff_text()
    • StandardContentDiffer.get_check_docs()
    • StandardContentDiffer.output_diff()
    • StandardContentDiffer.serialize_elements()
  • StigContentDiffer
    • StigContentDiffer.check_for_new_rules()
    • StigContentDiffer.compare_existing_rules()
    • StigContentDiffer.compare_rules()
    • StigContentDiffer.get_stig_rule_SV()
• ssg.contributors module
  • generate()
• ssg.controls module
  • Control
    • Control.KEYS
    • Control.MANDATORY_KEYS
    • Control.add_references()
    • Control.from_control_dict()
    • Control.represent_as_dict()
  • ControlsManager
    • ControlsManager.add_references()
    • ControlsManager.check_all_rules_exist()
    • ControlsManager.get_all_controls()
    • ControlsManager.get_all_controls_dict()
    • ControlsManager.get_all_controls_of_level()
    • ControlsManager.get_control()
    • ControlsManager.load()
    • ControlsManager.remove_selections_not_known()
    • ControlsManager.resolve_controls()
    • ControlsManager.save_everything()
  • InvalidStatus
  • Level
    • Level.KEYS
    • Level.from_level_dict()
  • Policy
    • Policy.add_references()
    • Policy.check_all_rules_exist()
    • Policy.check_levels_validity()
    • Policy.default_level
    • Policy.get_control()
    • Policy.get_level()
    • Policy.get_level_with_ancestors_sequence()
    • Policy.load()
    • Policy.remove_selections_not_known()
    • Policy.represent_as_dict()
    • Policy.save_controls_tree()
  • Status
    • Status.AUTOMATED
    • Status.DOCUMENTATION
    • Status.DOES_NOT_MEET
    • Status.INHERENTLY_MET
    • Status.MANUAL
    • Status.NOT_APPLICABLE
    • Status.PARTIAL
    • Status.PENDING
    • Status.PLANNED
    • Status.SUPPORTED
    • Status.from_control_info()
    • Status.get_status_list()
• ssg.environment module
  • open_environment()
• ssg.fixes module
  • applicable_platforms()
  • find_platform_line()
  • get_fix_contents()
  • get_fix_path()
  • set_applicable_platforms()
• ssg.id_translate module
  • IDTranslator
    • IDTranslator.generate_id()
    • IDTranslator.translate()
    • IDTranslator.translate_oval_document()
• ssg.jinja module
  • AbsolutePathFileSystemLoader
    • AbsolutePathFileSystemLoader.get_source()
  • MacroError
  • add_python_functions()
  • expand_yaml_path()
  • load_macros()
  • process_file()
  • process_file_with_macros()
  • raise_exception()
  • render_template()
  • update_substitutions_dict()
  • url_encode()
• ssg.oval module
  • applicable_platforms()
  • parse_affected()
• ssg.parse_oval module
  • ElementFinder
    • ElementFinder.find_element()
  • find_extending_defs()
  • get_container_groups()
  • resolve_definition()
• ssg.playbook_builder module
  • PlaybookBuilder
    • PlaybookBuilder.build()
    • PlaybookBuilder.choose_variable_value()
    • PlaybookBuilder.create_playbook()
    • PlaybookBuilder.create_playbook_for_single_rule()
    • PlaybookBuilder.create_playbooks_for_all_rules()
    • PlaybookBuilder.create_playbooks_for_all_rules_in_profile()
    • PlaybookBuilder.get_benchmark_variables()
    • PlaybookBuilder.get_data_from_snippet()
    • PlaybookBuilder.open_profile()
• ssg.products module
  • Product
    • Product.expand_by_acquired_data()
    • Product.get()
    • Product.read_properties_from_directory()
    • Product.transform_default_and_overrides_mappings_to_mapping()
    • Product.write()
  • get_all()
  • get_all_product_yamls()
  • get_all_products_with_same_guide_directory()
  • get_profile_files_from_root()
  • get_profiles_directory()
  • load_product_yaml()
  • product_yaml_path()
• ssg.requirement_specs module
  • Requirement
    • Requirement.arg
    • Requirement.get_base_for_parametrized()
    • Requirement.has_version_specs()
    • Requirement.is_parametrized()
    • Requirement.name
    • Requirement.ver_specs
• ssg.rule_dir_stats module
  • filter_rule_ids()
  • get_affected_products()
  • get_all_affected_products()
  • missing_oval()
  • missing_remediation()
  • product_names_oval()
  • product_names_remediation()
  • two_plus_oval()
  • two_plus_remediation()
  • walk_rule_stats()
  • walk_rules()
  • walk_rules_diff()
  • walk_rules_diff_stats()
  • walk_rules_parallel()
  • walk_rules_stats()
• ssg.rule_yaml module
  • add_key_value()
  • find_section_lines()
  • get_section_lines()
  • get_yaml_contents()
  • has_duplicated_subkeys()
  • parse_from_yaml()
  • remove_lines()
  • sort_section_keys()
  • update_key_value()
• ssg.rules module
  • applies_to_product()
  • find_rule_dirs()
  • find_rule_dirs_in_paths()
  • get_rule_dir_id()
  • get_rule_dir_ovals()
  • get_rule_dir_sces()
  • get_rule_dir_yaml()
  • is_rule_dir()
• ssg.shims module
  • input_func()
• ssg.templates module
  • Builder
    • Builder.build()
    • Builder.build_all_platforms()
    • Builder.build_all_rules()
    • Builder.build_cpe()
    • Builder.build_extra_ovals()
    • Builder.build_lang_for_templatable()
    • Builder.build_platform()
    • Builder.build_rule()
    • Builder.get_lang_contents_for_templatable()
    • Builder.get_resolved_langs_to_generate()
    • Builder.process_template_lang_file()
    • Builder.write_lang_contents_for_templatable()
  • Template
    • Template.load_template()
    • Template.preprocess()
  • TemplatingLang
  • load_module()
• ssg.utils module
  • SSGError
  • VersionSpecifier
    • VersionSpecifier.cpe_id
    • VersionSpecifier.ev_ver
    • VersionSpecifier.evr_dict_to_str()
    • VersionSpecifier.evr_op
    • VersionSpecifier.evr_ver
    • VersionSpecifier.oval_id
    • VersionSpecifier.title
    • VersionSpecifier.ver
  • VersionSpecifierSet
    • VersionSpecifierSet.cpe_id
    • VersionSpecifierSet.oval_id
    • VersionSpecifierSet.title
  • apply_formatting_on_dict_values()
  • banner_anchor_wrap()
  • banner_regexify()
  • check_conflict_regex_directory()
  • comparison_to_oval()
  • ensure_file_paths_and_file_regexes_are_correctly_defined()
  • enum()
  • escape_comparison()
  • escape_id()
  • escape_regex()
  • escape_yaml_key()
  • get_cpu_count()
  • get_fixed_product_version()
  • is_applicable()
  • is_applicable_for_product()
  • map_name()
  • merge_dicts()
  • mkdir_p()
  • name_to_platform()
  • parse_name()
  • parse_platform()
  • parse_template_boolean_value()
  • product_to_name()
  • product_to_platform()
  • read_file_list()
  • recurse_or_substitute_or_do_nothing()
  • required_key()
  • sha256()
  • split_string_content()
  • subset_dict()
  • write_list_file()
• ssg.xccdf module
  • get_benchmark_id_title_map()
  • get_profile_choices_for_input()
  • get_profile_short_id()
  • scrape_benchmarks()
• ssg.xml module
  • XMLBenchmark
    • XMLBenchmark.find_all_cpe_platforms()
    • XMLBenchmark.find_rule()
    • XMLBenchmark.find_rules()
  • XMLCPEPlatform
    • XMLCPEPlatform.find_all_check_fact_ref_elements()
  • XMLComponent
    • XMLComponent.find_boolean_question()
    • XMLComponent.find_ocil_boolean_question()
    • XMLComponent.find_ocil_questionnaire()
    • XMLComponent.find_ocil_test_action()
    • XMLComponent.find_oval_definition()
  • XMLContent
    • XMLContent.check_engines
    • XMLContent.find_benchmark()
    • XMLContent.get_benchmarks()
    • XMLContent.get_component_refs()
    • XMLContent.get_uris()
    • XMLContent.is_benchmark()
  • XMLElement
    • XMLElement.get_attr()
    • XMLElement.get_namespace()
    • XMLElement.ns
  • XMLOcilQuestion
    • XMLOcilQuestion.get_question_test_element()
  • XMLOcilQuestionnaire
    • XMLOcilQuestionnaire.get_test_action_ref_element()
  • XMLOcilTestAction
  • XMLOvalDefinition
    • XMLOvalDefinition.get_criteria_element()
    • XMLOvalDefinition.get_elements()
  • XMLRule
    • XMLRule.get_all_platform_elements()
    • XMLRule.get_check_content_ref_element()
    • XMLRule.get_check_element()
    • XMLRule.get_element_text()
    • XMLRule.get_fix_element()
    • XMLRule.get_version_element()
    • XMLRule.join_text_elements()
  • add_xhtml_namespace()
  • determine_xccdf_tree_namespace()
  • get_element_namespace()
  • get_element_tag_without_ns()
  • get_namespaces_from()
  • map_elements_to_their_ids()
  • open_xml()
  • oval_generated_header()
  • parse_file()
  • register_namespaces()
• ssg.yaml module
  • DocumentationNotComplete
  • convert_string_to_bool()
  • open_and_expand()
  • open_and_macro_expand()
  • open_raw()
  • ordered_dump()
  • ordered_load()
  • update_yaml_list_or_string()

Module contents