diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 50333b2..7d33595 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,8 +3,8 @@ # # The same three OTP/Elixir pairs as beam_mcp (floor, pinned, head): format, compile with # warnings as errors, Credo --strict (.credo.exs), the Hex audit (retired packages and OSV -# advisories against mix.lock), the suite; and the DCO sign-off on every commit, as beam_mcp's -# gate workflow checks it. Actions pinned by commit SHA with the version beside it. +# advisories against mix.lock), the suite; the REUSE lint over the tree; and the DCO sign-off +# on every commit, as beam_mcp's gate workflow checks it. Actions pinned by commit SHA with the version beside it. name: ci on: @@ -42,6 +42,16 @@ jobs: - run: mix hex.audit - run: mix test + + reuse: + name: REUSE lint + runs-on: ubuntu-24.04 + timeout-minutes: 5 + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + - name: every file carries copyright and licence information (the version beam_mcp pins) + run: pipx run reuse==6.2.0 lint + dco: name: DCO sign-off runs-on: ubuntu-24.04 diff --git a/.gitignore b/.gitignore index e8e8160..c1e58c4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Sudo Apt Holdings LLC +# SPDX-License-Identifier: Apache-2.0 + /_build/ /cover/ /deps/ diff --git a/.tool-versions.license b/.tool-versions.license new file mode 100644 index 0000000..f1cc249 --- /dev/null +++ b/.tool-versions.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: 2026 Sudo Apt Holdings LLC +SPDX-License-Identifier: Apache-2.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index d646087..9d29661 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,13 @@ SPDX-License-Identifier: Apache-2.0 ## [Unreleased] +### Added: gold groundwork (no code change) + +- `docs/security-review.md`: how a security review of this package is done, a checklist centred + on the key, and its record, empty until the first review. `CONTRIBUTING.md`: a code-review + section. REUSE compliance: `.gitignore` headed, `.tool-versions`, `mix.lock` and `NOTICE` + with `.license` sidecars, `LICENSES/Apache-2.0.txt`, and `reuse lint` in CI. + ### Changed: governance (no code change) - `GOVERNANCE.md` names two continuity holders, as on `beam_mcp`: `znmead` (the Maintain role diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6335aed..d786a45 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,28 @@ Erlang/OTP 27 or newer and Elixir 1.17 or newer, the same floor as `beam_mcp`. C (`test/beam_mcp/signer/no_key_source_test.exs`) red when the rule is broken: plant the break, show it red, restore it. +## Code review + +**How it is done.** Every change reaches `main` through a pull request, the maintainer's +included, rebased after CI is green on all three OTP/Elixir pairs. The reviewer reads the diff, +the commit messages and the CI results, and runs the suite locally for any change under `lib/`. + +**What must be checked.** +- The change does what its message says, and nothing else. +- New or changed behaviour has tests; a fix has a test that was seen failing first. +- **The key:** it is read from `opts[:private_key]` and nowhere else; no result, error term or + raise carries it; nothing is kept after the call. The key-source census + (`test/beam_mcp/signer/no_key_source_test.exs`) still passes for the right reason, and a + change to how the key is handled is shown red against a planted break. +- `SECURITY.md`, `docs/assurance-case.md` and the README change with the behaviour they describe. +- Sign-off on every commit, no attribution trailers, no key or secret in the diff. + +**What is acceptable.** All of the above hold, CI is green, and the reviewer can say why the +change is correct; otherwise it is sent back with the reason. **Who reviews:** the maintainer +reviews every pull request; the continuity holders in `GOVERNANCE.md` may review as well. A +review by a person other than the author on at least half of all changes is the project's aim; +the pull requests show who reviewed each one. + ## Coding style The Elixir community's: the output of `mix format` (this repository's `.formatter.exs`) and diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 0000000..184fb91 --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,201 @@ + 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 2026 Ayla Croft + + 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/NOTICE.license b/NOTICE.license new file mode 100644 index 0000000..f1cc249 --- /dev/null +++ b/NOTICE.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: 2026 Sudo Apt Holdings LLC +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/security-review.md b/docs/security-review.md new file mode 100644 index 0000000..b6fc5fa --- /dev/null +++ b/docs/security-review.md @@ -0,0 +1,53 @@ + + +# Security review + +How a security review of this package is done, and the record of each one. A review is a +person reading the code against the package's security claims; the tests, the census and Credo +support it and do not replace it. One is done at least every five years, and before `1.0.0`. +`beam_mcp`'s own procedure +([docs/security-review.md](https://github.com/ScriptKittyOS/beam_mcp/blob/main/docs/security-review.md)) +covers the bytes this package signs. + +## What it is measured against + +`SECURITY.md` ("What you can expect from this package") and the claim, threat model and trust +boundaries in `docs/assurance-case.md`. + +## The checklist + +Each item is answered with what was read, what was tried, and what was found. + +1. **One source for the key.** Read `lib/beam_mcp/signer/ed25519.ex` in full. Is the key read + from `opts[:private_key]` only? Does the census's regex and call list still describe the + compiled module (`test/beam_mcp/signer/no_key_source_test.exs`)? +2. **Nothing kept.** No process state, table, persistent term, application environment or + file after a call; a reference (`fn -> key end`) called once and dropped. +3. **Nothing printed.** Every result is a signature or a fixed error term; no clause can raise + on its arguments. Try a map for the options, a non-binary for the bytes, a wrong-length key + and a reference returning the wrong thing, and read what comes back and what a log would show. +4. **The signature.** Ed25519 over exactly the bytes given, verified independently with + `:crypto.verify/5` and through `beam_mcp`'s canonical bytes; no prehash, no other algorithm. +5. **Randomness.** None is used; confirm that no key or nonce is generated in `lib/`. +6. **Supply chain and release.** `mix.lock` against `mix hex.audit`; the `beam_mcp` requirement; + workflow permissions and pinned actions; a release tarball rebuilt with + `tools/release_tarball.sh` and compared with hex.pm's checksum; the tag's signature + (`docs/verifying-releases.md`). +7. **The pages.** Does the assurance case, `SECURITY.md` and the README still describe the code? + +## After a review + +Findings go through `SECURITY.md` (a private advisory where warranted), each with an issue or a +pull request. The review is recorded below in the pull request that adds the row. + +## Record + +| date | reviewer | commit | scope | findings | +|---|---|---|---|---| + +No review has been recorded yet. The audit that found and closed the key-in-exception defect +(`docs/assurance-case.md`, "Closed") was automated-assisted groundwork for the first review, not +a review under this page's definition. diff --git a/mix.exs b/mix.exs index f6a71f0..5bf3aa5 100644 --- a/mix.exs +++ b/mix.exs @@ -33,7 +33,8 @@ defmodule BeamMCP.Signer.Ed25519.MixProject do "docs/architecture.md", "docs/assurance-case.md", "docs/roadmap.md", - "docs/verifying-releases.md" + "docs/verifying-releases.md", + "docs/security-review.md" ] ], aliases: [check_otp: &check_otp!/1] diff --git a/mix.lock.license b/mix.lock.license new file mode 100644 index 0000000..f1cc249 --- /dev/null +++ b/mix.lock.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: 2026 Sudo Apt Holdings LLC +SPDX-License-Identifier: Apache-2.0