maskguard 1.0.0__tar.gz

maskguard-1.0.0/.env.example

@@ -0,0 +1,27 @@
+# DEVELOPMENT settings (synthetic demo data). For production see deploy/production.env.example and docs/DEPLOYMENT.md.
+# Copy to .env (never commit .env) and export before running, e.g.  set -a; source .env; set +a
+# Windows PowerShell:  Get-Content .env | ForEach-Object { if ($_ -match '^([^#=]+)=(.*)$') { Set-Item "env:$($matches[1])" $matches[2] } }
+
+# Database: sqlite:///data/bank.db | postgresql://user:pw@host:5432/bank | mysql://user:pw@host:3306/bank
+MASKGUARD_DB=sqlite:///data/bank.db
+
+# Required. Key for analyst HMAC tokens: at least 16 random bytes, e.g. `python -c "import secrets;print(secrets.token_hex(32))"`
+MASKGUARD_HMAC_KEY=
+# Recommended. Signs session tokens; without it tokens are invalidated on every restart.
+MASKGUARD_JWT_SECRET=
+
+# development (default) | production. Any other value is refused. Production refuses to start unless the user store,
+# secrets, database account and network settings are safe (docs/DEPLOYMENT.md).
+MASKGUARD_ENV=development
+# 1 = one-click demo identities (admin.ann, support.sam, analyst.ali, auditor.aud). Never in production.
+MASKGUARD_DEMO=1
+
+MASKGUARD_POLICY=policies/default.yaml
+MASKGUARD_USERS=policies/users.demo.yaml
+MASKGUARD_OVERRIDES=policies/overrides.yaml
+MASKGUARD_AUDIT=data/audit.jsonl
+MASKGUARD_REGISTRY=data/registry.yaml
+MASKGUARD_SCAN_INTERVAL=300
+
+# CLI only: talk to a running API instead of the in-process engine
+# MASKGUARD_API=http://127.0.0.1:8000

maskguard-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16
+        env: {POSTGRES_PASSWORD: maskguard, POSTGRES_DB: bank}
+        ports: ["5432:5432"]
+        options: --health-cmd "pg_isready -U postgres" --health-interval 2s --health-retries 30
+      mysql:
+        image: mysql:8.4
+        env: {MYSQL_ROOT_PASSWORD: maskguard, MYSQL_DATABASE: bank}
+        ports: ["3306:3306"]
+        options: --health-cmd "mysqladmin ping -h 127.0.0.1 -pmaskguard" --health-interval 3s --health-retries 40
+    env:
+      MASKGUARD_HMAC_KEY: ci-only-hmac-key
+      MASKGUARD_JWT_SECRET: ci-only-jwt-secret-0123456789-0123456789
+      MASKGUARD_TEST_PG: postgresql://postgres:maskguard@127.0.0.1:5432/bank
+      MASKGUARD_TEST_MYSQL: mysql://root:maskguard@127.0.0.1:3306/bank
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: sudo apt-get update && sudo apt-get install -y postgresql-client
+      - run: uv sync
+      - name: Tests on SQLite, PostgreSQL and MySQL
+        run: uv run pytest -q
+      - name: Attack suite must report zero leaks
+        run: uv run maskguard attack -u analyst.ali -p analyst123
+      - name: Security regression (attack suite per role + integrity proof)
+        run: uv run maskguard test
+      - uses: actions/setup-node@v4
+        with: {node-version: 20}
+      - name: Postman collection against a live API (Newman)
+        # Start the API from the synced venv, not `uv run`: a live `uv run` holds uv's cache lock, and setup-uv's
+        # post-job `uv cache prune` then waits on it until it times out and fails the job. Stop it on exit too.
+        run: |
+          MASKGUARD_DB=sqlite:///$RUNNER_TEMP/newman.db MASKGUARD_AUDIT=$RUNNER_TEMP/a.jsonl MASKGUARD_REGISTRY=$RUNNER_TEMP/r.yaml \
+            .venv/bin/maskguard serve --port 8000 > $RUNNER_TEMP/api.log 2>&1 &
+          API_PID=$!
+          trap 'kill $API_PID 2>/dev/null || true' EXIT
+          for i in $(seq 1 60); do curl -sf http://127.0.0.1:8000/health && break; sleep 1; done
+          npx -y newman@6 run postman/Smart-Data-Masking.postman_collection.json -e postman/Local.postman_environment.json \
+            --reporters cli,junit --reporter-junit-export newman.xml

