From 60fb40d61a3295ad04ccd611fb161acbd4170aae Mon Sep 17 00:00:00 2001 From: ston1th Date: Tue, 14 Mar 2023 01:43:04 +0100 Subject: [PATCH] initial commit --- .gitignore | 4 + COPYRIGHT | 14 + LICENSE | 674 +++++++++++++++++++++++++++++++++++ Makefile | 56 +++ README.md | 1 + VERSION | 1 + cmd/keyctl/main.go | 83 +++++ go.mod | 26 ++ pkg/api/client/client.go | 213 +++++++++++ pkg/api/client/helper.go | 43 +++ pkg/api/server.go | 101 ++++++ pkg/api/types/approver.go | 103 ++++++ pkg/api/types/context.go | 138 +++++++ pkg/api/types/error.go | 55 +++ pkg/api/types/types.go | 9 + pkg/api/v1/client/client.go | 100 ++++++ pkg/api/v1/schema/schema.go | 95 +++++ pkg/api/v1/server/handler.go | 136 +++++++ pkg/api/v1/server/routes.go | 59 +++ pkg/cli/cli.go | 3 + pkg/core/encoding.go | 56 +++ pkg/core/key.go | 26 ++ pkg/db/db.go | 53 +++ pkg/db/key.go | 48 +++ pkg/db/migration.go | 60 ++++ pkg/key/key.go | 48 +++ pkg/store/boltstore.go | 140 ++++++++ pkg/store/boltstore_test.go | 98 +++++ pkg/store/dump.go | 13 + pkg/store/gob.go | 25 ++ pkg/store/helper.go | 11 + pkg/store/marshal.go | 8 + pkg/store/store.go | 23 ++ scripts/install_openbsd.sh | 48 +++ 34 files changed, 2571 insertions(+) create mode 100644 .gitignore create mode 100644 COPYRIGHT create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 VERSION create mode 100644 cmd/keyctl/main.go create mode 100644 go.mod create mode 100644 pkg/api/client/client.go create mode 100644 pkg/api/client/helper.go create mode 100644 pkg/api/server.go create mode 100644 pkg/api/types/approver.go create mode 100644 pkg/api/types/context.go create mode 100644 pkg/api/types/error.go create mode 100644 pkg/api/types/types.go create mode 100644 pkg/api/v1/client/client.go create mode 100644 pkg/api/v1/schema/schema.go create mode 100644 pkg/api/v1/server/handler.go create mode 100644 pkg/api/v1/server/routes.go create mode 100644 pkg/cli/cli.go create mode 100644 pkg/core/encoding.go create mode 100644 pkg/core/key.go create mode 100644 pkg/db/db.go create mode 100644 pkg/db/key.go create mode 100644 pkg/db/migration.go create mode 100644 pkg/key/key.go create mode 100644 pkg/store/boltstore.go create mode 100644 pkg/store/boltstore_test.go create mode 100644 pkg/store/dump.go create mode 100644 pkg/store/gob.go create mode 100644 pkg/store/helper.go create mode 100644 pkg/store/marshal.go create mode 100644 pkg/store/store.go create mode 100755 scripts/install_openbsd.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3ef1901 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/keyctl +tmp +run.sh +TODO.txt diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..84bca3c --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,14 @@ +Copyright (C) 2022 Marius Schellenberger + +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 . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..4c8bd9f --- /dev/null +++ b/Makefile @@ -0,0 +1,56 @@ +CC=go +BUILD=build -v -trimpath +VERSION=$(shell cat VERSION) +GCFLAGS=-gcflags '-e' +LDFLAGS=-ldflags '-buildid=$(VERSION) -X main.version=$(VERSION) -s -w' +PROGRAM=keyctl +CMD=-o $(PROGRAM) cmd/$(PROGRAM)/main.go +ENV=CGO_ENABLED=0 GO111MODULE=on + +all: $(PROGRAM) + +setup: + $(CC) install github.com/client9/misspell/cmd/misspell@latest + $(CC) install honnef.co/go/tools/cmd/staticcheck@latest + +release: clean gofmt codeqa + $(ENV) $(CC) $(BUILD) $(GCFLAGS) $(LDFLAGS) $(CMD) + +release-vendor: clean gofmt codeqa + $(ENV) $(CC) $(BUILD) -mod=vendor $(GCFLAGS) $(LDFLAGS) $(CMD) + +vendor: clean gofmt + $(ENV) $(CC) $(BUILD) -mod=vendor $(GCFLAGS) $(LDFLAGS) $(CMD) + +$(PROGRAM): clean gofmt + $(ENV) $(CC) $(BUILD) $(GCFLAGS) $(LDFLAGS) $(CMD) + +clean: + $(CC) clean -x + +gofmt: + $(CC) fmt ./... + +codeqa: govet misspell staticcheck test + +govet: + $(CC) vet ./... + +misspell: + $(GOPATH)/bin/misspell cmd/* pkg/* Makefile README.md sri.sh + +staticcheck: + $(GOPATH)/bin/staticcheck ./... + +test: +ifeq ($(shell go env GOARCH), $(shell go env GOHOSTARCH)) +ifeq ($(shell go env GOOS), $(shell go env GOHOSTOS)) + $(CC) test ./... +else + $(info skipping tests of other platforms) +endif +else + $(info skipping tests of other platforms) +endif + +.PHONY: setup release release-vendor vendor build clean codeqa gofmt govet misspell staticcheck test diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3e7635 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# GoAcc - a simple OAuth2 login and consent provider diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..6b3126c --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +v1.0 diff --git a/cmd/keyctl/main.go b/cmd/keyctl/main.go new file mode 100644 index 0000000..d2bacbd --- /dev/null +++ b/cmd/keyctl/main.go @@ -0,0 +1,83 @@ +// Copyright (C) 2023 Marius Schellenberger + +package main + +import ( + "context" + "flag" + "fmt" + "os" + "os/signal" + "syscall" + "time" + + "git.giftfish.de/ston1th/keyctl/pkg/server" + "github.com/go-logr/logr" + "k8s.io/klog/v2" + "k8s.io/klog/v2/klogr" +) + +var ( + version string + + listen string + path string + + log logr.Logger +) + +func usage() { + fmt.Printf(`keyctl %s: + supported subcommands: + keyctl server - starts a keyctl server + keyctl new - generates a new key + keyctl get - retrieve a key from the server + keyctl ls - list configured keys + keyctl req - list current key requests + keyctl approve - approve a key request + keyctl del - delete a key + keyctl help - show this usage +`, version) + os.Exit(1) +} + +func main() { + if len(os.Args) == 0 { + usage() + } + switch os.Args[0] { + case "new", "get", "ls", "req", "approve", "del": + //flag.StringVar(&config, "config", "/etc/keyctl/url.conf", "path to client config file") + //flag.Parse() + //cli. + case "server": + klog.InitFlags(nil) + flag.StringVar(&listen, "listen", ":7070", "listen ip:port") + flag.StringVar(&path, "path", "/var/keyctl/data.db", "data storage db") + flag.Parse() + default: + usage() + } + + log = klogr.New().WithName("main") + log.Info("starting keyctl", "version", version) + srv, err := server.NewServer(klogr.New().WithName("srv"), listen, path) + if err != nil { + klog.Fatalf("init failed: %s", err) + } + + err = srv.Start(klogr.New().WithName("db")) + if err != nil { + klog.Fatalf("init failed: %s", err) + } + + sigs := make(chan os.Signal, 1) + signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM) + <-sigs + log.Info("keyctl shutdown initiated") + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + srv.Shutdown(ctx) + cancel() + log.Info("keyctl shutdown completed") + os.Exit(0) +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..b225f31 --- /dev/null +++ b/go.mod @@ -0,0 +1,26 @@ +module git.giftfish.de/ston1th/keyctl + +go 1.20 + +require ( + git.giftfish.de/ston1th/godrop/v2 v2.1.0 + git.giftfish.de/ston1th/jwt/v3 v3.2.0 + github.com/go-logr/logr v1.2.3 + github.com/gorilla/mux v1.8.0 + github.com/ory/hydra-client-go v1.11.8 + github.com/pquerna/otp v1.3.0 + go.etcd.io/bbolt v1.3.6 + golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8 + k8s.io/klog/v2 v2.70.1 +) + +require ( + github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/golang/protobuf v1.5.2 // indirect + golang.org/x/net v0.0.0-20220812174116-3211cb980234 // indirect + golang.org/x/oauth2 v0.0.0-20220808172628-8227340efae7 // indirect + golang.org/x/sys v0.0.0-20220818161305-2296e01440c6 // indirect + google.golang.org/appengine v1.6.7 // indirect + google.golang.org/protobuf v1.28.1 // indirect +) diff --git a/pkg/api/client/client.go b/pkg/api/client/client.go new file mode 100644 index 0000000..60706bb --- /dev/null +++ b/pkg/api/client/client.go @@ -0,0 +1,213 @@ +// Copyright (C) 2023 Marius Schellenberger + +package client + +import ( + "bytes" + "context" + "crypto/tls" + "errors" + "fmt" + "io" + "net" + "net/http" + "net/http/httputil" + "os" + "strconv" + "strings" + "time" +) + +type Client struct { + endpoint string + username string + password string + auth bool + httpClient *http.Client + debugWriter io.Writer + insecure bool +} + +var ( + ErrNotFound = errors.New("not found") +) + +type ClientOption func(*Client) + +func WithEndpoint(endpoint string) ClientOption { + return func(client *Client) { + client.endpoint = strings.TrimRight(endpoint, "/") + } +} + +func WithDebugWriter(debugWriter io.Writer) ClientOption { + return func(client *Client) { + client.debugWriter = debugWriter + } +} + +func WithHTTPClient(httpClient *http.Client) ClientOption { + return func(client *Client) { + client.httpClient = httpClient + } +} + +func WithInsecureClient(insecure bool) ClientOption { + return func(client *Client) { + client.insecure = insecure + } +} + +func WithCredentials(username, password string) ClientOption { + return func(client *Client) { + client.username = username + client.password = password + client.auth = true + } +} + +var ( + ErrMissingEndpointEnv = errors.New("missing environment variable HAPROXY_LB_ENDPOINT") + ErrMissingUserEnv = errors.New("missing environment variable HAPROXY_LB_USER") + ErrMissingPasswordEnv = errors.New("missing environment variable HAPROXY_LB_PASSWORD") + + ErrMissingEndpoint = errors.New("missing Endpoint in config") + ErrMissingUser = errors.New("missing User in config") + ErrMissingPassword = errors.New("missing Password in config") +) + +type Config struct { + Endpoint string `json:"endpoint"` + NoAuth bool `json:"no_auth"` + User string `json:"user"` + Password string `json:"password"` + Insecure bool `json:"insecure"` +} + +func ClientOptionsFromConfig(cfg Config) (options []ClientOption, err error) { + if cfg.Endpoint == "" { + err = ErrMissingEndpoint + return + } + options = []ClientOption{ + WithEndpoint(cfg.Endpoint), + WithInsecureClient(cfg.Insecure), + } + if cfg.NoAuth { + return + } + if cfg.User == "" { + err = ErrMissingUser + return + } + if cfg.Password == "" { + err = ErrMissingPassword + return + } + options = append(options, WithCredentials(cfg.User, cfg.Password)) + return +} + +func ClientOptionsFromEnv() (options []ClientOption, err error) { + endpoint := os.Getenv("HAPROXY_LB_ENDPOINT") + if endpoint == "" { + err = ErrMissingEndpointEnv + return + } + insecure, _ := strconv.ParseBool(os.Getenv("HAPROXY_LB_INSECURE")) + + options = []ClientOption{ + WithEndpoint(endpoint), + WithInsecureClient(insecure), + } + noAuth, _ := strconv.ParseBool(os.Getenv("HAPROXY_LB_NO_AUTH")) + if noAuth { + return + } + + user := os.Getenv("HAPROXY_LB_USER") + if user == "" { + err = ErrMissingUserEnv + return + } + + pass := os.Getenv("HAPROXY_LB_PASSWORD") + if pass == "" { + err = ErrMissingPasswordEnv + return + } + + options = append(options, WithCredentials(user, pass)) + return +} + +func NewClient(options ...ClientOption) *Client { + client := &Client{} + + for _, option := range options { + option(client) + } + + if client.httpClient == nil { + client.httpClient = &http.Client{Transport: &http.Transport{ + DialContext: (&net.Dialer{ + Timeout: 30 * time.Second, + KeepAlive: 30 * time.Second, + }).DialContext, + ForceAttemptHTTP2: true, + MaxIdleConns: 100, + IdleConnTimeout: 90 * time.Second, + TLSHandshakeTimeout: 10 * time.Second, + ExpectContinueTimeout: 1 * time.Second, + TLSClientConfig: &tls.Config{ + InsecureSkipVerify: client.insecure, + }, + }} + } + return client +} + +func (c *Client) NewRequest(ctx context.Context, method, path string, body io.Reader) (*http.Request, error) { + url := c.endpoint + path + req, err := http.NewRequest(method, url, body) + if err != nil { + return nil, err + } + if c.auth { + req.SetBasicAuth(c.username, c.password) + } + req = req.WithContext(ctx) + return req, nil +} + +func (c *Client) Do(r *http.Request, v interface{}) (resp *http.Response, err error) { + if c.debugWriter != nil { + dumpReq, err := httputil.DumpRequestOut(r, true) + if err != nil { + return &http.Response{}, err + } + fmt.Fprintf(c.debugWriter, "--- Request:\n%s\n\n", dumpReq) + } + resp, err = c.httpClient.Do(r) + if err != nil { + return + } + body, err := io.ReadAll(resp.Body) + if err != nil { + resp.Body.Close() + return + } + resp.Body.Close() + resp.Body = io.NopCloser(bytes.NewReader(body)) + + if c.debugWriter != nil { + dumpResp, err := httputil.DumpResponse(resp, true) + if err != nil { + return resp, err + } + fmt.Fprintf(c.debugWriter, "--- Response:\n%s\n\n", dumpResp) + } + + err = decodeResp(resp, v) + return +} diff --git a/pkg/api/client/helper.go b/pkg/api/client/helper.go new file mode 100644 index 0000000..5fc6fd1 --- /dev/null +++ b/pkg/api/client/helper.go @@ -0,0 +1,43 @@ +// Copyright (C) 2023 Marius Schellenberger + +package client + +import ( + "encoding/json" + "net/http" +) + +type Error struct { + Err string `json:"error"` + Status int `json:"status"` +} + +func (e Error) Error() string { + return e.Err +} + +func (e Error) Is(target error) bool { + return e.Err == target.Error() +} + +func decodeResp(resp *http.Response, v interface{}) error { + if resp.Body == nil { + return nil + } + defer resp.Body.Close() + if resp.StatusCode == 200 { + if v == nil { + return nil + } + return json.NewDecoder(resp.Body).Decode(&v) + } + var e Error + err := json.NewDecoder(resp.Body).Decode(&e) + if err != nil { + return err + } + if resp.StatusCode >= 400 && resp.StatusCode <= 599 { + return e + } + return nil +} diff --git a/pkg/api/server.go b/pkg/api/server.go new file mode 100644 index 0000000..03058e1 --- /dev/null +++ b/pkg/api/server.go @@ -0,0 +1,101 @@ +// Copyright (C) 2023 Marius Schellenberger + +package api + +import ( + "context" + "net" + "net/http" + "time" + + "git.giftfish.de/ston1th/keyctl/pkg/api/types" + serverv1 "git.giftfish.de/ston1th/keyctl/pkg/api/v1/server" + "git.giftfish.de/ston1th/keyctl/pkg/db" + + "github.com/go-logr/logr" + "github.com/gorilla/mux" +) + +// Server is the webapp and api server +type Server struct { + srv *http.Server + mux *mux.Router + log logr.Logger + + Data *types.ContextData + + init chan struct{} + stop chan struct{} + stopKeyReset chan struct{} + + listen net.Listener + + db *db.DB +} + +type notFoundHandler struct { + s *Server +} + +func (nf *notFoundHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + types.NewContext(w, r, nf.s.Data, nf.s.log).Err(types.ErrInvalidAPIRoute) +} + +// NewHTTPServer returns a new HTTPServer +func NewServer(log logr.Logger, listen string) (*Server, error) { + s := &Server{ + mux: mux.NewRouter(), + log: log, + Data: &types.ContextData{}, + + init: make(chan struct{}), + stop: make(chan struct{}), + stopKeyReset: make(chan struct{}), + } + l, err := net.Listen("tcp", listen) + if err != nil { + return nil, err + } + s.listen = l + + s.mux.NotFoundHandler = ¬FoundHandler{s} + for _, v := range serverv1.Routes { + s.mux.HandleFunc(v.Path, s.contextWrapper(v.Handler)).Methods(v.Methods...) + } + s.start() + return s, nil +} + +func (s *Server) start() { + s.srv = &http.Server{ + Handler: s.mux, + ReadTimeout: 10 * time.Second, + WriteTimeout: 10 * time.Second, + } + go func() { + <-s.init + err := s.srv.Serve(s.listen) + if err != nil { + s.log.Error(err, "") + } + }() + return +} + +func (s *Server) contextWrapper(h types.CtxHandler) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + h(types.NewContext(w, r, s.Data, s.log)) + } +} + +// Stop stops listening for incoming connections and closes currently open connections +func (s *Server) Stop() { + s.log.Info("stopping") + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + err := s.srv.Shutdown(ctx) + if err != nil { + s.log.Error(err, "") + } + s.log.Info("stopped") +} diff --git a/pkg/api/types/approver.go b/pkg/api/types/approver.go new file mode 100644 index 0000000..82a1696 --- /dev/null +++ b/pkg/api/types/approver.go @@ -0,0 +1,103 @@ +// Copyright (C) 2023 Marius Schellenberger + +package types + +import ( + "sync" + "time" + + "git.giftfish.de/ston1th/keyctl/pkg/key" + "golang.org/x/exp/maps" +) + +const maxSize = 10 + +type ApprovalMap map[string]Approval + +type Approver struct { + // protects m + mu sync.RWMutex + m ApprovalMap +} + +func NewApprover() *Approver { + return &Approver{ + m: make(ApprovalMap), + } +} + +func (a *Approver) New(id, name string) (aid string, err error) { + a.mu.Lock() + defer a.mu.Unlock() + size := len(a.m) + if size > maxSize { + err = ErrTooManyApprovals + return + } + aid, err = key.GenerateID() + if err != nil { + return + } + a.m[aid] = Approval{ + ID: id, + Name: name, + Created: time.Now().Unix(), + } + return +} + +func (a *Approver) List() (m ApprovalMap) { + a.mu.RLock() + m = maps.Clone(a.m) + a.mu.RUnlock() + return +} +func (a *Approver) Status(id, aid string) (s Status) { + a.mu.RLock() + if app, ok := a.m[aid]; ok && app.ID == id { + s = app.Status + } + a.mu.RUnlock() + return +} + +func (a *Approver) Update(aid string, s Status) { + a.mu.Lock() + if _, ok := a.m[aid]; ok { + a.m[aid].Status = s + } + a.mu.Unlock() +} + +type Approval struct { + ID string + Name string + Created int64 + Status Status +} + +type Status int + +const ( + Pending Status = iota + Approved + Rejected +) + +func (s Status) String() string { + switch s { + case Pending: + return "pending" + case Approved: + return "approved" + case Rejected: + return "rejected" + } + return "[invalid]" +} + +type Route struct { + Path string + Handler CtxHandler + Methods []string +} diff --git a/pkg/api/types/context.go b/pkg/api/types/context.go new file mode 100644 index 0000000..5502f91 --- /dev/null +++ b/pkg/api/types/context.go @@ -0,0 +1,138 @@ +// Copyright (C) 2023 Marius Schellenberger + +package types + +import ( + "encoding/json" + "io" + "net" + "net/http" + + "github.com/go-logr/logr" + "github.com/gorilla/mux" + + "git.giftfish.de/ston1th/keyctl/pkg/db" +) + +type ContextData struct { + DB *db.DB +} + +func NewContext(w http.ResponseWriter, r *http.Request, data *ContextData, log logr.Logger) *Context { + h := w.Header() + h.Set("Content-Type", "application/json") + return &Context{ + Code: http.StatusOK, + Request: r, + Response: w, + Data: data, + Log: log, + } +} + +// Context is the context object shared between http handlers +type Context struct { + Code int + + Request *http.Request + Response http.ResponseWriter + + Data *ContextData + Log logr.Logger +} + +// Method returns the request method +func (c *Context) Method() string { + return c.Request.Method +} + +// Path returns the request URL path +func (c *Context) Path() string { + return c.Request.URL.Path +} + +// Header returns the given http header +func (c *Context) Header(name string) string { + return c.Request.Header.Get(name) +} + +// SetHeader sets the given http header +func (c *Context) SetHeader(name, value string) { + h := c.Response.Header() + h.Set(name, value) +} + +// Form returns the given form value +func (c *Context) Form(name string) string { + return c.Request.FormValue(name) +} + +func (c *Context) ClientIP() (host string) { + host, _, _ = net.SplitHostPort(c.Request.RemoteAddr) + return +} + +// Var returns the given url variable +func (c *Context) Var(name string) (ret string) { + ret, _ = mux.Vars(c.Request)[name] + return +} + +func (c *Context) log() { + c.Log.Info("access", + "addr", c.Request.RemoteAddr, + "method", c.Request.Method, + "path", c.Request.URL.Path, + "code", c.Code, + ) +} + +func (c *Context) NotFound() { + c.Err(ErrNotFound) +} + +// OK is a empty HTTP 200 JSON response +func (c *Context) OK() { + c.log() +} + +func (c *Context) ReadBody() (b []byte, err error) { + b, err = io.ReadAll(c.Request.Body) + c.Request.Body.Close() + return +} + +func (c *Context) Body(b []byte) { + c.Response.Write(b) + c.log() +} + +// JSON is a json response +func (c *Context) JSON(v any) { + err := json.NewEncoder(c.Response).Encode(v) + if err != nil { + c.Err(ErrISE) + return + } + c.log() +} + +func (c *Context) Redirect(url string, code int) { + c.Code = code + http.Redirect(c.Response, c.Request, url, code) + c.log() +} + +// Err is a HTTPErr wrapper for the custom Error type +func (c *Context) Err(err Error) { + c.HTTPErr(err.JSON(), err.Code()) +} + +// HTTPErr is a http.Error wrapper +func (c *Context) HTTPErr(err string, code int) { + c.Code = code + http.Error(c.Response, err, code) + c.log() +} + +type CtxHandler func(*Context) diff --git a/pkg/api/types/error.go b/pkg/api/types/error.go new file mode 100644 index 0000000..8cd9038 --- /dev/null +++ b/pkg/api/types/error.go @@ -0,0 +1,55 @@ +// Copyright (C) 2023 Marius Schellenberger + +package types + +import ( + "net/http" + "strconv" +) + +// Error interface is a custom api error +type Error interface { + Error() string + JSON() string + Status() int +} + +// Err implements the Error interface +type Err struct { + err string + status int +} + +// Error returns the error string +func (a Err) Error() string { + return a.err +} + +// Error returns the error string as JSON format +func (a Err) JSON() string { + return `{"error":"` + a.err + `","status":` + strconv.Itoa(a.status) + `}` +} + +// Status returns the HTTP status code +func (a Err) Status() int { + return a.status +} + +func newError(err string, status int) Error { + return Err{ + err: err, + status: status, + } +} + +var ( + ErrInvalidAPIRoute = newError("invalid api route", http.StatusNotFound) + ErrBadreq = newError("bad request", http.StatusBadRequest) + ErrForbidden = newError("forbidden", http.StatusForbidden) + ErrNotFound = newError("not found", http.StatusNotFound) + ErrKeyNotFound = newError("key not found", http.StatusNotFound) + ErrReqNotFound = newError("key request not found", http.StatusNotFound) + ErrTooManyApprovals = newError("too many approvals pending", http.StatusConflict) + ErrMNA = newError("method not allowed", http.StatusMethodNotAllowed) + ErrISE = newError("internal server error", http.StatusInternalServerError) +) diff --git a/pkg/api/types/types.go b/pkg/api/types/types.go new file mode 100644 index 0000000..610e830 --- /dev/null +++ b/pkg/api/types/types.go @@ -0,0 +1,9 @@ +// Copyright (C) 2023 Marius Schellenberger + +package types + +type Route struct { + Path string + Handler CtxHandler + Methods []string +} diff --git a/pkg/api/v1/client/client.go b/pkg/api/v1/client/client.go new file mode 100644 index 0000000..e91dad7 --- /dev/null +++ b/pkg/api/v1/client/client.go @@ -0,0 +1,100 @@ +// Copyright (C) 2023 Marius Schellenberger + +package client + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "fmt" + + apiclient "git.giftfish.de/ston1th/keyctl/pkg/api/client" + "git.giftfish.de/ston1th/keyctl/pkg/api/v1/schema" +) + +var ( + ErrClientIsNil = errors.New("client is nil") + base = schema.LBPath +) + +type Client struct { + c *apiclient.Client +} + +func NewClient(c *apiclient.Client) (*Client, error) { + if c == nil { + return nil, ErrClientIsNil + } + return &Client{c}, nil +} + +func (c *Client) GetLoadBalancers(ctx context.Context) (lbs map[string]*schema.LoadBalancer, err error) { + return c.GetLoadBalancersWithCluster(ctx, "") +} + +func (c *Client) GetLoadBalancersWithCluster(ctx context.Context, cluster string) (lbs map[string]*schema.LoadBalancer, err error) { + path := base + if cluster != "" { + path += "/" + cluster + } + req, err := c.c.NewRequest(ctx, "GET", path, nil) + if err != nil { + return + } + lbs = make(map[string]*schema.LoadBalancer) + _, err = c.c.Do(req, &lbs) + return +} + +func (c *Client) GetLoadBalancer(ctx context.Context, cluster, name string) (lb *schema.LoadBalancer, err error) { + path := fmt.Sprintf("%s/%s/%s", base, cluster, name) + req, err := c.c.NewRequest(ctx, "GET", path, nil) + if err != nil { + return + } + _, err = c.c.Do(req, &lb) + return +} + +func (c *Client) CreateLoadBalancer(ctx context.Context, cluster, name string, lb *schema.LoadBalancer) (err error) { + buf := new(bytes.Buffer) + path := fmt.Sprintf("%s/%s/%s", base, cluster, name) + err = lb.ValidateClient() + if err != nil { + return + } + err = json.NewEncoder(buf).Encode(lb) + if err != nil { + return + } + req, err := c.c.NewRequest(ctx, "POST", path, buf) + if err != nil { + return + } + _, err = c.c.Do(req, nil) + return +} + +func (c *Client) DeleteLoadBalancer(ctx context.Context, cluster, name string) (err error) { + path := fmt.Sprintf("%s/%s/%s", base, cluster, name) + req, err := c.c.NewRequest(ctx, "DELETE", path, nil) + if err != nil { + return + } + _, err = c.c.Do(req, nil) + return +} + +func (c *Client) DeleteLoadBalancersWithCluster(ctx context.Context, cluster string) (err error) { + if cluster == "" { + return errors.New("cluster value can not be empty") + } + path := base + "/" + cluster + req, err := c.c.NewRequest(ctx, "DELETE", path, nil) + if err != nil { + return + } + _, err = c.c.Do(req, nil) + return +} diff --git a/pkg/api/v1/schema/schema.go b/pkg/api/v1/schema/schema.go new file mode 100644 index 0000000..3083c98 --- /dev/null +++ b/pkg/api/v1/schema/schema.go @@ -0,0 +1,95 @@ +// Copyright (C) 2023 Marius Schellenberger + +package schema + +import ( + "errors" + + "git.giftfish.de/ston1th/keyctl/pkg/api/types" + "git.giftfish.de/ston1th/keyctl/pkg/core" + "golang.org/x/exp/slices" +) + +const ( + Version = "v1" + KeyName = "key" + ReqName = "req" + KeyPath = "/" + Version + "/" + KeyName + ReqPath = "/" + Version + "/" + ReqName +) + +type NewKey struct { + Name string `json:"name"` + Size int `json:"size"` + Encoding core.Encoding `json:"encoding"` +} + +var ( + ErrInvalidKeyName = errors.New("invalid key name") + ErrInvalidKeySize = errors.New("invalid key size") +) + +const ( + MinKeySize = 1 + MaxKeySize = 1024 +) + +func (nk NewKey) Validate() error { + if core.NameRe.MatchString(nk.Name) { + return ErrInvalidKeyName + } + if nk.Size > MaxKeySize || nk.Size < MinKeySize { + return ErrInvalidKeySize + } + return nil +} + +func ApproveURL(id, aid string) string { + return KeyPath + "/" + id + "/" + aid +} + +type Key struct { + ID string `json:"id"` + Name string `json:"name"` + Created int64 `json:"created"` + Size int `json:"size"` + Encoding core.Encoding `json:"encoding"` + Key string `json:"key"` +} + +type Keys []Key + +func (Keys) Less(a, b Key) { return a.Name < b.Name } +func (k Keys) Sort() { slices.SortStableFunc(k, k.Less) } + +func NewKeys(keys core.Keys) (k Keys) { + k = Keys(keys) + k.Sort() +} + +type Approval struct { + ID string `json:"id"` + AID string `json:"aid"` + Name string `json:"name"` + Created int64 `json:"created"` + Status types.Status `json:"status"` +} + +type Approvals []Approval + +func (Approvals) Less(a, b Approval) { return a.Name < b.Name } +func (a Approvals) Sort() { slices.SortStableFunc(a, a.Less) } + +func NewApprovals(m types.ApprovalMap) (a Approvals) { + for k, v := range m { + a = append(a, Approval{ + ID: v.ID, + AID: k, + Name: v.Name, + Created: v.Created, + Status: v.Status, + }) + } + a.Sort() + return +} diff --git a/pkg/api/v1/server/handler.go b/pkg/api/v1/server/handler.go new file mode 100644 index 0000000..3a4e73e --- /dev/null +++ b/pkg/api/v1/server/handler.go @@ -0,0 +1,136 @@ +// Copyright (C) 2023 Marius Schellenberger + +package server + +import ( + "encoding/json" + "net/http" + "net/netip" + + "git.giftfish.de/ston1th/keyctl/pkg/api/types" + "git.giftfish.de/ston1th/keyctl/pkg/api/v1/schema" +) + +func local(h types.CtxHandler) types.CtxHandler { + return func(ctx *types.Context) { + addr, err := netip.ParseAddr(ctx.ClientIP()) + if err != nil { + ctx.Err(types.ErrForbidden) + return + } + if !addr.IsLoopback() { + ctx.Err(types.ErrForbidden) + return + } + h(ctx) + } +} + +func healthzHandler(ctx *types.Context) { + ctx.OK() +} + +func newHandler(ctx *types.Context) { + if ctx.Method() == "POST" { + b, err := ctx.ReadBody() + if err != nil { + ctx.Log.Error(err, "error reading request body") + ctx.Err(types.ErrISE) + return + } + var newKey schema.NewKey + err = json.Unmarshal(b, &newKey) + if err != nil { + ctx.Log.Error(err, "error decoding request body") + ctx.Err(types.ErrInvalid) + return + } + err = newKey.Validate() + if err != nil { + ctx.Log.Error(err, "error empty name for new key") + ctx.Err(types.ErrInvalid) + return + } + key, err := ctx.Data.DB.CreateKey(newKey.Name, newKey.Size, newKey.Encoding) + if err != nil { + ctx.Log.Error(err, "error writing loadbalancer", "cluster", cl, "name", n) + ctx.Err(types.ErrISE) + return + } + ctx.JSON(schema.Key(key)) + } +} + +func keyHandler(ctx *types.Context) { + id := ctx.Var("id") + k, err := ctx.Data.DB.GetKey(id) + if err != nil { + //TODO error 404 + ctx.Log.Error(err, "error reading key", "id", id) + ctx.Err(types.ErrISE) + return + } + switch ctx.Method() { + case "GET": + aid := ctx.Var("aid") + if aid == "" { + aid, err = ctx.Data.Approvals.New(id, k.Name) + if err != nil { + ctx.Log.Error(err, "error creating approval", "id", id, "name", k.Name) + ctx.Err(types.ErrISE) + return + } + ctx.Redirect(schema.ApproveURL(id, aid), http.StatusFound) + return + } + if !ctx.Data.Approvals.Approved(id, aid) { + ctx.Redirect(schema.ApproveURL(id, aid), http.StatusFound) + return + } + k, err := ctx.Data.DB.GetKeyWithSecret(id) + if err != nil { + //TODO error 404 + ctx.Log.Error(err, "error reading key", "id", id) + ctx.Err(types.ErrISE) + return + } + ctx.JSON(schema.Key(k)) + case "DELETE": + err = ctx.Data.DB.DeleteKey(id) + if err != nil { + ctx.Log.Error(err, "error deleting key", "id", id, "name", k.Name) + ctx.Err(types.ErrISE) + return + } + ctx.OK() + } +} + +func reqListHandler(ctx *types.Context) { + l := ctx.Data.Approvals.List() + ctx.JSON(schema.NewApprovals(l)) +} + +func keyListHandler(ctx *types.Context) { + k, err := ctx.Data.DB.GetKeys() + if err != nil { + //TODO error 404 + ctx.Log.Error(err, "error reading keys") + ctx.Err(types.ErrISE) + return + } + ctx.JSON(schema.NewKeys(k)) +} + +func reqHandler(ctx *types.Context) { + id := ctx.Var("id") + status := types.Pending + switch ctx.Method() { + case "PUT": + status = types.Approved + case "DELETE": + status = types.Rejected + } + ctx.Data.Approvals.Update(id, status) + ctx.OK() +} diff --git a/pkg/api/v1/server/routes.go b/pkg/api/v1/server/routes.go new file mode 100644 index 0000000..18b05d2 --- /dev/null +++ b/pkg/api/v1/server/routes.go @@ -0,0 +1,59 @@ +// Copyright (C) 2023 Marius Schellenberger + +package server + +import ( + "git.giftfish.de/ston1th/keyctl/pkg/api/types" + "git.giftfish.de/ston1th/keyctl/pkg/api/v1/schema" + "git.giftfish.de/ston1th/keyctl/pkg/core" +) + +const ( + healthz = "/healthz" + keyID = schema.KeyPath + core.IDRoute + keyReqID = schema.KeyPath + core.IDRoute + core.AIDRoute + reqID = schema.ReqPath + core.IDRoute +) + +var Routes = []types.Route{ + { + healthz, + healthzHandler, + []string{"GET"}, + }, + { + schema.KeyPath, + local(keyListHandler), + []string{"GET"}, + }, + { + schema.KeyPath, + local(newHandler), + []string{"POST"}, + }, + { + keyID, + keyHandler, + []string{"GET"}, + }, + { + keyReqID, + keyHandler, + []string{"GET"}, + }, + { + keyID, + local(keyHandler), + []string{"DELETE"}, + }, + { + schema.ReqPath, + local(reqListHandler), + []string{"GET"}, + }, + { + reqID, + local(reqHandler), + []string{"PUT", "DELETE"}, + }, +} diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go new file mode 100644 index 0000000..5eddcea --- /dev/null +++ b/pkg/cli/cli.go @@ -0,0 +1,3 @@ +// Copyright (C) 2023 Marius Schellenberger + +package cli diff --git a/pkg/core/encoding.go b/pkg/core/encoding.go new file mode 100644 index 0000000..429922d --- /dev/null +++ b/pkg/core/encoding.go @@ -0,0 +1,56 @@ +// Copyright (C) 2023 Marius Schellenberger + +package core + +import ( + "encoding/base32" + "encoding/base64" + "encoding/hex" +) + +var b32raw = base32.StdEncoding.WithPadding(base32.NoPadding) + +type Encoding int + +func (e Encoding) String() string { + switch e { + case Base32: + return "base32" + case Base64: + return "base64" + case Base64URL: + return "base64url" + } + return "hex" +} + +func (e Encoding) EncodeToString(src []byte) string { + switch e { + case Base32: + return b32raw.EncodeToString(src) + case Base64: + return base64.RawStdEncoding.EncodeToString(src) + case Base64URL: + return base64.RawURLEncoding.EncodeToString(src) + } + return hex.EncodeToString(src) +} + +func EncodingFromString(e string) Encoding { + switch e { + case "base32": + return Base32 + case "base64": + return Base64 + case "base64url": + return Base64URL + } + return Hex +} + +const ( + Hex Encoding = iota + Base32 + Base64 + Base64URL +) diff --git a/pkg/core/key.go b/pkg/core/key.go new file mode 100644 index 0000000..ef45192 --- /dev/null +++ b/pkg/core/key.go @@ -0,0 +1,26 @@ +// Copyright (C) 2023 Marius Schellenberger + +package core + +import "regexp" + +const ( + re = "a-zA-Z0-9_-" + id = "[a-f0-9]{32}" + nameReReverse = "[^" + re + "]+" + IDRoute = "/{id:" + id + "}" + AIDRoute = "/{aid:" + id + "}" +) + +var NameRe = regexp.MustCompile(nameReReverse) + +type Key struct { + ID string + Name string + Created int64 + Size int + Encoding Encoding + Key string +} + +type Keys []Key diff --git a/pkg/db/db.go b/pkg/db/db.go new file mode 100644 index 0000000..6c5dbb3 --- /dev/null +++ b/pkg/db/db.go @@ -0,0 +1,53 @@ +// Copyright (C) 2023 Marius Schellenberger + +package db + +import ( + "io" + "path/filepath" + + "git.giftfish.de/ston1th/godrop/v2" + "git.giftfish.de/ston1th/keyctl/pkg/core" + "git.giftfish.de/ston1th/keyctl/pkg/store" + "github.com/go-logr/logr" +) + +const storeFile = "store.db" + +type DB struct { + log logr.Logger + store store.Store +} + +func NewPlain(log logr.Logger, cfg *core.Config) (db *DB, err error) { + db = &DB{log: log} + dbFile := filepath.Join(cfg.DataDir, storeFile) + err = godrop.Unveil(dbFile, "rwc") + if err != nil { + return + } + db.store, err = store.NewBoltStore(dbFile, nil) + return +} + +func New(log logr.Logger, cfg *core.Config) (db *DB, err error) { + db, err = NewPlain(log, cfg) + if err != nil { + return + } + + err = db.RunMigrations() + return +} + +func (db *DB) Dump(w io.Writer) error { + return db.store.Dump(w) +} + +func (db *DB) Restore(r io.Reader) error { + return db.store.Restore(r) +} + +func (db *DB) Close() error { + return db.store.Close() +} diff --git a/pkg/db/key.go b/pkg/db/key.go new file mode 100644 index 0000000..28de809 --- /dev/null +++ b/pkg/db/key.go @@ -0,0 +1,48 @@ +// Copyright (C) 2023 Marius Schellenberger + +package db + +import ( + "sort" + + "git.giftfish.de/ston1th/goacc/pkg/core" + "git.giftfish.de/ston1th/keyctl/pkg/key" +) + +const keyPrefix = "key/" + +func (db *DB) GetKeys() (keys core.Keys, err error) { + err = db.store.ForEachPrefix(keyPrefix, func(k string, _ []byte) error { + k, err := db.GetKey(k) + if err == nil { + keys = append(keys, k) + } + return nil + }) + sort.Sort(keys) + return +} + +func (db *DB) GetKey(id string) (k core.Key, err error) { + k, err = db.GetKeyWithSecret(id) + k.Key = "" + return +} + +func (db *DB) GetKeyWithSecret(id string) (k core.Key, err error) { + err = db.store.Get(keyPrefix+id, &k) + return +} + +func (db *DB) CreateKey(name string, size int, enc core.Encoding) (k core.Key, err error) { + k, err = key.Generate(name, size, enc) + if err != nil { + return + } + err = db.store.Set(keyPrefix+k.ID, &k) + return +} + +func (db *DB) DeleteKey(id string) error { + return db.store.Delete(keyPrefix + id) +} diff --git a/pkg/db/migration.go b/pkg/db/migration.go new file mode 100644 index 0000000..224ddfd --- /dev/null +++ b/pkg/db/migration.go @@ -0,0 +1,60 @@ +// Copyright (C) 2022 Marius Schellenberger + +package db + +import ( + "errors" + + "git.giftfish.de/ston1th/keyctl/pkg/store" +) + +const ( + versionKey = "version/version" + currentVersion = 0 +) + +type migrator func(*DB, int) error + +var migrators = []migrator{ + func(_ *DB, _ int) error { + return nil + }, +} + +func (db *DB) RunMigrations() (err error) { + log := db.log.WithName("migration") + var version int + err = db.store.Get(versionKey, &version) + if err == store.ErrKeyNotFound { + err = db.store.Set(versionKey, currentVersion) + if err != nil { + return + } + err = db.store.Get(versionKey, &version) + if err != nil { + return + } + } + log.Info("db versions", "current", version, "new", currentVersion) + if currentVersion < version { + return errors.New("incompatible versions") + } + if currentVersion == version { + log.Info("nothing to do") + } + for version < currentVersion { + v := version + 1 + log.Info("running", "version", v) + err = migrators[v](db, v) + if err != nil { + return + } + err = db.store.Set(versionKey, v) + if err != nil { + return + } + version = v + log.Info("finished", "version", v) + } + return +} diff --git a/pkg/key/key.go b/pkg/key/key.go new file mode 100644 index 0000000..8f36975 --- /dev/null +++ b/pkg/key/key.go @@ -0,0 +1,48 @@ +// Copyright (C) 2023 Marius Schellenberger + +package key + +import ( + "crypto/rand" + "encoding/hex" + "io" + "time" + + "git.giftfish.de/ston1th/keyctl/pkg/core" +) + +const idSize = 16 + +func generate(size int) (buf []byte, err error) { + buf = make([]byte, size) + _, err = io.ReadFull(rand.Reader, buf) + return +} + +func GenerateID() (string, error) { + id, err := generate(idSize) + if err != nil { + return "", err + } + return hex.EncodeToString(id), nil +} + +func Generate(name string, size int, enc core.Encoding) (k core.Key, err error) { + id, err := GenerateID() + if err != nil { + return + } + key, err := generate(size) + if err != nil { + return + } + k = core.Key{ + Name: name, + ID: id, + Size: size, + Encoding: enc.String(), + Key: enc.Encode(key), + Created: time.Now().Unix(), + } + return +} diff --git a/pkg/store/boltstore.go b/pkg/store/boltstore.go new file mode 100644 index 0000000..1772934 --- /dev/null +++ b/pkg/store/boltstore.go @@ -0,0 +1,140 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +import ( + "encoding/json" + "io" + + bolt "go.etcd.io/bbolt" +) + +const ( + defaultBoltBucket = "default" + fileMode = 0o600 +) + +type BoltStore struct { + Marshaler + db *bolt.DB +} + +func NewBoltStore(file string, m Marshaler) (Store, error) { + if m == nil { + m = NewGOB() + } + db, err := bolt.Open(file, fileMode, nil) + if err != nil { + return nil, err + } + if err := db.Update(func(tx *bolt.Tx) (err error) { + _, err = tx.CreateBucketIfNotExists([]byte(defaultBoltBucket)) + return + }); err != nil { + return nil, err + } + return &BoltStore{m, db}, nil +} + +type dump struct { + K string `json:"k"` + V []byte `json:"v"` +} + +func (bs *BoltStore) Dump(w io.Writer) (err error) { + if w == nil { + return ErrWriterIsNil + } + var d []dump + err = bs.ForEach(func(k string, v []byte) error { + b := make([]byte, len(v)) + copy(b, v) + d = append(d, dump{k, b}) + return nil + }) + if err != nil { + return + } + return json.NewEncoder(w).Encode(d) +} + +func (bs *BoltStore) Restore(r io.Reader) (err error) { + if r == nil { + return ErrReaderIsNil + } + var d []dump + err = json.NewDecoder(r).Decode(&d) + if err != nil { + return + } + if err = bs.db.Update(func(tx *bolt.Tx) (err error) { + if err = tx.DeleteBucket([]byte(defaultBoltBucket)); err != nil { + return + } + _, err = tx.CreateBucket([]byte(defaultBoltBucket)) + return + }); err != nil { + return + } + return bs.db.Update(func(tx *bolt.Tx) (err error) { + b := tx.Bucket([]byte(defaultBoltBucket)) + for _, v := range d { + b.Put([]byte(v.K), v.V) + } + return nil + }) +} + +func (bs *BoltStore) Get(key string, v interface{}) (err error) { + err = bs.db.View(func(tx *bolt.Tx) error { + b := tx.Bucket([]byte(defaultBoltBucket)).Get([]byte(key)) + if b == nil { + return ErrKeyNotFound + } + if v != nil { + return bs.Unmarshal(b, v) + } + return nil + }) + return +} + +func (bs *BoltStore) Set(key string, v interface{}) error { + return bs.db.Update(func(tx *bolt.Tx) (err error) { + var b []byte + if v != nil { + b, err = bs.Marshal(v) + if err != nil { + return + } + } + return tx.Bucket([]byte(defaultBoltBucket)).Put([]byte(key), b) + }) +} + +func (bs *BoltStore) ForEach(f func(string, []byte) error) error { + return bs.db.View(func(tx *bolt.Tx) error { + return tx.Bucket([]byte(defaultBoltBucket)).ForEach(func(k, v []byte) error { + return f(string(k), v) + }) + }) +} + +func (bs *BoltStore) ForEachPrefix(prefix string, f func(string, []byte) error) error { + return bs.ForEach(func(k string, v []byte) error { + if trim, ok := hasTrimPrefix(k, prefix); ok { + return f(trim, v) + } + return nil + }) +} + +func (bs *BoltStore) Delete(key string) error { + return bs.db.Update(func(tx *bolt.Tx) error { + return tx.Bucket([]byte(defaultBoltBucket)).Delete([]byte(key)) + }) +} + +func (bs *BoltStore) Close() error { + return bs.db.Close() +} diff --git a/pkg/store/boltstore_test.go b/pkg/store/boltstore_test.go new file mode 100644 index 0000000..8015c06 --- /dev/null +++ b/pkg/store/boltstore_test.go @@ -0,0 +1,98 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +import ( + "bytes" + "errors" + "os" + "path/filepath" + "testing" +) + +type testData struct { + Data string +} + +func TestBoltStore(t *testing.T) { + data := []testData{ + {"123"}, + {"hello"}, + } + dir, err := os.MkdirTemp("", "") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(dir) + bs, err := NewBoltStore(filepath.Join(dir, "bolt.db"), nil) + if err != nil { + t.Fatal(err) + } + + err = bs.Set("key0", data[0]) + if err != nil { + t.Fatal(err) + } + err = bs.Set("key1", data[1]) + if err != nil { + t.Fatal(err) + } + + t.Run("GetKey0", func(t *testing.T) { + var d testData + err := bs.Get("key0", &d) + if err != nil { + t.Fatal(err) + } + if d != data[0] { + t.Error("d is not data[0]") + } + }) + t.Run("ForEach", func(t *testing.T) { + err := bs.ForEach(func(k string, v []byte) error { + if k == "key0" || k == "key1" { + return nil + } + return errors.New("key0 or key1 not found") + }) + if err != nil { + t.Fatal(err) + } + }) + t.Run("DumpRestore", func(t *testing.T) { + buf := new(bytes.Buffer) + err := bs.Dump(buf) + if err != nil { + t.Fatal(err) + } + if buf.Len() == 0 { + t.Error("no dump written") + } + err = bs.Restore(buf) + if err != nil { + t.Fatal(err) + } + }) + t.Run("DeleteKey1", func(t *testing.T) { + err := bs.Delete("key1") + if err != nil { + t.Fatal(err) + } + }) + t.Run("GetKey1", func(t *testing.T) { + var d testData + err := bs.Get("key1", &d) + if err == nil { + t.Error("key1 should be deleted") + } + if d == data[1] { + t.Error("d is not data[1]") + } + }) + t.Run("Close", func(t *testing.T) { + err := bs.Close() + if err != nil { + t.Fatal(err) + } + }) +} diff --git a/pkg/store/dump.go b/pkg/store/dump.go new file mode 100644 index 0000000..08dc40b --- /dev/null +++ b/pkg/store/dump.go @@ -0,0 +1,13 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +import "io" + +type Dumper interface { + Dump(io.Writer) error +} + +type Restorer interface { + Restore(io.Reader) error +} diff --git a/pkg/store/gob.go b/pkg/store/gob.go new file mode 100644 index 0000000..cb6bc20 --- /dev/null +++ b/pkg/store/gob.go @@ -0,0 +1,25 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +import ( + "bytes" + "encoding/gob" +) + +type gobMarshaler struct{} + +func NewGOB() Marshaler { + return gobMarshaler{} +} + +func (gobMarshaler) Marshal(v interface{}) (b []byte, err error) { + buf := new(bytes.Buffer) + err = gob.NewEncoder(buf).Encode(v) + b = buf.Bytes() + return +} + +func (gobMarshaler) Unmarshal(data []byte, v interface{}) error { + return gob.NewDecoder(bytes.NewBuffer(data)).Decode(v) +} diff --git a/pkg/store/helper.go b/pkg/store/helper.go new file mode 100644 index 0000000..5f3a0a5 --- /dev/null +++ b/pkg/store/helper.go @@ -0,0 +1,11 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +// Parts taken from strings.TrimPrefix +func hasTrimPrefix(s, prefix string) (string, bool) { + if len(s) >= len(prefix) && s[0:len(prefix)] == prefix { + return s[len(prefix):], true + } + return s, false +} diff --git a/pkg/store/marshal.go b/pkg/store/marshal.go new file mode 100644 index 0000000..6ec9ddd --- /dev/null +++ b/pkg/store/marshal.go @@ -0,0 +1,8 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +type Marshaler interface { + Marshal(v interface{}) ([]byte, error) + Unmarshal(data []byte, v interface{}) error +} diff --git a/pkg/store/store.go b/pkg/store/store.go new file mode 100644 index 0000000..a3035e3 --- /dev/null +++ b/pkg/store/store.go @@ -0,0 +1,23 @@ +// Copyright (C) 2022 Marius Schellenberger + +package store + +import "errors" + +var ( + ErrKeyNotFound = errors.New("store: key not found") + ErrWriterIsNil = errors.New("store: writer is nil") + ErrReaderIsNil = errors.New("store: reader is nil") +) + +type Store interface { + Marshaler + Dumper + Restorer + Get(string, interface{}) error + Set(string, interface{}) error + ForEach(func(string, []byte) error) error + ForEachPrefix(string, func(string, []byte) error) error + Delete(string) error + Close() error +} diff --git a/scripts/install_openbsd.sh b/scripts/install_openbsd.sh new file mode 100755 index 0000000..133e55e --- /dev/null +++ b/scripts/install_openbsd.sh @@ -0,0 +1,48 @@ +#!/bin/sh + +cat <<'EOF'> /etc/rc.d/goacc +#!/bin/ksh + +daemon="/usr/local/sbin/goacc" +daemon_user="_goacc" + +. /etc/rc.d/rc.subr + +pexp=".*${daemon}.*" +rc_bg=YES +rc_reload=NO + +rc_start() { + ${rcexec} "${daemon} ${daemon_flags} < /dev/null 2>&1 | \ + logger -ip daemon.info -t goacc" +} + +rc_cmd $1 +EOF +chmod 555 /etc/rc.d/goacc +rcctl enable goacc +rcctl set goacc flags -config /var/acc/goacc.conf + +mkdir /var/acc +groupadd _goacc +useradd -d /var/acc -s /sbin/nologin -g _goacc _goacc +chown _goacc:_goacc /var/acc + +cat < /var/acc/goacc.conf +{ + "data_dir": "/var/acc", + "listen": "127.0.0.1:4443", + "secret": "$(openssl rand -hex 32)", + "hydra_admin_url": "http://127.0.0.1:4445", + "admin_disabled": false, + "secure_cookie": true +} +EOF +chmod 640 /var/acc/goacc.conf +chgrp _goacc /var/acc/goacc.conf + +cat <