diff --git a/.dockerignore b/.dockerignore index 5167f6c..8fa00fc 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,7 +1,8 @@ .git .gitignore -*.md -Dockerfile -.dockerignore +.DS_Store .env* .claude +node_modules +bin/ +data/ diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..92ec261 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[Makefile] +indent_style = tab + +[*.go] +indent_style = tab diff --git a/.gitea/workflows/check.yml b/.gitea/workflows/check.yml new file mode 100644 index 0000000..aca7a51 --- /dev/null +++ b/.gitea/workflows/check.yml @@ -0,0 +1,9 @@ +name: check +on: [push] +jobs: + check: + runs-on: ubuntu-latest + steps: + # actions/checkout v4.2.2, 2026-02-22 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 + - run: docker build . diff --git a/.gitignore b/.gitignore index 3392572..50fad0e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,20 +1,31 @@ +# OS +.DS_Store +Thumbs.db + +# Editors +*.swp +*.swo +*~ +*.bak +.idea/ +.vscode/ +*.sublime-* + +# Environment / secrets +.env +.env.* +*.pem +*.key + # Dependencies vendor/ +node_modules/ # Build output /bin/ /pixad /cmd/pixad/pixad -# IDE -.idea/ -.vscode/ -*.swp -*.swo - -# OS -.DS_Store - # Data /data/ *.sqlite3 diff --git a/Dockerfile b/Dockerfile index 26d3e17..f6e261d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,6 @@ # Build stage -FROM golang:1.24-alpine AS builder +# golang:1.25.4-alpine, 2026-02-25 +FROM golang:1.25.4-alpine@sha256:d3f0cf7723f3429e3f9ed846243970b20a2de7bae6a5b66fc5914e228d831bbb AS builder ARG VERSION=dev @@ -8,7 +9,15 @@ RUN apk add --no-cache \ build-base \ vips-dev \ libheif-dev \ - pkgconfig + pkgconfig \ + curl + +# golangci-lint v2.10.1, 2026-02-25 +RUN curl -sSfL https://github.com/golangci/golangci-lint/releases/download/v2.10.1/golangci-lint-2.10.1-linux-amd64.tar.gz -o /tmp/golangci-lint.tar.gz && \ + echo "dfa775874cf0561b404a02a8f4481fc69b28091da95aa697259820d429b09c99 /tmp/golangci-lint.tar.gz" | sha256sum -c - && \ + tar -xzf /tmp/golangci-lint.tar.gz -C /tmp && \ + mv /tmp/golangci-lint-2.10.1-linux-amd64/golangci-lint /usr/local/bin/ && \ + rm -rf /tmp/golangci-lint* WORKDIR /src @@ -19,11 +28,15 @@ RUN GOTOOLCHAIN=auto go mod download # Copy source code COPY . . +# Run all checks (fmt-check, lint, test) +RUN make check + # Build with CGO enabled RUN CGO_ENABLED=1 GOTOOLCHAIN=auto go build -ldflags "-X main.Version=${VERSION}" -o /pixad ./cmd/pixad # Runtime stage -FROM alpine:3.21 +# alpine:3.21, 2026-02-25 +FROM alpine:3.21@sha256:c3f8e73fdb79deaebaa2037150150191b9dcbfba68b4a46d70103204c53f4709 # Install runtime dependencies only RUN apk add --no-cache \ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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 index b7e0b05..63dff60 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,19 @@ -.PHONY: check lint test fmt build clean docker docker-test devserver devserver-stop +.PHONY: check lint test fmt fmt-check build clean docker docker-test devserver devserver-stop hooks VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "dev") LDFLAGS := -X main.Version=$(VERSION) +# Use nix-shell to provide CGO dependencies unless they are already available +# (e.g. inside a Docker build or an existing nix-shell). +HAS_PKGCONFIG := $(shell command -v pkg-config 2>/dev/null) +ifdef HAS_PKGCONFIG + NIX_RUN_PREFIX = + NIX_RUN_SUFFIX = +else + NIX_RUN_PREFIX = nix-shell -p pkg-config vips libheif golangci-lint git --run ' + NIX_RUN_SUFFIX = ' +endif + # Default target: run all checks check: fmt-check lint test @@ -19,19 +30,17 @@ fmt: # Run linter lint: @echo "Running linter..." - golangci-lint run + $(NIX_RUN_PREFIX)golangci-lint run$(NIX_RUN_SUFFIX) -# Run tests +# Run tests (30-second timeout) test: @echo "Running tests..." - go test -v ./... + $(NIX_RUN_PREFIX)CGO_ENABLED=1 go test -timeout 30s -v ./...$(NIX_RUN_SUFFIX) # Build the binary -build: ./bin/pixad - -./bin/pixad: ./internal/*/*.go ./cmd/pixad/*.go ./internal/static/* ./internal/templates/* +build: @echo "Building pixad..." - go build -ldflags "$(LDFLAGS)" -o $@ ./cmd/pixad + $(NIX_RUN_PREFIX)CGO_ENABLED=1 go build -ldflags "$(LDFLAGS)" -o ./bin/pixad ./cmd/pixad$(NIX_RUN_SUFFIX) # Clean build artifacts clean: @@ -58,3 +67,9 @@ devserver: docker devserver-stop devserver-stop: -docker stop pixad-dev 2>/dev/null -docker rm pixad-dev 2>/dev/null + +# Install pre-commit hook +hooks: + @printf '#!/bin/sh\nset -e\n' > .git/hooks/pre-commit + @printf 'make check\n' >> .git/hooks/pre-commit + @chmod +x .git/hooks/pre-commit diff --git a/README.md b/README.md index 7e8afe5..96b4c1a 100644 --- a/README.md +++ b/README.md @@ -1,324 +1,138 @@ -# pixa caching image reverse proxy server +# pixa -This is a web service written in go that is designed to proxy images from -source URLs, optionally resizing or transforming them, and serving the -results. Both the source images as well as the transformed images are -cached. The images served to the client are cached a configurable interval -so that subsequent requests to the same path on the pixa server are served -from disk without origin server requests or additional processing. +pixa is a GPL-3.0-licensed Go web server by +[@sneak](https://sneak.berlin) that proxies images from upstream +sources, optionally resizing or transforming them, and serves the +results. Both source and transformed images are cached to disk so that +subsequent requests are served without origin fetches or additional +processing. -# storage +## Getting Started -* unaltered source file straight from upstream: - * `/cache/src-content///` -* source path metadata - * `/cache/src-metadata//.json` - * fetch time - * all original resp headers - * original request - * sha256 hash +```bash +# clone and build +git clone https://git.eeqj.de/sneak/pixa.git +cd pixa +make build -Note that multiple source paths may reference the same content blob. We -won't do refcounting here, we'll use the state database for that. +# run with a config file +./bin/pixad --config config.example.yml -* database: - * `/state.sqlite3` +# or build and run via Docker +make docker +docker run -p 8080:8080 pixad:latest +``` -* output documents: - * `/cache/dst-content///` +## Rationale -While the database is the long-term authority on what we have in the output -cache, we must aggressively cache in-process the mapping between requests -and output content hashes so as to serve as a maximally efficient caching -proxy for extremely popular/hot request paths. The goal is the ability to -easily support 1-5k r/s. +Image-heavy web applications need a fast, caching reverse proxy that +can resize and transcode images on the fly. pixa fills that role as a +single, self-contained binary with no external runtime dependencies +beyond libvips. It supports HMAC-SHA256 signed URLs with expiration to +prevent abuse, and whitelisted source hosts for open access. -# Routes +## Design -/img///?signature=&format= +### Storage -Images are only fetched from origins using TLS. Origin certificates must be -valid at time of fetch. +- **Source content**: + `/cache/src-content///` +- **Source metadata**: + `/cache/src-metadata//.json` + (fetch time, original headers, request, content hash) +- **Database**: `/state.sqlite3` (SQLite) +- **Output documents**: + `/cache/dst-content///` - is one of 'orig', 'png', 'jpeg', 'webp' +Multiple source paths may reference the same content blob; the +database tracks references rather than using filesystem refcounting. +In-process caching of request-to-output mappings targets 1-5k r/s. - is one of 'orig' or 'x' +### Routes -# Source Hosts +``` +/v1/image///.?sig=&exp= +``` -Source hosts may be whitelisted in the pixa configuration. If not in the -explicit whitelist, a signature using a shared secret must be appended. +Images are only fetched from origins using TLS with valid certificates. -## Signature Specification +- ``: one of `orig`, `png`, `jpeg`, `webp` +- ``: `orig` or `x` (e.g. `800x600`) -Signatures use HMAC-SHA256 and include an expiration timestamp to prevent replay attacks. +### Source Hosts -### Signed Data Format +Source hosts may be whitelisted in the configuration. Non-whitelisted +hosts require an HMAC-SHA256 signature. -The signature is computed over a colon-separated string: +#### Signature Specification + +Signatures use HMAC-SHA256 and include an expiration timestamp to +prevent replay attacks. + +**Signed data format** (colon-separated): ``` HMAC-SHA256(secret, "host:path:query:width:height:format:expiration") ``` Where: -- `host` - Source origin hostname (e.g., `cdn.example.com`) -- `path` - Source path (e.g., `/photos/cat.jpg`) -- `query` - Source query string, empty string if none -- `width` - Requested width in pixels, `0` for original -- `height` - Requested height in pixels, `0` for original -- `format` - Output format (jpeg, png, webp, avif, gif, orig) -- `expiration` - Unix timestamp when signature expires -### URL Format with Signature +- `host` — source origin hostname (e.g. `cdn.example.com`) +- `path` — source path (e.g. `/photos/cat.jpg`) +- `query` — source query string, empty string if none +- `width` — requested width in pixels, `0` for original +- `height` — requested height in pixels, `0` for original +- `format` — output format (jpeg, png, webp, avif, gif, orig) +- `expiration` — Unix timestamp when signature expires -``` -/v1/image///.?sig=&exp= -``` - -### Example - -For a request to resize `https://cdn.example.com/photos/cat.jpg` to 800x600 WebP -with expiration at Unix timestamp 1704067200: - -1. Build the signature input: - ``` - cdn.example.com:/photos/cat.jpg::800:600:webp:1704067200 - ``` +**Example:** resize +`https://cdn.example.com/photos/cat.jpg` to 800x600 WebP with +expiration 1704067200: +1. Build input: + `cdn.example.com:/photos/cat.jpg::800:600:webp:1704067200` 2. Compute HMAC-SHA256 with your secret key - 3. Base64URL-encode the result +4. URL: + `/v1/image/cdn.example.com/photos/cat.jpg/800x600.webp?sig=&exp=1704067200` -4. Final URL: - ``` - /v1/image/cdn.example.com/photos/cat.jpg/800x600.webp?sig=&exp=1704067200 - ``` +**Whitelist patterns:** -### Whitelist Patterns +- **Exact match**: `cdn.example.com` — matches only that host +- **Suffix match**: `.example.com` — matches `cdn.example.com`, + `images.example.com`, and `example.com` -The whitelist supports two pattern types: -- **Exact match**: `cdn.example.com` - matches only that host -- **Suffix match**: `.example.com` - matches `cdn.example.com`, `images.example.com`, and `example.com` +### Configuration -# configuration +Configured via YAML file (`--config`). Key settings: -* access-control-allow-origin config -* source host whitelist -* upstream fetch timeout -* upstream max response size -* downstream timeout -* downstream max request size -* downstream max response size -* internal processing timeout -* referer blacklist +- `access_control_allow_origin` — CORS origin +- `source_host_whitelist` — list of allowed upstream hosts +- `upstream_fetch_timeout` — timeout for origin requests +- `upstream_max_response_size` — max origin response size +- `downstream_timeout` — client response timeout +- `signing_key` — HMAC secret for URL signatures -# Design Review & Recommendations +See `config.example.yml` for all options with defaults. -## Security Concerns +### Architecture -### Critical -- **HMAC signature scheme is undefined** - The "FIXME" for signature - construction is a blocker. Recommend HMAC-SHA256 over the full path: - `HMAC-SHA256(secret, "///?format=")` -- **No signature expiration** - Signatures should include a timestamp to - prevent indefinite replay. Add `&expires=` and include it in the - HMAC input -- **Path traversal risk** - Ensure `` cannot contain `..` - sequences or be used to access unintended resources on origin -- **SSRF potential** - Even with TLS requirement, internal/private IPs - (10.x, 172.16.x, 192.168.x, 127.x, ::1, link-local) must be blocked to - prevent server-side request forgery -- **Open redirect via Host header** - Validate that requests cannot be - manipulated to cache content under incorrect keys +- **Dependency injection**: Uber fx +- **HTTP router**: go-chi +- **Image processing**: govips (CGO wrapper for libvips) +- **Database**: SQLite via modernc.org/sqlite +- **Static assets**: embedded via `//go:embed` +- **Metrics**: Prometheus +- **Logging**: stdlib slog -### Important -- **No authentication for cache purge** - If cache invalidation is needed, it requires auth -- **Response header sanitization** - Strip sensitive headers from upstream before forwarding (X-Powered-By, Server, etc.) -- **Content-Type validation** - Verify upstream Content-Type matches expected image types before processing -- **Maximum image dimensions** - Limit output dimensions to prevent resource exhaustion (e.g., max 4096x4096) +## TODO -## URL Route Improvements +See [TODO.md](TODO.md) for the full prioritized task list. -Current: `/img///?signature=&format=` +## License -### Recommended Scheme -``` -/v1/image///x.?sig=&exp= -``` +GPL-3.0. See [LICENSE](LICENSE). -The size+format segment (e.g., `800x600.webp`) is appended to the source path and stripped when constructing the upstream request. This pattern is unambiguous (regex: `(\d+x\d+|orig)\.(webp|jpg|jpeg|png|avif)$`) and won't collide with real paths. +## Author -**Size options:** -- `800x600.` - resize to 800x600 -- `0x0.` - original size, format conversion only -- `orig.` - original size, format conversion only (human-friendly alias) - -**Benefits:** -- API versioning (`/v1/`) allows breaking changes later -- Human-readable URLs that can be manually constructed for whitelisted domains -- Format as extension is intuitive and CDN-friendly - -### Examples - -**Basic resize and convert:** -``` -/v1/image/cdn.example.com/photos/cat.jpg/800x600.webp?sig=abc123&exp=1704067200 -``` -Fetches `https://cdn.example.com/photos/cat.jpg`, resizes to 800x600, converts to webp. - -**Source URL with query parameters:** -``` -/v1/image/cdn.example.com/photos/cat.jpg%3Farg1=val1%26arg2=val2/800x600.webp?sig=abc123&exp=1704067200 -``` -Fetches `https://cdn.example.com/photos/cat.jpg?arg1=val1&arg2=val2`, resizes to 800x600, converts to webp. - -Note: The source query string must be URL-encoded (`?` → `%3F`, `&` → `%26`) to avoid ambiguity with pixa's own query parameters. - -**Original size, format conversion only:** -``` -/v1/image/cdn.example.com/photos/cat.jpg/orig.webp?sig=abc123&exp=1704067200 -/v1/image/cdn.example.com/photos/cat.jpg/0x0.webp?sig=abc123&exp=1704067200 -``` -Both fetch the original image and convert to webp without resizing. - -## Additional Formats - -### Output Formats to Support -- `avif` - Superior compression, growing browser support -- `gif` - For animated image passthrough (with frame limit) -- `svg` - Passthrough only, no resizing (vector) - -### Input Format Whitelist (MIME types to accept) -- `image/jpeg` -- `image/png` -- `image/webp` -- `image/gif` -- `image/avif` -- `image/svg+xml` (passthrough or rasterize) -- **Reject all others** - Especially `image/x-*`, `application/*` - -### Input Validation -- Verify magic bytes match declared Content-Type -- Maximum input file size (e.g., 50MB) -- Maximum input dimensions (e.g., 16384x16384) -- Reject files with embedded scripts (SVG sanitization) - -## Rate Limiting - -### Per-IP Limits -- Requests per second (e.g., 10 req/s burst, 100 req/min sustained) -- Concurrent connections (e.g., 50 per IP) - -### Global Limits -- Total concurrent upstream fetches (prevent origin overwhelm) -- Per-origin fetch rate limiting (be a good citizen) -- Cache miss rate limiting (prevent cache-busting attacks) - -### Response -- Return `429 Too Many Requests` with `Retry-After` header -- Consider `X-RateLimit-*` headers for transparency - -## Additional Features for 1.0 - -### Must Have -- **Health check endpoint** - `/health` or `/healthz` for load balancers -- **Metrics endpoint** - `/metrics` (Prometheus format) for observability -- **Graceful shutdown** - Drain connections on SIGTERM -- **Request ID/tracing** - `X-Request-ID` header propagation -- **Cache-Control headers** - Proper `Cache-Control`, `ETag`, `Last-Modified` on responses -- **Vary header** - `Vary: Accept` if doing content negotiation - -### Should Have -- **Auto-format selection** - If `format=auto`, pick best format based on `Accept` header -- **Quality parameter** - `&q=85` for lossy format quality control -- **Fit modes** - `fit=cover|contain|fill|inside|outside` for resize behavior -- **Background color** - For transparent-to-JPEG conversion -- **Blur/sharpen** - Common post-resize operations -- **Watermarking** - Optional overlay support - -### Nice to Have -- **Cache warming API** - Pre-populate cache for known images -- **Cache stats API** - Hit/miss rates, storage usage -- **Admin UI** - Simple dashboard for monitoring - -## Configuration Additions - -```yaml -server: - listen: ":8080" - read_timeout: 30s - write_timeout: 60s - max_header_bytes: 8192 - -cache: - directory: "/var/cache/pixa" - max_size_gb: 100 - ttl: 168h # 7 days - negative_ttl: 5m # Cache 404s briefly - -upstream: - timeout: 30s - max_response_size: 52428800 # 50MB - max_concurrent: 100 - user_agent: "Pixa/1.0" - -processing: - max_input_pixels: 268435456 # 16384x16384 - max_output_dimension: 4096 - default_quality: 85 - strip_metadata: true # Remove EXIF etc. - -security: - hmac_secret: "${PIXA_HMAC_SECRET}" # From env - signature_ttl: 3600 # 1 hour - blocked_networks: - - "10.0.0.0/8" - - "172.16.0.0/12" - - "192.168.0.0/16" - - "127.0.0.0/8" - - "::1/128" - - "fc00::/7" - -rate_limit: - per_ip_rps: 10 - per_ip_burst: 50 - per_origin_rps: 100 - -cors: - allowed_origins: ["*"] # Or specific list - allowed_methods: ["GET", "HEAD", "OPTIONS"] - max_age: 86400 -``` - -## Error Handling - -### HTTP Status Codes -- `400` - Bad request (invalid parameters, malformed URL) -- `403` - Forbidden (invalid/expired signature, blocked origin) -- `404` - Origin returned 404 (cache negative response briefly) -- `413` - Payload too large (origin image exceeds limits) -- `415` - Unsupported media type (origin returned non-image) -- `422` - Unprocessable (valid image but cannot transform as requested) -- `429` - Rate limited -- `500` - Internal error -- `502` - Bad gateway (origin connection failed) -- `503` - Service unavailable (overloaded) -- `504` - Gateway timeout (origin timeout) - -### Error Response Format -```json -{ - "error": "invalid_signature", - "message": "Signature has expired", - "request_id": "abc123" -} -``` - -## Quick Wins - -1. **Conditional requests** - Support `If-None-Match` / `If-Modified-Since` to return `304 Not Modified` -2. **HEAD support** - Allow clients to check image metadata without downloading -3. **Canonical URLs** - Redirect non-canonical requests to prevent cache fragmentation -4. **Debug header** - `X-Pixa-Cache: HIT|MISS|STALE` for debugging -5. **Robots.txt** - Serve a robots.txt to prevent search engine crawling of proxy URLs +[@sneak](https://sneak.berlin) diff --git a/REPO_POLICIES.md b/REPO_POLICIES.md new file mode 100644 index 0000000..5f8e062 --- /dev/null +++ b/REPO_POLICIES.md @@ -0,0 +1,182 @@ +--- +title: Repository Policies +last_modified: 2026-02-22 +--- + +This document covers repository structure, tooling, and workflow standards. Code +style conventions are in separate documents: + +- [Code Styleguide](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE.md) + (general, bash, Docker) +- [Go](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_GO.md) +- [JavaScript](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_JS.md) +- [Python](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_PYTHON.md) +- [Go HTTP Server Conventions](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/GO_HTTP_SERVER_CONVENTIONS.md) + +--- + +- Cross-project documentation (such as this file) must include + `last_modified: YYYY-MM-DD` in the YAML front matter so it can be kept in sync + with the authoritative source as policies evolve. + +- **ALL external references must be pinned by cryptographic hash.** This + includes Docker base images, Go modules, npm packages, GitHub Actions, and + anything else fetched from a remote source. Version tags (`@v4`, `@latest`, + `:3.21`, etc.) are server-mutable and therefore remote code execution + vulnerabilities. The ONLY acceptable way to reference an external dependency + is by its content hash (Docker `@sha256:...`, Go module hash in `go.sum`, npm + integrity hash in lockfile, GitHub Actions `@`). No exceptions. + This also means never `curl | bash` to install tools like pyenv, nvm, rustup, + etc. Instead, download a specific release archive from GitHub, verify its hash + (hardcoded in the Dockerfile or script), and only then install. Unverified + install scripts are arbitrary remote code execution. This is the single most + important rule in this document. Double-check every external reference in + every file before committing. There are zero exceptions to this rule. + +- Every repo with software must have a root `Makefile` with these targets: + `make test`, `make lint`, `make fmt` (writes), `make fmt-check` (read-only), + `make check` (prereqs: `test`, `lint`, `fmt-check`), `make docker`, and + `make hooks` (installs pre-commit hook). A model Makefile is at + `https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`. + +- Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.) + instead of invoking the underlying tools directly. The Makefile is the single + source of truth for how these operations are run. + +- The Makefile is authoritative documentation for how the repo is used. Beyond + the required targets above, it should have targets for every common operation: + running a local development server (`make run`, `make dev`), re-initializing + or migrating the database (`make db-reset`, `make migrate`), building + artifacts (`make build`), generating code, seeding data, or anything else a + developer would do regularly. If someone checks out the repo and types + `make`, they should see every meaningful operation available. A new + contributor should be able to understand the entire development workflow by + reading the Makefile. + +- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check` + as a build step so the build fails if the branch is not green. For non-server + repos, the Dockerfile should bring up a development environment and run + `make check`. For server repos, `make check` should run as an early build + stage before the final image is assembled. + +- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that + runs `docker build .` on push. Since the Dockerfile already runs `make check`, + a successful build implies all checks pass. + +- Use platform-standard formatters: `black` for Python, `prettier` for + JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with + two exceptions: four-space indents (except Go), and `proseWrap: always` for + Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown, + HTML, CSS) should also have `.prettierrc` and `.prettierignore`. + +- Pre-commit hook: `make check` if local testing is possible, otherwise + `make lint && make fmt-check`. The Makefile should provide a `make hooks` + target to install the pre-commit hook. + +- All repos with software must have tests that run via the platform-standard + test framework (`go test`, `pytest`, `jest`/`vitest`, etc.). If no meaningful + tests exist yet, add the most minimal test possible — e.g. importing the + module under test to verify it compiles/parses. There is no excuse for + `make test` to be a no-op. + +- `make test` must complete in under 20 seconds. Add a 30-second timeout in the + Makefile. + +- Docker builds must complete in under 5 minutes. + +- `make check` must not modify any files in the repo. Tests may use temporary + directories. + +- `main` must always pass `make check`, no exceptions. + +- Never commit secrets. `.env` files, credentials, API keys, and private keys + must be in `.gitignore`. No exceptions. + +- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`), + editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`. + Fetch the standard `.gitignore` from + `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up + a new repo. + +- Never use `git add -A` or `git add .`. Always stage files explicitly by name. + +- Never force-push to `main`. + +- Make all changes on a feature branch. You can do whatever you want on a + feature branch. + +- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only + manually by the user. Fetch from + `https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`. + +- When pinning images or packages by hash, add a comment above the reference + with the version and date (YYYY-MM-DD). + +- Use `yarn`, not `npm`. + +- Write all dates as YYYY-MM-DD (ISO 8601). + +- Simple projects should be configured with environment variables. + +- Dockerized web services listen on port 8080 by default, overridable with + `PORT`. + +- `README.md` is the primary documentation. Required sections: + - **Description**: First line must include the project name, purpose, + category (web server, SPA, CLI tool, etc.), license, and author. Example: + "µPaaS is an MIT-licensed Go web application by @sneak that receives + git-frontend webhooks and deploys applications via Docker in realtime." + - **Getting Started**: Copy-pasteable install/usage code block. + - **Rationale**: Why does this exist? + - **Design**: How is the program structured? + - **TODO**: Update meticulously, even between commits. When planning, put + the todo list in the README so a new agent can pick up where the last one + left off. + - **License**: MIT, GPL, or WTFPL. Ask the user for new projects. Include a + `LICENSE` file in the repo root and a License section in the README. + - **Author**: [@sneak](https://sneak.berlin). + +- First commit of a new repo should contain only `README.md`. + +- Go module root: `sneak.berlin/go/`. Always run `go mod tidy` before + committing. + +- Use SemVer. + +- Database migrations live in `internal/db/migrations/` and must be embedded in + the binary. Pre-1.0.0: modify existing migrations (no installed base assumed). + Post-1.0.0: add new migration files. + +- All repos should have an `.editorconfig` enforcing the project's indentation + settings. + +- Avoid putting files in the repo root unless necessary. Root should contain + only project-level config files (`README.md`, `Makefile`, `Dockerfile`, + `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and + language-specific config). Everything else goes in a subdirectory. Canonical + subdirectory names: + - `bin/` — executable scripts and tools + - `cmd/` — Go command entrypoints + - `configs/` — configuration templates and examples + - `deploy/` — deployment manifests (k8s, compose, terraform) + - `docs/` — documentation and markdown (README.md stays in root) + - `internal/` — Go internal packages + - `internal/db/migrations/` — database migrations + - `pkg/` — Go library packages + - `share/` — systemd units, data files + - `static/` — static assets (images, fonts, etc.) + - `web/` — web frontend source + +- When setting up a new repo, files from the `prompts` repo may be used as + templates. Fetch them from + `https://git.eeqj.de/sneak/prompts/raw/branch/main/`. + +- New repos must contain at minimum: + - `README.md`, `.git`, `.gitignore`, `.editorconfig` + - `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo) + - `Makefile` + - `Dockerfile`, `.dockerignore` + - `.gitea/workflows/check.yml` + - Go: `go.mod`, `go.sum`, `.golangci.yml` + - JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore` + - Python: `pyproject.toml` diff --git a/config.example.yml b/config.example.yml index 7b4d42b..1660cb4 100644 --- a/config.example.yml +++ b/config.example.yml @@ -1,13 +1,37 @@ -# Pixa configuration -# -# REQUIRED: Set signing_key before starting the server. -# Generate with: openssl rand -base64 32 +# Pixa Example Configuration +# Server settings +port: 8080 +debug: false +maintenance_mode: false + +# Data directory for SQLite database and cache files +state_dir: ./data + +# Image proxy settings +# HMAC signing key for URL signatures (leave empty to require whitelist for all requests) +# Generate with: openssl rand -base64 32 signing_key: "CHANGE_ME_generate_with_openssl_rand_base64_32" +# Hosts that don't require signatures +# Use "." prefix for wildcard subdomain matching (e.g., ".example.com" matches "cdn.example.com") whitelist_hosts: - s3.sneak.cloud - static.sneak.cloud - sneak.berlin - github.com - user-images.githubusercontent.com + +# Allow HTTP upstream (only for testing, always use HTTPS in production) +allow_http: false + +# Maximum concurrent connections per upstream host (default: 20) +upstream_connections_per_host: 20 + +# Sentry error reporting (optional) +sentry_dsn: "" + +# Metrics endpoint authentication (optional) +# metrics: +# username: "admin" +# password: "secret" diff --git a/example-config.yml b/example-config.yml deleted file mode 100644 index 0209cee..0000000 --- a/example-config.yml +++ /dev/null @@ -1,34 +0,0 @@ -# Pixa Example Configuration - -# Server settings -port: 8080 -debug: false -maintenance_mode: false - -# Data directory for SQLite database and cache files -state_dir: ./data - -# Image proxy settings -# HMAC signing key for URL signatures (leave empty to require whitelist for all requests) -signing_key: "change-me-to-a-secure-random-string" - -# Hosts that don't require signatures -# Use "." prefix for wildcard subdomain matching (e.g., ".example.com" matches "cdn.example.com") -whitelist_hosts: - - static.sneak.cloud - - sneak.berlin - - s3.sneak.cloud - -# Allow HTTP upstream (only for testing, always use HTTPS in production) -allow_http: false - -# Maximum concurrent connections per upstream host (default: 20) -upstream_connections_per_host: 20 - -# Sentry error reporting (optional) -sentry_dsn: "" - -# Metrics endpoint authentication (optional) -# metrics: -# username: "admin" -# password: "secret" diff --git a/internal/config/config.go b/internal/config/config.go index a42f442..3eb1bc2 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -132,7 +132,9 @@ func loadConfigFile(log *slog.Logger, appName string) (*smartconfig.Config, erro } for _, path := range configPaths { - if _, statErr := os.Stat(path); statErr == nil { + cleanPath := filepath.Clean(path) + //nolint:gosec // G703: paths are hardcoded config locations + if _, statErr := os.Stat(cleanPath); statErr == nil { sc, err := smartconfig.NewFromConfigPath(path) if err != nil { log.Warn("failed to parse config file", "path", path, "error", err) diff --git a/internal/imgcache/cache.go b/internal/imgcache/cache.go index f644fa7..7bd578b 100644 --- a/internal/imgcache/cache.go +++ b/internal/imgcache/cache.go @@ -8,7 +8,6 @@ import ( "fmt" "io" "path/filepath" - "sync" "time" ) @@ -43,8 +42,7 @@ type Cache struct { config CacheConfig // In-memory cache of variant metadata (content type, size) to avoid reading .meta files - metaCache map[VariantKey]variantMeta - metaCacheMu sync.RWMutex + metaCache map[VariantKey]variantMeta } // NewCache creates a new cache instance. @@ -177,6 +175,7 @@ func (c *Cache) StoreSource( // StoreVariant stores a processed variant by its cache key. func (c *Cache) StoreVariant(cacheKey VariantKey, content io.Reader, contentType string) error { _, err := c.variants.Store(cacheKey, content, contentType) + return err } diff --git a/internal/imgcache/fetcher.go b/internal/imgcache/fetcher.go index 66a07b2..dc70b32 100644 --- a/internal/imgcache/fetcher.go +++ b/internal/imgcache/fetcher.go @@ -9,6 +9,7 @@ import ( "net" "net/http" "net/http/httptrace" + neturl "net/url" "strings" "sync" "time" @@ -158,11 +159,18 @@ func (f *HTTPFetcher) Fetch(ctx context.Context, url string) (*FetchResult, erro } }() - req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) + parsedURL, err := neturl.Parse(url) if err != nil { - return nil, fmt.Errorf("failed to create request: %w", err) + return nil, fmt.Errorf("failed to parse URL: %w", err) } + req := &http.Request{ + Method: http.MethodGet, + URL: parsedURL, + Header: make(http.Header), + } + req = req.WithContext(ctx) + req.Header.Set("User-Agent", f.config.UserAgent) req.Header.Set("Accept", strings.Join(f.config.AllowedContentTypes, ", ")) @@ -180,6 +188,7 @@ func (f *HTTPFetcher) Fetch(ctx context.Context, url string) (*FetchResult, erro startTime := time.Now() + //nolint:gosec // G704: URL validated by validateURL() above resp, err := f.client.Do(req) fetchDuration := time.Since(startTime) diff --git a/internal/imgcache/processor.go b/internal/imgcache/processor.go index 08c79fb..846983e 100644 --- a/internal/imgcache/processor.go +++ b/internal/imgcache/processor.go @@ -12,7 +12,7 @@ import ( ) // vipsOnce ensures vips is initialized exactly once. -var vipsOnce sync.Once +var vipsOnce sync.Once //nolint:gochecknoglobals // package-level sync.Once for one-time vips init // initVips initializes libvips with quiet logging. func initVips() { @@ -38,6 +38,7 @@ type ImageProcessor struct{} // NewImageProcessor creates a new image processor. func NewImageProcessor() *ImageProcessor { initVips() + return &ImageProcessor{} } @@ -177,6 +178,7 @@ func (p *ImageProcessor) resize(img *vips.ImageRef, width, height int, fit FitMo scale := min(scaleW, scaleH) newW := int(float64(imgW) * scale) newH := int(float64(imgH) * scale) + return img.Thumbnail(newW, newH, vips.InterestingNone) case FitFill: @@ -194,6 +196,7 @@ func (p *ImageProcessor) resize(img *vips.ImageRef, width, height int, fit FitMo scale := min(scaleW, scaleH) newW := int(float64(imgW) * scale) newH := int(float64(imgH) * scale) + return img.Thumbnail(newW, newH, vips.InterestingNone) case FitOutside: @@ -204,6 +207,7 @@ func (p *ImageProcessor) resize(img *vips.ImageRef, width, height int, fit FitMo scale := max(scaleW, scaleH) newW := int(float64(imgW) * scale) newH := int(float64(imgH) * scale) + return img.Thumbnail(newW, newH, vips.InterestingNone) default: diff --git a/internal/imgcache/service.go b/internal/imgcache/service.go index 519f6c1..53b99d2 100644 --- a/internal/imgcache/service.go +++ b/internal/imgcache/service.go @@ -103,6 +103,7 @@ func (s *Service) Get(ctx context.Context, req *ImageRequest) (*ImageResponse, e "host", req.SourceHost, "path", req.SourcePath, ) + return nil, fmt.Errorf("%w: %w", ErrUpstreamError, ErrNegativeCached) } diff --git a/internal/imgcache/storage.go b/internal/imgcache/storage.go index 612fa8e..371138a 100644 --- a/internal/imgcache/storage.go +++ b/internal/imgcache/storage.go @@ -16,6 +16,8 @@ import ( const ( // StorageDirPerm is the permission mode for storage directories. StorageDirPerm = 0750 + // StorageFilePerm is the permission mode for storage files. + StorageFilePerm = 0600 // MinHashLength is the minimum hash length for path splitting. MinHashLength = 4 ) @@ -101,7 +103,8 @@ func (s *ContentStorage) Store(r io.Reader) (hash ContentHash, size int64, err e } // Atomic rename - if err := os.Rename(tmpPath, path); err != nil { + //nolint:gosec // G703: paths from internal SHA256 hashes + if err := os.Rename(filepath.Clean(tmpPath), filepath.Clean(path)); err != nil { return "", 0, fmt.Errorf("failed to rename temp file: %w", err) } @@ -171,10 +174,10 @@ func (s *ContentStorage) Exists(hash ContentHash) bool { func (s *ContentStorage) hashToPath(hash ContentHash) string { h := string(hash) if len(h) < MinHashLength { - return filepath.Join(s.baseDir, h) + return filepath.Clean(filepath.Join(s.baseDir, h)) } - return filepath.Join(s.baseDir, h[0:2], h[2:4], h) + return filepath.Clean(filepath.Join(s.baseDir, h[0:2], h[2:4], h)) } // MetadataStorage handles JSON metadata file storage. @@ -250,7 +253,8 @@ func (s *MetadataStorage) Store(host string, pathHash PathHash, meta *SourceMeta } // Atomic rename - if err := os.Rename(tmpPath, path); err != nil { + //nolint:gosec // G703: paths from internal SHA256 hashes + if err := os.Rename(filepath.Clean(tmpPath), filepath.Clean(path)); err != nil { return fmt.Errorf("failed to rename temp file: %w", err) } @@ -300,7 +304,7 @@ func (s *MetadataStorage) Exists(host string, pathHash PathHash) bool { // metaPath returns the file path for metadata: //.json func (s *MetadataStorage) metaPath(host string, pathHash PathHash) string { - return filepath.Join(s.baseDir, host, string(pathHash)+".json") + return filepath.Clean(filepath.Join(s.baseDir, host, string(pathHash)+".json")) } // HashPath computes the SHA256 hash of a path string. @@ -393,7 +397,8 @@ func (s *VariantStorage) Store(key VariantKey, r io.Reader, contentType string) } // Atomic rename content - if err := os.Rename(tmpPath, path); err != nil { + //nolint:gosec // G703: paths from internal SHA256 hashes + if err := os.Rename(filepath.Clean(tmpPath), filepath.Clean(path)); err != nil { return 0, fmt.Errorf("failed to rename temp file: %w", err) } @@ -409,7 +414,7 @@ func (s *VariantStorage) Store(key VariantKey, r io.Reader, contentType string) return 0, fmt.Errorf("failed to marshal metadata: %w", err) } - if err := os.WriteFile(metaPath, metaData, 0640); err != nil { + if err := os.WriteFile(metaPath, metaData, StorageFilePerm); err != nil { // Non-fatal, content is stored _ = err } diff --git a/internal/logger/logger.go b/internal/logger/logger.go index 7112735..23a24d1 100644 --- a/internal/logger/logger.go +++ b/internal/logger/logger.go @@ -40,12 +40,13 @@ func New(_ fx.Lifecycle, params Params) (*Logger, error) { } // replaceAttr simplifies the source attribute to "file.go:line" - replaceAttr := func(groups []string, a slog.Attr) slog.Attr { + replaceAttr := func(_ []string, a slog.Attr) slog.Attr { if a.Key == slog.SourceKey { if src, ok := a.Value.Any().(*slog.Source); ok { a.Value = slog.StringValue(fmt.Sprintf("%s:%d", filepath.Base(src.File), src.Line)) } } + return a }