context-armor 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 as an addendum 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Context Armor contributors
+
+   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.

package/README.md

@@ -0,0 +1,260 @@
+# Context Armor
+
+**Know what an AI agent can see before it sees it.**
+
+Context Armor is a zero-dependency, local-first preflight scanner for secrets, personal data, and risky documents in AI workspaces. It scans source code **and** the business files that ordinary repository scanners miss: DOCX, XLSX, PPTX, PDF, and optionally images.
+
+```bash
+npx context-armor scan .
+```
+
+No account. No upload. No telemetry. Raw findings never appear in reports.
+
+> Status: early release. Context Armor is useful today, but it is not a substitute for credential rotation, access control, or a full DLP program.
+
+## Why this exists
+
+AI coding agents routinely receive access to an entire working directory. Real workspaces are rarely clean Git repositories: they contain contracts, tax exports, identity scans, screenshots, old backups, API keys, and customer lists.
+
+Most secret scanners answer, “Is this safe to commit?” Context Armor answers a different question:
+
+> “Is this directory safe to expose to an AI agent?”
+
+It was built after a real small-business workspace audit found credentials and personal documents mixed into the same directory as web projects.
+
+## What makes it different
+
+| Capability | Context Armor |
+| --- | --- |
+| Runs fully locally | Yes |
+| Runtime dependencies | Zero |
+| Source and plain-text files | Yes |
+| DOCX / XLSX / PPTX | Built-in ZIP/XML extraction |
+| PDF | Local `pdftotext`, when installed |
+| Images | Optional local Tesseract OCR |
+| Korean PII | Checksum-aware resident number and phone rules |
+| Safe reports | Redacted evidence plus one-way fingerprints |
+| AI-tool protection | Claude settings, `.cursorignore`, `.geminiignore` |
+| CI integration | GitHub Action, JSON, and SARIF |
+| Baseline support | Yes |
+
+Context Armor complements runtime agent firewalls and traditional secret scanners. It focuses on mixed, pre-existing workspace context before a session begins.
+
+## Quick start
+
+Requires Node.js 20 or newer.
+
+```bash
+# One-off scan
+npx context-armor scan .
+
+# Install globally
+npm install --global context-armor
+context-armor scan ~/work/project
+
+# Fail CI on high or critical findings
+context-armor scan . --fail-on high
+
+# Create local ignore and configuration files
+context-armor init .
+```
+
+Example output:
+
+```text
+Context Armor scanned 247 files in 183ms
+
+CRITICAL config/local.env:3:9 SECRET_ANTHROPIC_KEY
+         An Anthropic API key was found.
+HIGH     documents/id-scan.pdf FILE_IDENTITY_DOCUMENT_KR
+         The filename indicates a Korean identity document.
+LOW      README.md:42:11 PII_EMAIL
+         An email address was found.
+
+1 critical · 1 high · 0 medium · 1 low
+```
+
+The matched key, identity number, email, or card number is never printed or serialized.
+
+## Protect a workspace
+
+`protect` scans the directory and writes local deny lists for supported agents:
+
+```bash
+context-armor protect .
+```
+
+It creates or updates:
+
+- `.cursorignore`
+- `.geminiignore`
+- `.claude/settings.local.json`
+- `.context-armor/protected-paths.txt`
+
+Only paths with findings at or above the selected threshold are protected. Existing Cursor and Gemini ignore content is preserved in a clearly marked block. Existing Claude settings are merged, not replaced.
+
+```bash
+# Protect medium, high, and critical paths
+context-armor protect . --fail-on medium
+```
+
+Review generated policies before starting an agent. Ignore files are a defense-in-depth convenience, not a security sandbox.
+
+## Rich documents
+
+Context Armor treats an AI workspace as more than source code:
+
+| Format | Behavior |
+| --- | --- |
+| DOCX | Extracts document, header, footer, and comment XML |
+| XLSX | Extracts shared strings and worksheet XML |
+| PPTX | Extracts slide and speaker-note XML |
+| PDF | Uses local `pdftotext`; reports reduced coverage if unavailable |
+| PNG/JPEG/TIFF/WebP | Uses local Tesseract only with `--ocr` |
+| Legacy DOC/XLS/PPT | Filename rules only; richer extraction is planned |
+
+Install optional local extractors:
+
+```bash
+# macOS
+brew install poppler tesseract tesseract-lang
+
+# Ubuntu / Debian
+sudo apt-get install poppler-utils tesseract-ocr
+```
+
+Then verify coverage:
+
+```bash
+context-armor doctor
+context-armor scan . --ocr --ocr-languages eng+kor
+```
+
+## Rules
+
+The initial ruleset covers:
+
+- Private keys, AWS access keys, GitHub tokens
+- Anthropic, OpenAI, Google, Slack, and Stripe credentials
+- Database URLs with embedded credentials
+- JSON Web Tokens and hard-coded passwords
+- Luhn-valid payment card numbers
+- Korean resident registration numbers with legacy checksum validation
+- Korean mobile numbers, US SSNs, and email addresses
+- Sensitive filenames for environment files, keys, credentials, dumps, and Korean identity, financial, and legal documents
+
+Rules favor precision over counting every possible secret. Please open an issue for false positives or missing formats—using synthetic data only.
+
+## Configuration
+
+Run `context-armor init .` or create `context-armor.config.json`:
+
+```json
+{
+  "failOn": "high",
+  "maxFileSize": "8mb",
+  "maxFiles": 100000,
+  "documents": true,
+  "ocr": false,
+  "respectGitignore": true,
+  "ignore": ["fixtures/public/**"],
+  "disabledRules": ["PII_EMAIL"],
+  "severity": {
+    "PII_KR_PHONE": "high"
+  }
+}
+```
+
+Context Armor also reads `.contextarmorignore`. Its syntax follows the common Git ignore subset: comments, glob patterns, directories, and `!` negation.
+
+### Baselines
+
+Adopt Context Armor without hiding new problems:
+
+```bash
+context-armor scan . --write-baseline .context-armor-baseline.json --fail-on none
+context-armor scan . --baseline .context-armor-baseline.json --fail-on high
+```
+
+Baselines contain only one-way finding fingerprints.
+
+## GitHub Action
+
+```yaml
+name: Context Armor
+on: [push, pull_request]
+
+permissions:
+  contents: read
+  security-events: write
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: feelyday/context-armor@v0
+        with:
+          path: .
+          fail_on: high
+          output: context-armor-results.sarif
+      - uses: github/codeql-action/upload-sarif@v3
+        if: always()
+        with:
+          sarif_file: context-armor-results.sarif
+```
+
+The action executes the checked-out release directly. It does not install package dependencies.
+
+## Library API
+
+```js
+import { scan } from "context-armor";
+
+const report = await scan(".", {
+  failOn: "high",
+  documents: true,
+  ocr: false,
+  disabledRules: ["PII_EMAIL"],
+});
+
+console.log(report.summary);
+```
+
+## Privacy and threat model
+
+- File content is processed in memory on the local machine.
+- Context Armor makes no network requests.
+- Reports contain paths, rule identifiers, locations, and redacted evidence lengths.
+- Fingerprints are SHA-256-derived and intentionally do not preserve raw values.
+- Symbolic links are not followed.
+- ZIP extraction has entry and decompression bounds.
+- External document tools are invoked with argument arrays, never through a shell.
+
+Read [SECURITY.md](SECURITY.md) for limitations and reporting guidance.
+
+## Roadmap
+
+- More country-specific, checksum-aware PII packs
+- Better legacy Office and image metadata coverage
+- Safe shadow-workspace mode for analysis-only sessions
+- First-class hooks for more AI coding agents
+- Policy packs for GDPR, HIPAA, and Korean PIPA workflows
+- Community-maintained custom rules
+
+## 한국어
+
+Context Armor는 Claude, Codex, Cursor, Gemini 같은 AI 에이전트가 업무 폴더를 읽기 전에 API 키·개인정보·민감 문서를 로컬에서 점검하는 오픈소스 도구입니다. 소스코드뿐 아니라 DOCX, XLSX, PPTX, PDF와 선택적 이미지 OCR을 지원하며, 검사 내용은 외부로 전송하지 않습니다.
+
+```bash
+npx context-armor scan .
+npx context-armor protect .
+```
+
+한국 주민등록번호는 단순 숫자 패턴이 아니라 날짜 형태와 구형 체크섬을 함께 검증합니다. 오탐이나 추가로 필요한 국내 문서 형식은 실제 개인정보가 아닌 합성 예제로 제보해 주세요.
+
+## Contributing
+
+Bug reports, detection improvements, documentation, and regional PII expertise are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+Apache-2.0 © Context Armor contributors.

