diff --git a/.changeset/olive-moons-invent.md b/.changeset/olive-moons-invent.md new file mode 100644 index 0000000..4767513 --- /dev/null +++ b/.changeset/olive-moons-invent.md @@ -0,0 +1,14 @@ +--- +"@germ-network/two-mls-pq": patch +--- + +Add the dual MIT/Apache-2.0 license and fill in package metadata. + +The repository was public with no license file, while `rust/Cargo.toml` already declared +`license = "MIT OR Apache-2.0"`. This adds `LICENSE-MIT` and `LICENSE-APACHE` so that +declaration is backed by actual license text, and states the inbound contribution terms in +`CONTRIBUTING.md` and `README.md`. + +Also corrects documentation that still referred to `Sources/AbstractTwoMLS/` (moved to a +separate package) and to the vendored binding's old location — including the path in the +binding-contract mismatch error, which pointed developers at the wrong file to re-sync. diff --git a/.gitignore b/.gitignore index 1f2d2e3..2df79be 100644 --- a/.gitignore +++ b/.gitignore @@ -9,8 +9,10 @@ Cargo.lock # UniFFI binding + xcframework build outputs (never committed; released as assets) /buildIos /buildIosFramework +/buildAndroid /bindings *.xcframework +*.artifactbundle # Swift / SwiftPM / Xcode .build/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7517977..61f9bca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,4 +30,13 @@ We also use the [periphery static analyzer](https://github.com/peripheryapp/peri ## Changesets We use [Changesets](https://github.com/changesets/changesets) to document changes and releases. -Please [generate a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) for your pull requests. \ No newline at end of file +Please [generate a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) for your pull requests. + +## License + +This project is dual licensed under either of [Apache License, Version 2.0](./LICENSE-APACHE) +or [MIT license](./LICENSE-MIT) at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion +in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, +without any additional terms or conditions. diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + 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 diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..9910cb8 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Germ Network, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Package.swift b/Package.swift index bb54178..5dcdaf2 100644 --- a/Package.swift +++ b/Package.swift @@ -17,7 +17,7 @@ import PackageDescription // SKIPS build+pin+upload when the url already names the tag being finalized. A hand-pre-pinned // url therefore ships a release with NO asset — the url 404s. Leave these lagging; the workflow // pins each tag forward. (v0.10.0 was shipped asset-less exactly this way; see the guard fix.) -// EITHER WAY, keep `Sources/TwoMLSPQ/two_mls_pq.swift` re-synced from the SAME build +// EITHER WAY, keep `Sources/TwoMLSPQBinding/two_mls_pq.swift` re-synced from the SAME build // as the binary (uniffi embeds a checksum contract verified at init; the // `binding_contract_version()` ↔ `expectedBindingContract` canary guards a mismatch). // The packaging stays DYNAMIC so the adopting app can still link the legacy static diff --git a/README.md b/README.md index ba3cc32..a98b88d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # TwoMLSPQ -Germ Network's implementation of 1:1 aysnc, end-to-end encrypted messaging sessions, +Germ Network's implementation of 1:1 async, end-to-end encrypted messaging sessions, built on MLS. It implements a triple ratchet (symmetric encryption, asymmetric classical encryption, asymmetric PQ encryption) for forward secrecy and post-compromise security. It further bundles MLS handshake plane messages so that there is no dependency among in-flight messages, and applies header encryption to the bundle. This repository holds the whole stack: the Rust/UniFFI core under [`rust/`](rust/), and -the hand-written Swift wrapper (**AbstractTwoMLS**) that consumes it — `Package.swift`, +the hand-written Swift wrapper (**TwoMLSPQ**) that consumes it — `Package.swift`, [`Sources/`](Sources/), and [`Tests/`](Tests/) — at the top level. A wire change and its Swift adapter land in one PR, tested against a **local** xcframework build; there is no publish-a-release-to-test-an-integration step. @@ -29,8 +29,8 @@ just book-serve # serve at http://localhost:3000 ``` Package.swift Swift package manifest (env-gated binaryTarget — see below) -Sources/AbstractTwoMLS/ Hand-written Swift wrapper (the vended library) -Sources/TwoMLSPQ/ Vendored UniFFI binding (two_mls_pq.swift) — re-synced from bindings/ +Sources/TwoMLSPQ/ Hand-written Swift wrapper (the vended library) +Sources/TwoMLSPQBinding/ Vendored UniFFI binding (two_mls_pq.swift) — re-synced from bindings/ Tests/ Swift tests book/ mdBook guide + API reference scripts/ iOS build tooling (buildIosDynamic.sh) @@ -143,14 +143,14 @@ The loop that replaces release-to-test: ```sh bash scripts/buildIosDynamic.sh # build the local xcframework + bindings -cp bindings/two_mls_pq.swift Sources/TwoMLSPQ/ # re-sync the vendored binding in-tree +cp bindings/two_mls_pq.swift Sources/TwoMLSPQBinding/ # re-sync the vendored binding in-tree TWOMLSPQ_LOCAL_XCFRAMEWORK=1 swift test # build + test against the local build ``` -Keep `Sources/TwoMLSPQ/two_mls_pq.swift` re-synced from the SAME build as the binary: uniffi -embeds a checksum contract verified at init, and the `binding_contract_version()` ↔ -`expectedBindingContract` canary (in `Sources/AbstractTwoMLS/AbstractTwoMLS+TwoMLSPQ.swift`) -guards a stale-binding/fresh-binary mismatch. +Keep `Sources/TwoMLSPQBinding/two_mls_pq.swift` re-synced from the SAME build as the binary: +uniffi embeds a checksum contract verified at init, and the `binding_contract_version()` ↔ +`expectedBindingContract` canary (in `Sources/TwoMLSPQ/PQSession.swift`) guards a +stale-binding/fresh-binary mismatch. ## Release Process @@ -167,3 +167,19 @@ never blocks development — only the tagged commit carries the pinned checksum, lands before any asset is uploaded, so no consumer can resolve a half-finalized tag. Releases: https://github.com/germ-network/TwoMLSPQ/releases + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion +in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, +without any additional terms or conditions. diff --git a/Sources/TwoMLSPQ/PQSession.swift b/Sources/TwoMLSPQ/PQSession.swift index 26d919b..b38773f 100644 --- a/Sources/TwoMLSPQ/PQSession.swift +++ b/Sources/TwoMLSPQ/PQSession.swift @@ -256,7 +256,7 @@ enum TwoMLSPQBindingContract { """ TwoMLSPQ binding/binary mismatch: the vendored two_mls_pq.swift expects \ contract \(expectedBindingContract) but the loaded binary provides \(actual). \ - Re-sync Sources/TwoMLSPQ/two_mls_pq.swift and the TwoMLSPQ xcframework \ + Re-sync Sources/TwoMLSPQBinding/two_mls_pq.swift and the TwoMLSPQ xcframework \ from the SAME build. """ ) diff --git a/package.json b/package.json index c8e791a..ba96105 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,13 @@ "name": "@germ-network/two-mls-pq", "private": true, "version": "0.16.0", + "description": "Post-quantum 1:1 end-to-end encrypted messaging sessions built on MLS — Rust/UniFFI core with a Swift package wrapper", + "license": "MIT OR Apache-2.0", + "author": "Germ Network, Inc.", + "repository": { + "type": "git", + "url": "git+https://github.com/germ-network/TwoMLSPQ.git" + }, "engines": { "node": ">=24" }, diff --git a/rust/fuzz/Cargo.toml b/rust/fuzz/Cargo.toml index d5c525f..a44e186 100644 --- a/rust/fuzz/Cargo.toml +++ b/rust/fuzz/Cargo.toml @@ -1,5 +1,6 @@ [package] edition = "2021" +license = "MIT OR Apache-2.0" name = "two-mls-pq-fuzz" publish = false version = "0.0.0"