Metadata-Version: 2.4
Name: badass-runner
Version: 0.3.2
Summary: BADASS Local Runner — connects local AI endpoints to BADASS Cloud
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other transformations
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean, as defined by the copyright owner,
              any work of authorship, including the original version of the Work and
              any modifications or additions to that Work or Derivative Works of the
              Work, that is intentionally submitted to the Licensor for inclusion
              in the Work by the copyright owner or by an individual or Legal Entity
              authorized to submit on behalf of the copyright owner. For the purposes
              of this definition, "submitted" means any form of electronic, verbal,
              or written communication sent to the Licensor or its representatives,
              including but not limited to communication on electronic mailing lists,
              source code control systems, and issue tracking systems that are managed
              by, or on behalf of, the Licensor for the purpose of discussing and
              improving the Work, but excluding communication that is conspicuously
              marked or designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by the combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a cross-claim
              or counterclaim in a lawsuit) alleging that the Work or any
              Contribution embodied within the Work constitutes direct or contributory
              patent infringement, then any patent licenses granted to You under
              this License for that Work shall terminate as of the date such
              litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, in
                  at least one of the following places: within a NOTICE text
                  file distributed as part of the Derivative Works; within
                  the Source form or documentation, if provided along with the
                  Derivative Works; or, within a display generated by the
                  Derivative Works, if and wherever such third-party notices
                  normally appear. The contents of the NOTICE file are for
                  informational purposes only and do not modify the License.
                  You may add Your own attribution notices within Derivative
                  Works that You distribute, alongside or in addition to the
                  NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the
                  License.
        
              You may add Your own license statement for Your modifications and
              may provide additional grant of rights to use, modify, or distribute
              Your modifications, or for such Derivative Works as a whole, under
              the terms of this License, if Your distribution includes the Work in
              Source or Object form.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or all other
              commercial damages or losses), even if such Contributor has been
              advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may offer only
              conditions that are consistent with this License and for which you
              can fully compensate each other Contributor for any damages,
              incurred by such Contributor as a result of warranty, indemnity,
              or other liability obligations you accept.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2026 BADASS Security
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0
Requires-Dist: httpx>=0.28.0
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Dynamic: license-file

# BADASS Connector

> **Connect your local or private AI endpoints to BADASS Cloud for adversarial security testing.**

---

## What it is

The BADASS Connector (`badass-runner`) is a lightweight Python agent you run on your own machine or server. It creates a secure, outbound-only channel between a local AI endpoint and the BADASS Cloud testing platform.

Once connected, BADASS Cloud can dispatch adversarial harness tests against your endpoint, collect sanitized results, and surface findings — all without your endpoint ever being exposed to the public internet.

## Why it exists

Many AI systems under test run behind:

- corporate VPNs
- private cloud networks
- localhost development environments
- firewalls that block inbound connections

BADASS Cloud cannot reach these endpoints directly. The connector solves this by running **inside** your network and pulling jobs from the cloud rather than receiving inbound traffic.

Your endpoint never needs a public IP address. Your credentials never leave your machine.

---

## Requirements

- Python **3.11** or later
- Network access to `https://badass-sec.com` (outbound HTTPS only)
- The AI endpoint you want to test (reachable from the machine running the connector)

---

## Installation

### From PyPI (recommended)

```bash
pip install badass-runner
```

### From source

```bash
git clone https://github.com/DKB8man/badass-connector
cd badass-connector
pip install .
```

### Verify

```bash
badass-runner --version
```

See [docs/install.md](docs/install.md) for detailed install options, virtual environment setup, and environment variable reference.

---

## Quick start

### 1. Pair this machine with BADASS Cloud

```bash
badass-runner login --server-url https://badass-sec.com
```

This opens a browser window showing a short pairing code. Approve it in the BADASS Cloud dashboard. No token or password is required on the command line — the credential is negotiated during the pairing handshake and saved locally.

You only need to run `login` once per machine.

### 2. Start the connector

```bash
badass-runner start
```

The connector runs in the foreground, sends a heartbeat to the cloud every 30 seconds, and polls for harness jobs assigned to it. When a job arrives it executes the test sequence locally against your endpoint, strips credentials from the results, and uploads the sanitized transcript.

Press **Ctrl-C** or run `badass-runner stop` (from another terminal) to shut it down.

### 3. Check status

```bash
badass-runner status
```

---

## Testing private and local AI apps

The connector targets any HTTP endpoint that accepts a text message and returns a text reply — the same interface used by most chat-completion, agent, and RAG APIs.

