Metadata-Version: 2.4
Name: openldap-audit2json
Version: 0.1.2
Summary: A tool to convert OpenLDAP audit logs to JSON format
Project-URL: Homepage, https://github.com/InkbridgeNetworks/openldap-audit2json
Project-URL: GitHub, https://github.com/InkbridgeNetworks/openldap-audit2json
Project-URL: Issues, https://github.com/InkbridgeNetworks/openldap-audit2json/issues
Author: Ethan Thompson, Arran Cudbard-Bell
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: aiofiles
Requires-Dist: watchfiles
Description-Content-Type: text/markdown

# Openldap-Audit2JSON
A tool for automatically parsing an Openldap audit log, converting the logs to JSON, and then sending the formatted logs to a destination server.

## Setup
To use the tool, we will first need to setup the environment to be able to install pip packages. The steps are as follows:
1. Create a Python virtual environment using `python3 -m venv .venv`
2. Make sure the environment is activated by running `source .venv/bin/activate`
3. (For development only) Install the requirements using `pip install -r requirements.txt`

## Installing the pip package
To install the distribution package, download the up-to-date version from the [package repository](https://pypi.inkbridge.io/openldap-audit2json) and in your virtual environment, run `pip install /path/to/gzip-tarball`.

## (OPTIONAL) Build and Install from Source
To build and install the project from the source code found on the [GitHub repository](https://github.com/InkbridgeNetworks/openldap-audit2json), follow the instructions below:
1. Clone the repository to your location machine using `git clone https://github.com/InkbridgeNetworks/openldap-audit2json.git`
2. Enter the project directory using `cd openldap-audit2json`
3. Install the required dependancies using `pip install -r requirements.txt`
4. Install the `build` package using `pip install build`
5. Build the package using `python3 -m build`
6. Install the package using `pip install dist/<name of gzip-tarball>`

After installing the tool, the following commands will be available in the virtual environment:
- `openldap-audit2json-config`: This will create any files or folders needed to use the tool on this host.
- `openldap-audit2json`: The command used to start the tool.

## Configure
To get started using the Openldap-Audit2JSON tool, we will first need to setup a config for the tool to use.
1. Run the `openldap-audit2json-config` command to create a config file on the host at `/etc/openldap-audit2json/config.ini`
2. Edit the options found in `/etc/openldap-audit2json/config.ini` using your editor of choice. In particular, you will want to make sure the `Source` and `Destination` configurations are correct.

## Running the Tool
To start the tool, simply run `openldap-audit2json`.