Skip to main content

Tamper-evident BAC contribution attribution ledger

Project description

๐Ÿงญ Bensz Auto Contribution

Tamper-evident contribution attribution for human-AI software collaboration

Release Python BAC Format License

English | ไธญๆ–‡


โœจ Introduction

Bensz Auto Contribution, or BAC, is a contribution attribution and audit system designed for AI coding tools. Its core artifact is a .bac file: a project-bound, append-only, tamper-evident record of what came from humans, what came from AI, what came from tools, and what evidence was observed during development.

BAC does not claim that a file can never be modified. Instead, it makes changes detectable through structured events, canonical JSON, hash chaining, local checkpoints, project context binding, and future-ready signature and timestamp fields.

๐ŸŒŸ Core Highlight: BAC gives AI coding sessions a durable audit trail. It helps teams explain AI usage, review collaboration boundaries, verify generated work, and reconstruct development history without mixing human intent, AI generation, tool output, and file evidence into one vague blob.

Key Features

  • ๐Ÿง‘โ€๐Ÿ’ป Human-AI Attribution: Explicitly separates human, ai, tool, and system sources.
  • ๐Ÿงพ Append-Only Event Model: Records contribution history as ordered events instead of overwriting prior state.
  • ๐Ÿ”— Hash-Chain Verification: Detects modified, inserted, deleted, duplicated, or reordered events.
  • ๐Ÿ“ฆ Single-File .bac Container: Stores a ZIP-based v2 ledger with manifest.json and canonical JSON event files.
  • ๐Ÿ›ก๏ธ Tamper-Evident Security Boundary: Describes integrity guarantees honestly without overstating immutability.
  • โฑ๏ธ Private Anchors: Supports local mode and hybrid mode with blinded remote anchor receipts.
  • ๐Ÿง  AI Tool Ready: Designed for Codex CLI, Claude Code, and other agentic coding environments.
  • ๐Ÿ” Evidence-Aware Records: Captures file hashes, git diff summaries, command text, exit codes, test results, and checkpoints.
  • ๐Ÿงผ Sensitive Data Redaction: Avoids storing secrets, private prompts, or unrelated user data by default.

โญ If this project helps you, please give it a Star!

Building reliable attribution for AI-assisted work takes careful design, testing, and threat modeling. Your Star helps more builders discover BAC.

Star History Chart


๐Ÿš€ Quick Start

Prerequisites

  • Python 3.10+
  • No runtime third-party dependencies

Installation

python -m pip install bensz-auto-contribution

# source or development install
python -m pip install -e .

Basic Usage

Create a single-file .bac container and write the genesis event:

bac init

Record a human requirement:

bac record \
  --event-type human_instruction \
  --source-type human \
  --summary "Add BAC verification workflow"

Record AI generation or implementation intent:

bac record \
  --event-type ai_generation \
  --source-type ai \
  --summary "Implemented hash-chain verifier"

Record a tool result:

bac record \
  --event-type test_result \
  --source-type tool \
  --summary "Unit tests passed" \
  --command-text "python -m unittest discover -s tests -v" \
  --exit-code 0

Record a local checkpoint to reduce tail-truncation risk:

bac record \
  --event-type checkpoint \
  --source-type system \
  --summary "Local checkpoint"

Verify integrity:

bac verify

Inspect the contribution timeline:

bac inspect

Extract human contributions, optionally by date:

bac inspect --human
bac inspect --human --on 2026-05-31
bac inspect --source-type human --since 2026-05-01 --until 2026-05-31 --json

Date-only --since, --until, and --on values are interpreted as UTC calendar dates. --until 2026-05-31 includes events through the end of that UTC date; pass an ISO-8601 timestamp for an exact boundary.

All commands support --root for the target project root and --bac-file for a custom .bac path. init, record, verify, and inspect also support --json for machine-readable output.

Private Anchor Workflow

bac init defaults to hybrid mode while keeping records local-first. It can create a blinded anchor request without uploading .bac content, file paths, diffs, prompts, actors, project names, or the raw head_hash:

bac anchor request --json

Import a signed receipt from an anchor service:

bac anchor import --receipt-file receipt.json --public-key "$ANCHOR_PUBLIC_KEY"
bac verify --require-anchor

For a configured service:

bac config set anchor.url http://localhost:8080
bac anchor push --allow-insecure-anchor-url

bac anchor push allows only safe https:// public URLs by default, including DNS resolution checks for private and local addresses. The explicit insecure flag is intended for local development only. For production anchor servers that require a write token, pass --token or set BAC_ANCHOR_API_TOKEN; BAC does not write that token into .bac.

For a user-facing BAC Cloud flow, users can register or log in, store a local token outside .bac, and bind a project ledger:

bac cloud register --url https://bac.example.com --email user@example.com
bac cloud login --url https://bac.example.com --email user@example.com
bac cloud link --url https://bac.example.com --ledger-name my-project
bac cloud status

bac cloud link creates a server-side ledger, enables anchor.require plus automatic anchoring, and immediately anchors the newly linked ledger head. Future bac record calls still write the local .bac file, then submit a blinded anchor_hash and low-sensitivity client_summary to the configured service. The service returns a signed receipt that is appended locally as an anchored checkpoint.

The optional reference service lives in server/ and can be started with:

docker compose -f server/docker-compose.yml up --build

๐Ÿงฉ Where BAC Fits

BAC is a process record and audit aid, not a final judge of contribution ownership.

In AI-assisted research, writing, and software projects, BAC can record human requirements, constraints, reviews, hand-written edits, final approvals, AI drafts, refactoring proposals, generated code, command outputs, tests, citation checks, build logs, file snapshots, and diff summaries.

