<commit_before>SELinux Policy Analysis Tool Help File
apol, version 1.2
January 2, 2004
<EMAIL>

This file contains basic help information for using apol, version 1.2 
This version of apol allows you to:

	+ examine, search, and relate policy components (types, type 
	attributes, object classes, object permissions, roles, and 
	users), and policy rules (type allow, neverallow, auditallow, 
	dontaudit, type_transition, type_change); and 
	
	+ perform some simple automated analysis of policies which 
	currently includes forward and reverse domain transition 
	analyses, direct information flow analysis, and an experimental 
	transitive (indirect) information flow analysis.

New in this version are several new automated analyses (see Analysis 
Tab below), to include reverse domain transition analysis, direct 
information flow analysis, and transitive information flow analysis.

Apol attempts to provide compatibility with the current and older 
policy syntax to allow one to analyze current and old policies.  As of 
this version, we believe the tools are compatible with all policy 
versions from Version 11 to the current Version 15.

See setools/ChangeLog-setools for a list of new features in this 
release. See setools/KNOWN_BUGS for a list of current bugs.

1. MENUS:  

Apol expects you to open a policy.conf file, and it expects that this 
file can be successfully parsed using checkpolicy -d.  Only one 
policy.conf file can be open at a time, so if you open another file, 
the current one will be closed.

The Query menu allows the user to save and/or load a query for a TE Rules
search or for an analysis module listed on the Analysis tab. Saving a 
query involves saving the required query parameters, as well as any 
specified filter settings to a file. Query files are saved with a '.qf' 
extension. Loading a query involves parsing the specified query file, 
raising the correct notebook tab in apol and configuring the query options 
with the specified query parameters and filter settings. Currently, the 
save query menu item is only enabled when the ANALYSIS TAB or the 
TE RULES TAB (see POLICY RULES TAB below) is raised. However, the load 
query menu item is enabled across all tabs. The Analysis menu also allows 
the user to display statistics about the currently loaded policy. A 
shorthand version of these statistics is always displayed on the status 
bar when a policy file is opened.

The Advanced menu currently allows you to directly manage permission 
mappings for apol's direct and transitive information flow analyses, 
which are new features in this version of the tool. You do not need to 
use this tab in order to perform an information flow analysis.  However 
you might need greater control over the mappings of permission to 
read/write access for a given analysis you are performing.  This tab 
gives you the flexibility to control these mappings directly.  The built-
in default mappings are based on the "mls" file distributed with the 
policy.  See the separate help file on information flow for more 
information about permission mappings and their management.

2. POLICY COMPONENTS TAB

These tabs allow you to examine, search, and relate the core 
components of an SELinux policy.

	I. TYPES TAB:<commit_msg>Minor change in help file.<commit_after>SELinux Policy Analysis Tool Help File
apol, version 1.2
January 2, 2004
<EMAIL>

This file contains basic help information for using apol, version 1.2 
This version of apol allows you to:

	+ examine, search, and relate policy components (types, type 
	attributes, object classes, object permissions, roles, and 
	users), and policy rules (type allow, neverallow, auditallow, 
	dontaudit, type_transition, type_change); and 
	
	+ perform some simple automated analysis of policies which 
	currently includes forward and reverse domain transition 
	analyses, direct information flow analysis, and an experimental 
	transitive (indirect) information flow analysis.

New in this version are several new automated analyses (see Analysis 
Tab below), to include reverse domain transition analysis, direct 
information flow analysis, and transitive information flow analysis.

Apol attempts to provide compatibility with the current and older 
policy syntax to allow one to analyze current and old policies.  As of 
this version, we believe the tools are compatible with all policy 
versions from Version 11 to the current Version 15.

See setools/ChangeLog-setools for a list of new features in this 
release. See setools/KNOWN_BUGS for a list of current bugs.

1. MENUS:  

Apol expects you to open a policy.conf file, and it expects that this 
file can be successfully parsed using checkpolicy -d.  Only one 
policy.conf file can be open at a time, so if you open another file, 
the current one will be closed.

The Query menu allows the user to save and/or load a query for a TE Rules
search or for an analysis module listed on the Analysis tab. Saving a 
query involves saving the required query parameters, as well as any 
specified filter settings to a file. Query files are saved with a '.qf' 
extension. Loading a query involves parsing the specified query file, 
raising the correct notebook tab in apol and configuring the query options 
with the specified query parameters and filter settings. Currently, the 
save query menu item is only enabled when the ANALYSIS TAB or the 
TE RULES TAB (see POLICY RULES TAB below) is raised. However, the load 
query menu item is enabled across all tabs. The Query menu also allows 
the user to display statistics about the currently loaded policy. A 
shorthand version of these statistics is always displayed on the status 
bar when a policy file is opened.

The Advanced menu currently allows you to directly manage permission 
mappings for apol's direct and transitive information flow analyses, 
which are new features in this version of the tool. You do not need to 
use this tab in order to perform an information flow analysis.  However 
you might need greater control over the mappings of permission to 
read/write access for a given analysis you are performing.  This tab 
gives you the flexibility to control these mappings directly.  The built-
in default mappings are based on the "mls" file distributed with the 
policy.  See the separate help file on information flow for more 
information about permission mappings and their management.

2. POLICY COMPONENTS TAB

These tabs allow you to examine, search, and relate the core 
components of an SELinux policy.

	I. TYPES TAB:
{'fraction_non_alphanumeric': 0.02951973080452738, 'fraction_numerical': 0.004588559192413582, 'mean_word_length': 4.30762987012987, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1522793', 'n_tokens_mistral': 1660, 'n_tokens_neox': 1565, 'n_words': 1015}