From 1a6af44a736c0202a8e7ca332c4681ac9badca5e Mon Sep 17 00:00:00 2001 From: Goose Date: Thu, 2 Apr 2026 13:54:37 +0000 Subject: [PATCH] feat: add shannon pentesting skill and AGPL-3.0 license Copy the shannon skill from unicodeveloper/shannon into the Agent Skills repo. Add proper full AGPL-3.0 license text to respect upstream licensing. Update CLAUDE.md to document the new skill. Co-Authored-By: Paperclip --- CLAUDE.md | 3 +- LICENSE | 661 +++++++++++++++++++++++++++++++ shannon/CLAUDE.md | 19 + shannon/SKILL.md | 461 +++++++++++++++++++++ shannon/scripts/setup-shannon.sh | 60 +++ shannon/scripts/sync.sh | 31 ++ 6 files changed, 1234 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 shannon/CLAUDE.md create mode 100644 shannon/SKILL.md create mode 100755 shannon/scripts/setup-shannon.sh create mode 100755 shannon/scripts/sync.sh diff --git a/CLAUDE.md b/CLAUDE.md index 8eab502..bb3471f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -16,10 +16,11 @@ Each skill follows this convention: - **`github-app-token`** — Documents how to generate short-lived GitHub App installation access tokens. Requires `GITHUB_APP_ID`, `GITHUB_APP_INSTALLATION_ID`, and `GITHUB_APP_PEM_FILE` env vars. Inline commands only — no bundled scripts. - **`playwright-ephemeral`** — Provisions ephemeral Playwright MCP browser sessions as Kubernetes Jobs for E2E testing. Creates a Job + Service pair in a dedicated namespace, waits for readiness, and returns the MCP endpoint URL. Requires `kubectl` and appropriate RBAC. +- **`shannon`** — Autonomous AI pentester for web apps and APIs. Wraps the Docker-based Shannon pentester as a `/shannon` slash command. Requires `docker`, `git`, and an AI API key (`ANTHROPIC_API_KEY` or equivalent). ## Key Patterns -- Scripts are pure bash with no external dependencies beyond standard Unix tools (`openssl`, `curl`, `jq`, `kubectl`). +- Scripts are pure bash with no external dependencies beyond standard Unix tools (`openssl`, `curl`, `jq`, `kubectl`, `docker`). - The `die()` function prints errors to stderr and exits non-zero. ## No Build/Test/Lint System diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/shannon/CLAUDE.md b/shannon/CLAUDE.md new file mode 100644 index 0000000..8981c4a --- /dev/null +++ b/shannon/CLAUDE.md @@ -0,0 +1,19 @@ +# Shannon Skill + +Claude Code skill for autonomous AI pentesting via Shannon. +Wraps the Docker-based Shannon pentester as a `/shannon` slash command. + +## Structure +- `SKILL.md` — skill definition (deployed to ~/.claude/skills/shannon/) +- `scripts/setup-shannon.sh` — installer/updater for Shannon +- `scripts/sync.sh` — deploy to ~/.claude, ~/.agents, ~/.codex + +## Commands +```bash +bash scripts/sync.sh # Deploy to all skill locations +``` + +## Rules +- ALWAYS confirm authorization before running pentests +- NEVER target production systems +- After edits: run `bash scripts/sync.sh` to deploy diff --git a/shannon/SKILL.md b/shannon/SKILL.md new file mode 100644 index 0000000..6cab8f5 --- /dev/null +++ b/shannon/SKILL.md @@ -0,0 +1,461 @@ +--- +name: shannon +version: "1.0.0" +description: "Autonomous AI pentester for web apps and APIs. Run white-box security assessments with Shannon — analyzes source code, identifies attack vectors, and executes real exploits to prove vulnerabilities. Triggered by 'shannon', 'pentest', 'security audit', 'vuln scan'." +argument-hint: 'shannon http://localhost:3000 myapp, shannon --workspace=audit1 http://staging.example.com myrepo' +allowed-tools: Bash, Read, Write, AskUserQuestion, WebSearch +homepage: https://github.com/KeygraphHQ/shannon +repository: https://github.com/KeygraphHQ/shannon +author: KeygraphHQ +license: AGPL-3.0 +user-invocable: true +metadata: + openclaw: + emoji: "🔐" + category: "security" + requires: + env: + - ANTHROPIC_API_KEY + optionalEnv: + - CLAUDE_CODE_OAUTH_TOKEN + - CLAUDE_CODE_USE_BEDROCK + - CLAUDE_CODE_USE_VERTEX + - AWS_REGION + - AWS_ACCESS_KEY_ID + - AWS_SECRET_ACCESS_KEY + bins: + - docker + - git + primaryEnv: ANTHROPIC_API_KEY + files: + - "scripts/*" + tags: + - security + - pentesting + - pentest + - vulnerability + - exploit + - owasp + - xss + - sqli + - ssrf + - authentication + - authorization + - white-box + - appsec +--- + +# Shannon: Autonomous AI Pentester for Web Apps & APIs + +> **Permissions overview:** This skill orchestrates Shannon, a Docker-based pentesting tool that actively executes attacks against a target application. It clones/updates the Shannon repo locally, runs Docker containers, and reads pentest reports. **Shannon performs real exploits — only run against apps you own or have explicit written authorization to test.** Never run against production systems. + +Shannon analyzes your source code, identifies attack vectors, and executes real exploits to prove vulnerabilities before they reach production. 96.15% exploit success rate on the XBOW security benchmark. Covers OWASP Top 10: Injection, XSS, SSRF, Broken Auth, Broken AuthZ, and more. + +--- + +## CRITICAL: Safety Checks (ALWAYS run first) + +Before doing ANYTHING, you MUST confirm: + +1. **Authorization**: Ask the user — "Do you have explicit authorization to pentest this target?" If they say no or are unsure, STOP and explain they need written permission from the system owner. +2. **Environment**: Confirm the target is a local, staging, or sandboxed environment — NEVER production. +3. **Scope**: Clarify what they want tested (full pentest vs specific category). + +``` +⚠️ Shannon executes REAL ATTACKS with mutative effects. +├─ Only run on systems you OWN or have WRITTEN AUTHORIZATION to test +├─ Never target production environments +├─ Results require human review — LLM output may contain hallucinations +└─ You are responsible for complying with all applicable laws +``` + +Display this warning BEFORE every pentest run. If the user has already confirmed authorization in this session, a brief reminder suffices. + +--- + +## Parse User Intent + +Extract from the user's input: + +1. **TARGET_URL**: The URL to pentest (e.g., `http://localhost:3000`, `http://staging.example.com`) +2. **REPO_NAME**: The source code folder name (placed in `./repos/` inside Shannon) +3. **SCOPE**: Full pentest (default) or specific categories (injection, xss, ssrf, auth, authz) +4. **WORKSPACE**: Named workspace for resume capability (optional) +5. **CONFIG**: Custom YAML config path (optional, for auth flows, focus/avoid rules) + +Common invocation patterns: +- `/shannon http://localhost:3000 myapp` → Full pentest of local app +- `/shannon --workspace=audit1 http://staging.example.com backend-api` → Named workspace for resuming +- `/shannon --scope=xss,injection http://localhost:8080 frontend` → Targeted categories +- `/shannon status` → Check running pentests +- `/shannon results` → Show latest report +- `/shannon stop` → Stop running pentest + +Display parsed intent: +``` +🔐 Shannon Pentest +├─ Target: {TARGET_URL} +├─ Source: repos/{REPO_NAME} +├─ Scope: {SCOPE or "Full (all 5 OWASP categories)"} +├─ Workspace: {WORKSPACE or "auto-generated"} +└─ Config: {CONFIG or "default"} + +Estimated runtime: 1–1.5 hours │ Estimated cost: ~$50 (Claude Sonnet) +``` + +--- + +## Step 0: Ensure Shannon is Installed + +Check if Shannon is cloned locally: + +```bash +SHANNON_HOME="${SHANNON_HOME:-$HOME/shannon}" + +if [ -d "$SHANNON_HOME" ] && [ -f "$SHANNON_HOME/shannon" ]; then + echo "Shannon found at $SHANNON_HOME" + cd "$SHANNON_HOME" && git pull --ff-only 2>/dev/null || true +else + echo "Shannon not found. Cloning..." + git clone https://github.com/KeygraphHQ/shannon.git "$SHANNON_HOME" +fi + +# Verify Docker is available +if command -v docker &>/dev/null; then + echo "Docker: $(docker --version)" +else + echo "ERROR: Docker is required. Install Docker Desktop: https://docker.com/products/docker-desktop" + exit 1 +fi +``` + +If Shannon is not installed, clone it and inform the user. If Docker is missing, stop and tell them to install it. + +**SHANNON_HOME** defaults to `~/shannon`. Users can override with `SHANNON_HOME` env var. + +--- + +## Step 1: Prepare Source Code + +Shannon needs the target's source code in `$SHANNON_HOME/repos/{REPO_NAME}/`. + +Ask the user where their source code is: + +```bash +# If user provides a local path +REPO_PATH="/path/to/their/source" +REPO_NAME="myapp" + +# Create symlink or copy into Shannon's repos directory +mkdir -p "$SHANNON_HOME/repos" +if [ ! -d "$SHANNON_HOME/repos/$REPO_NAME" ]; then + ln -s "$(realpath "$REPO_PATH")" "$SHANNON_HOME/repos/$REPO_NAME" + echo "Linked $REPO_PATH → repos/$REPO_NAME" +fi +``` + +If the user provides a GitHub URL instead: +```bash +cd "$SHANNON_HOME/repos" +git clone "$GITHUB_URL" "$REPO_NAME" +``` + +--- + +## Step 2: Configure Authentication (if needed) + +If the target requires login, help the user create a YAML config: + +```yaml +# $SHANNON_HOME/configs/target-config.yaml +authentication: + type: form # "form" or "sso" + login_url: "http://localhost:3000/login" + credentials: + username: "admin" + password: "password123" + flow: "Navigate to login page, enter username and password, click Sign In" + success_condition: + url_contains: "/dashboard" + +rules: + avoid: + - "/logout" + - "/admin/delete" + focus: + - "/api/" + - "/auth/" + +pipeline: + max_concurrent_pipelines: 5 # 1-5, default 5 +``` + +**Only create a config if the target requires authentication or has specific scope rules.** For open/unauthenticated targets, no config is needed. + +--- + +## Step 3: Verify API Credentials + +Check that AI provider credentials are available: + +```bash +cd "$SHANNON_HOME" + +# Check for Anthropic API key (primary) +if [ -n "${ANTHROPIC_API_KEY:-}" ]; then + echo "✅ ANTHROPIC_API_KEY is set" +elif [ -n "${CLAUDE_CODE_OAUTH_TOKEN:-}" ]; then + echo "✅ CLAUDE_CODE_OAUTH_TOKEN is set" +elif [ "${CLAUDE_CODE_USE_BEDROCK:-}" = "1" ]; then + echo "✅ AWS Bedrock mode enabled" +elif [ "${CLAUDE_CODE_USE_VERTEX:-}" = "1" ]; then + echo "✅ Google Vertex AI mode enabled" +else + echo "❌ No AI credentials found." + echo "Set one of: ANTHROPIC_API_KEY, CLAUDE_CODE_OAUTH_TOKEN, or enable Bedrock/Vertex" + exit 1 +fi +``` + +If no credentials are found, explain the options: +- **Direct API** (recommended): `export ANTHROPIC_API_KEY=sk-ant-...` +- **OAuth**: `export CLAUDE_CODE_OAUTH_TOKEN=...` +- **AWS Bedrock**: `export CLAUDE_CODE_USE_BEDROCK=1` + AWS credentials +- **Google Vertex**: `export CLAUDE_CODE_USE_VERTEX=1` + service account in `./credentials/` + +Also recommend: `export CLAUDE_CODE_MAX_OUTPUT_TOKENS=64000` + +--- + +## Step 4: Launch the Pentest + +**CRITICAL: Confirm with the user before launching.** Display the full command and wait for approval. + +```bash +cd "$SHANNON_HOME" + +# Build the command +CMD="./shannon start URL={TARGET_URL} REPO={REPO_NAME}" + +# Add optional flags +# CONFIG=configs/target-config.yaml (if auth config exists) +# WORKSPACE={WORKSPACE} (if user specified) +# OUTPUT=./audit-logs/ (default) + +echo "Ready to launch:" +echo " $CMD" +echo "" +echo "This will start Docker containers and begin the pentest." +echo "Runtime: ~1-1.5 hours │ Cost: ~\$50 (Claude Sonnet)" +``` + +After user confirms, run in background: +```bash +cd "$SHANNON_HOME" && ./shannon start URL={TARGET_URL} REPO={REPO_NAME} {EXTRA_FLAGS} +``` + +Use `run_in_background: true` with a timeout of 600000ms (10 minutes for initial setup). The pentest itself runs in Docker and will continue independently. + +--- + +## Step 5: Monitor Progress + +While the pentest runs, the user can check status: + +```bash +cd "$SHANNON_HOME" + +# List active workspaces +./shannon workspaces + +# View logs for a specific workflow +./shannon logs ID={workflow-id} +``` + +Explain the 5-phase pipeline: +``` +Shannon Pipeline (5 phases, parallel where possible): +├─ Phase 1: Pre-Recon — Source code analysis + external scans (Nmap, Subfinder, WhatWeb) +├─ Phase 2: Recon — Live attack surface mapping via browser automation +├─ Phase 3: Vulnerability Analysis — 5 parallel agents (Injection, XSS, SSRF, Auth, AuthZ) +├─ Phase 4: Exploitation — Dedicated agents execute real attacks to validate findings +└─ Phase 5: Reporting — Executive summary with reproducible PoCs +``` + +--- + +## Step 6: Read and Interpret Results + +Reports are saved to `$SHANNON_HOME/audit-logs/{hostname}_{sessionId}/`. + +```bash +cd "$SHANNON_HOME" + +# Find the latest report +LATEST=$(ls -td audit-logs/*/ 2>/dev/null | head -1) +if [ -n "$LATEST" ]; then + echo "Latest report: $LATEST" + # Find the main report file + find "$LATEST" -name "*.md" -type f | head -5 +fi +``` + +Read the report and present a summary: + +``` +🔐 Shannon Pentest Report: {TARGET} +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +🔴 Critical: {N} vulnerabilities +🟠 High: {N} vulnerabilities +🟡 Medium: {N} vulnerabilities +🔵 Low: {N} vulnerabilities + +Top Findings: +1. [CRITICAL] {Vuln type} — {location} — PoC: {brief description} +2. [HIGH] {Vuln type} — {location} — PoC: {brief description} +3. ... + +Each finding includes a reproducible proof-of-concept exploit. +``` + +**IMPORTANT: Shannon's "no exploit, no report" policy means every finding has a working PoC.** But remind the user that LLM-generated content requires human review. + +--- + +## Utility Commands + +### Check status +```bash +cd "$SHANNON_HOME" && ./shannon workspaces +``` + +### View logs +```bash +cd "$SHANNON_HOME" && ./shannon logs ID={workflow-id} +``` + +### Stop pentest +```bash +cd "$SHANNON_HOME" && ./shannon stop +``` + +### Stop and clean up all data +```bash +# DESTRUCTIVE — confirm with user first +cd "$SHANNON_HOME" && ./shannon stop CLEAN=true +``` + +### Resume a previous workspace +```bash +cd "$SHANNON_HOME" && ./shannon start URL={URL} REPO={REPO} WORKSPACE={name} +``` + +--- + +## Targeting Local Apps + +If the user's app runs on localhost, explain: +``` +Shannon runs inside Docker. To reach your local app: +├─ Use http://host.docker.internal:{PORT} instead of http://localhost:{PORT} +├─ macOS/Windows: works automatically with Docker Desktop +└─ Linux: add --add-host=host.docker.internal:host-gateway to docker run +``` + +Automatically translate `localhost` URLs to `host.docker.internal` in the command. + +--- + +## Configuration Reference + +### Environment Variables +| Variable | Required | Description | +|----------|----------|-------------| +| `ANTHROPIC_API_KEY` | One of these | Direct Anthropic API key | +| `CLAUDE_CODE_OAUTH_TOKEN` | required | Anthropic OAuth token | +| `CLAUDE_CODE_USE_BEDROCK` | | Set to `1` for AWS Bedrock | +| `CLAUDE_CODE_USE_VERTEX` | | Set to `1` for Google Vertex AI | +| `CLAUDE_CODE_MAX_OUTPUT_TOKENS` | Recommended | Set to `64000` | +| `SHANNON_HOME` | Optional | Shannon install dir (default: `~/shannon`) | + +### YAML Config Options +| Section | Field | Description | +|---------|-------|-------------| +| `authentication.type` | `form` / `sso` | Login method | +| `authentication.login_url` | URL | Login page | +| `authentication.credentials` | object | username, password, totp_secret | +| `authentication.flow` | string | Natural language login instructions | +| `authentication.success_condition` | object | `url_contains` or `element_present` | +| `rules.avoid` | list | Paths/subdomains to skip | +| `rules.focus` | list | Paths/subdomains to prioritize | +| `pipeline.retry_preset` | `subscription` | Extended backoff for rate-limited plans | +| `pipeline.max_concurrent_pipelines` | 1-5 | Parallel agent count (default: 5) | + +--- + +## Vulnerability Coverage + +Shannon tests 50+ specific cases across 5 OWASP categories: + +| Category | Examples | +|----------|----------| +| **Injection** | SQL injection, command injection, SSTI, NoSQL injection | +| **XSS** | Reflected, stored, DOM-based, via file upload | +| **SSRF** | Internal service access, cloud metadata, protocol smuggling | +| **Broken Auth** | Default creds, JWT flaws, session fixation, MFA bypass, CSRF | +| **Broken AuthZ** | IDOR, privilege escalation, path traversal, forced browsing | + +--- + +## Integrated Security Tools (bundled in Docker) + +- **Nmap** — port scanning and service detection +- **Subfinder** — subdomain enumeration +- **WhatWeb** — web technology fingerprinting +- **Schemathesis** — API schema-based fuzzing +- **Chromium** — headless browser for automated exploitation (Playwright) + +--- + +## Context Memory + +For the rest of this conversation, remember: +- **SHANNON_HOME**: Path to Shannon installation +- **TARGET_URL**: The URL being tested +- **REPO_NAME**: Source code folder name +- **WORKSPACE**: Workspace name (if any) +- **PENTEST_STATUS**: running / completed / stopped + +When the user asks follow-up questions: +- Check pentest status and report on progress +- Read and interpret new findings from audit-logs +- Help remediate discovered vulnerabilities with code fixes +- Explain PoC exploits and their impact + +--- + +## Security & Permissions + +**What this skill does:** +- Clones/updates the Shannon repo from GitHub to `~/shannon` (or `$SHANNON_HOME`) +- Creates symlinks from user's source code into `~/shannon/repos/` +- Starts Docker containers (Temporal server, worker, optional router) via `./shannon` CLI +- Reads pentest reports from `~/shannon/audit-logs/` +- Optionally creates YAML config files in `~/shannon/configs/` + +**What Shannon does (inside Docker):** +- Executes real exploits against the target URL (SQL injection, XSS, SSRF, etc.) +- Scans with Nmap, Subfinder, WhatWeb, Schemathesis +- Automates browser interactions via headless Chromium +- Sends prompts to Anthropic API (or Bedrock/Vertex) for reasoning +- Writes reports to `audit-logs/` directory + +**What this skill does NOT do:** +- Does not target any system without user confirmation +- Does not store or transmit API keys beyond the configured provider +- Does not modify the user's source code +- Does not access production systems unless explicitly directed (which it warns against) +- Does not run without Docker — all attack tools are containerized + +**Review the Shannon source code before first use:** https://github.com/KeygraphHQ/shannon diff --git a/shannon/scripts/setup-shannon.sh b/shannon/scripts/setup-shannon.sh new file mode 100755 index 0000000..1da9f9a --- /dev/null +++ b/shannon/scripts/setup-shannon.sh @@ -0,0 +1,60 @@ +#!/usr/bin/env bash +# setup-shannon.sh - Install or update Shannon pentester +# Usage: bash scripts/setup-shannon.sh [SHANNON_HOME] +set -euo pipefail + +SHANNON_HOME="${1:-${SHANNON_HOME:-$HOME/shannon}}" + +echo "🔐 Shannon Setup" +echo "━━━━━━━━━━━━━━━━" + +# Check Docker +if ! command -v docker &>/dev/null; then + echo "❌ Docker is required but not installed." + echo " Install: https://docker.com/products/docker-desktop" + exit 1 +fi +echo "✅ Docker: $(docker --version 2>/dev/null | head -1)" + +# Check git +if ! command -v git &>/dev/null; then + echo "❌ Git is required but not installed." + exit 1 +fi +echo "✅ Git: $(git --version)" + +# Clone or update Shannon +if [ -d "$SHANNON_HOME" ] && [ -f "$SHANNON_HOME/shannon" ]; then + echo "✅ Shannon found at $SHANNON_HOME" + echo " Updating..." + cd "$SHANNON_HOME" && git pull --ff-only 2>/dev/null || echo " (already up to date or can't fast-forward)" +else + echo "📥 Cloning Shannon to $SHANNON_HOME..." + git clone https://github.com/KeygraphHQ/shannon.git "$SHANNON_HOME" + echo "✅ Shannon cloned successfully" +fi + +# Check API credentials +echo "" +echo "API Credentials:" +if [ -n "${ANTHROPIC_API_KEY:-}" ]; then + echo "✅ ANTHROPIC_API_KEY is set" +elif [ -n "${CLAUDE_CODE_OAUTH_TOKEN:-}" ]; then + echo "✅ CLAUDE_CODE_OAUTH_TOKEN is set" +elif [ "${CLAUDE_CODE_USE_BEDROCK:-}" = "1" ]; then + echo "✅ AWS Bedrock mode enabled" +elif [ "${CLAUDE_CODE_USE_VERTEX:-}" = "1" ]; then + echo "✅ Google Vertex AI mode enabled" +else + echo "⚠️ No AI credentials detected. Set one of:" + echo " export ANTHROPIC_API_KEY=sk-ant-..." + echo " export CLAUDE_CODE_OAUTH_TOKEN=..." + echo " export CLAUDE_CODE_USE_BEDROCK=1" + echo " export CLAUDE_CODE_USE_VERTEX=1" +fi + +echo "" +echo "Recommended: export CLAUDE_CODE_MAX_OUTPUT_TOKENS=64000" +echo "" +echo "Shannon is ready at: $SHANNON_HOME" +echo "Run a pentest: cd $SHANNON_HOME && ./shannon start URL=http://localhost:3000 REPO=myapp" diff --git a/shannon/scripts/sync.sh b/shannon/scripts/sync.sh new file mode 100755 index 0000000..2da838c --- /dev/null +++ b/shannon/scripts/sync.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash +# sync.sh - Deploy shannon skill to all host locations +# Usage: bash scripts/sync.sh (run from repo root) +set -euo pipefail + +SRC="$(cd "$(dirname "$0")/.." && pwd)" +echo "Source: $SRC" + +TARGETS=( + "$HOME/.claude/skills/shannon" + "$HOME/.agents/skills/shannon" + "$HOME/.codex/skills/shannon" +) + +for t in "${TARGETS[@]}"; do + echo "" + echo "--- Syncing to $t ---" + mkdir -p "$t/scripts" + + cp "$SRC/SKILL.md" "$t/" + + # Helper scripts + if ls "$SRC/scripts/"*.sh &>/dev/null; then + rsync -a "$SRC/scripts/"*.sh "$t/scripts/" + fi + + echo " Deployed to $t" +done + +echo "" +echo "Sync complete."