diff options
23 files changed, 2370 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a843a02 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# Xcode +xcuserdata/ +*.xcuserstate +DerivedData/ +build/ + +# macOS +.DS_Store + +# Claude Code local settings +.claude/settings.local.json @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2415317 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# octosentry + +A macOS menu bar app that aggregates GitHub security alerts — Dependabot, +code scanning, and secret scanning — across your repos into a single, +severity-ranked feed. No dashboard, no general-purpose GitHub browsing: +just a fast triage view that deep-links out to github.com to act. + +## Features + +- Unified feed across all three GitHub security alert types, normalized + onto one severity scale +- Source badge, repo, GitHub's own severity label, one-line summary, and + age for each alert +- Click an alert to open it directly on github.com +- Errors and unavailable sources (e.g. an alert type disabled for a repo) + are surfaced in the popover instead of failing silently +- Zero third-party dependencies — pure SwiftUI and URLSession + +## Requirements + +- macOS 14 or later +- A GitHub personal access token (fine-grained or classic) with read + access to Dependabot alerts, code scanning alerts, and secret scanning + alerts for the repo you want to watch + +## Usage + +octosentry currently watches a single, hardcoded repo and reads its +GitHub token from the `GITHUB_TOKEN` environment variable — this is a +development-only shortcut ahead of a proper device authorization flow. + +1. Build and run the app (see Building, below). +2. Set `GITHUB_TOKEN` in your **personal, non-shared** Xcode scheme + (Product → Scheme → Edit Scheme… → Run → Arguments → + Environment Variables). Don't add it to a shared scheme — that would + commit the token to git. +3. Click the shield icon in the menu bar to open the popover. It fetches + automatically on open, or use the refresh button. +4. Click any alert to open it on github.com. + +If a source shows as unavailable, it usually means that alert type is +disabled for the repo, or the token is missing that one permission — not +that something is broken. + +## Building + +Open `octosentry.xcodeproj` in Xcode and run the `octosentry` scheme. +The project targets macOS 14 with Swift 6 language mode and strict +concurrency enabled — no package dependencies to resolve. + +## Contributing + +Issues and pull requests are welcome. A few things worth knowing before +you start: + +- No third-party dependencies — this is a hard constraint, not a + preference. +- Swift 6 strict concurrency is on; new code should compile clean under + it, not suppress it. +- Match the existing file-per-type layout (models, mapping, API client, + views) rather than introducing new architectural patterns. + +## License + +GPL-3.0 — see [LICENSE](LICENSE). diff --git a/octosentry.xcodeproj/project.pbxproj b/octosentry.xcodeproj/project.pbxproj new file mode 100644 index 0000000..a6c2fcc --- /dev/null +++ b/octosentry.xcodeproj/project.pbxproj @@ -0,0 +1,586 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 77; + objects = { + +/* Begin PBXContainerItemProxy section */ + 8B8FD177300A873200B09EAA /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 8B8FD161300A873000B09EAA /* Project object */; + proxyType = 1; + remoteGlobalIDString = 8B8FD168300A873000B09EAA; + remoteInfo = octosentry; + }; + 8B8FD181300A873200B09EAA /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 8B8FD161300A873000B09EAA /* Project object */; + proxyType = 1; + remoteGlobalIDString = 8B8FD168300A873000B09EAA; + remoteInfo = octosentry; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXFileReference section */ + 8B8FD169300A873000B09EAA /* octosentry.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = octosentry.app; sourceTree = BUILT_PRODUCTS_DIR; }; + 8B8FD176300A873200B09EAA /* octosentryTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = octosentryTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 8B8FD180300A873200B09EAA /* octosentryUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = octosentryUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFileSystemSynchronizedRootGroup section */ + 8B8FD16B300A873000B09EAA /* octosentry */ = { + isa = PBXFileSystemSynchronizedRootGroup; + path = octosentry; + sourceTree = "<group>"; + }; + 8B8FD179300A873200B09EAA /* octosentryTests */ = { + isa = PBXFileSystemSynchronizedRootGroup; + path = octosentryTests; + sourceTree = "<group>"; + }; + 8B8FD183300A873200B09EAA /* octosentryUITests */ = { + isa = PBXFileSystemSynchronizedRootGroup; + path = octosentryUITests; + sourceTree = "<group>"; + }; +/* End PBXFileSystemSynchronizedRootGroup section */ + +/* Begin PBXFrameworksBuildPhase section */ + 8B8FD166300A873000B09EAA /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD173300A873200B09EAA /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD17D300A873200B09EAA /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 8B8FD160300A873000B09EAA = { + isa = PBXGroup; + children = ( + 8B8FD16B300A873000B09EAA /* octosentry */, + 8B8FD179300A873200B09EAA /* octosentryTests */, + 8B8FD183300A873200B09EAA /* octosentryUITests */, + 8B8FD16A300A873000B09EAA /* Products */, + ); + sourceTree = "<group>"; + }; + 8B8FD16A300A873000B09EAA /* Products */ = { + isa = PBXGroup; + children = ( + 8B8FD169300A873000B09EAA /* octosentry.app */, + 8B8FD176300A873200B09EAA /* octosentryTests.xctest */, + 8B8FD180300A873200B09EAA /* octosentryUITests.xctest */, + ); + name = Products; + sourceTree = "<group>"; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 8B8FD168300A873000B09EAA /* octosentry */ = { + isa = PBXNativeTarget; + buildConfigurationList = 8B8FD18A300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentry" */; + buildPhases = ( + 8B8FD165300A873000B09EAA /* Sources */, + 8B8FD166300A873000B09EAA /* Frameworks */, + 8B8FD167300A873000B09EAA /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + ); + fileSystemSynchronizedGroups = ( + 8B8FD16B300A873000B09EAA /* octosentry */, + ); + name = octosentry; + packageProductDependencies = ( + ); + productName = octosentry; + productReference = 8B8FD169300A873000B09EAA /* octosentry.app */; + productType = "com.apple.product-type.application"; + }; + 8B8FD175300A873200B09EAA /* octosentryTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 8B8FD18D300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentryTests" */; + buildPhases = ( + 8B8FD172300A873200B09EAA /* Sources */, + 8B8FD173300A873200B09EAA /* Frameworks */, + 8B8FD174300A873200B09EAA /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 8B8FD178300A873200B09EAA /* PBXTargetDependency */, + ); + fileSystemSynchronizedGroups = ( + 8B8FD179300A873200B09EAA /* octosentryTests */, + ); + name = octosentryTests; + packageProductDependencies = ( + ); + productName = octosentryTests; + productReference = 8B8FD176300A873200B09EAA /* octosentryTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 8B8FD17F300A873200B09EAA /* octosentryUITests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 8B8FD190300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentryUITests" */; + buildPhases = ( + 8B8FD17C300A873200B09EAA /* Sources */, + 8B8FD17D300A873200B09EAA /* Frameworks */, + 8B8FD17E300A873200B09EAA /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 8B8FD182300A873200B09EAA /* PBXTargetDependency */, + ); + fileSystemSynchronizedGroups = ( + 8B8FD183300A873200B09EAA /* octosentryUITests */, + ); + name = octosentryUITests; + packageProductDependencies = ( + ); + productName = octosentryUITests; + productReference = 8B8FD180300A873200B09EAA /* octosentryUITests.xctest */; + productType = "com.apple.product-type.bundle.ui-testing"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 8B8FD161300A873000B09EAA /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = 1; + LastSwiftUpdateCheck = 2660; + LastUpgradeCheck = 2660; + TargetAttributes = { + 8B8FD168300A873000B09EAA = { + CreatedOnToolsVersion = 26.6; + }; + 8B8FD175300A873200B09EAA = { + CreatedOnToolsVersion = 26.6; + TestTargetID = 8B8FD168300A873000B09EAA; + }; + 8B8FD17F300A873200B09EAA = { + CreatedOnToolsVersion = 26.6; + TestTargetID = 8B8FD168300A873000B09EAA; + }; + }; + }; + buildConfigurationList = 8B8FD164300A873000B09EAA /* Build configuration list for PBXProject "octosentry" */; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 8B8FD160300A873000B09EAA; + minimizedProjectReferenceProxies = 1; + preferredProjectObjectVersion = 77; + productRefGroup = 8B8FD16A300A873000B09EAA /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 8B8FD168300A873000B09EAA /* octosentry */, + 8B8FD175300A873200B09EAA /* octosentryTests */, + 8B8FD17F300A873200B09EAA /* octosentryUITests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 8B8FD167300A873000B09EAA /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD174300A873200B09EAA /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD17E300A873200B09EAA /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 8B8FD165300A873000B09EAA /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD172300A873200B09EAA /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 8B8FD17C300A873200B09EAA /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 8B8FD178300A873200B09EAA /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 8B8FD168300A873000B09EAA /* octosentry */; + targetProxy = 8B8FD177300A873200B09EAA /* PBXContainerItemProxy */; + }; + 8B8FD182300A873200B09EAA /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 8B8FD168300A873000B09EAA /* octosentry */; + targetProxy = 8B8FD181300A873200B09EAA /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin XCBuildConfiguration section */ + 8B8FD188300A873200B09EAA /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++20"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = YES; + GCC_C_LANGUAGE_STANDARD = gnu17; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + LOCALIZATION_PREFERS_STRING_CATALOGS = YES; + MACOSX_DEPLOYMENT_TARGET = 14.0; + MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; + MTL_FAST_MATH = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = "DEBUG $(inherited)"; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 8B8FD189300A873200B09EAA /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++20"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = YES; + GCC_C_LANGUAGE_STANDARD = gnu17; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + LOCALIZATION_PREFERS_STRING_CATALOGS = YES; + MACOSX_DEPLOYMENT_TARGET = 14.0; + MTL_ENABLE_DEBUG_INFO = NO; + MTL_FAST_MATH = YES; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + }; + name = Release; + }; + 8B8FD18B300A873200B09EAA /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + ENABLE_APP_SANDBOX = YES; + ENABLE_HARDENED_RUNTIME = YES; + ENABLE_OUTGOING_NETWORK_CONNECTIONS = YES; + ENABLE_PREVIEWS = YES; + ENABLE_USER_SELECTED_FILES = readonly; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_KEY_CFBundleDisplayName = OctoSentry; + INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.developer-tools"; + INFOPLIST_KEY_LSUIElement = YES; + INFOPLIST_KEY_NSHumanReadableCopyright = ""; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentry; + PRODUCT_NAME = "$(TARGET_NAME)"; + REGISTER_APP_GROUPS = YES; + STRING_CATALOG_GENERATE_SYMBOLS = YES; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_DEFAULT_ACTOR_ISOLATION = MainActor; + SWIFT_EMIT_LOC_STRINGS = YES; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + }; + name = Debug; + }; + 8B8FD18C300A873200B09EAA /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + ASSETCATALOG_COMPILER_GLOBAL_ACCENT_COLOR_NAME = AccentColor; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + ENABLE_APP_SANDBOX = YES; + ENABLE_HARDENED_RUNTIME = YES; + ENABLE_OUTGOING_NETWORK_CONNECTIONS = YES; + ENABLE_PREVIEWS = YES; + ENABLE_USER_SELECTED_FILES = readonly; + GENERATE_INFOPLIST_FILE = YES; + INFOPLIST_KEY_CFBundleDisplayName = OctoSentry; + INFOPLIST_KEY_LSApplicationCategoryType = "public.app-category.developer-tools"; + INFOPLIST_KEY_LSUIElement = YES; + INFOPLIST_KEY_NSHumanReadableCopyright = ""; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentry; + PRODUCT_NAME = "$(TARGET_NAME)"; + REGISTER_APP_GROUPS = YES; + STRING_CATALOG_GENERATE_SYMBOLS = YES; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_DEFAULT_ACTOR_ISOLATION = MainActor; + SWIFT_EMIT_LOC_STRINGS = YES; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + }; + name = Release; + }; + 8B8FD18E300A873200B09EAA /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + GENERATE_INFOPLIST_FILE = YES; + MACOSX_DEPLOYMENT_TARGET = 14.0; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentryTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + STRING_CATALOG_GENERATE_SYMBOLS = NO; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_EMIT_LOC_STRINGS = NO; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/octosentry.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/octosentry"; + }; + name = Debug; + }; + 8B8FD18F300A873200B09EAA /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + GENERATE_INFOPLIST_FILE = YES; + MACOSX_DEPLOYMENT_TARGET = 14.0; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentryTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + STRING_CATALOG_GENERATE_SYMBOLS = NO; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_EMIT_LOC_STRINGS = NO; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/octosentry.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/octosentry"; + }; + name = Release; + }; + 8B8FD191300A873200B09EAA /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentryUITests; + PRODUCT_NAME = "$(TARGET_NAME)"; + STRING_CATALOG_GENERATE_SYMBOLS = NO; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_EMIT_LOC_STRINGS = NO; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + TEST_TARGET_NAME = octosentry; + }; + name = Debug; + }; + 8B8FD192300A873200B09EAA /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + DEVELOPMENT_TEAM = ZCNAX3VL9D; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = net.cleberg.octosentryUITests; + PRODUCT_NAME = "$(TARGET_NAME)"; + STRING_CATALOG_GENERATE_SYMBOLS = NO; + SWIFT_APPROACHABLE_CONCURRENCY = YES; + SWIFT_EMIT_LOC_STRINGS = NO; + SWIFT_UPCOMING_FEATURE_MEMBER_IMPORT_VISIBILITY = YES; + SWIFT_VERSION = 6.0; + TEST_TARGET_NAME = octosentry; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 8B8FD164300A873000B09EAA /* Build configuration list for PBXProject "octosentry" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 8B8FD188300A873200B09EAA /* Debug */, + 8B8FD189300A873200B09EAA /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 8B8FD18A300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentry" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 8B8FD18B300A873200B09EAA /* Debug */, + 8B8FD18C300A873200B09EAA /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 8B8FD18D300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentryTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 8B8FD18E300A873200B09EAA /* Debug */, + 8B8FD18F300A873200B09EAA /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 8B8FD190300A873200B09EAA /* Build configuration list for PBXNativeTarget "octosentryUITests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 8B8FD191300A873200B09EAA /* Debug */, + 8B8FD192300A873200B09EAA /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 8B8FD161300A873000B09EAA /* Project object */; +} diff --git a/octosentry.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/octosentry.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/octosentry.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<Workspace + version = "1.0"> + <FileRef + location = "self:"> + </FileRef> +</Workspace> diff --git a/octosentry.xcodeproj/xcshareddata/xcschemes/octosentry.xcscheme b/octosentry.xcodeproj/xcshareddata/xcschemes/octosentry.xcscheme new file mode 100644 index 0000000..e45fdf6 --- /dev/null +++ b/octosentry.xcodeproj/xcshareddata/xcschemes/octosentry.xcscheme @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<Scheme + LastUpgradeVersion = "2660" + version = "1.7"> + <BuildAction + parallelizeBuildables = "YES" + buildImplicitDependencies = "YES" + buildArchitectures = "Automatic"> + <BuildActionEntries> + <BuildActionEntry + buildForTesting = "YES" + buildForRunning = "YES" + buildForProfiling = "YES" + buildForArchiving = "YES" + buildForAnalyzing = "YES"> + <BuildableReference + BuildableIdentifier = "primary" + BlueprintIdentifier = "8B8FD168300A873000B09EAA" + BuildableName = "octosentry.app" + BlueprintName = "octosentry" + ReferencedContainer = "container:octosentry.xcodeproj"> + </BuildableReference> + </BuildActionEntry> + </BuildActionEntries> + </BuildAction> + <TestAction + buildConfiguration = "Debug" + selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" + selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" + shouldUseLaunchSchemeArgsEnv = "YES" + shouldAutocreateTestPlan = "YES"> + <Testables> + <TestableReference + skipped = "NO" + parallelizable = "YES"> + <BuildableReference + BuildableIdentifier = "primary" + BlueprintIdentifier = "8B8FD175300A873200B09EAA" + BuildableName = "octosentryTests.xctest" + BlueprintName = "octosentryTests" + ReferencedContainer = "container:octosentry.xcodeproj"> + </BuildableReference> + </TestableReference> + <TestableReference + skipped = "NO" + parallelizable = "YES"> + <BuildableReference + BuildableIdentifier = "primary" + BlueprintIdentifier = "8B8FD17F300A873200B09EAA" + BuildableName = "octosentryUITests.xctest" + BlueprintName = "octosentryUITests" + ReferencedContainer = "container:octosentry.xcodeproj"> + </BuildableReference> + </TestableReference> + </Testables> + </TestAction> + <LaunchAction + buildConfiguration = "Debug" + selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" + selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" + launchStyle = "0" + useCustomWorkingDirectory = "NO" + ignoresPersistentStateOnLaunch = "NO" + debugDocumentVersioning = "YES" + debugServiceExtension = "internal" + allowLocationSimulation = "YES" + queueDebuggingEnableBacktraceRecording = "Yes"> + <BuildableProductRunnable + runnableDebuggingMode = "0"> + <BuildableReference + BuildableIdentifier = "primary" + BlueprintIdentifier = "8B8FD168300A873000B09EAA" + BuildableName = "octosentry.app" + BlueprintName = "octosentry" + ReferencedContainer = "container:octosentry.xcodeproj"> + </BuildableReference> + </BuildableProductRunnable> + </LaunchAction> + <ProfileAction + buildConfiguration = "Release" + shouldUseLaunchSchemeArgsEnv = "YES" + savedToolIdentifier = "" + useCustomWorkingDirectory = "NO" + debugDocumentVersioning = "YES"> + <BuildableProductRunnable + runnableDebuggingMode = "0"> + <BuildableReference + BuildableIdentifier = "primary" + BlueprintIdentifier = "8B8FD168300A873000B09EAA" + BuildableName = "octosentry.app" + BlueprintName = "octosentry" + ReferencedContainer = "container:octosentry.xcodeproj"> + </BuildableReference> + </BuildableProductRunnable> + </ProfileAction> + <AnalyzeAction + buildConfiguration = "Debug"> + </AnalyzeAction> + <ArchiveAction + buildConfiguration = "Release" + revealArchiveInOrganizer = "YES"> + </ArchiveAction> +</Scheme> diff --git a/octosentry/Assets.xcassets/AccentColor.colorset/Contents.json b/octosentry/Assets.xcassets/AccentColor.colorset/Contents.json new file mode 100644 index 0000000..eb87897 --- /dev/null +++ b/octosentry/Assets.xcassets/AccentColor.colorset/Contents.json @@ -0,0 +1,11 @@ +{ + "colors" : [ + { + "idiom" : "universal" + } + ], + "info" : { + "author" : "xcode", + "version" : 1 + } +} diff --git a/octosentry/Assets.xcassets/AppIcon.appiconset/Contents.json b/octosentry/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..3f00db4 --- /dev/null +++ b/octosentry/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,58 @@ +{ + "images" : [ + { + "idiom" : "mac", + "scale" : "1x", + "size" : "16x16" + }, + { + "idiom" : "mac", + "scale" : "2x", + "size" : "16x16" + }, + { + "idiom" : "mac", + "scale" : "1x", + "size" : "32x32" + }, + { + "idiom" : "mac", + "scale" : "2x", + "size" : "32x32" + }, + { + "idiom" : "mac", + "scale" : "1x", + "size" : "128x128" + }, + { + "idiom" : "mac", + "scale" : "2x", + "size" : "128x128" + }, + { + "idiom" : "mac", + "scale" : "1x", + "size" : "256x256" + }, + { + "idiom" : "mac", + "scale" : "2x", + "size" : "256x256" + }, + { + "idiom" : "mac", + "scale" : "1x", + "size" : "512x512" + }, + { + "idiom" : "mac", + "scale" : "2x", + "size" : "512x512" + } + ], + "info" : { + "author" : "xcode", + "version" : 1 + } +} diff --git a/octosentry/Assets.xcassets/Contents.json b/octosentry/Assets.xcassets/Contents.json new file mode 100644 index 0000000..73c0059 --- /dev/null +++ b/octosentry/Assets.xcassets/Contents.json @@ -0,0 +1,6 @@ +{ + "info" : { + "author" : "xcode", + "version" : 1 + } +} diff --git a/octosentry/GitHubAPIError.swift b/octosentry/GitHubAPIError.swift new file mode 100644 index 0000000..7baf918 --- /dev/null +++ b/octosentry/GitHubAPIError.swift @@ -0,0 +1,41 @@ +// +// GitHubAPIError.swift +// octosentry +// + +import Foundation + +enum GitHubAPIError: Error, LocalizedError, Sendable { + case missingToken + case network(String) + case invalidResponse + case unauthorized + case forbidden + case notFound + case rateLimited + case httpError(status: Int) + case decodingFailed(String) + + var errorDescription: String? { + switch self { + case .missingToken: + "No GitHub token found in the GITHUB_TOKEN environment variable." + case .network(let message): + "Network error: \(message)" + case .invalidResponse: + "Received an unexpected response from GitHub." + case .unauthorized: + "GitHub rejected the token (401 Unauthorized)." + case .forbidden: + "Token lacks permission for this alert type (403 Forbidden)." + case .notFound: + "Repository or endpoint not found (404)." + case .rateLimited: + "GitHub API rate limit exceeded (429)." + case .httpError(let status): + "GitHub API returned HTTP \(status)." + case .decodingFailed(let message): + "Failed to parse GitHub API response: \(message)" + } + } +} diff --git a/octosentry/GitHubAPIModels.swift b/octosentry/GitHubAPIModels.swift new file mode 100644 index 0000000..3a84aa8 --- /dev/null +++ b/octosentry/GitHubAPIModels.swift @@ -0,0 +1,88 @@ +// +// GitHubAPIModels.swift +// octosentry +// +// Decodable wire types for the three GitHub REST alert endpoints. Kept +// private to this file — GitHubSecurityAPIClient maps them into SecurityEvent. +// + +import Foundation + +nonisolated struct DependabotAlertDTO: Decodable { + let number: Int + let htmlUrl: URL + let createdAt: Date + let updatedAt: Date + let securityAdvisory: SecurityAdvisory + + struct SecurityAdvisory: Decodable { + let summary: String + let severity: String + } + + enum CodingKeys: String, CodingKey { + case number + case htmlUrl = "html_url" + case createdAt = "created_at" + case updatedAt = "updated_at" + case securityAdvisory = "security_advisory" + } +} + +nonisolated struct CodeScanningAlertDTO: Decodable { + let number: Int + let htmlUrl: URL + let createdAt: Date + let updatedAt: Date + let rule: Rule + let mostRecentInstance: MostRecentInstance? + + struct Rule: Decodable { + let id: String? + let description: String? + let severity: String? + let securitySeverityLevel: String? + + enum CodingKeys: String, CodingKey { + case id + case description + case severity + case securitySeverityLevel = "security_severity_level" + } + } + + struct MostRecentInstance: Decodable { + let message: Message? + + struct Message: Decodable { + let text: String? + } + } + + enum CodingKeys: String, CodingKey { + case number + case htmlUrl = "html_url" + case createdAt = "created_at" + case updatedAt = "updated_at" + case rule + case mostRecentInstance = "most_recent_instance" + } +} + +nonisolated struct SecretScanningAlertDTO: Decodable { + let number: Int + let htmlUrl: URL + let createdAt: Date + let updatedAt: Date + let secretTypeDisplayName: String + let validity: String? + + enum CodingKeys: String, CodingKey { + case number + case htmlUrl = "html_url" + case createdAt = "created_at" + case updatedAt = "updated_at" + case secretTypeDisplayName = "secret_type_display_name" + case validity + } +} diff --git a/octosentry/GitHubSecurityAPIClient.swift b/octosentry/GitHubSecurityAPIClient.swift new file mode 100644 index 0000000..629699a --- /dev/null +++ b/octosentry/GitHubSecurityAPIClient.swift @@ -0,0 +1,168 @@ +// +// GitHubSecurityAPIClient.swift +// octosentry +// +// Fetches Dependabot, code scanning, and secret scanning alerts for a +// single repo and normalizes them into SecurityEvent. Auth is a PAT read +// by the caller from the GITHUB_TOKEN environment variable — a dev-only +// shortcut ahead of the device authorization flow (spec §6, §13). +// + +import Foundation + +actor GitHubSecurityAPIClient { + private let token: String + private let session: URLSession + private let baseURL = URL(string: "https://api.github.com")! + + private static let decoder: JSONDecoder = { + let decoder = JSONDecoder() + decoder.dateDecodingStrategy = .iso8601 + return decoder + }() + + init(token: String, session: URLSession = .shared) { + self.token = token + self.session = session + } + + func fetchDependabotAlerts(owner: String, repo: String) async throws -> [SecurityEvent] { + let url = alertsURL(owner: owner, repo: repo, path: "dependabot/alerts") + let dtos: [DependabotAlertDTO] = try await fetchAllPages(url: url) + let repoFullName = "\(owner)/\(repo)" + return dtos.map { dto in + SecurityEvent( + id: "dependabot-\(repoFullName)-\(dto.number)", + source: .dependabot, + repoFullName: repoFullName, + severity: SeverityMapping.dependabot(dto.securityAdvisory.severity), + nativeSeverityLabel: dto.securityAdvisory.severity.capitalized, + summary: dto.securityAdvisory.summary, + detailURL: dto.htmlUrl, + createdAt: dto.createdAt, + updatedAt: dto.updatedAt, + seenLocally: false + ) + } + } + + func fetchCodeScanningAlerts(owner: String, repo: String) async throws -> [SecurityEvent] { + let url = alertsURL(owner: owner, repo: repo, path: "code-scanning/alerts") + let dtos: [CodeScanningAlertDTO] = try await fetchAllPages(url: url) + let repoFullName = "\(owner)/\(repo)" + return dtos.map { dto in + SecurityEvent( + id: "codeScanning-\(repoFullName)-\(dto.number)", + source: .codeScanning, + repoFullName: repoFullName, + severity: SeverityMapping.codeScanning( + securitySeverityLevel: dto.rule.securitySeverityLevel, + ruleSeverity: dto.rule.severity + ), + nativeSeverityLabel: (dto.rule.securitySeverityLevel ?? dto.rule.severity ?? "unknown").capitalized, + summary: dto.mostRecentInstance?.message?.text ?? dto.rule.description ?? dto.rule.id ?? "Code scanning alert", + detailURL: dto.htmlUrl, + createdAt: dto.createdAt, + updatedAt: dto.updatedAt, + seenLocally: false + ) + } + } + + func fetchSecretScanningAlerts(owner: String, repo: String) async throws -> [SecurityEvent] { + let url = alertsURL(owner: owner, repo: repo, path: "secret-scanning/alerts") + let dtos: [SecretScanningAlertDTO] = try await fetchAllPages(url: url) + let repoFullName = "\(owner)/\(repo)" + return dtos.map { dto in + SecurityEvent( + id: "secretScanning-\(repoFullName)-\(dto.number)", + source: .secretScanning, + repoFullName: repoFullName, + severity: SeverityMapping.secretScanning(validity: dto.validity), + nativeSeverityLabel: (dto.validity ?? "unknown").capitalized, + summary: dto.secretTypeDisplayName, + detailURL: dto.htmlUrl, + createdAt: dto.createdAt, + updatedAt: dto.updatedAt, + seenLocally: false + ) + } + } + + private func alertsURL(owner: String, repo: String, path: String) -> URL { + var components = URLComponents(url: baseURL, resolvingAgainstBaseURL: false)! + components.path = "/repos/\(owner)/\(repo)/\(path)" + components.queryItems = [ + URLQueryItem(name: "state", value: "open"), + URLQueryItem(name: "per_page", value: "100"), + ] + return components.url! + } + + /// Follows the `Link: rel="next"` header until GitHub stops returning one, + /// since these endpoints paginate (default 30, up to 100 per page) rather + /// than returning every open alert in one response. + private func fetchAllPages<T: Decodable>(url: URL) async throws -> [T] { + var results: [T] = [] + var nextURL: URL? = url + while let currentURL = nextURL { + let (data, response) = try await fetchData(url: currentURL) + results += try decode(data) + nextURL = nextPageURL(from: response) + } + return results + } + + private func nextPageURL(from response: HTTPURLResponse) -> URL? { + guard let linkHeader = response.value(forHTTPHeaderField: "Link") else { return nil } + for part in linkHeader.components(separatedBy: ",") { + let segments = part.components(separatedBy: ";").map { $0.trimmingCharacters(in: .whitespaces) } + guard segments.count >= 2, segments[1] == "rel=\"next\"" else { continue } + let urlString = segments[0].trimmingCharacters(in: CharacterSet(charactersIn: "<>")) + return URL(string: urlString) + } + return nil + } + + private func fetchData(url: URL) async throws -> (data: Data, response: HTTPURLResponse) { + var request = URLRequest(url: url) + request.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization") + request.setValue("application/vnd.github+json", forHTTPHeaderField: "Accept") + request.setValue("2022-11-28", forHTTPHeaderField: "X-GitHub-Api-Version") + + let data: Data + let response: URLResponse + do { + (data, response) = try await session.data(for: request) + } catch { + throw GitHubAPIError.network(error.localizedDescription) + } + + guard let httpResponse = response as? HTTPURLResponse else { + throw GitHubAPIError.invalidResponse + } + + switch httpResponse.statusCode { + case 200: + return (data, httpResponse) + case 401: + throw GitHubAPIError.unauthorized + case 403: + throw GitHubAPIError.forbidden + case 404: + throw GitHubAPIError.notFound + case 429: + throw GitHubAPIError.rateLimited + default: + throw GitHubAPIError.httpError(status: httpResponse.statusCode) + } + } + + private func decode<T: Decodable>(_ data: Data) throws -> T { + do { + return try Self.decoder.decode(T.self, from: data) + } catch { + throw GitHubAPIError.decodingFailed(error.localizedDescription) + } + } +} diff --git a/octosentry/SecurityEvent.swift b/octosentry/SecurityEvent.swift new file mode 100644 index 0000000..ca5de0d --- /dev/null +++ b/octosentry/SecurityEvent.swift @@ -0,0 +1,19 @@ +// +// SecurityEvent.swift +// octosentry +// + +import Foundation + +struct SecurityEvent: Identifiable, Codable, Sendable { + let id: String + let source: SecurityEventSource + let repoFullName: String + let severity: SecurityEventSeverity + let nativeSeverityLabel: String + let summary: String + let detailURL: URL + let createdAt: Date + let updatedAt: Date + var seenLocally: Bool +} diff --git a/octosentry/SecurityEventListView.swift b/octosentry/SecurityEventListView.swift new file mode 100644 index 0000000..4542275 --- /dev/null +++ b/octosentry/SecurityEventListView.swift @@ -0,0 +1,143 @@ +// +// SecurityEventListView.swift +// octosentry +// + +import AppKit +import SwiftUI + +struct SecurityEventListView: View { + var store: SecurityEventStore + + var body: some View { + VStack(alignment: .leading, spacing: 0) { + header + Divider() + content + } + .frame(width: 380, height: 420) + .task { + await store.refresh() + } + } + + private var header: some View { + HStack { + Text("Security Events") + .font(.headline) + + if store.isLoading { + ProgressView() + .controlSize(.small) + } + + Spacer() + + Button { + Task { await store.refresh() } + } label: { + Image(systemName: "arrow.clockwise") + } + .buttonStyle(.plain) + .disabled(store.isLoading) + + Button("Quit") { + NSApplication.shared.terminate(nil) + } + .buttonStyle(.plain) + .foregroundStyle(.secondary) + } + .padding(12) + } + + @ViewBuilder + private var content: some View { + if store.events.isEmpty && !store.errorMessages.isEmpty { + StatusView(systemImage: "exclamationmark.triangle", tint: .orange, message: store.errorMessages.joined(separator: "\n\n")) + } else if store.events.isEmpty && !store.isLoading { + VStack(spacing: 8) { + StatusView(systemImage: "checkmark.shield", tint: .green, message: "No open security alerts") + if !store.unavailableNotices.isEmpty { + NoticeBanner(messages: store.unavailableNotices) + .padding(.horizontal) + .padding(.bottom) + } + } + } else { + ScrollView { + LazyVStack(alignment: .leading, spacing: 0) { + if !store.errorMessages.isEmpty { + ErrorBanner(messages: store.errorMessages) + Divider() + } + if !store.unavailableNotices.isEmpty { + NoticeBanner(messages: store.unavailableNotices) + Divider() + } + ForEach(store.events) { event in + SecurityEventRow(event: event) + Divider() + } + } + } + } + } +} + +private struct ErrorBanner: View { + let messages: [String] + + var body: some View { + VStack(alignment: .leading, spacing: 4) { + ForEach(messages, id: \.self) { message in + Label(message, systemImage: "exclamationmark.triangle") + .font(.caption) + .foregroundStyle(.orange) + } + } + .frame(maxWidth: .infinity, alignment: .leading) + .padding(10) + .background(.orange.opacity(0.1)) + } +} + +private struct NoticeBanner: View { + let messages: [String] + + var body: some View { + VStack(alignment: .leading, spacing: 4) { + ForEach(messages, id: \.self) { message in + Label(message, systemImage: "info.circle") + .font(.caption2) + .foregroundStyle(.secondary) + } + } + .frame(maxWidth: .infinity, alignment: .leading) + .padding(10) + .background(.secondary.opacity(0.08)) + } +} + +private struct StatusView: View { + let systemImage: String + let tint: Color + let message: String + + var body: some View { + VStack(spacing: 8) { + Image(systemName: systemImage) + .font(.title2) + .foregroundStyle(tint) + Text(message) + .font(.callout) + .multilineTextAlignment(.center) + .foregroundStyle(.secondary) + } + .padding() + .frame(maxWidth: .infinity, maxHeight: .infinity) + } +} + +#Preview { + SecurityEventListView(store: SecurityEventStore()) +} diff --git a/octosentry/SecurityEventRow.swift b/octosentry/SecurityEventRow.swift new file mode 100644 index 0000000..9a73037 --- /dev/null +++ b/octosentry/SecurityEventRow.swift @@ -0,0 +1,73 @@ +// +// SecurityEventRow.swift +// octosentry +// + +import AppKit +import SwiftUI + +struct SecurityEventRow: View { + let event: SecurityEvent + + private static let relativeFormatter: RelativeDateTimeFormatter = { + let formatter = RelativeDateTimeFormatter() + formatter.unitsStyle = .abbreviated + return formatter + }() + + var body: some View { + Button { + NSWorkspace.shared.open(event.detailURL) + } label: { + VStack(alignment: .leading, spacing: 3) { + HStack(spacing: 6) { + Text(event.nativeSeverityLabel.uppercased()) + .font(.caption2.weight(.bold)) + .foregroundStyle(event.severity.color) + .padding(.horizontal, 6) + .padding(.vertical, 2) + .background(event.severity.color.opacity(0.18), in: Capsule()) + + Text(event.source.displayName) + .font(.caption2.weight(.semibold)) + .padding(.horizontal, 6) + .padding(.vertical, 2) + .background(.secondary.opacity(0.15), in: Capsule()) + + Text(event.repoFullName) + .font(.caption) + .foregroundStyle(.secondary) + + Spacer() + + Text(Self.relativeFormatter.localizedString(for: event.createdAt, relativeTo: .now)) + .font(.caption2) + .foregroundStyle(.secondary) + } + + Text(event.summary) + .font(.callout) + .lineLimit(1) + .foregroundStyle(.primary) + } + .padding(10) + .contentShape(Rectangle()) + } + .buttonStyle(.plain) + } +} + +#Preview { + SecurityEventRow(event: SecurityEvent( + id: "preview-1", + source: .dependabot, + repoFullName: "zerolabsco/octosentry", + severity: .critical, + nativeSeverityLabel: "Critical", + summary: "Denial of service in some-package", + detailURL: URL(string: "https://github.com")!, + createdAt: .now.addingTimeInterval(-3600 * 26), + updatedAt: .now, + seenLocally: false + )) +} diff --git a/octosentry/SecurityEventSeverity.swift b/octosentry/SecurityEventSeverity.swift new file mode 100644 index 0000000..f975639 --- /dev/null +++ b/octosentry/SecurityEventSeverity.swift @@ -0,0 +1,35 @@ +// +// SecurityEventSeverity.swift +// octosentry +// + +import SwiftUI + +enum SecurityEventSeverity: Int, Codable, Comparable, CaseIterable { + case low + case medium + case high + case critical + + static func < (lhs: SecurityEventSeverity, rhs: SecurityEventSeverity) -> Bool { + lhs.rawValue < rhs.rawValue + } + + var displayName: String { + switch self { + case .low: "Low" + case .medium: "Medium" + case .high: "High" + case .critical: "Critical" + } + } + + var color: Color { + switch self { + case .low: .blue + case .medium: .yellow + case .high: .orange + case .critical: .red + } + } +} diff --git a/octosentry/SecurityEventSource.swift b/octosentry/SecurityEventSource.swift new file mode 100644 index 0000000..9c68296 --- /dev/null +++ b/octosentry/SecurityEventSource.swift @@ -0,0 +1,20 @@ +// +// SecurityEventSource.swift +// octosentry +// + +import Foundation + +enum SecurityEventSource: String, Codable, CaseIterable { + case dependabot + case codeScanning + case secretScanning + + var displayName: String { + switch self { + case .dependabot: "Dependabot" + case .codeScanning: "CodeQL" + case .secretScanning: "Secret Scanning" + } + } +} diff --git a/octosentry/SecurityEventStore.swift b/octosentry/SecurityEventStore.swift new file mode 100644 index 0000000..a45d5c7 --- /dev/null +++ b/octosentry/SecurityEventStore.swift @@ -0,0 +1,93 @@ +// +// SecurityEventStore.swift +// octosentry +// +// Holds the fetched event stream for the popover. MVP scope: one +// hardcoded repo, in-memory only, PAT read from GITHUB_TOKEN (spec §13). +// +// Each alert source is fetched independently so a problem with one +// endpoint doesn't blank out the other two. A 403/404 on a single source +// usually just means that alert type is disabled for the repo (or the +// token lacks that one permission) — not a real failure — so those are +// reported as quiet "unavailable" notices rather than alarming errors. +// + +import Foundation +import Observation + +@Observable +final class SecurityEventStore { + private(set) var events: [SecurityEvent] = [] + private(set) var isLoading = false + private(set) var errorMessages: [String] = [] + private(set) var unavailableNotices: [String] = [] + + private let owner = "ccleberg" + private let repo = "cleberg.net" + + func refresh() async { + isLoading = true + errorMessages = [] + unavailableNotices = [] + defer { isLoading = false } + + guard let token = ProcessInfo.processInfo.environment["GITHUB_TOKEN"], !token.isEmpty else { + errorMessages = [GitHubAPIError.missingToken.errorDescription ?? "Missing GITHUB_TOKEN."] + return + } + + let client = GitHubSecurityAPIClient(token: token) + + async let dependabot = fetchSource(label: "Dependabot") { + try await client.fetchDependabotAlerts(owner: self.owner, repo: self.repo) + } + async let codeScanning = fetchSource(label: "Code scanning") { + try await client.fetchCodeScanningAlerts(owner: self.owner, repo: self.repo) + } + async let secretScanning = fetchSource(label: "Secret scanning") { + try await client.fetchSecretScanningAlerts(owner: self.owner, repo: self.repo) + } + + let outcomes = await [dependabot, codeScanning, secretScanning] + + var fetchedEvents: [SecurityEvent] = [] + var errors: [String] = [] + var notices: [String] = [] + for outcome in outcomes { + switch outcome { + case .events(let sourceEvents): + fetchedEvents += sourceEvents + case .unavailable(let label): + notices.append("\(label) alerts aren't available for this repo (disabled, or token lacks that permission).") + case .failed(let label, let message): + errors.append("\(label): \(message)") + } + } + + events = fetchedEvents.sorted { lhs, rhs in + lhs.severity != rhs.severity ? lhs.severity > rhs.severity : lhs.createdAt > rhs.createdAt + } + errorMessages = errors + unavailableNotices = notices + } + + private enum SourceOutcome { + case events([SecurityEvent]) + case unavailable(label: String) + case failed(label: String, message: String) + } + + private func fetchSource( + label: String, + _ operation: () async throws -> [SecurityEvent] + ) async -> SourceOutcome { + do { + return .events(try await operation()) + } catch GitHubAPIError.forbidden, GitHubAPIError.notFound { + return .unavailable(label: label) + } catch { + let description = (error as? LocalizedError)?.errorDescription ?? error.localizedDescription + return .failed(label: label, message: description) + } + } +} diff --git a/octosentry/SeverityMapping.swift b/octosentry/SeverityMapping.swift new file mode 100644 index 0000000..5befb46 --- /dev/null +++ b/octosentry/SeverityMapping.swift @@ -0,0 +1,52 @@ +// +// SeverityMapping.swift +// octosentry +// +// Normalizes each GitHub alert source's native severity vocabulary into +// the shared SecurityEventSeverity scale. Kept as a single auditable +// source file per the spec (§4) rather than scattered across the client. +// + +import Foundation + +nonisolated enum SeverityMapping { + /// Dependabot alerts report CVSS-derived severity on the vulnerability object. + static func dependabot(_ nativeSeverity: String) -> SecurityEventSeverity { + switch nativeSeverity.lowercased() { + case "critical": .critical + case "high": .high + case "moderate", "medium": .medium + case "low": .low + default: .medium + } + } + + /// Code scanning alerts expose `rule.security_severity_level` (CVSS-derived) when + /// present, falling back to `rule.severity` (note/warning/error) otherwise. + static func codeScanning(securitySeverityLevel: String?, ruleSeverity: String?) -> SecurityEventSeverity { + if let securitySeverityLevel { + switch securitySeverityLevel.lowercased() { + case "critical": return .critical + case "high": return .high + case "medium": return .medium + case "low": return .low + default: break + } + } + switch ruleSeverity?.lowercased() { + case "error": return .high + case "warning": return .medium + case "note": return .low + default: return .medium + } + } + + /// Secret scanning has no native severity field. Per spec: validated/active + /// secrets are treated as critical, unvalidated ones as high. + static func secretScanning(validity: String?) -> SecurityEventSeverity { + switch validity?.lowercased() { + case "active": .critical + default: .high + } + } +} diff --git a/octosentry/octosentryApp.swift b/octosentry/octosentryApp.swift new file mode 100644 index 0000000..4d5a859 --- /dev/null +++ b/octosentry/octosentryApp.swift @@ -0,0 +1,20 @@ +// +// octosentryApp.swift +// octosentry +// +// Created by cmc on 2026-07-17. +// + +import SwiftUI + +@main +struct octosentryApp: App { + @State private var store = SecurityEventStore() + + var body: some Scene { + MenuBarExtra("OctoSentry", systemImage: "shield.lefthalf.filled") { + SecurityEventListView(store: store) + } + .menuBarExtraStyle(.window) + } +} diff --git a/octosentryTests/octosentryTests.swift b/octosentryTests/octosentryTests.swift new file mode 100644 index 0000000..8e46c85 --- /dev/null +++ b/octosentryTests/octosentryTests.swift @@ -0,0 +1,19 @@ +// +// octosentryTests.swift +// octosentryTests +// +// Created by cmc on 2026-07-17. +// + +import Testing +@testable import octosentry + +struct octosentryTests { + + @Test func example() async throws { + // Write your test here and use APIs like `#expect(...)` to check expected conditions. + // Swift Testing Documentation + // https://developer.apple.com/documentation/testing + } + +} diff --git a/octosentryUITests/octosentryUITests.swift b/octosentryUITests/octosentryUITests.swift new file mode 100644 index 0000000..576538e --- /dev/null +++ b/octosentryUITests/octosentryUITests.swift @@ -0,0 +1,43 @@ +// +// octosentryUITests.swift +// octosentryUITests +// +// Created by cmc on 2026-07-17. +// + +import XCTest + +final class octosentryUITests: XCTestCase { + + override func setUpWithError() throws { + // Put setup code here. This method is called before the invocation of each test method in the class. + + // In UI tests it is usually best to stop immediately when a failure occurs. + continueAfterFailure = false + + // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this. + } + + override func tearDownWithError() throws { + // Put teardown code here. This method is called after the invocation of each test method in the class. + } + + @MainActor + func testExample() throws { + // UI tests must launch the application that they test. + let app = XCUIApplication() + app.launch() + + // Use XCTAssert and related functions to verify your tests produce the correct results. + // XCUIAutomation Documentation + // https://developer.apple.com/documentation/xcuiautomation + } + + @MainActor + func testLaunchPerformance() throws { + // This measures how long it takes to launch your application. + measure(metrics: [XCTApplicationLaunchMetric()]) { + XCUIApplication().launch() + } + } +} diff --git a/octosentryUITests/octosentryUITestsLaunchTests.swift b/octosentryUITests/octosentryUITestsLaunchTests.swift new file mode 100644 index 0000000..7001f38 --- /dev/null +++ b/octosentryUITests/octosentryUITestsLaunchTests.swift @@ -0,0 +1,35 @@ +// +// octosentryUITestsLaunchTests.swift +// octosentryUITests +// +// Created by cmc on 2026-07-17. +// + +import XCTest + +final class octosentryUITestsLaunchTests: XCTestCase { + + override class var runsForEachTargetApplicationUIConfiguration: Bool { + true + } + + override func setUpWithError() throws { + continueAfterFailure = false + } + + @MainActor + func testLaunch() throws { + let app = XCUIApplication() + app.launch() + + // Insert steps here to perform after app launch but before taking a screenshot, + // such as logging into a test account or navigating somewhere in the app + // XCUIAutomation Documentation + // https://developer.apple.com/documentation/xcuiautomation + + let attachment = XCTAttachment(screenshot: app.screenshot()) + attachment.name = "Launch Screen" + attachment.lifetime = .keepAlways + add(attachment) + } +} |