# analysis-toolkit
The analysis toolkit is a collection of scripts designed to assist auditors analyze the results of the KP system auditing scripts maintained at:
* [Linux](https://github.com/kirkpatrickprice/linux-audit-scripts)
* [Windows](https://github.com/kirkpatrickprice/windows-audit-scripts)
* [MacOS](https://github.com/kirkpatrickprice/macos-auditor)
## Critical dependencies ##
* Shell: a recent version of `bash`
* Python: A recent release of version 3. Both 3.8 (Ubuntu 20.04) and 3.10 (Ubuntu 22.04) should be fine
* Misc. commands: `grep` `echo` `awk` `sort`
The scripts have been tested and are usually used on Ubuntu distributions. They were developed on WSL instances of Ubuntu 20.04 and 22.04. YMMV on other distributions or versions, but I don't foresee any problems, say, on a MacOS Terminal prompt.
For KP auditors, I strongly recommend following the [Getting started with WSL](https://kirkpatrickprice.atlassian.net/l/c/jP0AuG7j) and [Bashing Our Way to Efficient Audits](https://kirkpatrickprice.atlassian.net/l/c/6oaQWQpv) pages on Confluence.
I also recommend that you use the Windows Terminal app available from the Microsoft Store. Among other numerous benefits, this will allow to click on hyperlinks created by some of the tools.
## Installation ##
Installation is as simple as cloning this repo to your system.
Change to your favorite location where you'd like to install them. A sub-directory will be created called `analysis-toolkit`. If you're not sure where to put them, create a `tools` directory under home directory (the examples below assume this is your path).
```
mkdir ~/tools # If the tools directory doesn't already exist...
cd ~/tools
git clone https://github.com/kirkpatrickprice/analysis-toolkit
```
Edit your user's .bashrc file
`nano ~/.bashrc`
And add the `analysis-toolkit` directory to your path by appending the following to the end of the file
`export PATH="${HOME}/tools:${HOME}/tools/analysis-toolkit:${PATH}"`
With the `analysis-toolkit` in your path, you will be able to use these commands anywhere in your Bash shell prompt.
Now, you'll need to install the Python dependencies. If you'll be using your Python install for more than just the analysis toolkit, you might want to create a `venv` to run it in. Check out https://python.land/virtual-environments/virtualenv if you need a tutorial. Then...
```
cd ~/tools/analysis-tookit
python3 -m pip install --upgrade pip # Upgrade PIP if it's not already up to date
python3 -m pip install -r requirements.txt # Install the packages listed in the file
```
## Updating the toolkit ##
Change to the analysis-toolkit directory
`cd ~/tools/analysis-toolkit`
And issue the following `git` commands. Any changes you might have made in this directory will be overwritten.
```
git fetch
git reset --hard HEAD
git merge
```
If you get any errors from Python about missing packages, re-run the PIP-related commands from the Installation section above to make sure you have all the dependencies installed.
## Using the toolkit scripts ##
Each toolkit script includes a "help" function to explain the options.
`<script> -h`
Raw data
{
"_id": null,
"home_page": null,
"name": "kp-analysis-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "pii discovery, data discovery, credit card discovery",
"author": null,
"author_email": "Randy Bartels <rjbartels@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/af/1f/3fc7b3baf98df6ee0c7a18f81a199f9f76885ad23ae8cfaa807660730908/kp_analysis_toolkit-1.0.1.tar.gz",
"platform": null,
"description": "# analysis-toolkit\n\nThe analysis toolkit is a collection of scripts designed to assist auditors analyze the results of the KP system auditing scripts maintained at:\n* [Linux](https://github.com/kirkpatrickprice/linux-audit-scripts) \n* [Windows](https://github.com/kirkpatrickprice/windows-audit-scripts)\n* [MacOS](https://github.com/kirkpatrickprice/macos-auditor)\n\n## Critical dependencies ##\n* Shell: a recent version of `bash`\n* Python: A recent release of version 3. Both 3.8 (Ubuntu 20.04) and 3.10 (Ubuntu 22.04) should be fine\n* Misc.\u00a0commands:\u00a0\u00a0\u00a0`grep`\u00a0`echo`\u00a0`awk`\u00a0`sort`\n\nThe scripts have been tested and are usually used on Ubuntu distributions. They were developed on WSL instances of Ubuntu 20.04 and 22.04. YMMV on other distributions or versions, but I don't foresee any problems, say, on a MacOS Terminal prompt.\n\nFor KP auditors, I strongly recommend following the [Getting started with WSL](https://kirkpatrickprice.atlassian.net/l/c/jP0AuG7j) and [Bashing Our Way to Efficient Audits](https://kirkpatrickprice.atlassian.net/l/c/6oaQWQpv) pages on Confluence.\n\nI also recommend that you use the Windows Terminal app available from the Microsoft Store. Among other numerous benefits, this will allow to click on hyperlinks created by some of the tools.\n\n## Installation ##\nInstallation is as simple as cloning this repo to your system.\n\nChange to your favorite location where you'd like to install them. A sub-directory will be created called `analysis-toolkit`. If you're not sure where to put them, create a `tools` directory under home directory (the examples below assume this is your path).\n\n```\nmkdir ~/tools # If the tools directory doesn't already exist...\ncd ~/tools\ngit clone https://github.com/kirkpatrickprice/analysis-toolkit\n```\n\nEdit your user's .bashrc file\n\n`nano ~/.bashrc`\n\nAnd add the `analysis-toolkit` directory to your path by appending the following to the end of the file\n\n`export PATH=\"${HOME}/tools:${HOME}/tools/analysis-toolkit:${PATH}\"`\n\nWith the `analysis-toolkit` in your path, you will be able to use these commands anywhere in your Bash shell prompt.\n\nNow, you'll need to install the Python dependencies. If you'll be using your Python install for more than just the analysis toolkit, you might want to create a `venv` to run it in. Check out https://python.land/virtual-environments/virtualenv if you need a tutorial. Then...\n```\ncd ~/tools/analysis-tookit\npython3 -m pip install --upgrade pip # Upgrade PIP if it's not already up to date\npython3 -m pip install -r requirements.txt # Install the packages listed in the file\n```\n\n## Updating the toolkit ##\nChange to the analysis-toolkit directory\n\n`cd ~/tools/analysis-toolkit`\n\nAnd issue the following `git` commands. Any changes you might have made in this directory will be overwritten.\n```\ngit fetch\ngit reset --hard HEAD\ngit merge\n```\n\nIf you get any errors from Python about missing packages, re-run the PIP-related commands from the Installation section above to make sure you have all the dependencies installed.\n\n## Using the toolkit scripts ##\nEach toolkit script includes a \"help\" function to explain the options.\n\n`<script> -h`\n",
"bugtrack_url": null,
"license": null,
"summary": "Python utilities to parse technical information for security audits",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/kirkpatrickprice/analysis-toolkit",
"Issues": "https://github.com/kirkpatrickprice/analysis-toolkit/issues"
},
"split_keywords": [
"pii discovery",
" data discovery",
" credit card discovery"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2091edd5fa5f2793e3bfc43b587382b4c41223b76e6d124eeee1417e044c3608",
"md5": "02013f05663f82bc069c5cc147dfcce5",
"sha256": "fc343ef82d51693222502b9bbbb1c62285e5ebee309c342f05cb4db55b3d39a1"
},
"downloads": -1,
"filename": "kp_analysis_toolkit-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02013f05663f82bc069c5cc147dfcce5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 82469,
"upload_time": "2025-01-26T16:12:56",
"upload_time_iso_8601": "2025-01-26T16:12:56.100770Z",
"url": "https://files.pythonhosted.org/packages/20/91/edd5fa5f2793e3bfc43b587382b4c41223b76e6d124eeee1417e044c3608/kp_analysis_toolkit-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "af1f3fc7b3baf98df6ee0c7a18f81a199f9f76885ad23ae8cfaa807660730908",
"md5": "3ae26b9ab3453890cfcdf4b1b94e0fde",
"sha256": "7a37131c130191453187fc0ae37c3479823dc5f82799ec49b14b59efa47d1f90"
},
"downloads": -1,
"filename": "kp_analysis_toolkit-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3ae26b9ab3453890cfcdf4b1b94e0fde",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 71083,
"upload_time": "2025-01-26T16:12:57",
"upload_time_iso_8601": "2025-01-26T16:12:57.217706Z",
"url": "https://files.pythonhosted.org/packages/af/1f/3fc7b3baf98df6ee0c7a18f81a199f9f76885ad23ae8cfaa807660730908/kp_analysis_toolkit-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-26 16:12:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kirkpatrickprice",
"github_project": "analysis-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "kp-analysis-toolkit"
}
JSON