These records can support AI usage disclosure, internal review, compliance notes, and dispute reconstruction. They do not automatically determine academic authorship, legal ownership, or final responsibility. Those decisions still require project policy, institutional rules, journal guidelines, and human judgment.

๐Ÿ“ฆ .bac Format

The default file is project.bac. Externally, it is one file. Internally, it is a ZIP container with at least:

manifest.json
events/000000000001.json
events/000000000002.json

manifest.json records the container version, event format, project binding information, genesis event hash, and storage conventions. Each file under events/ is one canonical JSON event. Event filenames are continuous and start at 000000000001.json.

A BAC event includes:

  • format: currently bac.event.v2
  • event_type: examples include genesis, human_instruction, ai_generation, tool_command, file_change, test_result, and checkpoint
  • source_type: one of human, ai, tool, or system
  • trust_level: one of declared, observed, signed, verified, or anchored; signed is reserved until event signatures are implemented, and anchored is valid only for checkpoint events with a verified remote receipt
  • project: root path, project binding hash, git remote, commit, branch, and dirty state
  • payload: summary, command data, file snapshots, or event-specific content
  • evidence: diff summaries, file hashes, command results, or other verifiable evidence
  • redactions: fields removed or masked for safety
  • prev_event_hash and event_hash: the verifiable hash chain

The verifier checks whether the file is a valid ZIP container, whether internal paths are duplicated, whether event numbering is continuous, whether the manifest matches the genesis event, and whether the hash chain can be recomputed.

For a field-by-field walkthrough, see BAC Tutorial.

๐Ÿ›ก๏ธ Security Model

BAC is tamper-evident, not tamper-proof.

It can detect common integrity problems such as edited event content, missing events, reordered events, duplicated internal ZIP paths, broken event numbering, mismatched genesis metadata, invalid hash links, and checkpoint inconsistencies.

Without an external anchor, a purely local hash chain cannot fully prevent tail truncation. BAC therefore supports local checkpoints and remote signed receipts. A valid receipt proves that a blinded ledger head existed at the service timestamp; it does not prove that every real-world action was recorded.

The verifier treats .bac files as untrusted input: it bounds container size, event count, and JSON member size before reading. The reference anchor server is open for local development, but production mode requires bearer tokens for anchor writes, admin access, and ledger receipt queries.

๐Ÿงช Development

Run the test suite:

python -m pytest -q
python -m unittest discover -s tests -v

Current coverage includes canonicalization, v2 container structure, hash-chain recomputation, tamper detection, duplicate internal path detection, checkpoint verification, private anchor receipt verification, sensitive data redaction, server API flows, and CLI end-to-end flows.

Build and check PyPI distributions locally:

python -m pip install --upgrade build twine
python -m build
python -m twine check dist/*

Releases are published to PyPI through GitHub Actions and PyPI Trusted Publishing. See PyPI Release.

Publish the BAC Anchor Server Docker image directly to DockerHub as linux/amd64:

make dockerhub-publish

See DockerHub Release. This path is intentionally local/publisher-machine based and does not use GitHub Actions.

๐Ÿ—‚๏ธ Project Structure

bensz-auto-contribution/
โ”œโ”€โ”€ AGENTS.md
โ”œโ”€โ”€ CHANGELOG.md
โ”œโ”€โ”€ CLAUDE.md
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ README.zh-CN.md
โ”œโ”€โ”€ docs
โ”‚   โ”œโ”€โ”€ bac-tutorial.md
โ”‚   โ”œโ”€โ”€ dockerhub-release.md
โ”‚   โ”œโ”€โ”€ pypi-release.md
โ”‚   โ””โ”€โ”€ plans
โ”œโ”€โ”€ Makefile
โ”œโ”€โ”€ pyproject.toml
โ”œโ”€โ”€ src
โ”‚   โ””โ”€โ”€ bac
โ”‚       โ”œโ”€โ”€ adapters
โ”‚       โ”œโ”€โ”€ core
โ”‚       โ”œโ”€โ”€ report
โ”‚       โ”œโ”€โ”€ service
โ”‚       โ””โ”€โ”€ storage
โ”œโ”€โ”€ tests
โ”œโ”€โ”€ tools
โ””โ”€โ”€ server

๐Ÿค– AI-Assisted Development

This repository includes project instructions for AI coding tools:

  • AGENTS.md for OpenAI Codex CLI
  • CLAUDE.md for Claude Code

When changing contribution attribution logic, keep the security boundary precise: BAC provides verifiable, tamper-evident records. It should not be described as impossible to modify.

๐Ÿค Contributing

Issues and pull requests are welcome around the .bac file format, threat model, AI tool integration, verification logic, signing and timestamping, and developer experience.

๐Ÿ“„ License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bensz_auto_contribution-1.2.3.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bensz_auto_contribution-1.2.3-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file bensz_auto_contribution-1.2.3.tar.gz.

File metadata

  • Download URL: bensz_auto_contribution-1.2.3.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for bensz_auto_contribution-1.2.3.tar.gz
Algorithm Hash digest
SHA256 e8ac43484e783c015e7065d322a8a696507a7bfd58c366d9100974c80da3e9f0
MD5 0577dc4b3fa539240fece5a22781085b
BLAKE2b-256 fb13db457fcd0fe76cf1c8eba7e92f80d520ef349189830a937038735c2913d0

See more details on using hashes here.

File details

Details for the file bensz_auto_contribution-1.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for bensz_auto_contribution-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 806552a806b939496c4f0230cf1a42f4ca0324abbef1d857833b6e12f7bd68e3
MD5 7594cf3f91a37699d63618c443a26289
BLAKE2b-256 ca1c641000509bc5a459a32364490b8e024482aedfefd9613ffde602f66253e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page