Skip to content

Commit

Permalink
standardizing header formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
skipmcgee authored May 25, 2022
1 parent 5768a43 commit 32ceda7
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Approved for open-source release via C21099 / C22007 as rhelhostinfo v1.x, authored by Skip McGee`

# Abstract:
## Abstract:
<pre>
rhelhostinfo v1.X adds some functionality to the existing rhelhostinfo project by enumerating host configuration information and
identifying changes over time. It provides a framework that allows organizations to modify the application
Expand All @@ -11,7 +11,7 @@ conduct limited packet capture and identify relevant network information. It use
to enumerate security-relevant information about the host and the surrounding network and report relevant changes.
</pre>

# Objective
## Objective
<pre>
rhelhostinfo primarily provides passive host inventory and change detection via the --checkconfig option
and active host inventory and change detection on an IPv4 /24 network segment via the --scan option.
Expand All @@ -23,7 +23,7 @@ tailoring to needs and desires as appropriate. Finally, the data generated by th
to an enterprise log server for parsing, alerting, reporting and display.
</pre>

# Requirements
## Requirements
<pre>
1. The syslog client (rsyslog / syslog-ng) is configured and functional on your RHEL host
2. If use of the openscap functionality is desired, use the openscap guide at:
Expand All @@ -35,7 +35,7 @@ Substitute in your organization's name for the profile variables in app/openscap

## Useage:
1. Use the latest rpm artifact to the [workflow](https://github.com/lanl/rhelhostinfo/actions/workflows/rpmbuild.yml) or fork this repo and build your own rpm!
2. Install the rpm 'rpm -Uvh <path_to_rpm>'
2. Install the rpm `rpm -Uvh <path_to_rpm>`
3. To run via the installed rpm:
`rhelhostinfo --help`
<pre>
Expand Down Expand Up @@ -110,6 +110,7 @@ optional arguments:
│   └── rhel8-no-gui-tailoring.xml
└──Software_Bill_of_Materials.md
</pre>

2. To run natively in python3:
+ `yum install rh-python38`
+ `python3 -m venv venv`
Expand All @@ -119,8 +120,8 @@ optional arguments:
+ `python3 main.py <option>`

## Additional resources and references:
+ openscap project: ``https://www.open-scap.org/``
+ lynis: ``https://cisofy.com/lynis/``
+ [openscap project](https://www.open-scap.org/)
+ [lynis](https://cisofy.com/lynis/)

## Still to do / functionality to add:
1. Consider scapy for limited packet capture / scripting options?
Expand Down

0 comments on commit 32ceda7

Please sign in to comment.