pinstack 0.1.0__tar.gz

pinstack-0.1.0/LICENSE

@@ -0,0 +1,194 @@
+                                 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, "submit" 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 tracking
+      modifications to 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 patent
+      claim embodied in the Work constitutes direct or indirect 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, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as separate from the 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 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 such obligations 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 format in use; we also recommend that a
+      file and/or class name and description be included on the same
+      "printed page" as the copyright notice for easier identification
+      within third-party archives.
+
+   Copyright 2024 smthmlk
+
+   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.

pinstack-0.1.0/PKG-INFO

@@ -0,0 +1,340 @@
+Metadata-Version: 2.4
+Name: pinstack
+Version: 0.1.0
+Summary: Supply-chain dependency pinning enforcement for every ecosystem
+Author: smthmlk
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/a4899e/pinstack
+Project-URL: Repository, https://github.com/a4899e/pinstack
+Project-URL: Bug Tracker, https://github.com/a4899e/pinstack/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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 :: Security
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: ruff==0.15.7; extra == "dev"
+Requires-Dist: pyright==1.1.408; extra == "dev"
+Requires-Dist: invoke==2.2.1; extra == "dev"
+Requires-Dist: jsonschema==4.26.0; extra == "dev"
+Requires-Dist: bandit==1.9.4; extra == "dev"
+Dynamic: license-file
+
+# pinstack
+
+Supply-chain dependency pinning enforcement for every ecosystem.
+
+pinstack scans a project directory and reports unpinned or loosely-pinned
+dependencies across the most common package managers, container formats, and
+infrastructure tools. It is designed to drop into any CI pipeline with a single
+command and zero setup beyond `pip install pinstack`.
+
+---
+
+## Project Goals
+
+**1. Broad ecosystem coverage**
+
+pinstack understands as many project and language types as possible. A single
+invocation on a monorepo surfaces pinning issues in Python packages, Node
+modules, Docker images, Go modules, Rust crates, Ruby gems, Terraform providers,
+Helm charts, and more.
+
+**2. Zero dependencies**
+
+pinstack has no runtime dependencies outside the Python standard library. It
+runs on any system's `python3` (3.9 or later) without a virtual environment or
+any other setup step. This makes it practical to adopt in non-Python projects
+where adding a Python dependency tree would be unwelcome.
+
+**3. CLI-only configuration**
+
+There are no config files to maintain. Every behaviour is controlled by flags
+passed on the command line. What you see in the command is what it does, making
+pinstack easy to audit, reproduce, and reason about in CI logs.
+
+---
+
+## Installation
+
+```
+pip install pinstack
+```
+
+Because pinstack has zero runtime dependencies, it can also be run directly
+from a checkout without installation:
+
+```
+python -m pinstack .
+```
+
+---
+
+## Quick Start
+
+Scan the current directory:
+
+```
+pinstack .
+```
+
+Only check Python and Docker dependency files:
+
+```
+pinstack . --check requirements,pyproject,dockerfile
+```
+
+Output as SARIF for GitHub Code Scanning integration:
+
+```
+pinstack . --format sarif > results.sarif
+```
+
+---
+
+## Supported Ecosystems
+
+| Checker | Files Examined | What Is Checked |
+|---|---|---|
+| `requirements` | `requirements*.txt` | `==` pinning and `--hash` verification |
+| `pyproject` | `pyproject.toml` | `==` exact pins in `[project.dependencies]` and `[project.optional-dependencies]` |
+| `package_json` | `package.json` | No `^`, `~`, or range specifiers in any dependency section |
+| `package_lock` | `package-lock.json` | `integrity` hashes present on all packages |
+| `yarn_lock` | `yarn.lock` | Integrity checksums present |
+| `pnpm_lock` | `pnpm-lock.yaml` | `integrity` hashes present |
+| `dockerfile` | `Dockerfile*` | `@sha256:` digest on every `FROM` |
+| `github_actions` | `.github/workflows/*.yml` | 40-char commit SHA after `@` in `uses:` |
+| `go` | `go.mod`, `go.sum` | `go.sum` exists alongside `go.mod`; `h1:` hashes present |
+| `cargo` | `Cargo.lock` | `checksum` field on each registry `[[package]]` |
+| `gemfile` | `Gemfile`, `Gemfile.lock` | Lock file exists alongside Gemfile |
+| `terraform` | `.terraform.lock.hcl` | `h1:` hashes present per provider |
+| `helm` | `Chart.yaml`, `Chart.lock` | Lock file exists when Chart.yaml has dependencies; `digest:` present |
+| `compose` | `docker-compose*.yml`, `compose*.yml` | `@sha256:` digest on `image:` references |
+
+---
+
+## CLI Reference
+
+```
+pinstack [PATH] [OPTIONS]
+```
+
+| Option | Description |
+|---|---|
+| `PATH` | Directory to scan. Defaults to `.` (current directory). |
+| `--check NAME,NAME` | Only run these checkers (comma-separated). Mutually exclusive with `--exclude`. |
+| `--exclude NAME,NAME` | Skip these checkers (comma-separated). Mutually exclusive with `--check`. |
+| `--format FORMAT` | Output format: `text` (default) or `sarif`. |
+| `--exit-zero` | Always exit 0, even when findings are present. Useful for advisory-only runs. |
+| `--max-depth N` | Maximum directory depth to recurse into. Default: 4. Increase for deep monorepos. |
+| `--max-files N` | Maximum number of dependency files to index. Default: 384. Increase for large monorepos. A warning is printed to stderr if the limit is reached. |
+| `--exclude-dir DIR,DIR` | Additional directory names to skip during traversal (comma-separated). |
+| `--list-checkers` | Print all available checkers and exit. |
+| `--version` | Print the pinstack version and exit. |
+
+### Exit Codes
+
+| Code | Meaning |
+|---|---|
+| `0` | No findings (or `--exit-zero` was set). |
+| `1` | One or more findings reported. |
+| `2` | Runtime error. |
+
+---
+
+## Output Formats
+
+### text (default)
+
+Human-readable output suitable for local development and CI logs:
+
+```
+FAIL  Dockerfile:3  FROM without @sha256: digest: python:3.11-slim
+FAIL  requirements.txt:7  not pinned with ==: requests>=2.28
+FAIL  go.mod  go.sum missing alongside go.mod
+
+3 errors in 3 files
+```
+
+### sarif
+
+SARIF 2.1.0 JSON, consumable by GitHub Code Scanning, GitLab SAST, and other
+tools that support the standard.
+
+---
+
+## CI Integration
+
+pinstack is a standalone CLI tool, not a library. It works with any project
+regardless of language. Python 3.9+ is the only requirement, and it ships on
+virtually every CI runner out of the box.
+
+### GitHub Actions
+
+```yaml
+name: Supply Chain Check
+on: [push, pull_request]
+
+jobs:
+  pinstack:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
+
+      - name: Set up Python
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+        with:
+          python-version: "3.x"
+
+      - name: Install pinstack
+        run: pip install pinstack
+
+      - name: Check dependency pinning
+        run: pinstack .
+```
+
+To upload results to GitHub Code Scanning:
+
+```yaml
+      - name: Check dependency pinning (SARIF)
+        run: pinstack . --format sarif > pinstack.sarif
+        continue-on-error: true
+
+      - name: Upload SARIF
+        uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d
+        with:
+          sarif_file: pinstack.sarif
+```
+
+### GitLab CI
+
+```yaml
+pinstack:
+  stage: test
+  image: python:3-slim
+  before_script:
+    - pip install pinstack
+  script:
+    - pinstack .
+```
+
+To integrate with GitLab SAST, output SARIF and use the
+[SAST report artifact](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html):
+
+```yaml
+pinstack:
+  stage: test
+  image: python:3-slim
+  before_script:
+    - pip install pinstack
+  script:
+    - pinstack . --format sarif > gl-sast-report.json || true
+  artifacts:
+    reports:
+      sast: gl-sast-report.json
+```
+
+### Python Projects (Invoke)
+
+Add a task to your `tasks.py`:
+
+```python
+from invoke import task
+
+@task
+def supply_chain(c):
+    """Check dependency pinning."""
+    c.run("pinstack .")
+```
+
+Then run it with `invoke supply-chain` or include it in your build task:
+
+```python
+@task(pre=[lint, typecheck, test, supply_chain])
+def build(c):
+    """Full build pipeline."""
+    pass
+```
+
+### Any Project
+
+pinstack runs anywhere Python 3.9+ is available. No virtual environment needed,
+no dependencies to install beyond pinstack itself.
+
+**With pip:**
+
+```
+pip install pinstack
+pinstack .
+```
+
+**Without pip (clone and run directly):**
+
+```
+git clone https://github.com/a4899e/pinstack.git /tmp/pinstack
+python3 /tmp/pinstack/pinstack .
+```
+
+**Check only specific ecosystems:**
+
+```
+# Java project -- only check Maven and Gradle
+pinstack . --check maven,gradle
+
+# Node project -- only check JS ecosystem
+pinstack . --check package_json,package_lock,yarn_lock,pnpm_lock
+
+# Docker-only check
+pinstack . --check dockerfile,compose
+```
+
+**Skip directories that contain third-party code:**
+
+```
+pinstack . --exclude-dir vendor,third_party,checkouts
+```
+
+---
+
+## Contributing
+
+1. Fork the repository at https://github.com/a4899e/pinstack
+2. Create a branch from `develop` (not `main`)
+3. Add tests for any new checker or behaviour
+4. Open a pull request against `develop`
+
+Development setup:
+
+```
+pip install -e ".[dev]"
+git config core.hooksPath .githooks
+```
+
+The pre-commit hook runs `invoke build` (tests + lint) before each commit.
+You can also run these manually:
+
+```
+invoke test      # run tests
+invoke build     # tests + ruff + pyright + bandit
+invoke clean     # remove .pyc, caches, build artifacts
+```
+
+---
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE) for the full text.
+
+Copyright 2024 Trevor T. <trevort@scantonomous.ai>