diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..695ec9e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM python:3.12-slim + +ENV PYTHONDONTWRITEBYTECODE=1 PYTHONUNBUFFERED=1 + +RUN apt-get update && apt-get install -y --no-install-recommends ca-certificates && rm -rf /var/lib/apt/lists/* +WORKDIR /app + +COPY pyproject.toml README.md /app/ +RUN pip install --no-cache-dir -e . + +COPY app /app/app +COPY .env.example /app/.env.example + +ENV PORT=8000 +EXPOSE 8000 +CMD ["uvicorn", "app.main:app", "--host=0.0.0.0", "--port=8000"] diff --git a/LICENSE b/LICENSE index f288702..dc885bb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,16 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 +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. +Copyright (C) 2025 John Coffey - Preamble +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, version 3 of the License. - The GNU General Public License is a free, copyleft license for -software and other kinds of works. +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. - 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 -. +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..40d8ae6 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +.PHONY: run dev test build + +run: + uvicorn app.main:app --host 0.0.0.0 --port 8000 + +dev: + uvicorn app.main:app --reload + +test: + pytest + +build: + docker compose build diff --git a/README.md b/README.md new file mode 100644 index 0000000..d3699b7 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# ihasmail + +![ihasmail logo](app/static/img/logo.png) + +A polished, FastAPI + HTMX/Jinja webmail for Stalwart, with JMAP mail/contacts/calendar, Sieve UI, DAV browsing, and reverse-proxy friendly deploy. + +A production-leaning, **FastAPI** + **HTMX/Jinja** webmail for [Stalwart Mail Server](https://stalw.art/), using **JMAP** for mail, contacts, and calendar, plus simple **WebDAV/CalDAV** helpers. Authenticates with the user's Stalwart mailbox (like Roundcube). Designed to run behind a reverse proxy. + +## Features +- Login with Stalwart mailbox (HTTP Basic against JMAP session or bearer token if provided) +- Inbox listing, read messages (plain text), compose & send via JMAP (`Email`, `EmailSubmission`) +- Contacts/Directory via JMAP `Contact` +- Calendar view via JMAP `CalendarEvent` +- WebDAV browser (read-only sample) and CalDAV endpoints (external DAV clients) +- CSRF on POST, signed session cookie, proxy-friendly +- Dockerfile + docker-compose for easy deploy + +> HTML rendering and attachment streaming are stubbed—extend using the JMAP `downloadUrl` and sanitize HTML before display. + +## Quick Start (Docker) + +```bash +# 1) Configure environment +cp .env.example .env +# Edit JMAP_BASE, CALDAV_BASE, WEBDAV_BASE, APP_SECRET + +# 2) Build & run +docker compose up --build -d + +# 3) Reverse proxy (Nginx/Caddy) to http://127.0.0.1:8080 +``` + +## Environment Variables +- `APP_SECRET` – random string for signing cookies (required) +- `JMAP_BASE` – e.g., `https://mail.example.com/jmap` +- `CALDAV_BASE` – e.g., `https://mail.example.com/caldav/` +- `WEBDAV_BASE` – e.g., `https://mail.example.com/webdav/` +- `COOKIE_NAME` – cookie name (default: `stalwart_webmail`) +- `TRUST_PROXY` – `1` to honor `X-Forwarded-*` (default: `1`) +- `UPSTREAM_TIMEOUT` – seconds for upstream HTTP (default: `15`) + +## Dev +```bash +python -m venv .venv && source .venv/bin/activate +pip install -e ".[dev]" +uvicorn app.main:app --reload +pytest +``` + +## Security & Hardening +- Prefer **bearer tokens** if Stalwart issues them; update `jmap_session()` to store `accessToken` +- Set explicit `accountId` from the JMAP session `primaryAccounts` +- Add mailbox/folder navigation via `Mailbox/query` + `Mailbox/get` +- Sanitize HTML bodies (e.g., `bleach`) before rendering +- Add Sieve UI via `urn:ietf:params:jmap:sieve` +- Consider rate limiting and security headers in the reverse proxy +- Serve static assets via proxy/CDN + +## License +GPL-3.0-or-later diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/config.py b/app/config.py new file mode 100644 index 0000000..74abbb2 --- /dev/null +++ b/app/config.py @@ -0,0 +1,9 @@ +import os, secrets + +APP_SECRET = os.getenv("APP_SECRET") or secrets.token_urlsafe(32) +COOKIE_NAME = os.getenv("COOKIE_NAME", "stalwart_webmail") +JMAP_BASE = os.getenv("JMAP_BASE", "https://mail.example.com/jmap") +CALDAV_BASE = os.getenv("CALDAV_BASE", "https://mail.example.com/caldav/") +WEBDAV_BASE = os.getenv("WEBDAV_BASE", "https://mail.example.com/webdav/") +TRUST_PROXY = os.getenv("TRUST_PROXY", "1") == "1" +UPSTREAM_TIMEOUT = float(os.getenv("UPSTREAM_TIMEOUT", "15")) diff --git a/app/dav.py b/app/dav.py new file mode 100644 index 0000000..1d315ab --- /dev/null +++ b/app/dav.py @@ -0,0 +1,41 @@ +from typing import List, Dict, Any, Tuple, Optional +import httpx +from urllib.parse import urljoin +from . import config + +DAV_PROPFIND = """ + + + + + + +""" + +async def propfind(ac: httpx.AsyncClient, base: str, path: Optional[str], auth: Tuple[str,str]) -> List[Dict[str, Any]]: + href = urljoin(base, path or "/") + r = await ac.request("PROPFIND", href, content=DAV_PROPFIND, headers={"Depth": "1"}, auth=auth) + if r.status_code not in (207, 200): + raise RuntimeError(f"WebDAV error {r.status_code}") + import xml.etree.ElementTree as ET + tree = ET.fromstring(r.text) + ns = {"d":"DAV:"} + items: List[Dict[str, Any]] = [] + for resp in tree.findall("d:response", ns): + href_el = resp.find("d:href", ns) + prop = resp.find("d:propstat/d:prop", ns) + if href_el is None or prop is None: + continue + name = prop.find("d:displayname", ns) + cl = prop.find("d:getcontentlength", ns) + rtype = prop.find("d:resourcetype", ns) + is_collection = rtype is not None and rtype.find("d:collection", ns) is not None + items.append({ + "href": href_el.text, + "name": (name.text if name is not None and name.text else href_el.text.rstrip("/").split("/")[-1] or "/"), + "type": "directory" if is_collection else "file", + "size": int(cl.text) if (cl is not None and cl.text and cl.text.isdigit()) else None + }) + if items: + items = items[1:] + return items diff --git a/app/jmap.py b/app/jmap.py new file mode 100644 index 0000000..975a79d --- /dev/null +++ b/app/jmap.py @@ -0,0 +1,31 @@ +from typing import Any, Dict, List, Tuple +import httpx +from . import config + +def client() -> httpx.AsyncClient: + limits = httpx.Limits(max_connections=20, max_keepalive_connections=10) + return httpx.AsyncClient(timeout=config.UPSTREAM_TIMEOUT, limits=limits, trust_env=True) + +async def get_session(ac: httpx.AsyncClient, base: str, username: str, password: str) -> Dict[str, Any]: + r = await ac.get(base, auth=(username, password)) + if r.status_code == 401: + raise PermissionError("Invalid credentials") + r.raise_for_status() + return r.json() + +async def call(ac: httpx.AsyncClient, api_url: str, auth: Tuple[str,str] | None, method_calls: List[list]) -> Dict[str, Any]: + payload = { + "using": [ + "urn:ietf:params:jmap:core", + "urn:ietf:params:jmap:mail", + "urn:ietf:params:jmap:contacts", + "urn:ietf:params:jmap:calendars" + ], + "methodCalls": method_calls + } + kwargs: Dict[str, Any] = {"json": payload} + if auth: + kwargs["auth"] = auth + r = await ac.post(api_url, **kwargs) + r.raise_for_status() + return r.json() diff --git a/app/main.py b/app/main.py new file mode 100644 index 0000000..a9d13e4 --- /dev/null +++ b/app/main.py @@ -0,0 +1,34 @@ +import bleach +from fastapi import FastAPI, Request +from fastapi.staticfiles import StaticFiles +from starlette.middleware.sessions import SessionMiddleware +from starlette.middleware.proxy_headers import ProxyHeadersMiddleware +from . import config +from .routes import auth, mail, contacts, calendar, webdav, sieve + +app = FastAPI(title="Stalwart Webmail (Python)") + +if config.TRUST_PROXY: + app.add_middleware(ProxyHeadersMiddleware, trusted_hosts="*") + +app.add_middleware(SessionMiddleware, secret_key=config.APP_SECRET, session_cookie=config.COOKIE_NAME, same_site="lax", https_only=True) + +app.mount("/static", StaticFiles(directory="app/static"), name="static") + +@app.get("/", include_in_schema=False) +async def root(request: Request): + from fastapi.responses import RedirectResponse + return RedirectResponse("/mail" if request.session.get("user") else "/login") + +# Routers +app.include_router(auth.router) +app.include_router(mail.router) +app.include_router(contacts.router) +app.include_router(calendar.router) +app.include_router(webdav.router) +app.include_router(sieve.router) + + +@app.get("/healthz", include_in_schema=False) +async def healthz(): + return {"ok": True} diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/routes/auth.py b/app/routes/auth.py new file mode 100644 index 0000000..7989108 --- /dev/null +++ b/app/routes/auth.py @@ -0,0 +1,45 @@ +from fastapi import APIRouter, Request, Form, HTTPException +from fastapi.responses import RedirectResponse, HTMLResponse +from starlette.middleware.sessions import SessionMiddleware +from starlette.responses import PlainTextResponse +from .. import config, jmap +from fastapi.templating import Jinja2Templates +from jinja2 import FileSystemLoader, Environment, select_autoescape +import pathlib, base64, os + +router = APIRouter() + +templates = Jinja2Templates(directory=str(pathlib.Path(__file__).resolve().parent.parent / "templates")) + +def make_csrf(session: dict) -> str: + token = base64.urlsafe_b64encode(os.urandom(24)).decode() + session["csrf"] = token + return token + +def check_csrf(session: dict, token: str): + if not token or token != session.get("csrf"): + raise HTTPException(status_code=400, detail="CSRF token invalid") + +@router.get("/login", response_class=HTMLResponse) +async def login_form(request: Request): + csrf = make_csrf(request.session) + return templates.TemplateResponse("login.html", {"request": request, "csrf": csrf, "jmap_base": config.JMAP_BASE}) + +@router.post("/login") +async def login_submit(request: Request, username: str = Form(...), password: str = Form(...), jmap_base: str = Form(...), csrf: str = Form(...)): + check_csrf(request.session, csrf) + async with jmap.client() as ac: + try: + session = await jmap.get_session(ac, jmap_base, username, password) + except PermissionError: + raise HTTPException(status_code=401, detail="Invalid credentials") + api_url = session.get("apiUrl") or jmap_base + download_url = session.get("downloadUrl") or "" + primary = session.get("primaryAccounts") or {} + request.session["user"] = {"username": username, "jmap_base": jmap_base, "api_url": api_url, "auth": (username, password), "download_url": download_url, "primary": primary, "session": session} + return RedirectResponse("/mail", status_code=303) + +@router.get("/logout") +async def logout(request: Request): + request.session.clear() + return RedirectResponse("/login", status_code=303) diff --git a/app/routes/calendar.py b/app/routes/calendar.py new file mode 100644 index 0000000..115855c --- /dev/null +++ b/app/routes/calendar.py @@ -0,0 +1,39 @@ +from fastapi import APIRouter, Request, Depends, HTTPException +from fastapi.responses import HTMLResponse +from fastapi.templating import Jinja2Templates +import pathlib, datetime +from .. import jmap +from ..utils import fmt_when + +router = APIRouter() +templates = Jinja2Templates(directory=str(pathlib.Path(__file__).resolve().parent.parent / "templates")) + +def require_user(request: Request): + user = request.session.get("user") + if not user: + raise HTTPException(status_code=401) + return user + +@router.get("/calendar", response_class=HTMLResponse) +async def calendar(request: Request, user=Depends(require_user)): + async with jmap.client() as ac: + api = user["api_url"] + account_id = None + now = datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc) + until = now + datetime.timedelta(days=30) + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["CalendarEvent/query", {"accountId": account_id, "limit": 200, "sort":[{"property":"start","isAscending": True}]}, "q1"], + ["CalendarEvent/get", {"accountId": account_id, "#ids": {"resultOf":"q1","name":"CalendarEvent/query","path":"ids"}, "properties":["id","title","start","end","location"]}, "g1"] + ]) + events = [] + for name, data, _ in res.get("methodResponses", []): + if name == "CalendarEvent/get": + for e in data.get("list", []): + try: + s = datetime.datetime.fromisoformat((e.get("start") or "").replace("Z","+00:00")) + if s < now - datetime.timedelta(days=1) or s > until: + continue + except Exception: + pass + events.append({"title": e.get("title") or "(no title)", "start": fmt_when(e.get("start")), "end": fmt_when(e.get("end")), "loc": e.get("location")}) + return templates.TemplateResponse("calendar.html", {"request": request, "events": events, "user": user}) diff --git a/app/routes/contacts.py b/app/routes/contacts.py new file mode 100644 index 0000000..222aa7b --- /dev/null +++ b/app/routes/contacts.py @@ -0,0 +1,35 @@ +from typing import Optional +from fastapi import APIRouter, Request, Depends, HTTPException +from fastapi.responses import HTMLResponse +from fastapi.templating import Jinja2Templates +import pathlib +from .. import jmap + +router = APIRouter() +templates = Jinja2Templates(directory=str(pathlib.Path(__file__).resolve().parent.parent / "templates")) + +def require_user(request: Request): + user = request.session.get("user") + if not user: + raise HTTPException(status_code=401) + return user + +@router.get("/contacts", response_class=HTMLResponse) +async def contacts(request: Request, q: Optional[str] = None, user=Depends(require_user)): + async with jmap.client() as ac: + api = user["api_url"] + account_id = None + filter_cond = {"text": q} if q else {} + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["Contact/query", {"accountId": account_id, "filter": filter_cond, "limit": 100}, "c1"], + ["Contact/get", {"accountId": account_id, "#ids": {"resultOf":"c1","name":"Contact/query","path":"ids"}, "properties":["id","firstName","lastName","emails","company"]}, "c2"] + ]) + contacts = [] + for name, data, _ in res.get("methodResponses", []): + if name == "Contact/get": + for c in data.get("list", []): + emails = [e.get("email","") for e in (c.get("emails") or [])] + contacts.append({"name": f"{c.get('firstName','')} {c.get('lastName','')}".strip() or (emails[0] if emails else ""), + "email": ", ".join(emails), + "org": c.get("company")}) + return templates.TemplateResponse("contacts.html", {"request": request, "contacts": contacts, "q": q, "user": user}) diff --git a/app/routes/mail.py b/app/routes/mail.py new file mode 100644 index 0000000..8e076c7 --- /dev/null +++ b/app/routes/mail.py @@ -0,0 +1,316 @@ +import json +import io +import bleach +from typing import Optional +from fastapi import APIRouter, Request, Depends, HTTPException, Form, UploadFile, File +from fastapi.responses import HTMLResponse, RedirectResponse, StreamingResponse, JSONResponse +from fastapi.templating import Jinja2Templates +import pathlib +from .. import jmap +from ..utils import human_size, fmt_when + +router = APIRouter() +templates = Jinja2Templates(directory=str(pathlib.Path(__file__).resolve().parent.parent / "templates")) + +def require_user(request: Request): + user = request.session.get("user") + if not user: + raise HTTPException(status_code=401) + return user + +def make_csrf(session: dict) -> str: + import os, base64 + token = base64.urlsafe_b64encode(os.urandom(24)).decode() + session["csrf"] = token + return token + +def check_csrf(session: dict, token: str): + if not token or token != session.get("csrf"): + raise HTTPException(status_code=400, detail="CSRF token invalid") + +@router.get("/mail", response_class=HTMLResponse) +async def inbox(request: Request, q: Optional[str] = None, mailbox: Optional[str] = None, user=Depends(require_user)): + async with jmap.client() as ac: + api = user["api_url"] + primary = user.get("primary", {}) + account_id = primary.get("urn:ietf:params:jmap:mail") + boxes, inbox_id = await get_mailboxes(ac, api, tuple(user["auth"]), account_id) + box_id = mailbox or inbox_id + filt = {"text": q} if q else ({"inMailbox": box_id} if box_id else {}) + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["Email/query", {"accountId": account_id, "filter": filt, "sort": [{"property":"receivedAt","isAscending": False}], "limit": 50}, "c1"], + ["Email/get", {"accountId": account_id, "#ids": {"resultOf":"c1","name":"Email/query","path":"ids"}, "properties": ["id","subject","from","size","receivedAt"]}, "c2"] + ]) + emails = [] + + for name, data, _ in res.get("methodResponses", []): + if name == "Email/get": + for e in data.get("list", []): + from_str = ", ".join([a.get("name") or a.get("email","") for a in (e.get("from") or [])]) + emails.append({"id": e["id"], "subject": e.get("subject") or "(no subject)", "from": from_str, "when": fmt_when(e.get("receivedAt")), "size": human_size(e.get("size"))}) + return templates.TemplateResponse("mail.html", {"request": request, "messages": emails, "q": q, "user": user, "mailboxes": boxes, "selected": box_id}) + +@router.get("/mail/{email_id}", response_class=HTMLResponse) +async def read_message(request: Request, email_id: str, user=Depends(require_user)): + async with jmap.client() as ac: + api = user["api_url"] + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["Email/get", {"ids": [email_id], "properties": ["id","subject","from","to","receivedAt","size","keywords","preview","bodyStructure","htmlBody","textBody"]}, "c1"] + ]) + msg = {"id": email_id, "subject":"", "from":"", "to":[], "when":"", "textBody":"", "htmlBody":"", "attachments":[]} + bstruct = None + cid_map = {} + for name, data, _ in res.get("methodResponses", []): + if name == "Email/get": + lst = data.get("list", []) + if lst: + e = lst[0] + msg["subject"] = e.get("subject") or msg["subject"] + msg["from"] = ", ".join([a.get("name") or a.get("email","") for a in (e.get("from") or [])]) or msg["from"] + msg["to"] = [a.get("email","") for a in (e.get("to") or [])] or msg["to"] + msg["when"] = fmt_when(e.get("receivedAt")) or msg["when"] + if "textBody" in e: + msg["textBody"] = e.get("textBody") or msg["textBody"] + if "htmlBody" in e: + raw_html = e.get("htmlBody") + if raw_html: + msg["htmlBody"] = bleach.clean(raw_html, tags=bleach.sanitizer.ALLOWED_TAGS.union({"p","span","div","br","hr","pre","code","blockquote","ul","ol","li","table","thead","tbody","tr","th","td","img","a","b","i","strong","em"}), attributes={"a":["href","title"],"img":["src","alt","title","width","height"]}, strip=True) + bstruct = bstruct or e.get("bodyStructure") + def walk_cid(bs): + if not isinstance(bs, dict): return + cid = bs.get("cid") + if cid and bs.get("blobId"): + cid_map[cid.strip("<>")] = {"blobId": bs["blobId"], "name": bs.get("name") or "inline"} + for p in bs.get("subParts", []) or []: + walk_cid(p) + if bstruct: + walk_cid(bstruct) + + def walk_bs(bs, out): + if not isinstance(bs, dict): return + if bs.get("disposition") == "attachment": + out.append({"name": bs.get("name") or "attachment", "type": bs.get("type") or "application/octet-stream", "size": bs.get("size"), "blobId": bs.get("blobId")}) + for p in bs.get("subParts", []) or []: + walk_bs(p, out) + att = [] + walk_bs(bstruct, att) + msg["attachments"] = att + # Inline CID images via internal route + if msg.get("htmlBody") and cid_map: + import re as _re + def _repl(m): + cid = m.group(1) + return f'src="/mail/{email_id}/cid/{cid}"' + msg["htmlBody"] = _re.sub(r'src=\"cid:([^\"]+)\"', _repl, msg["htmlBody"]) # cid_rewrite + return templates.TemplateResponse("message.html", {"request": request, "msg": msg, "user": user}) + +@router.get("/compose", response_class=HTMLResponse) +async def compose_form(request: Request, user=Depends(require_user)): + csrf = make_csrf(request.session) + return templates.TemplateResponse("compose.html", {"request": request, "csrf": csrf, "user": user}) + +@router.post("/compose") +async def compose_send(request: Request, to: str = Form(...), subject: str = Form(""), body: str = Form(""), csrf: str = Form(...), action: str = Form("send"), files: list[UploadFile] = File(default=[]), user=Depends(require_user)): + check_csrf(request.session, csrf) + async with jmap.client() as ac: + api = user["api_url"] + primary = user.get("primary", {}) + account_id = primary.get("urn:ietf:params:jmap:mail") + # Upload attachments if any + upload_url = user.get("upload_url") + blobs = [] + form = await request.form() + for k, v in form.multi_items(): + if k == 'preblob': + try: + b = json.loads(v) + if b.get('blobId'): blobs.append(b) + except Exception: + pass + if files: + for f in files: + data = await f.read() + if upload_url: + url = upload_url.replace("{accountId}", account_id or "") + ru = await ac.post(url, content=data, headers={"Content-Type": f.content_type or "application/octet-stream"}, auth=tuple(user["auth"])) + ru.raise_for_status() + up = ru.json() + blobs.append({"blobId": up.get("blobId"), "type": f.content_type or "application/octet-stream", "name": f.filename, "size": len(data)}) + email_creation_id = "k1" + submission_creation_id = "k2" + create_email = { + "accountId": account_id, + "create": { + email_creation_id: { + "mailboxIds": {}, + "from": [{"email": user["username"]}], + "to": [{"email": x.strip()} for x in to.split(",") if x.strip()], + "subject": subject, + "textBody": body, + "attachments": [{"blobId": b["blobId"], "type": b["type"], "name": b["name"]} for b in blobs] + } + } + } + # Move to Drafts if requested, else submit and move to Sent + special = await get_special_mailboxes(ac, api, tuple(user["auth"]), account_id) + sent_id = special.get("sent") + drafts_id = special.get("drafts") + calls = [] + calls.append(["Email/set", create_email, "s1"]) + if action == "draft": + if drafts_id: + calls.append(["Email/set", {"accountId": account_id, "onSuccessUpdateEmail": {"#kEmail": {"mailboxIds": {drafts_id: True}}}}, "sdraft"]) + else: + calls.append(["EmailSubmission/set", {"accountId": account_id, "create": {submission_creation_id: {"emailId": {"resultOf":"s1","name":"Email/set","path": f"created/{email_creation_id}/id"}}}}, "s2"]) + if sent_id: + calls.append(["Email/set", {"accountId": account_id, "onSuccessUpdateEmail": {"#kEmail": {"mailboxIds": {sent_id: True}}}}, "ssent"]) + await jmap.call(ac, api, tuple(user["auth"]), calls) + return RedirectResponse("/mail", status_code=303) + +async def get_mailboxes(ac, api, auth, account_id): + res = await jmap.call(ac, api, auth, [ + ["Mailbox/query", {"accountId": account_id, "sort":[{"property":"sortOrder","isAscending": True},{"property":"name","isAscending": True}], "limit": 200}, "q1"], + ["Mailbox/get", {"accountId": account_id, "#ids": {"resultOf":"q1","name":"Mailbox/query","path":"ids"}, "properties":["id","name","role","totalEmails","unreadEmails"]}, "g1"] + ]) + boxes = [] + inbox_id = None + for name, data, _ in res.get("methodResponses", []): + if name == "Mailbox/get": + for b in data.get("list", []): + boxes.append({"id": b["id"], "name": b.get("name",""), "role": b.get("role"), "total": b.get("totalEmails",0), "unread": b.get("unreadEmails",0)}) + if b.get("role") == "inbox": + inbox_id = b["id"] + return boxes, inbox_id or (boxes[0]["id"] if boxes else None) + +@router.get("/mail/{email_id}/attach/{index}") +async def download_attachment(request: Request, email_id: str, index: int, user=Depends(require_user)): + atts = request.query_params.get("atts") + # Re-fetch message to resolve bodyStructure (simple approach; could cache) + async with jmap.client() as ac: + api = user["api_url"] + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["Email/get", {"ids": [email_id], "properties": ["bodyStructure"]}, "c1"] + ]) + bstruct = None + cid_map = {} + for name, data, _ in res.get("methodResponses", []): + if name == "Email/get": + lst = data.get("list", []) + if lst: + bstruct = lst[0].get("bodyStructure") + parts = [] + def walk(bs, out): + if not isinstance(bs, dict): return + if bs.get("disposition") == "attachment": + out.append(bs) + for p in bs.get("subParts", []) or []: + walk(p, out) + walk(bstruct, parts) + if index < 0 or index >= len(parts): + raise HTTPException(status_code=404, detail="Attachment not found") + p = parts[index] + blob = p.get("blobId") + name = p.get("name") or "attachment" + ctype = p.get("type") or "application/octet-stream" + + # Build download URL from session template + tmpl = user.get("download_url") or "" + primary = user.get("primary", {}) + account_id = primary.get("urn:ietf:params:jmap:mail") + url = tmpl + if "{accountId}" in url: + url = url.replace("{accountId}", account_id or "") + if "{blobId}" in url: + url = url.replace("{blobId}", blob or "") + if "{name}" in url: + from urllib.parse import quote + url = url.replace("{name}", quote(name)) + # Fallback naive pattern if template missing + if not url or "{" in url: + from urllib.parse import urljoin, quote + base = user.get("jmap_base") + url = urljoin(base, f"/download/{quote(account_id or '')}/{quote(blob or '')}/{quote(name)}") + + async with jmap.client() as ac: + r = await ac.get(url, auth=tuple(user["auth"])) + r.raise_for_status() + return StreamingResponse(io.BytesIO(r.content), media_type=ctype, headers={"Content-Disposition": f'attachment; filename="{name}"'}) + + +async def get_special_mailboxes(ac, api, auth, account_id): + res = await jmap.call(ac, api, auth, [ + ["Mailbox/query", {"accountId": account_id, "limit": 200}, "q1"], + ["Mailbox/get", {"accountId": account_id, "#ids": {"resultOf":"q1","name":"Mailbox/query","path":"ids"}, "properties":["id","role","name"]}, "g1"] + ]) + sent_id = drafts_id = inbox_id = None + boxes = {} + for name, data, _ in res.get("methodResponses", []): + if name == "Mailbox/get": + for b in data.get("list", []): + boxes[b["id"]] = b + role = b.get("role") + if role == "sent": sent_id = b["id"] + if role == "drafts": drafts_id = b["id"] + if role == "inbox": inbox_id = b["id"] + return {"sent": sent_id, "drafts": drafts_id, "inbox": inbox_id, "all": boxes} + + +@router.get("/mail/{email_id}/cid/{cid}") +async def fetch_cid(request: Request, email_id: str, cid: str, user=Depends(require_user)): + # Walk bodyStructure to find matching cid, then download via downloadUrl + async with jmap.client() as ac: + api = user["api_url"] + res = await jmap.call(ac, api, tuple(user["auth"]), [ + ["Email/get", {"ids": [email_id], "properties": ["bodyStructure"]}, "c1"] + ]) + bstruct = None + for name, data, _ in res.get("methodResponses", []): + if name == "Email/get": + lst = data.get("list", []) + if lst: + bstruct = lst[0].get("bodyStructure") + target = None + def walk(bs): + nonlocal target + if not isinstance(bs, dict) or target is not None: return + if bs.get("cid") and bs.get("cid").strip("<>") == cid: + target = bs + return + for p in bs.get("subParts", []) or []: + walk(p) + walk(bstruct) + if not target: + raise HTTPException(status_code=404, detail="Inline part not found") + blob = target.get("blobId") + ctype = target.get("type") or "application/octet-stream" + name = target.get("name") or "inline" + tmpl = user.get("download_url") or "" + primary = user.get("primary", {}) + account_id = primary.get("urn:ietf:params:jmap:mail") + from urllib.parse import quote, urljoin + if tmpl and "{accountId}" in tmpl and "{blobId}" in tmpl: + url = tmpl.replace("{accountId}", account_id or "").replace("{blobId}", blob or "") + if "{name}" in url: + url = url.replace("{name}", quote(name)) + else: + url = urljoin(user.get("jmap_base"), f"/download/{quote(account_id or '')}/{quote(blob or '')}/{quote(name)}") + async with jmap.client() as ac: + r = await ac.get(url, auth=tuple(user["auth"])) + r.raise_for_status() + return StreamingResponse(io.BytesIO(r.content), media_type=ctype) + + +@router.post("/upload") +async def upload_file(request: Request, file: UploadFile = File(...), user=Depends(require_user)): + async with jmap.client() as ac: + primary = user.get("primary", {}) + account_id = user.get("active_account") or primary.get("urn:ietf:params:jmap:mail") + upload_url = user.get("upload_url") + if not upload_url or not account_id: + raise HTTPException(status_code=400, detail="Upload not available") + url = upload_url.replace("{accountId}", account_id) + data = await file.read() + r = await ac.post(url, content=data, headers={"Content-Type": file.content_type or "application/octet-stream"}, auth=tuple(user["auth"])) + r.raise_for_status() + up = r.json() + return JSONResponse({"blobId": up.get("blobId"), "type": file.content_type or "application/octet-stream", "name": file.filename, "size": len(data)}) diff --git a/app/routes/webdav.py b/app/routes/webdav.py new file mode 100644 index 0000000..807554e --- /dev/null +++ b/app/routes/webdav.py @@ -0,0 +1,21 @@ +from typing import Optional +from fastapi import APIRouter, Request, Depends, HTTPException +from fastapi.responses import HTMLResponse +from fastapi.templating import Jinja2Templates +import pathlib +from .. import dav, jmap, config + +router = APIRouter() +templates = Jinja2Templates(directory=str(pathlib.Path(__file__).resolve().parent.parent / "templates")) + +def require_user(request: Request): + user = request.session.get("user") + if not user: + raise HTTPException(status_code=401) + return user + +@router.get("/webdav", response_class=HTMLResponse) +async def webdav_browse(request: Request, path: Optional[str]=None, user=Depends(require_user)): + async with jmap.client() as ac: + items = await dav.propfind(ac, config.WEBDAV_BASE, path, tuple(user["auth"])) + return templates.TemplateResponse("webdav.html", {"request": request, "items": items, "base": config.WEBDAV_BASE, "user": user}) diff --git a/app/static/css/style.css b/app/static/css/style.css new file mode 100644 index 0000000..7c3c50b --- /dev/null +++ b/app/static/css/style.css @@ -0,0 +1,30 @@ +:root { color-scheme: light dark; --header-bg: #f6f7f9; --header-fg: #111; --card-bg: #fff; } +@media (prefers-color-scheme: dark) { :root { --header-bg: #0f172a; --header-fg: #e5e7eb; --card-bg: #0b1222; } } +body { margin:0; font: 14px/1.45 system-ui, -apple-system, Segoe UI, Roboto, sans-serif; } +header, footer { padding: 10px 14px; border-bottom: 1px solid #4443; background: var(--header-bg); color: var(--header-fg); } +main { padding: 14px; max-width: 1100px; margin: 0 auto; } +nav a { margin-right: 12px; } +.btn { display:inline-block; padding:6px 10px; border:1px solid #6665; border-radius:8px; text-decoration:none; } +table { border-collapse: collapse; width: 100%; } +th, td { padding: 8px; border-bottom: 1px solid #6662; text-align: left; vertical-align: top; } +.muted { color: #888; } +input, textarea, select { padding:6px 8px; width:100%; box-sizing: border-box; } +form .row { display:grid; grid-template-columns: 160px 1fr; gap: 8px; align-items: center; margin-bottom:10px; } +.msg { cursor:pointer; } +.pill { display:inline-block; font-size:12px; padding:2px 6px; border:1px solid #6663; border-radius:999px; margin-right:6px;} +.nowrap { white-space: nowrap; } +.right { text-align:right; } +.toolbar { display:flex; gap:8px; align-items:center; margin:8px 0; } +.panel { border:1px solid #6663;padding:10px;border-radius:8px;margin:10px 0;white-space:pre-wrap } + +#dropzone{padding:16px;border:2px dashed #6665;border-radius:8px;text-align:center;margin:10px 0} + +.brand { display:flex; align-items:center; gap:10px; } +.brand .logo { height:28px; vertical-align:middle; } +.brand-link { text-decoration:none; color:inherit; } +header nav { margin-top:6px; } +.badge { display:inline-block; padding:0 6px; border-radius:10px; font-size:12px; background:#6662; margin-left:6px; } + +.card{background:var(--card-bg); border:1px solid #6663; border-radius:12px; padding:18px; box-shadow:0 2px 6px #0001;} +.center{display:grid; place-items:center; min-height:60vh;} +.logo-lg{height:64px;} diff --git a/app/static/img/logo.png b/app/static/img/logo.png new file mode 100644 index 0000000..105c559 Binary files /dev/null and b/app/static/img/logo.png differ diff --git a/app/templates/base.html b/app/templates/base.html new file mode 100644 index 0000000..4b203e0 --- /dev/null +++ b/app/templates/base.html @@ -0,0 +1,37 @@ + + + + + {{ title or "ihasmail" }} + + + + + + + + +
+ + +
+
+ {% block content %}{% endblock %} +
+
ihasmail • JMAP • Sieve • DAV • FastAPI • reverse-proxy ready
+ + diff --git a/app/templates/calendar.html b/app/templates/calendar.html new file mode 100644 index 0000000..25c71f1 --- /dev/null +++ b/app/templates/calendar.html @@ -0,0 +1,15 @@ +{% extends "base.html" %} +{% block content %} +

Calendar (JMAP & CalDAV)

+

Listing upcoming events via JMAP. CalDAV endpoints available for DAV clients.

+ + + {% for e in events %} + + + + + + {% endfor %} +
WhenSummaryWhere
{{ e.start }} – {{ e.end }}{{ e.title }}{{ e.loc or "" }}
+{% endblock %} diff --git a/app/templates/compose.html b/app/templates/compose.html new file mode 100644 index 0000000..151c8bd --- /dev/null +++ b/app/templates/compose.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} +{% block content %} +

Compose

+
+ +
+
+
+ +
+{% endblock %} diff --git a/app/templates/contacts.html b/app/templates/contacts.html new file mode 100644 index 0000000..cf2806e --- /dev/null +++ b/app/templates/contacts.html @@ -0,0 +1,19 @@ +{% extends "base.html" %} +{% block content %} +

Contacts (Directory via JMAP)

+
+
+ +
+
+ + + {% for c in contacts %} + + + + + + {% endfor %} +
NameEmailOrg
{{ c.name }}{{ c.email }}{{ c.org or "" }}
+{% endblock %} diff --git a/app/templates/login.html b/app/templates/login.html new file mode 100644 index 0000000..c5d84d6 --- /dev/null +++ b/app/templates/login.html @@ -0,0 +1,24 @@ +{% extends "base.html" %} +{% block content %} +
+
ihasmail
+

Sign in

+
+ +
+ + +
+
+ + +
+
+ + +
+ +
+
+

Credentials are sent to your JMAP server to obtain a session/auth token; they are not stored on the server.

+{% endblock %} diff --git a/app/templates/mail.html b/app/templates/mail.html new file mode 100644 index 0000000..3de29e6 --- /dev/null +++ b/app/templates/mail.html @@ -0,0 +1,26 @@ +{% extends "base.html" %} +{% block content %} +

Inbox

+
+
+ + +
+ Compose +
+ + + {% for m in messages %} + + + + + + + {% endfor %} +
WhenFromSubjectSize
{{ m.when }}{{ m.from }}{{ m.subject }}{{ m.size }}
+{% endblock %} diff --git a/app/templates/message.html b/app/templates/message.html new file mode 100644 index 0000000..6556c2c --- /dev/null +++ b/app/templates/message.html @@ -0,0 +1,25 @@ +{% extends "base.html" %} +{% block content %} +

{{ msg.subject or "(no subject)" }}

+

From {{ msg.from }} To {{ msg.to|join(", ") }}

+

{{ msg.when }}

+{% if msg.htmlBody %} +
{{ (msg.htmlBody | safe) }}
+{% elif msg.textBody %} +
{{ msg.textBody }}
+{% else %} +
(no body)
+{% endif %} +
+ Reply + Forward +
+{% if msg.attachments %} +

Attachments

+
    +{% for a in msg.attachments %} +
  • {{ a.name }} ({{ a.type }}, {{ a.size }} bytes)
  • +{% endfor %} +
+{% endif %} +{% endblock %} diff --git a/app/templates/webdav.html b/app/templates/webdav.html new file mode 100644 index 0000000..d2ed6d4 --- /dev/null +++ b/app/templates/webdav.html @@ -0,0 +1,15 @@ +{% extends "base.html" %} +{% block content %} +

WebDAV

+

Browsing {{ base }}

+ + + {% for i in items %} + + + + + + {% endfor %} +
NameTypeSize
{{ i.name }}{{ i.type }}{% if i.size is not none %}{{ i.size }}{% endif %}
+{% endblock %} diff --git a/app/utils.py b/app/utils.py new file mode 100644 index 0000000..f97bf2e --- /dev/null +++ b/app/utils.py @@ -0,0 +1,19 @@ +import datetime + +def human_size(n: int | None) -> str: + if n is None: return "" + units = ["B","KB","MB","GB","TB","PB"] + i = 0 + x = float(n) + while x >= 1024 and i < len(units)-1: + x /= 1024.0 + i += 1 + return f"{x:.0f} {units[i]}" + +def fmt_when(iso: str | None) -> str: + if not iso: return "" + try: + dt = datetime.datetime.fromisoformat(iso.replace("Z","+00:00")).astimezone() + return dt.strftime("%Y-%m-%d %H:%M") + except Exception: + return iso or "" diff --git a/charts/ihasmail/Chart.yaml b/charts/ihasmail/Chart.yaml new file mode 100644 index 0000000..9c39854 --- /dev/null +++ b/charts/ihasmail/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +name: ihasmail +description: ihasmail — JMAP webmail for Stalwart (FastAPI) +type: application +version: 0.1.0 +appVersion: "0.2.0" diff --git a/charts/ihasmail/templates/NOTES.txt b/charts/ihasmail/templates/NOTES.txt new file mode 100644 index 0000000..7bea5f9 --- /dev/null +++ b/charts/ihasmail/templates/NOTES.txt @@ -0,0 +1,7 @@ +Thanks for installing ihasmail! + +Get the service URL by running these commands: + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "ihasmail.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }}/ + +If using Ingress and DNS, browse to the configured host (e.g., https://ihasmail.example.com). diff --git a/charts/ihasmail/templates/_helpers.tpl b/charts/ihasmail/templates/_helpers.tpl new file mode 100644 index 0000000..a8643fe --- /dev/null +++ b/charts/ihasmail/templates/_helpers.tpl @@ -0,0 +1,20 @@ +{{- define "ihasmail.name" -}} +{{- .Chart.Name -}} +{{- end -}} + +{{- define "ihasmail.fullname" -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{- define "ihasmail.labels" -}} +helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} +app.kubernetes.io/name: {{ include "ihasmail.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +app.kubernetes.io/version: {{ .Chart.AppVersion }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end -}} + +{{- define "ihasmail.selectorLabels" -}} +app.kubernetes.io/name: {{ include "ihasmail.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end -}} diff --git a/charts/ihasmail/templates/deployment.yaml b/charts/ihasmail/templates/deployment.yaml new file mode 100644 index 0000000..dcf21ff --- /dev/null +++ b/charts/ihasmail/templates/deployment.yaml @@ -0,0 +1,60 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "ihasmail.fullname" . }} + labels: + {{- include "ihasmail.labels" . | nindent 4 }} +spec: + replicas: 1 + selector: + matchLabels: + {{- include "ihasmail.selectorLabels" . | nindent 6 }} + template: + metadata: + labels: + {{- include "ihasmail.selectorLabels" . | nindent 8 }} + spec: + containers: + - name: app + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + env: + - name: APP_SECRET + valueFrom: + secretKeyRef: + name: {{ include "ihasmail.fullname" . }}-secret + key: APP_SECRET + - name: JMAP_BASE + value: {{ .Values.env.JMAP_BASE | quote }} + - name: CALDAV_BASE + value: {{ .Values.env.CALDAV_BASE | quote }} + - name: WEBDAV_BASE + value: {{ .Values.env.WEBDAV_BASE | quote }} + - name: COOKIE_NAME + value: {{ .Values.env.COOKIE_NAME | quote }} + - name: TRUST_PROXY + value: {{ .Values.env.TRUST_PROXY | quote }} + - name: UPSTREAM_TIMEOUT + value: {{ .Values.env.UPSTREAM_TIMEOUT | quote }} + ports: + - containerPort: 8000 + readinessProbe: + httpGet: + path: /healthz + port: 8000 + initialDelaySeconds: 5 + periodSeconds: 10 + livenessProbe: + httpGet: + path: /healthz + port: 8000 + initialDelaySeconds: 10 + periodSeconds: 20 +--- +apiVersion: v1 +kind: Secret +metadata: + name: {{ include "ihasmail.fullname" . }}-secret +type: Opaque +stringData: + APP_SECRET: {{ .Values.env.APP_SECRET | quote }} diff --git a/charts/ihasmail/templates/ingress.yaml b/charts/ihasmail/templates/ingress.yaml new file mode 100644 index 0000000..f3f99ba --- /dev/null +++ b/charts/ihasmail/templates/ingress.yaml @@ -0,0 +1,30 @@ +{{- if .Values.ingress.enabled }} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "ihasmail.fullname" . }} + {{- if .Values.ingress.className }} + annotations: + kubernetes.io/ingress.class: {{ .Values.ingress.className }} + {{- end }} +spec: + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + pathType: {{ .pathType }} + backend: + service: + name: {{ include "ihasmail.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- toYaml .Values.ingress.tls | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/ihasmail/templates/service.yaml b/charts/ihasmail/templates/service.yaml new file mode 100644 index 0000000..3c300bf --- /dev/null +++ b/charts/ihasmail/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "ihasmail.fullname" . }} + labels: + {{- include "ihasmail.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: 8000 + protocol: TCP + name: http + selector: + {{- include "ihasmail.selectorLabels" . | nindent 4 }} diff --git a/charts/ihasmail/values.yaml b/charts/ihasmail/values.yaml new file mode 100644 index 0000000..3e37d9c --- /dev/null +++ b/charts/ihasmail/values.yaml @@ -0,0 +1,32 @@ +image: + repository: ghcr.io/your-org/ihasmail + tag: latest + pullPolicy: IfNotPresent + +service: + type: ClusterIP + port: 8000 + +ingress: + enabled: false + className: "" + hosts: + - host: ihasmail.example.com + paths: + - path: / + pathType: Prefix + tls: [] + +env: + APP_SECRET: "CHANGE_ME" + JMAP_BASE: "https://mail.example.com/jmap" + CALDAV_BASE: "https://mail.example.com/caldav/" + WEBDAV_BASE: "https://mail.example.com/webdav/" + COOKIE_NAME: "ihasmail" + TRUST_PROXY: "1" + UPSTREAM_TIMEOUT: "15" + +resources: {} +nodeSelector: {} +tolerations: [] +affinity: {} diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..bd3e870 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +services: + ihasmail: + build: . + image: ihasmail:latest + env_file: .env + restart: unless-stopped + networks: [edge] + ports: + - "127.0.0.1:8080:8000" +networks: + edge: {} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d4f37b1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,30 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "ihasmail" +version = "0.2.0" +description = "ihasmail — JMAP webmail for Stalwart (FastAPI, HTMX/Jinja)" +authors = [{name = "John Coffey", email = "john@example.com"}] +readme = "README.md" +requires-python = ">=3.10" +license = {text = "GPL-3.0-or-later"} +dependencies = [ + "fastapi>=0.111", + "uvicorn[standard]>=0.30", + "httpx>=0.27", + "jinja2>=3.1", + "bleach>=6.1", + "python-multipart>=0.0.9", +] + +[project.optional-dependencies] +dev = [ + "pytest>=8.2", + "anyio>=4.4", + "httpx>=0.27", +] + +[tool.pytest.ini_options] +addopts = "-q" diff --git a/tests/test_smoke.py b/tests/test_smoke.py new file mode 100644 index 0000000..c7b9b08 --- /dev/null +++ b/tests/test_smoke.py @@ -0,0 +1,7 @@ +from fastapi.testclient import TestClient +from app.main import app + +def test_root_redirect(): + client = TestClient(app) + r = client.get("/", allow_redirects=False) + assert r.status_code in (302, 303)