package/action.yml

@@ -0,0 +1,34 @@
+name: Context Armor
+description: Scan a workspace for secrets, PII, and risky documents before AI agents or CI process it.
+author: Context Armor contributors
+branding:
+  icon: shield
+  color: purple
+inputs:
+  path:
+    description: Directory to scan
+    required: false
+    default: .
+  fail_on:
+    description: Lowest severity that fails the action
+    required: false
+    default: high
+  output:
+    description: SARIF output path
+    required: false
+    default: context-armor-results.sarif
+runs:
+  using: composite
+  steps:
+    - name: Scan workspace
+      shell: bash
+      env:
+        CONTEXT_ARMOR_PATH: ${{ inputs.path }}
+        CONTEXT_ARMOR_FAIL_ON: ${{ inputs.fail_on }}
+        CONTEXT_ARMOR_OUTPUT: ${{ inputs.output }}
+      run: >-
+        node "$GITHUB_ACTION_PATH/bin/context-armor.js"
+        scan "$CONTEXT_ARMOR_PATH"
+        --format sarif
+        --output "$CONTEXT_ARMOR_OUTPUT"
+        --fail-on "$CONTEXT_ARMOR_FAIL_ON"

package/bin/context-armor.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { runCli } from "../src/cli.js";
+
+runCli(process.argv.slice(2)).catch((error) => {
+  const message = error instanceof Error ? error.message : String(error);
+  process.stderr.write(`context-armor: ${message}\n`);
+  process.exitCode = 2;
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "context-armor",
+  "version": "0.1.0",
+  "description": "Local-first preflight scanner for secrets, PII, and risky documents before AI agents read your workspace.",
+  "type": "module",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./rules": "./src/rules.js"
+  },
+  "bin": {
+    "context-armor": "bin/context-armor.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "action.yml",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "node --test",
+    "lint": "node --check bin/context-armor.js && node --check src/*.js",
+    "prepack": "npm run lint && npm test"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "ai",
+    "claude",
+    "codex",
+    "cursor",
+    "gemini",
+    "privacy",
+    "pii",
+    "secrets",
+    "security",
+    "dlp",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/feelyday/context-armor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/feelyday/context-armor/issues"
+  },
+  "homepage": "https://github.com/feelyday/context-armor#readme",
+  "license": "Apache-2.0",
+  "author": "Context Armor contributors"
+}