Skip to content

KP Analysis Toolkit Documentation

Welcome to the comprehensive documentation for the KP Analysis Toolkit - a Python application designed to assist auditors with analyzing and processing various types of data encountered during security assessments.

About the Toolkit

The KP Analysis Toolkit provides specialized modules for different data formats and analysis tasks commonly used in information security audits. Built by KirkpatrickPrice, this toolkit streamlines the audit process by automating data collection analysis, format conversion, and reporting tasks.

Introducing KPAT Video

Available Documentation

📚 User Guides

Comprehensive guides for using the toolkit's features and modules:

🏗️ Architecture Documentation

Coming Soon - Technical documentation for developers:

  • System Architecture - Overall design and component relationships
  • Module Documentation - Detailed technical specifications for each module
  • API Reference - Programmatic interfaces and integration points
  • Development Guide - Contributing and extending the toolkit

Toolkit Modules

The KP Analysis Toolkit currently includes three main modules:

Process Scripts

Processes text files generated by KirkpatrickPrice's OS-specific collection scripts. Provides flexible search capabilities, automated analysis, and comprehensive reporting through Excel workbooks.

Supported Collection Scripts:

Nipper Expander

Transforms Nipper CSV export files from compact format (multiple devices per row) into expanded format (one row per device per finding), making vulnerability analysis easier with Excel pivot tables and other analysis tools.

RTF to Text Converter

Converts Rich Text Format (RTF) files to plain text files using ASCII encoding. Particularly useful when customers provide router/firewall configurations as RTF documents instead of plaintext files.

Quick Start

  1. Install the toolkit using the installation guide
  2. Review PowerShell basics if you're new to command line interfaces
  3. Choose your module based on your analysis needs
  4. Follow the specific user guide for your chosen module

Getting Help

Documentation

  • Browse the User Guides for step-by-step instructions
  • Check the PowerShell Primer for command line help
  • Review module-specific guides for detailed usage instructions

Support Resources

  • GitHub Repository: analysis-toolkit
  • Issue Reporting: Use the GitHub Issues tab for bug reports and feature requests

System Requirements

  • Python 3.14 or higher
  • Windows, macOS, or Linux (Windows is the primary development platform)
  • Command line interface (PowerShell recommended for Windows users)

About KirkpatrickPrice

KirkpatrickPrice is an information security auditing firm specializing in compliance frameworks including SOC 1, SOC 2, PCI DSS, HIPAA, HITRUST CSF, GDPR, ISO 27001, and FISMA audits, as well as penetration testing.

Ready to get started? Begin with the User Guides or jump directly to Installation.