maskguard-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release
+
+# Publishes to PyPI when a version tag (v1.0.0, v1.0.1, …) is pushed. Uses PyPI Trusted Publishing: PyPI trusts this
+# repository's workflow directly, so no API token is stored anywhere. One-time setup is in docs/RELEASING.md.
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:          # manual run: builds and smoke-tests, publishes only for a tag
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - name: Tag matches the package version
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: test "${GITHUB_REF_NAME#v}" = "$(uv version --short)"
+      - name: Build wheel and sdist
+        run: uv build
+      - name: Install the wheel in a clean environment and run it from an empty folder
+        run: |
+          uv venv /tmp/smoke
+          VIRTUAL_ENV=/tmp/smoke uv pip install dist/*.whl
+          cd "$(mktemp -d)"
+          MASKGUARD_HMAC_KEY=release-smoke-key /tmp/smoke/bin/maskguard status
+          MASKGUARD_HMAC_KEY=release-smoke-key /tmp/smoke/bin/maskguard compare "SELECT name, ssn FROM users LIMIT 1" --roles admin,support
+          # production must refuse the demo user store bundled in the package (exit code 4)
+          set +e
+          MASKGUARD_ENV=production MASKGUARD_JWT_SECRET="$(openssl rand -hex 32)" MASKGUARD_HMAC_KEY="$(openssl rand -hex 32)" \
+            MASKGUARD_DB=postgresql://x@127.0.0.1:1/x /tmp/smoke/bin/maskguard status
+          test $? -eq 4
+      - uses: actions/upload-artifact@v4
+        with: {name: dist, path: dist/}
+
+  publish:
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write         # lets PyPI verify this workflow (Trusted Publishing)
+    steps:
+      - uses: actions/download-artifact@v4
+        with: {name: dist, path: dist/}
+      - uses: pypa/gh-action-pypi-publish@release/v1

maskguard-1.0.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+data/
+.env
+deploy/production.env
+deploy/secrets/

maskguard-1.0.0/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.12-slim
+RUN apt-get update && apt-get install -y --no-install-recommends libgomp1 && rm -rf /var/lib/apt/lists/*
+RUN pip install --no-cache-dir uv==0.8.22
+WORKDIR /app
+COPY pyproject.toml uv.lock README.md ./
+COPY src ./src
+RUN uv sync --frozen --no-dev
+COPY policies ./policies
+COPY bench ./bench
+COPY postman ./postman
+ENV PATH="/app/.venv/bin:$PATH" PYTHONUNBUFFERED=1
+EXPOSE 8000 8501
+CMD ["maskguard", "serve", "--host", "0.0.0.0", "--port", "8000"]

maskguard-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

maskguard-1.0.0/Makefile

@@ -0,0 +1,40 @@
+export MASKGUARD_HMAC_KEY ?= dev-only-hmac-key-change-me
+export MASKGUARD_JWT_SECRET ?= dev-only-jwt-secret-change-me-0123456789
+
+.PHONY: install test test-pg bench dashboard api scan attack postman demo up down
+
+install:
+	uv sync
+
+test:
+	uv run pytest -q
+
+test-pg:            ## needs a running Postgres, e.g. `docker compose up -d postgres`
+	MASKGUARD_TEST_PG=postgresql://maskguard:maskguard@127.0.0.1:5432/bank uv run pytest -q
+
+bench:
+	uv run python bench/overhead.py
+
+dashboard:
+	uv run maskguard dashboard
+
+api:
+	uv run maskguard serve
+
+scan:
+	uv run maskguard scan
+
+attack:
+	uv run maskguard attack -u analyst.ali -p analyst123
+
+postman:            ## API must be running on :8000
+	npx -y newman@6 run postman/Smart-Data-Masking.postman_collection.json -e postman/Local.postman_environment.json
+
+demo:               ## interactive security console
+	uv run maskguard
+
+up:
+	docker compose up --build
+
+down:
+	docker compose down

maskguard-1.0.0/NOTICE

@@ -0,0 +1,7 @@
+MaskGuard
+Copyright 2026 G. Harshith, G. Praneeth, D. Mandeep and K. Surya Srinivas
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+MaskGuard's code, synthetic training data generator and trained models are original work. The external benchmark
+used for evaluation (bharat-pii-bench) is run separately and is not included in this repository.

maskguard-1.0.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.5
+Name: maskguard
+Version: 1.0.0
+Summary: AI-powered PII discovery and query-time, role-based masking gateway for PostgreSQL, MySQL and SQLite
+Project-URL: Homepage, https://github.com/hotaro6754/mask
+Project-URL: Documentation, https://github.com/hotaro6754/mask/blob/claude/zealous-bell-me62fn/docs/GUIDE.md
+Project-URL: Source, https://github.com/hotaro6754/mask
+Author: G. Harshith, G. Praneeth, D. Mandeep, K. Surya Srinivas
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: aadhaar,data-masking,dpdp,gateway,mysql,pii,postgresql,privacy,security
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Security
+Requires-Python: >=3.10
+Requires-Dist: faker
+Requires-Dist: fastapi>=0.143.0
+Requires-Dist: joblib>=1.6.0
+Requires-Dist: lightgbm>=4.7.0
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: psycopg[binary]>=3.3.6
+Requires-Dist: pyjwt>=2.15.1
+Requires-Dist: pymysql>=1.2.3
+Requires-Dist: python-stdnum
+Requires-Dist: pyyaml
+Requires-Dist: rich>=13
+Requires-Dist: scikit-learn>=1.7.2
+Requires-Dist: sqlglot
+Requires-Dist: streamlit>=1.65.0
+Requires-Dist: typer>=0.12
+Requires-Dist: uvicorn>=0.54.0
+Description-Content-Type: text/markdown
+
+# MaskGuard
+
+**AI-powered PII discovery and query-time, role-based masking for PostgreSQL, MySQL and SQLite.**
+
+MaskGuard is a gateway between people and the database. It finds sensitive columns by looking at their values (a
+LightGBM classifier plus checksum validators for Aadhaar, PAN, GSTIN, cards, IBAN and more). It rewrites every query
+so the database itself returns only what the caller's role may see. It watches for probing, and records every
+decision in a hash-chained audit log. Stored data never changes.
+
+| Role | Sees |
+|---|---|
+| Admin | real values |
+| Support | partial masks: `4111-XXXX-XXXX-1111`, `XXX-XX-6789`, `r***@bank.in`, rounded balances |
+| Analyst | keyed tokens (joinable, not reversible); no individual balances |
+| Auditor | `REDACTED`, plus the audit log, policies and integrity proofs |
+
+![One query as four roles](https://raw.githubusercontent.com/hotaro6754/mask/claude/zealous-bell-me62fn/docs/img/control-room-playground.png)
+
+## Install and try it
+
+```bash
+pip install maskguard
+export MASKGUARD_HMAC_KEY=dev-only-hmac-key-change-me     # Windows PowerShell: $env:MASKGUARD_HMAC_KEY="..."
+maskguard                                                # console with synthetic demo data (created in ./data/)
+maskguard compare "SELECT name, ssn, phone FROM users LIMIT 2" --roles admin,support,analyst,auditor
+maskguard serve                                          # REST API + Control Room at http://127.0.0.1:8000/ui/
+```
+
+Demo logins: `admin.ann`, `support.sam`, `analyst.ali` and `auditor.aud`, each with password `<role>123`. Data,
+the audit log and the scanner registry are written to `./data/` in the folder you run it from.
+
+To use your own database, set `MASKGUARD_DB` (`postgresql://…` or `mysql://…`). For real data, run in production
+mode (`MASKGUARD_ENV=production`): it refuses to start on any unsafe setting.
+
+## Results
+
+- **PII discovery:** 0.965 F1 with misleading column names and 5 sample values per column; the benchmark baseline
+  scores 0.844.
+- **Attack suite:** 0 of 17 bypass and inference attacks leak, against 14–15 of 17 for output-only masking.
+- **Tests:** 476 tests on SQLite, PostgreSQL 16 and MySQL 8.4.
+- **Latency:** about 8 ms added per query.
+
+## Learn more
+
+- [README and screenshots](https://github.com/hotaro6754/mask/blob/claude/zealous-bell-me62fn/README.md)
+- [Beginner's guide](https://github.com/hotaro6754/mask/blob/claude/zealous-bell-me62fn/docs/GUIDE.md): every term,
+  with diagrams and step-by-step workflows
+- [Deployment guide](https://github.com/hotaro6754/mask/blob/claude/zealous-bell-me62fn/docs/DEPLOYMENT.md)
+- [8-minute walkthrough video](https://github.com/hotaro6754/mask/blob/claude/zealous-bell-me62fn/docs/demo_full.mp4)
+
+Noisy analyst aggregates are experimental and refused in production until an independent privacy review. Licensed
+under Apache-2.0.