diff --git a/Dockerfile b/Dockerfile index 6b70bad..a6ee3d1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,6 +10,8 @@ # contributor a working tool from `docker compose run` with nothing installed on their machine. FROM eclipse-temurin:21-jre-noble +LABEL org.opencontainers.image.licenses="Apache-2.0" \ + org.opencontainers.image.source="https://github.com/norandom/OpenUltraSAST" ARG JOERN_VERSION=v4.0.625 ARG ARCHIVE=joern-cli-linux-x86_64.zip diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/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. diff --git a/README.md b/README.md index 3049384..24834bf 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ uv run ousast plane remember validation-46 # ingest the run's rows the store's rewrites. The flow and the task catalogue: [docs/plane.md](docs/plane.md); what runs where today and what a separate cluster would take: [docs/deployment.md](docs/deployment.md). -HarnessX, the earlier agentic extra, was retired on 2026-09-30: a `[harnessx]` section is ignored +HarnessX, the earlier agentic extra, was retired 2026-09-30: a `[harnessx]` section is ignored with one warning, and `[models] verifier`, `[fusion] panel_model` and `[fusion] decider_model` fail naming the plane replacement, as do config keys nothing ever read. Fusion is deterministic. @@ -246,9 +246,7 @@ candidate enumerator can reach). ## Licence -The repository carries no licence file yet (checked 2026-10-02: no `LICENSE` at the root and no -`license` field in `pyproject.toml`), so until one is added, treat the code as all rights reserved -and ask the maintainer before reusing it. Third-party material keeps its own terms: Joern is -downloaded at image build time under its own licence, the tree-sitter wheels of the `semantic` -extra are MIT, and the published benchmark cases were licence-checked one by one (v1's OpenCVE -case is BUSL-1.1, see [RELEASE_NOTES.md](RELEASE_NOTES.md)). +OpenUltraSAST is licensed under the [Apache License 2.0](LICENSE). Third-party material keeps its +own terms: Joern (Apache-2.0) is downloaded at image build time, the tree-sitter wheels of the +`semantic` extra are MIT, and the published benchmark cases were licence-checked one by one (v1's +OpenCVE case is BUSL-1.1, see [RELEASE_NOTES.md](RELEASE_NOTES.md)). diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 746de2d..968852d 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,4 +1,22 @@ -# Unreleased +# v2.0.1 (2026-10-02) + +v2.0.0 was tagged but never published: its release job stopped at the format check (see below). v2.0.1 is +the first published 2.x release and carries everything listed under v2.0.0 plus the following. + +- **Licence: Apache-2.0.** `LICENSE` added; `pyproject.toml` declares `license = "Apache-2.0"`; both images + carry the `org.opencontainers.image.licenses` label. +- **Container images on GHCR.** Each version tag pushes `ghcr.io/norandom/openultrasast` (the scan image: + Joern and php-cli) and `ghcr.io/norandom/openultrasast-runner` (the plane's task runner), tagged with the + version and, for full releases, `latest`. The digests are in the release job's summary; pin by digest + (Agent Substrate rejects tags). +- **CI green again.** CI and the release job check formatting and lint over the whole repository; eight + benchmark scripts had drifted. They were reformatted (two `noqa` comments, one renamed loop variable; no + script computes anything differently), and the local gate now runs the same whole-tree commands. +- **Front-door README.** Install in four tiers (quick scan without Docker; standard and deep with the scan + image; the plane on kind; Kubernetes on k3s, planned), every claim checked against the CLI, and links to + every documentation page. + +## Also in this release (previously listed as Unreleased) - **Documentation audited against v2.0.0** (no behaviour change). New `docs/deployment.md`: where the plane runs today, this host's setup, and step-by-step guidance for a separate Kubernetes cluster with what is implemented diff --git a/plane/Dockerfile.runner b/plane/Dockerfile.runner index 106cebd..0a0366f 100644 --- a/plane/Dockerfile.runner +++ b/plane/Dockerfile.runner @@ -12,6 +12,8 @@ # `ops/ax/up.sh` builds it and loads it into kind; nothing here is exercised by the unit tests. FROM python:3.12-slim +LABEL org.opencontainers.image.licenses="Apache-2.0" \ + org.opencontainers.image.source="https://github.com/norandom/OpenUltraSAST" RUN apt-get update \ && apt-get install -y --no-install-recommends git ca-certificates \ diff --git a/pyproject.toml b/pyproject.toml index d6977bc..ebe7bbe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,9 +4,11 @@ build-backend = "uv_build" [project] name = "openultrasast" -version = "2.0.0" +version = "2.0.1" description = "OpenCode-oriented SAST harness for evidence-gated security analysis" readme = "README.md" +license = "Apache-2.0" +license-files = ["LICENSE"] requires-python = ">=3.11" dependencies = ["pyyaml>=6.0"] diff --git a/src/openultrasast/__init__.py b/src/openultrasast/__init__.py index b9fd156..d360fc2 100644 --- a/src/openultrasast/__init__.py +++ b/src/openultrasast/__init__.py @@ -2,4 +2,4 @@ __all__ = ["__version__"] -__version__ = "2.0.0" +__version__ = "2.0.1" diff --git a/uv.lock b/uv.lock index f9046e6..b76fa2b 100644 --- a/uv.lock +++ b/uv.lock @@ -1024,7 +1024,7 @@ wheels = [ [[package]] name = "openultrasast" -version = "2.0.0" +version = "2.0.1" source = { editable = "." } dependencies = [ { name = "pyyaml" },