codeguard-cli 2.0.0__tar.gz

codeguard_cli-2.0.0/.gitignore

@@ -0,0 +1,308 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+PYTHONPATH
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Node.js
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+
+# Vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# React build output
+build/
+
+# IDE and Editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Database files
+*.db
+*.sqlite
+*.sqlite3
+
+# Log files
+*.log
+logs/
+
+# Temporary files
+*.tmp
+*.temp
+
+# API keys and secrets
+.env.local
+.env.production
+.env.development
+config/secrets.json
+secrets/
+
+# ML models and data
+models/
+data/
+*.pkl
+*.joblib
+*.h5
+*.pb
+
+# Documentation build
+docs/build/
+docs/_build/
+
+# Test artifacts
+test-results/
+screenshots/
+videos/

codeguard_cli-2.0.0/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to CodeGuard are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
+CodeGuard follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html). From
+`2.0.0` the rule IDs, `Finding` / JSON schema, config keys, and CLI exit codes are a
+stable contract.
+
+Entries are assembled by [towncrier](https://towncrier.readthedocs.io/) from news
+fragments in `changelog.d/` — run `towncrier build --draft` to preview unreleased
+changes.
+
+`2.0.0` is a large step from the `0.1` alpha (multi-language scanning, config file,
+diff-aware CI, baselines, packaged distribution). See
+[docs/migration-v2.md](docs/migration-v2.md) for every backward-incompatible change.
+
+<!-- towncrier release notes start -->
+
+## [2.0.0] - 2026-08-31
+
+### Breaking changes
+
+- Exit codes `3` (config error) and `4` (internal error) are now distinct from `2` (usage error); `0` and `1` are unchanged. The `scan --severity` flag is a deprecated alias of the new `--fail-on` (which controls the exit code); `--fail-on` defaults to `info`.
+- The PyPI project is now `codeguard-cli` (the bare `codeguard` name belongs to an unrelated project). The installed command and the import package are both still `codeguard`. Install with `pipx install codeguard-cli` / `uv tool install codeguard-cli` / `pip install codeguard-cli`.
+- The rule API changed: `Rule.check(tree, source, filename)` is now `Rule.analyze(ctx)`, taking a `RuleContext`, and every rule declares a `languages` set. Python rules that subclass the new `AstRule` keep their `check_ast(tree, source, filename)` method unchanged. A new `codeguard.lang` package provides the language adapter layer for the tree-sitter backends.
+- `--format json` now emits an envelope object — `{ schema_version, tool, rules, results, summary }` — with a per-finding `fingerprint`. The previous bare-array output is available as `--format json-legacy` for one minor version and prints a deprecation warning.
+- `Location.col` (and `end_col`) is now 1-indexed to match editors and SARIF. JSON `location.col` values shift by one; SARIF column values are unchanged in effect (the formatter no longer adds its own offset).
+
+### Added
+
+- Added `codeguard.toml` / `pyproject.toml [tool.codeguard]` configuration: `include`/`exclude`, `fail_on`, `output`, `jobs`, `gitignore`, `[rules] enable`/`disable`, per-rule `severity`/`confidence_min`, `[severity_remap]`, and path-scoped `[[overrides]]`. Config is discovered by walking up to the repository root; `codeguard validate` checks it and a starter file comes from `codeguard init`. ([#7](https://github.com/mevichitra/codeguard/issues/7))
+- Suppression comments gained governance: a `reason:` is expected (bare ones raise `CG-META-001`), an `until=YYYY-MM-DD` reactivates the finding once past (`CG-META-002`), the file-level keyword is now `ignore-file[...]` (`disable[...]` is a deprecated alias), and `codeguard suppressions list [--expired] [--unused]` audits every suppression with an active/expired/unused status. `//` comments work for JavaScript and TypeScript. ([#9](https://github.com/mevichitra/codeguard/issues/9))
+- Added a `.pre-commit-hooks.yaml` (hook ids `codeguard`, `codeguard-full`, `codeguard-ci`) and a composite GitHub Action at `action/` — `uses: mevichitra/codeguard/action@v2` — that runs `codeguard ci` and uploads SARIF to code scanning. ([#13](https://github.com/mevichitra/codeguard/issues/13))
+- Added six JavaScript / TypeScript security rules (the `CG-SEC-1xx` block): dynamic code execution via `eval` / `new Function` / string timers (CG-SEC-101), `child_process.exec` shell injection (CG-SEC-102), DOM XSS sinks like `innerHTML` and `document.write` (CG-SEC-103), React `dangerouslySetInnerHTML` (CG-SEC-104), hardcoded secrets (CG-SEC-105), and `Math.random()` used for tokens or secrets (CG-SEC-106). ([#14](https://github.com/mevichitra/codeguard/issues/14))
+- Added the tree-sitter language backends for JavaScript (`.js/.jsx/.mjs/.cjs`) and TypeScript (`.ts/.tsx/.mts/.cts`). `SourceNode` now wraps tree-sitter nodes as well as Python `ast` nodes, with `child_by_field` for named children. Grammars load lazily, so a Python-only scan never imports tree-sitter.
+- Directory scans now honour the repository `.gitignore`, skip vendor/tooling directories (`.venv`, `node_modules`, `__pycache__`, `dist`, ...) and generated files (`*.min.js`, `*.d.ts`) by default, and never follow directory symlinks. `AnalysisRunner.run_files(..., jobs=N)` fans a scan across a process pool with output identical to a sequential run.
+- Every finding now carries a stable `fingerprint` (scheme `codeguard/v1`) derived from the rule, the file, the enclosing function/class, and the normalized statement — stable across reformatting and line moves. SARIF output emits it as `partialFingerprints`, and it is the identity key for the baseline and diff workflows.
+- New `codeguard ci` command: diff-aware scanning for pull requests. It scans only files changed since the base branch (auto-detected, or `--diff REF`), applies the baseline, defaults to GitHub Actions annotations, and can also write a SARIF report with `--sarif PATH`.
+- New baseline support: `codeguard baseline create / update / prune` writes a fingerprint file of today's findings, and `scan --baseline PATH` (or `baseline = "..."` in config) marks those findings so they no longer fail the run. Baselined findings are hidden by default, revealed with `--show-suppressed`.
+- New commands: `codeguard list-rules`, `codeguard explain <RULE-ID>`, `codeguard validate`, and `codeguard init`.
+- SARIF output gained `partialFingerprints`, `security-severity`, `helpUri`, and CWE taxonomy tags on each rule.
+- Three new `--format` options: `github` (GitHub Actions annotations), `rdjson` (reviewdog), and `junit` (JUnit XML).
+- `codeguard scan --diff REF` restricts a scan to files changed since REF (merge-base with HEAD), including uncommitted and untracked changes.
+- `codeguard scan` accepts multiple paths, reads stdin with `-`, and gains `--config`, `--exclude`/`--include`, `--fail-on`/`--exit-zero`, `--no-gitignore`, `-j/--jobs`, `-q/--quiet`, and `--no-color`.
+
+### Fixed
+
+- CG-SEC-005 now flags `os.system`, `os.popen`, `subprocess.getoutput`, and `subprocess.getstatusoutput` with a non-literal argument -- these always use a shell and have no `shell=` keyword, so they were previously missed entirely. ([#3](https://github.com/mevichitra/codeguard/issues/3))
+- CG-SEC-004 and CG-SEC-005 now resolve import aliases, so `from pickle import loads`, `import subprocess as sp`, and `from os import system as sh` are detected. A shared resolver (`codeguard.rules._pyimports`) handles this. ([#4](https://github.com/mevichitra/codeguard/issues/4))
+- CG-SEC-001 no longer reports a false positive for a multi-part concatenation of string literals such as `"SELECT " + " * " + " FROM t"`; the whole `+` tree is checked, not just the outermost operands. ([#5](https://github.com/mevichitra/codeguard/issues/5))
+- Added the missing `.license-header.txt` so the `insert-license` pre-commit hook passes on a clean checkout.
+- Fixed all in-repo GitHub URLs, which pointed at a non-existent `codeguard-ai/codeguard` org, to `mevichitra/codeguard` (including the SARIF `informationUri`).
+
+### Documentation
+
+- Added a documentation site (`docs/`, MkDocs + Material) covering install, usage, exit codes, suppressions, output formats, CI, architecture, and a v2 migration guide; published to GitHub Pages on release.
+- Corrected the CWE reference for CG-SEC-003 in the README (CWE-95, matching the rule).
+- Filled in the "Migrating to v2" guide with the changes that have landed (package rename, 1-indexed columns, JSON envelope, `--fail-on`, exit codes 3/4, gitignore-aware discovery, rule API).
+- Rewrote the "Adding a rule" guide for the new `AstRule` / `analyze(ctx)` API and the import-alias resolver.
+
+### Internal
+
+- Added `TreeSitterRule`, a base class for JS/TS rules that walk a `SourceNode` tree, and `codeguard.rules._jsnodes` with call / argument / literal helpers. `run_benchmark.py` now also picks up `.js` / `.jsx` / `.ts` / `.tsx` corpus samples.
+- Changelog is now assembled by towncrier from fragments in `changelog.d/`.
+- Moved the abandoned FastAPI backend and the two React frontends (which shared no code with the CLI) into `archive/`; they are no longer built, tested, or released.
+- Overhauled CI: concurrency cancellation, pip caching, a Windows/macOS/Python 3.13 test matrix, a build-and-install smoke test, `pip-audit`, a docs build, an old-org URL guard, and a changelog-fragment check. The release workflow now runs lint, types, and tests behind a tag/version consistency check before publishing.
+- Seeded `benchmarks/corpus/` with true/false-positive cases for CG-SEC-001, CG-SEC-004, and CG-SEC-005 (precision and recall 1.0 on the seed set).
+- Switched the build backend from setuptools to hatchling; the version is single-sourced from `src/codeguard/__init__.py`.
+- Test fixtures moved to `tests/fixtures/<language>/<category>/<rule_id>/` and `conftest.load_fixture` gained a leading `language` argument, so JavaScript and TypeScript rules can carry their own fixtures.
+- `scan` and `ci` share a single implementation (`codeguard.cli._run`); the `Finding` model gains a `baselined` flag.
+
+
+## [0.1.0]
+
+Initial alpha: AST rule engine, CLI (`scan`), and five security rules
+(CG-SEC-001..005) with human / JSON / SARIF output and inline suppression comments.
+
+[0.1.0]: https://github.com/mevichitra/codeguard/releases/tag/v0.1.0

codeguard_cli-2.0.0/LICENSE

@@ -0,0 +1,184 @@
+                                 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 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, as 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 otherwise 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 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 any
+      Contribution embodied within the Work constitutes direct or
+      contributory patent infringement, then any patent rights 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 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on its own or as part of the Work, subject to
+      the terms and conditions of 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 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 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 2024 CodeGuard 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.