**Typical configuration in the BADASS Cloud dashboard:**

| Field | Example |
|---|---|
| Base URL | `http://localhost:8000` |
| Message path | `/api/chat` |
| Method | `POST` |
| Request field | `message` |
| Response field | `reply` |
| Auth type | `bearer` / `api_key` / `none` |

Credentials (API keys, Bearer tokens) are stored in the connector's **local auth store** on your machine and looked up at runtime. They are never sent to the cloud. See [Where credentials live](#where-credentials-live) below.

---

## Alternative: token-based registration

If your workflow does not support a browser (CI pipelines, headless servers), you can generate a one-time registration token in the BADASS Cloud dashboard and pass it directly:

```bash
badass-runner start \
  --server-url https://badass-sec.com \
  --token    badass_reg_YOURTOKEN \
  --name     my-ci-runner
```

The token is consumed on first use and replaced with a long-lived runner credential stored in the local config file.

---

## Where credentials live

All connector state is stored in `~/.badass-runner/` (overridable with `$BADASS_RUNNER_HOME`):

```
~/.badass-runner/
  config.json   # runner_id, runner_token, server_url, runner_name
  runner.pid    # PID of the running connector process
```

`config.json` is written with permissions **0600** (owner read/write only). It contains:

- `server_url` — the BADASS Cloud base URL
- `runner_name` — a human-readable label you chose
- `runner_id` — your runner's UUID assigned by the cloud
- `runner_token` — the long-lived bearer token used to authenticate job polls and result uploads

**Your API keys and endpoint credentials are never written to `config.json`.** They are managed separately through the BADASS Cloud dashboard and resolved by the connector at job execution time from your local auth store.

---

## What data is uploaded

When the connector completes a harness test, it uploads to BADASS Cloud:

| Data | Description |
|---|---|
| Run status | `DONE`, `FAILED`, or `CANCELLED` |
| Per-test turn sequences | The messages sent to and received from your endpoint, with auth headers stripped |
| Endpoint metadata | Base URL, method, path, auth type (not auth values) |
| Validation evidence | Pattern-match results used to determine PASS/FAIL |
| Error messages | Failure reasons, passed through credential redaction before upload |

## What is never uploaded

The connector is designed so the following data **never leaves your machine**:

| Data | Handling |
|---|---|
| API keys | Stored locally; injected into requests at runtime; never included in uploaded results |
| Bearer tokens | Stripped from all request/response transcripts before upload |
| Cookies | Stripped from all transcripts; cookie values are replaced with `[REDACTED]` |
| Raw `Authorization` headers | Removed from all uploaded turn data |
| `X-Api-Key`, `X-Auth-Token` headers | Removed from all uploaded turn data |
| Proxy or VPN credentials | Never read or transmitted by the connector |
| Quoted-assignment secrets in log lines | Caught and redacted by the text-level redactor before error strings are uploaded |

See [docs/security-model.md](docs/security-model.md) for the full technical description of the redaction layer.

---

## Commands

| Command | Description |
|---|---|
| `badass-runner login` | Pair this machine with BADASS Cloud via browser |
| `badass-runner start` | Start the connector (foreground) |
| `badass-runner status` | Show whether a connector process is running locally |
| `badass-runner stop` | Send SIGTERM to the running connector |
| `badass-runner recorder` | HTTP traffic recorder for endpoint discovery |
| `badass-runner --version` | Print connector version |
| `badass-runner --help` | Show all commands and options |

---

## Environment variables

| Variable | Default | Description |
|---|---|---|
| `BADASS_SERVER_URL` | — | Cloud base URL (replaces `--server-url`) |
| `BADASS_REG_TOKEN` | — | One-time registration token (replaces `--token`) |
| `BADASS_RUNNER_NAME` | — | Runner label (replaces `--name`) |
| `BADASS_RUNNER_HOME` | `~/.badass-runner` | Override config directory |
| `BADASS_STATUS_PORT` | `7890` | Local status server port |

---

## Local status server

While running, the connector exposes a read-only HTTP status endpoint on localhost at port 7890 (configurable via `--port` or `BADASS_STATUS_PORT`). This is **not** accessible from outside the machine. It is intended for local monitoring integrations.

---

## Security

See [SECURITY.md](SECURITY.md) for how to report vulnerabilities and our data handling commitments.

See [docs/security-model.md](docs/security-model.md) for a full description of what data the connector handles, what it redacts, and what it uploads.

---

## License

See `LICENSE` file.
