Metadata-Version: 2.4
Name: akii
Version: 0.0.1
Summary: HTTP header analyzer
Author: Mintesio
License: MIT License
        
        Copyright (c) 2026 Mintesio
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.32.0
Requires-Dist: PyYAML>=6.0
Requires-Dist: colorama>=0.4.6
Requires-Dist: packaging>=24.0
Dynamic: license-file

# AkII

> A lightweight HTTP security analysis toolkit

AkII is an open-source security tool designed to analyze HTTP security configurations and identify common web security misconfigurations.

It focuses on analyzing HTTP responses, security headers, and related security mechanisms to help security researchers and developers identify potential weaknesses.

> **⚠️ Pre-release**
>
> AkII is currently a pre-release version and is not considered production-ready. Some features are incomplete, and breaking changes may occur as the project evolves. New security checks and improvements will be added in future releases.

## Features

* Analyze HTTP security headers
* CORS security analysis
* Passive security checks
* Automated security configuration comparison
* Human-readable terminal output
* JSON output for automation
* Lightweight and extensible YAML-based rule system

## Overview

AkII is built to be extensible and automation-friendly.

The goal is to provide a consistent way to analyze HTTP security configurations across multiple targets.

It is designed for:

* Security automation
* Bug bounty workflows
* Web application security testing
* Batch analysis of multiple targets
* Integration with custom security pipelines

## Installation

### From PyPI (Recommended)

```bash
pipx install akii
```

or:

```bash
pip install akii
```

### From Source

```bash
git clone https://github.com/Mintesio/AkII.git
cd akii
pip install -e .
```

## Update

To update AkII, use the command matching your installation method.

### Installed with pip

```bash
pip install --upgrade akii
```

or:

```bash
pip install -U akii
```

### Installed with pipx

```bash
pipx upgrade akii
```

Update all pipx packages:

```bash
pipx upgrade-all
```

### Check Current Version

```bash
akii --version
```

If you encounter problems after updating, make sure you are running the latest version before reporting an issue.

## Uninstallation

### Installed with pipx

```bash
pipx uninstall akii
```

### Installed with pip

```bash
pip uninstall akii
```

### Installed from source

```bash
pip uninstall akii
cd ..
rm -rf akii
```

## Usage

### Scan a Single Target

```bash
akii -T https://example.com
```

### Scan Multiple Targets

```bash
akii -w targets.txt
```

### Show Request Headers

```bash
akii -T https://example.com --request
```

### Show Response Headers

```bash
akii -T https://example.com --response
```

### Verbose Mode

```bash
akii -T https://example.com --verbose
```

### Save Report

```bash
akii -T https://example.com -o report.txt
```

### Export JSON

```bash
akii -T https://example.com -j report.json
```

## Project Structure

```
src
├─ core: Application logic, controller, CLI handling, and argument parsing.
├─ http: HTTP client responsible for request handling.
├─ scan: Coordinates scanning workflows and security checks.
├─ checks: Security analysis modules such as CORS, CSP, Cookies, and HSTS.
├─ templates: YAML-based security rule definitions.
└─ output: Terminal formatting and report generation.
```

## Current Checks

### Cross-Origin Resource Sharing (CORS)

Current MVP focus.

Planned CORS capabilities:

* Passive CORS analysis
* Origin behavior analysis
* Misconfiguration detection
* Header comparison
* Automated CORS testing scenarios

More security checks will be added in future releases.

## Roadmap

### Security Checks

* [ ] Complete CORS analysis

  * [ ] Passive analysis
  * [ ] Origin comparison
  * [ ] Automated test cases
  * [ ] Fuzzing support

* [ ] HSTS analysis

* [ ] Cookie security analysis

* [ ] Cache-Control analysis

* [ ] Permissions-Policy analysis

* [ ] Referrer-Policy analysis

* [ ] Content Security Policy (CSP)

### Output & Integration

* [ ] HTML reports
* [ ] Improved JSON reporting
* [ ] Plugin system
* [ ] Custom rule support

## Contributing

Contributions are welcome.

If you find a bug, have a feature request, or want to improve AkII, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License.
