RepoMirrors/setools
1
0
Fork 0
mirror of https://github.com/SELinuxProject/setools synced 2025-03-25 04:26:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Further README revision and formatting.

Browse Source
This commit is contained in:
Chris PeBenito 2015-03-31 10:31:59 -04:00
parent d6ea1014a0
commit f24a8237ab
1 changed files with 10 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -1,4 +1,4 @@
# SETools - Policy analysis tools for SELinux # SETools: Policy analysis tools for SELinux
https://github.com/TresysTechnology/setools/wiki https://github.com/TresysTechnology/setools/wiki
## Overview ## Overview
@ -8,75 +8,52 @@ is a collection of graphical tools, command-line tools, and libraries
designed to facilitate SELinux policy analysis. Please consult the designed to facilitate SELinux policy analysis. Please consult the
KNOWN-BUGS file prior to reporting bugs. KNOWN-BUGS file prior to reporting bugs.
## Installation ## Installation
SETools uses the Python setuptools build system to build, and install. SETools uses the Python setuptools build system to build, and install.
As such it contains a setup.py script that will install the tools. As such it contains a setup.py script that will install the tools.
SETools requires the following development packages for building:
* Python 2.7 or 3.3+
* setuptools
* gcc
* bison
* flex
* libselinux
* libsepol 2.4+
* libbz2
* SWIG 2.0.12+ or 3.0+
To build SETools' graphical tools, the following packages are required:
TBD
To run SETools, the following packages are required: To run SETools, the following packages are required:
* Python 2.7 or 3.3+ * Python 2.7 or 3.3+
* NetworkX 1.8+ * NetworkX 1.8+
* setuptools * setuptools
* libselinux * libselinux
* libsepol 2.4+
* libbz2 * libbz2
To run SETools unit tests, the following packages are required: To build SETools, the following development packages are required, in
* Python 2.7 or 3.3+ addition to the development packages from the above list:
* setuptools
* gcc * gcc
* bison * bison
* flex * flex
* libselinux
* libsepol 2.4+ * libsepol 2.4+
* checkpolicy 2.4+
* libbz2
* SWIG 2.0.12+ or 3.0+ * SWIG 2.0.12+ or 3.0+
To run SETools unit tests, the following packages are required, in
addition to the above dependencies:
* mock (on Python 2.7 only) * mock (on Python 2.7 only)
* tox (optional) * tox (optional)
### Building SETools ### Building SETools
Unpack the official distribution or check out the git repository, Unpack the official distribution or check out the git repository,
and perform the following: and perform the following at the root:
``` ```
$ cd setools
$ python setup.py build $ python setup.py build
$ python setup.py install $ python setup.py install
``` ```
This will put the applications in /usr/bin, data files in /usr/share/setools, This will put the applications in /usr/bin, data files in /usr/share/setools,
and libraries in /usr/lib/pythonX.Y/site-packages/setools. and libraries in /usr/lib/pythonX.Y/site-packages/setools.
### Installation Options ### Installation Options
Please see `python setup.py --help` or `python setup.py install --help` Please see `python setup.py --help` or `python setup.py install --help`
for up-to-date information on build and install options, respectively. for up-to-date information on build and install options, respectively.
### Unit Tests ### Unit Tests
One goal for SETools is to provide confidence in the validity of the One goal for SETools is to provide confidence in the validity of the
output for the tools. The unit tests for SETools can be run with output for the tools. The unit tests for SETools can be run with
the following command the following command
``` ```
$ python setup.py test $ python setup.py test
``` ```
@ -87,12 +64,10 @@ SETools encompasses a number of tools, both graphical and command
line, and libraries. Many of the programs have help files accessible line, and libraries. Many of the programs have help files accessible
during runtime. during runtime.
### Graphical tools ### Graphical tools
TBD TBD
### Command-line tools ### Command-line tools
Some tools in the SETools suite may be run in a terminal Some tools in the SETools suite may be run in a terminal
@ -105,15 +80,13 @@ seinfo | A tool to get a list of policy components.
seinfoflow | A tool to perform information flow analysis. seinfoflow | A tool to perform information flow analysis.
sesearch | A tool to search rules (allow, type_transition, etc.) sesearch | A tool to search rules (allow, type_transition, etc.)
### Analysis Libraries ### Analysis Libraries
The SETools support libraries are available for use in third-party The SETools libraries are available for use in third-party
applications. Although they are not officially supported (and thus applications. Although this is are not officially supported (and thus
subject to change between SETools releases), we will do our best to subject to change between SETools releases), we will do our best to
maintain API stability. maintain API stability.
### Obtaining SETools ### Obtaining SETools
Official releases of SETools may be freely downloaded from: Official releases of SETools may be freely downloaded from:
@ -122,11 +95,9 @@ https://github.com/TresysTechnology/setools/releases
SETools source code is maintained within a GitHub repository. SETools source code is maintained within a GitHub repository.
From the command line do: From the command line do:
``` ```
$ git clone https://github.com/TresysTechnology/setools.git $ git clone https://github.com/TresysTechnology/setools.git
``` ```
You may also browse the GitHub repository at You may also browse the GitHub repository at
https://github.com/TresysTechnology/setools. https://github.com/TresysTechnology/setools.
@ -134,14 +105,12 @@ SETools included in most Linux distributions which support
SELinux, such as Fedora, Red Hat Enterprise Linux, Gentoo, SELinux, such as Fedora, Red Hat Enterprise Linux, Gentoo,
and Debian. and Debian.
### Reporting bugs ### Reporting bugs
Bugs can be reported in the SETools GitHub issues tracker: Bugs can be reported in the SETools GitHub issues tracker:
https://github.com/TresysTechnology/setools/issues https://github.com/TresysTechnology/setools/issues
### Copyright license ### Copyright license
The intent is to allow free use of this source code. All programs' The intent is to allow free use of this source code. All programs'
@ -149,5 +118,4 @@ source files are copyright protected and freely distributed under the
GNU General Public License (see COPYING.GPL). All library source GNU General Public License (see COPYING.GPL). All library source
files are copyright under the GNU Lesser General Public License (see files are copyright under the GNU Lesser General Public License (see
COPYING.LGPL). All files distributed with this package indicate the COPYING.LGPL). All files distributed with this package indicate the
appropriate license to use with that file. Absolutely no warranty is appropriate license to use. Absolutely no warranty is provided or implied.
provided or implied.