diff --git a/.github/workflows/base-image.yml b/.github/workflows/base-image.yml index f8d91757..e10c2f9e 100644 --- a/.github/workflows/base-image.yml +++ b/.github/workflows/base-image.yml @@ -18,6 +18,13 @@ on: - .github/workflows/base-image.yml workflow_dispatch: +# One publication of `:latest` at a time, the newest queued last: two merges a +# minute apart started two builds, and the older one finished second and put +# its image back over the newer one. +concurrency: + group: publish-base-image + cancel-in-progress: false + permissions: {} jobs: diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index da578eb8..874c46fe 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -67,6 +67,10 @@ jobs: docker: needs: test runs-on: ubuntu-latest + # Pushes `:latest` on main; two pushes racing would let the older image win. + concurrency: + group: docker-${{ github.ref }} + cancel-in-progress: false permissions: contents: read packages: write diff --git a/AGENTS.md b/AGENTS.md index 870e5d52..a6e45241 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -483,6 +483,21 @@ scope. Add yours. suite hung. The close had been the only thing ending it. → Before removing an exit from a loop, find what else that exit was the bound for, and test the loop with a medium that never waits. +- **`ls a b` used as "does either exist".** A probe for a library in `lib` or + `lib64` listed both; `ls` fails when either is missing, so a library in `lib` + alone was never seen and the rebuild it was meant to trigger never ran. The + end-to-end scenario caught it; the unit tests had not been written yet. → In + shell, test existence with `[ -e ]` per path, and write the unit test for a + probe with each of its branches before the scenario that relies on it. +- **A test edited from memory of it.** A replacement was written for a cache + test the agent had not opened, and matched nothing; the half of the edit that + did apply left the suite red for a reason that looked like the code's. → + Read the test before writing its replacement, every time. +- **A path read relative to the current directory in a script that is + sourced.** `start.sh` read `scripts/liboqs.lock` relative to wherever it had + `cd`'d, which under the test harness was `/usr/bin`; every stamp then looked + wrong. → A file that decides trust is read from the script's own tree + (`BASH_SOURCE`), never from the current directory. - **A rate called "at rest" that was a mesh still settling.** About 30 packets per second per node was published as idle traffic; it was taken 25 s after start, with searches and handshakes still running, and the same mesh sent diff --git a/BUGSVULNS.MD b/BUGSVULNS.MD index 1bfb812a..4cc79d6a 100644 --- a/BUGSVULNS.MD +++ b/BUGSVULNS.MD @@ -4143,3 +4143,23 @@ where a node holds no link (93 of 100 on average over four seeds, the same as without, for 4 to 6 packets per second per node at rest instead of 2.4 to 4.4). And there is nothing larger than 240 nodes to measure on this machine: the simulator needs more cores than the 8 it has once the mesh is chatty, and at rest it is the first number to check again. + +## 109 — medium — Two builds raced to publish the base image, and the older won + +> **Status — fixed.** Tests: `tests/test_workflows_pinned.py` +> (`test_what_publishes_latest_does_it_one_run_at_a_time`). + +**Where** — `.github/workflows/base-image.yml`; the `docker` job of `ci.yml` +pushes the application image's `:latest` the same way. + +**What happens** — merging two PRs that both touched the base image a minute +apart started two builds. The one from the older commit finished second, so +`nmesh-base:latest` went back to a build from before liboqs was compiled from a +checked source, without `/opt/liboqs`; every application build after it failed +on the missing directory. Nothing in the image says which commit it came from, +so the only symptom was that later builds broke. + +**Fixed** — both publishers run in a concurrency group that never cancels a run +in progress, so they finish in the order they were queued and the newest commit +publishes last. The base was republished from `main` by hand. + diff --git a/Docs/Setup/guide b/Docs/Setup/guide index 0a599d51..26a7aa11 100644 --- a/Docs/Setup/guide +++ b/Docs/Setup/guide @@ -124,9 +124,20 @@ recompiling. `start.sh` also looks at the prefixes `install.sh` points it at (`OQS_REUSE_FROM`, a `:`-separated list): the installer's home, their old user installation, `/opt/nmesh`. -Reuse is never decided on a version number or a file name: the wrapper actually -**loads** the candidate library and both required algorithms answer, or we -recompile. After the copy, the check is run again **at the destination**. A +Reuse is never decided on a version number or a file name: the candidate must +carry **`nmesh-liboqs.lock`**, the stamp `scripts/build_liboqs.sh` writes beside +every build it proved, matching the lock in this tree; it must belong to this +account or to root and be writable by no group and no one else (the stamp is a +file like any other); and the wrapper must actually **load** it with both +required algorithms answering. After the copy, the check is run again **at the +destination**. + +A library already in the prefix with no current stamp — every one built before +the source was checked — is **rebuilt** at the next start: beside the old one, +swapped in only once the new one loads, so a node that cannot rebuild (no +network, no compiler) keeps what it has, says so, and tries again next time. +A library the system provides (a distribution's package, Homebrew) carries no +stamp and needs none. A wrapper version bump changes the cache key and therefore forces a real rebuild — wrapper and library must stay paired. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index f72755ea..11047d5a 100644 --- a/README.md +++ b/README.md @@ -353,3 +353,16 @@ docker/ relay-node image and compose file Docs/ guides (setup, transports, console, connector, packets) tests/ unit tests + tests/integration (real nodes) ``` + +## License + +NMesh is free software: you can redistribute it and/or modify it under the +terms of the GNU General Public License, version 3, as published by the Free +Software Foundation. It is distributed in the hope that it will be useful, but +**without any warranty**; see [`LICENSE`](LICENSE) for the full text. + +The tree ships its license wherever it goes — the updater, Fleet's +provisioning payload, the Docker image and the zipapp all carry `LICENSE`. +Its two runtime dependencies are compatible with it: `liboqs-python` and +liboqs are MIT, `cryptography` is Apache-2.0 or BSD. + diff --git a/docker/Dockerfile b/docker/Dockerfile index d76c8c96..4e283837 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -43,7 +43,7 @@ COPY scripts/ ./scripts/ # sends runs `install.sh` there (which in turn runs `start.sh`) — see # Docs/Apps/fleet. Without these the payload cannot be built at all: "no NMesh # tree at /app". -COPY start.sh install.sh pyproject.toml requirements.txt ./ +COPY start.sh install.sh pyproject.toml requirements.txt LICENSE ./ COPY docker/entrypoint.sh /entrypoint.sh RUN chmod +x /entrypoint.sh diff --git a/pyproject.toml b/pyproject.toml index 2a316fce..b47ac020 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,6 +5,7 @@ build-backend = "setuptools.backends.legacy:build" [project] name = "nmesh" version = "0.4.111" +license = "GPL-3.0-only" [tool.pytest.ini_options] testpaths = ["tests"] diff --git a/scripts/build_liboqs.sh b/scripts/build_liboqs.sh index a8b5129e..79e1b00e 100755 --- a/scripts/build_liboqs.sh +++ b/scripts/build_liboqs.sh @@ -102,4 +102,7 @@ cmake -S "$SRC" -B "$WORK/build" "${GENERATOR[@]}" \ || die "cmake configure failed" cmake --build "$WORK/build" --parallel "$JOBS" || die "build failed" cmake --install "$WORK/build" || die "install failed" +# What this build was proven to be, beside it. start.sh reuses a library only +# when this matches the lock it is running with; nothing else writes it. +grep -E '^LIBOQS_(VERSION|COMMIT|TARBALL_SHA256)=' "$LOCK" > "$PREFIX/nmesh-liboqs.lock" echo "build_liboqs: liboqs $VERSION ($COMMIT) installed in $PREFIX" diff --git a/scripts/build_pyz.py b/scripts/build_pyz.py index 15ba10c8..7a3e14d4 100755 --- a/scripts/build_pyz.py +++ b/scripts/build_pyz.py @@ -25,6 +25,8 @@ def build(output: str) -> None: # nmesh_node becomes the archive's entry point. shutil.copy(os.path.join(ROOT, "scripts", "nmesh_node.py"), os.path.join(work, "__main__.py")) + # The GPL travels with the program, in every form it is handed over. + shutil.copy(os.path.join(ROOT, "LICENSE"), os.path.join(work, "LICENSE")) zipapp.create_archive( work, target=output, interpreter="/usr/bin/env python3", ) diff --git a/src/apps/fleet_provision.py b/src/apps/fleet_provision.py index c0c30aed..502fb104 100644 --- a/src/apps/fleet_provision.py +++ b/src/apps/fleet_provision.py @@ -60,7 +60,7 @@ # `install.sh` is not optional here: the bootstrap hands the whole install over # to it rather than reimplementing one, so a payload without it installs nothing. PAYLOAD_INCLUDE = ("src", "scripts", "start.sh", "install.sh", - "requirements.txt", "pyproject.toml") + "requirements.txt", "pyproject.toml", "LICENSE") PAYLOAD_EXCLUDE_DIRS = {"__pycache__", ".git", ".venv", "data", "tests"} MAX_PAYLOAD = 16 * 1024 * 1024 # refuse to push an implausible tree # What a failed run keeps of the target's own output. Enough to see the error a diff --git a/src/boot_guard.py b/src/boot_guard.py index c645d373..ba115c5a 100644 --- a/src/boot_guard.py +++ b/src/boot_guard.py @@ -47,7 +47,7 @@ # project and the updater can import this one. REPLACE_ENTRIES = ("src", "scripts", "start.sh", "install.sh", "requirements.txt", "pyproject.toml", "Docs", "docker", - "README.md", "AGENTS.md", "CLAUDE.md") + "README.md", "AGENTS.md", "CLAUDE.md", "LICENSE") BACKUP_DIR = ".nmesh-previous" FAILED_DIR = ".nmesh-failed" TRIAL_FILE = ".nmesh-trial.json" diff --git a/start.sh b/start.sh index 89beaaf4..9cbafa8b 100755 --- a/start.sh +++ b/start.sh @@ -24,6 +24,10 @@ # this file with NMESH_START_LIB=1 to exercise them without installing anything. set -euo pipefail cd "$(dirname "$0")" +# The tree this script belongs to, whoever sourced it from wherever: the files +# that decide which liboqs is trusted are read from here, never from the +# current directory. +NMESH_TREE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" # ── colours ────────────────────────────────────────────────────────────────── if [ -t 1 ]; then @@ -384,9 +388,9 @@ available_mem_mb() { pq_lib_on_disk() { # The node's own test (src/liboqs_guard.py), loaded by path: importing the # package would import the wrapper, which is the thing being protected. - python - >/dev/null 2>&1 <<'PYEOF' + python - "$NMESH_TREE/src/liboqs_guard.py" >/dev/null 2>&1 <<'PYEOF' import importlib.util, sys -spec = importlib.util.spec_from_file_location("liboqs_guard", "src/liboqs_guard.py") +spec = importlib.util.spec_from_file_location("liboqs_guard", sys.argv[1]) guard = importlib.util.module_from_spec(spec) spec.loader.exec_module(guard) sys.exit(0 if guard.library_on_disk() else 1) @@ -418,6 +422,86 @@ liboqs_usable_at() ( pq_ready ) +# ── which liboqs was proven ─────────────────────────────────────────────────── +# `scripts/build_liboqs.sh` writes `nmesh-liboqs.lock` beside every build: the +# release, commit and archive digest it checked the source against. A library +# in a prefix without the current one was built before sources were checked +# (BUGSVULNS 92, 93), or from another lock, and is neither reused nor kept. +# A library the system provides (a distribution's package, Homebrew) carries +# no stamp and needs none: its packager signed it. +lock_identity() { + grep -E '^LIBOQS_(VERSION|COMMIT|TARBALL_SHA256)=' "$1" 2>/dev/null | sort +} + +liboqs_in_prefix() { + local found + for found in "$1"/lib/liboqs.* "$1"/lib64/liboqs.*; do + [ -e "$found" ] && return 0 + done + return 1 +} + +liboqs_proven_at() { + [ -f "$1/nmesh-liboqs.lock" ] || return 1 + [ "$(lock_identity "$1/nmesh-liboqs.lock")" = "$(lock_identity "$NMESH_TREE/scripts/liboqs.lock")" ] +} + +# A copy that another account could have rewritten since it was stamped is no +# better than an unstamped one: the stamp is a file like any other. Owned by +# this account or by root, and writable by neither group nor others. +liboqs_writable_by_others() { + [ -n "$(find "$1" -maxdepth 3 ! -type l \( -perm -0002 -o -perm -0020 \) -print 2>/dev/null | head -n 1)" ] \ + && return 0 + [ -n "$(find "$1" -maxdepth 3 ! -user "$(id -u)" ! -user 0 -print 2>/dev/null | head -n 1)" ] +} + +liboqs_unproven_at() { + liboqs_in_prefix "$1" && ! liboqs_proven_at "$1" +} + +# One job per core OOM-kills the build on machines with many cores but little +# RAM (~1.5 GB per compile unit) — cap jobs by available RAM. +liboqs_build_jobs() { + local jobs mem + jobs="$(cpu_count)" + mem="$(available_mem_mb || true)" + if [ -n "${mem:-}" ] && [ "$mem" -gt 0 ]; then + mem=$(( mem / 1500 )) + [ "$mem" -ge 1 ] || mem=1 + [ "$mem" -lt "$jobs" ] && jobs="$mem" + fi + echo "$jobs" +} + +build_liboqs_into() { + local prefix="$1" jobs build_dir + jobs="$(liboqs_build_jobs)" + info "Building liboqs with $jobs parallel job(s) (capped by available RAM)…" + build_dir="${LIBOQS_BUILD_DIR:-$(node_home)/_oqs_build}" + LIBOQS_BUILD_DIR="$build_dir" bash "$NMESH_TREE/scripts/build_liboqs.sh" "$prefix" "$jobs" || return 1 + rm -rf "$build_dir" +} + +# A library built before its source was checked is rebuilt next to it and +# swapped in only once the new one answers. A node that cannot rebuild — no +# network, no compiler — keeps what it has and says so: a node with no crypto +# at all is the one outcome worse than this. +replace_unproven_liboqs() { + local next="$OQS_PREFIX.next" old="$OQS_PREFIX.unproven" + warn "the liboqs in $OQS_PREFIX was built before its source was checked — rebuilding it from scripts/liboqs.lock" + rm -rf "$next" + if build_liboqs_into "$next" && liboqs_usable_at "$next" && liboqs_proven_at "$next"; then + rm -rf "$old" + mv "$OQS_PREFIX" "$old" && mv "$next" "$OQS_PREFIX" && rm -rf "$old" + ok "liboqs rebuilt from a checked source" + cache_liboqs "$OQS_PY_VER" + return 0 + fi + rm -rf "$next" + warn "could not rebuild liboqs — keeping the one built before sources were checked; this node will try again at its next start" + return 1 +} + # Where a built liboqs is kept so the *next* install does not rebuild it. Keyed # by the wrapper version: a wrapper bump must recompile, since the two have to # stay in lockstep around the crypto. @@ -440,11 +524,13 @@ cache_liboqs() { cache="$(liboqs_cache_dir "${1:-}")" [ "$cache" != "$OQS_PREFIX" ] || return 0 mkdir -p "$cache" 2>/dev/null || return 0 + liboqs_proven_at "$OQS_PREFIX" || return 0 for part in lib lib64 include; do [ -d "$OQS_PREFIX/$part" ] || continue rm -rf "$cache/$part" 2>/dev/null || true cp -a "$OQS_PREFIX/$part" "$cache/" 2>/dev/null || return 0 done + cp "$OQS_PREFIX/nmesh-liboqs.lock" "$cache/" 2>/dev/null || return 0 # The library is not a secret and the next install may run as someone else. chmod -R a+rX "$cache" 2>/dev/null || true return 0 @@ -474,6 +560,8 @@ adopt_liboqs() { local candidate while read -r candidate; do [ -n "$candidate" ] || continue + liboqs_proven_at "$candidate" || continue + liboqs_writable_by_others "$candidate" && continue liboqs_usable_at "$candidate" || continue mkdir -p "$OQS_PREFIX" # lib on most systems, lib64 on Fedora/openSUSE — copy whichever exist, @@ -484,6 +572,7 @@ adopt_liboqs() { [ -d "$candidate/$part" ] || continue cp -a "$candidate/$part" "$OQS_PREFIX/" 2>/dev/null && copied=true done + cp "$candidate/nmesh-liboqs.lock" "$OQS_PREFIX/" 2>/dev/null || copied=false [ "$copied" = true ] || continue # Copying is not proof: re-check *at the destination* before believing # it — named explicitly rather than through the ambient @@ -702,7 +791,8 @@ OQS_PREFIX="${OQS_INSTALL_PATH:-$(node_home)/_oqs}" # would be built in one place and looked for in another. export OQS_INSTALL_PATH="$OQS_PREFIX" -if pq_ready && crypto_ready && python -c "import pytest, pytest_asyncio" >/dev/null 2>&1; then +if pq_ready && ! liboqs_unproven_at "$OQS_PREFIX" && crypto_ready \ + && python -c "import pytest, pytest_asyncio" >/dev/null 2>&1; then ok "Dependencies already installed (fast start)" else info "Installing Python dependencies…" @@ -772,11 +862,14 @@ else brew list liboqs &>/dev/null || brew install liboqs || true fi - # The wrapper version decides which liboqs release we need — both for - # reusing one and for building it, so it is resolved before either. + # The wrapper version keys the cache, for reusing a build and for keeping + # one, so it is resolved before either. + OQS_PY_VER=$(python -c "import importlib.metadata as m; print(m.version('liboqs-python'))") \ + || fail "liboqs-python is not installed" + if liboqs_unproven_at "$OQS_PREFIX"; then + replace_unproven_liboqs || true + fi if ! pq_ready; then - OQS_PY_VER=$(python -c "import importlib.metadata as m; print(m.version('liboqs-python'))") \ - || fail "liboqs-python is not installed" if adopt_liboqs "$OQS_PY_VER"; then ok "Reused the liboqs already built in $ADOPTED_FROM (no recompile)" fi @@ -787,23 +880,7 @@ else # stay in lockstep — a mismatched wrapper/library pair around the # crypto is not acceptable, even when it happens to load. info "Building liboqs from source, verified against scripts/liboqs.lock (one-time — a few minutes)…" - - # One job per core OOM-kills the build on machines with many cores but - # little RAM (~1.5 GB per compile unit) — cap jobs by available RAM. - BUILD_JOBS="$(cpu_count)" - MEM_MB="$(available_mem_mb || true)" - if [ -n "${MEM_MB:-}" ] && [ "$MEM_MB" -gt 0 ]; then - MEM_JOBS=$(( MEM_MB / 1500 )) - [ "$MEM_JOBS" -ge 1 ] || MEM_JOBS=1 - if [ "$MEM_JOBS" -lt "$BUILD_JOBS" ]; then BUILD_JOBS="$MEM_JOBS"; fi - fi - info "Building liboqs with $BUILD_JOBS parallel job(s) (capped by available RAM)…" - - BUILD_DIR="${LIBOQS_BUILD_DIR:-$(node_home)/_oqs_build}" - LIBOQS_BUILD_DIR="$BUILD_DIR" bash ./scripts/build_liboqs.sh "$OQS_PREFIX" "$BUILD_JOBS" \ - || fail "liboqs could not be built (see output above)" - # The install lives in $OQS_PREFIX — the build tree is dead weight. - rm -rf "$BUILD_DIR" + build_liboqs_into "$OQS_PREFIX" || fail "liboqs could not be built (see output above)" # Keep a copy so the next install — another prefix, another node on this # machine — reuses it instead of spending these minutes again. cache_liboqs "$OQS_PY_VER" diff --git a/tests/test_liboqs_lock.py b/tests/test_liboqs_lock.py index 0d0f8f0c..9ee33755 100644 --- a/tests/test_liboqs_lock.py +++ b/tests/test_liboqs_lock.py @@ -154,3 +154,32 @@ def test_the_locked_archive_is_the_one_github_serves(tmp_path): with urllib.request.urlopen(url, timeout=60) as response: body = response.read(64 * 1024 * 1024) assert hashlib.sha256(body).hexdigest() == _lock()["LIBOQS_TARBALL_SHA256"] + + +class TestTheBuildStamps: + def _proven_git(self, sandbox): + _tool(sandbox, "git", 'case "$1" in\n' + ' clone) for last; do :; done; mkdir -p "$last";;\n' + f' -C) echo {_lock()["LIBOQS_COMMIT"]};;\n' + "esac\n") + + def test_a_proven_build_leaves_the_lock_it_was_proven_against(self, sandbox): + self._proven_git(sandbox) + _tool(sandbox, "cmake", "exit 0\n") + _tool(sandbox, "grep", f'exec {shutil.which("grep")} "$@"\n') + (sandbox / "prefix").mkdir() + result = _run(sandbox) + assert result.returncode == 0, result.stderr + stamp = (sandbox / "prefix" / "nmesh-liboqs.lock").read_text() + assert f"LIBOQS_COMMIT={_lock()['LIBOQS_COMMIT']}" in stamp + assert f"LIBOQS_TARBALL_SHA256={_lock()['LIBOQS_TARBALL_SHA256']}" in stamp + + def test_a_refused_build_leaves_none(self, sandbox): + _tool(sandbox, "git", 'case "$1" in\n' + ' clone) for last; do :; done; mkdir -p "$last";;\n' + ' -C) echo ' + "f" * 40 + ';;\n' + "esac\n") + _tool(sandbox, "cmake", "exit 0\n") + (sandbox / "prefix").mkdir() + assert _run(sandbox).returncode != 0 + assert not (sandbox / "prefix" / "nmesh-liboqs.lock").exists() diff --git a/tests/test_license.py b/tests/test_license.py new file mode 100644 index 00000000..2dd63347 --- /dev/null +++ b/tests/test_license.py @@ -0,0 +1,33 @@ +"""The GPL is in the tree, says so in the metadata, and travels with the +program in every form a node hands it over.""" +import pathlib +import zipfile + +from src import boot_guard +from src.apps import fleet_provision + +ROOT = pathlib.Path(__file__).resolve().parent.parent + + +def test_the_license_is_the_gpl_version_3(): + text = (ROOT / "LICENSE").read_text() + assert text.lstrip().startswith("GNU GENERAL PUBLIC LICENSE") + assert "Version 3, 29 June 2007" in text + assert 'license = "GPL-3.0-only"' in (ROOT / "pyproject.toml").read_text() + + +def test_it_travels_with_every_copy(): + assert "LICENSE" in boot_guard.REPLACE_ENTRIES + assert "LICENSE" in fleet_provision.PAYLOAD_INCLUDE + assert "LICENSE" in (ROOT / "docker" / "Dockerfile").read_text() + + +def test_the_zipapp_carries_it(tmp_path): + import importlib.util + spec = importlib.util.spec_from_file_location("build_pyz", ROOT / "scripts" / "build_pyz.py") + module = importlib.util.module_from_spec(spec) + spec.loader.exec_module(module) + out = tmp_path / "nmesh.pyz" + module.build(str(out)) + with zipfile.ZipFile(out) as archive: + assert "LICENSE" in archive.namelist() diff --git a/tests/test_start_script.py b/tests/test_start_script.py index e0637de9..eda2d762 100644 --- a/tests/test_start_script.py +++ b/tests/test_start_script.py @@ -448,10 +448,19 @@ def test_a_missing_candidate_is_not_usable(tmp_path): assert out == "NOT_USABLE" +def _stamp(prefix): + """What `scripts/build_liboqs.sh` leaves beside a build it proved.""" + lines = (START.parent / "scripts" / "liboqs.lock").read_text().splitlines() + (prefix / "nmesh-liboqs.lock").write_text("\n".join( + line for line in lines + if line.startswith(("LIBOQS_VERSION=", "LIBOQS_COMMIT=", "LIBOQS_TARBALL_SHA256="))) + "\n") + + def test_adoption_copies_the_library_instead_of_building(tmp_path): source = tmp_path / "old" / "_oqs" (source / "lib").mkdir(parents=True) (source / "lib" / "liboqs.so").write_text("ELF") + _stamp(source) (source / "include").mkdir() (source / "include" / "oqs.h").write_text("header") dest = tmp_path / "new" / "_oqs" @@ -466,6 +475,23 @@ def test_adoption_copies_the_library_instead_of_building(tmp_path): assert out == f"ADOPTED:{source}" assert (dest / "lib" / "liboqs.so").read_text() == "ELF" assert (dest / "include" / "oqs.h").exists() + assert (dest / "nmesh-liboqs.lock").exists() + + +def test_a_candidate_with_no_stamp_is_never_adopted(tmp_path): + """It may have been built before sources were checked: rebuild instead.""" + source = tmp_path / "old" / "_oqs" + (source / "lib").mkdir(parents=True) + (source / "lib" / "liboqs.so").write_text("ELF") + dest = tmp_path / "new" / "_oqs" + out = run_snippet(tmp_path, f""" + OQS_PREFIX="{dest}" + OQS_REUSE_FROM="{source}" + pq_ready() {{ [ -f "${{OQS_INSTALL_PATH:-}}/lib/liboqs.so" ]; }} + adopt_liboqs 1.2.3 && echo ADOPTED || echo NOT_ADOPTED + """, env={"NMESH_LIBOQS_CACHE": str(tmp_path / "cache")}) + assert out == "NOT_ADOPTED" + assert not dest.exists() or not (dest / "lib").exists() def test_an_unloadable_candidate_is_never_adopted(tmp_path): @@ -510,12 +536,26 @@ def test_a_build_fills_the_cache(tmp_path): built = tmp_path / "prefix" (built / "lib").mkdir(parents=True) (built / "lib" / "liboqs.so").write_text("ELF") + _stamp(built) cache = tmp_path / "cache" run_snippet(tmp_path, f""" OQS_PREFIX="{built}" cache_liboqs 0.16.0 """, env={"NMESH_LIBOQS_CACHE": str(cache)}) assert (cache / "liboqs-0.16.0" / "lib" / "liboqs.so").read_text() == "ELF" + assert (cache / "liboqs-0.16.0" / "nmesh-liboqs.lock").exists() + + +def test_an_unproven_build_is_never_cached(tmp_path): + built = tmp_path / "prefix" + (built / "lib").mkdir(parents=True) + (built / "lib" / "liboqs.so").write_text("ELF") + cache = tmp_path / "cache" + run_snippet(tmp_path, f""" + OQS_PREFIX="{built}" + cache_liboqs 0.16.0 + """, env={"NMESH_LIBOQS_CACHE": str(cache)}) + assert not (cache / "liboqs-0.16.0" / "lib").exists() def test_an_unwritable_cache_does_not_break_the_install(tmp_path): @@ -770,3 +810,63 @@ def test_the_last_resort_build_links_the_interpreter_in(): symbols, wrong on Android.""" main = START.read_text().split("MAIN", 1)[1] assert "-C link-arg=-lpython" in main + + +# ── which liboqs was proven (BUGSVULNS 93) ────────────────────────────────── + +class TestTheProvenLibrary: + """A library in the prefix is kept or reused only with the stamp + `scripts/build_liboqs.sh` writes beside it, for the lock in this tree.""" + + def _prefix(self, tmp_path, *, lib="lib", stamp=None): + prefix = tmp_path / "_oqs" + (prefix / lib).mkdir(parents=True) + (prefix / lib / "liboqs.so.9").write_bytes(b"") + if stamp is not None: + (prefix / "nmesh-liboqs.lock").write_text(stamp) + return prefix + + def _ask(self, tmp_path, question, prefix): + root = START.parent + return run_snippet(tmp_path, f'cd "{root}"; {question} "{prefix}" && echo yes || echo no') + + def _current(self): + lines = (START.parent / "scripts" / "liboqs.lock").read_text().splitlines() + return "\n".join(l for l in lines if l.startswith(("LIBOQS_VERSION=", "LIBOQS_COMMIT=", + "LIBOQS_TARBALL_SHA256="))) + "\n" + + def test_a_library_in_lib_alone_is_found(self, tmp_path): + prefix = self._prefix(tmp_path) + assert self._ask(tmp_path, "liboqs_in_prefix", prefix) == "yes" + + def test_one_in_lib64_alone_is_found(self, tmp_path): + prefix = self._prefix(tmp_path, lib="lib64") + assert self._ask(tmp_path, "liboqs_in_prefix", prefix) == "yes" + + def test_no_stamp_is_unproven(self, tmp_path): + prefix = self._prefix(tmp_path) + assert self._ask(tmp_path, "liboqs_unproven_at", prefix) == "yes" + + def test_the_current_lock_s_stamp_is_proven(self, tmp_path): + prefix = self._prefix(tmp_path, stamp=self._current()) + assert self._ask(tmp_path, "liboqs_proven_at", prefix) == "yes" + assert self._ask(tmp_path, "liboqs_unproven_at", prefix) == "no" + + def test_another_lock_s_stamp_is_not(self, tmp_path): + prefix = self._prefix(tmp_path, stamp=self._current().replace("LIBOQS_COMMIT=", "LIBOQS_COMMIT=0")) + assert self._ask(tmp_path, "liboqs_unproven_at", prefix) == "yes" + + def test_an_empty_prefix_is_nothing_to_replace(self, tmp_path): + (tmp_path / "_oqs").mkdir() + assert self._ask(tmp_path, "liboqs_unproven_at", tmp_path / "_oqs") == "no" + + def test_a_copy_others_could_rewrite_is_refused(self, tmp_path): + prefix = self._prefix(tmp_path, stamp=self._current()) + assert self._ask(tmp_path, "liboqs_writable_by_others", prefix) == "no" + (prefix / "lib" / "liboqs.so.9").chmod(0o664) + assert self._ask(tmp_path, "liboqs_writable_by_others", prefix) == "yes" + + def test_a_symlink_is_not_mistaken_for_a_writable_file(self, tmp_path): + prefix = self._prefix(tmp_path, stamp=self._current()) + (prefix / "lib" / "liboqs.so").symlink_to("liboqs.so.9") + assert self._ask(tmp_path, "liboqs_writable_by_others", prefix) == "no" diff --git a/tests/test_workflows_pinned.py b/tests/test_workflows_pinned.py index 9bf7e1ec..437defc6 100644 --- a/tests/test_workflows_pinned.py +++ b/tests/test_workflows_pinned.py @@ -80,3 +80,13 @@ def test_a_tag_reference_is_refused(): assert not _PINNED.match("actions/checkout@v4") assert not _PINNED.match("actions/checkout@11d5960") assert _PINNED.match("actions/checkout@" + "a" * 40) + + +@pytest.mark.parametrize("name", ["base-image.yml", "ci.yml"]) +def test_what_publishes_latest_does_it_one_run_at_a_time(name): + """Two merges a minute apart once let the older build overwrite the newer + `:latest` (BUGSVULNS 100).""" + text = (WORKFLOWS / name).read_text() + assert re.search(r"concurrency:\s*\n\s+group: ", text), name + assert "cancel-in-progress: false" in text +