commit 1b7f5afa28e38ecc7697fea4689b53fd18ece909 Author: Jason Rhinelander Date: Mon Oct 18 23:59:48 2021 -0300 Initial import diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..31efa1c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/config.py diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..aa27ca5 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,683 @@ + +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. + +Copyright (c) 2020-2021 The Oxen Project + + + 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/README.md b/README.md new file mode 100644 index 0000000..4d97309 --- /dev/null +++ b/README.md @@ -0,0 +1,144 @@ +# Session File Server + +This is the Session file server that hosts encrypted avatars and attachments for the Session +network. It is effectively a "dumb" store of data as it simply stores, retrieves, and expires but +cannot read the encrypted blobs. + +It has one additional feature used by Session which is acting as a cache and server of the current +version of Session (as posted on GitHub) to allow Session clients to check the version without +leaking metadata (by making an onion request through the Oxen service node network). + +## Requires + +### Python3 + +A reasonably recent version of Python 3 (3.8 or newer are tested, earlier may or may not work), with +the following modules installed. (Most of these are available as `apt install python3-NAME` on +Debian/Ubuntu). +- flask +- coloredlogs +- psycopg 3.x (*not* the older psycopg2 currently found in most linux distros) +- psycopg_pool +- requests + +Additionally you need to build the Oxen Project's pyoxenmq and pylibonionreq. This repository links +to them as submodules; `make` will build them locally for simple setups (proper deb packaging of +those libs is still a TODO). + +### WSGI request handler + +The file server uses WSGI for incoming HTTP requests. See below for one possible way to set this +up. + +### PostgreSQL + +Everything is stored in PostgreSQL; no local file storage is used at all. + +## Getting started + +0. Create a user, clone the code as a user, run the code as a user, NOT as root. + +1. Install the required Python packages: + + ```bash + sudo apt install python3 python3-flask python3-coloredlogs python3-requests python3-pip + + pip3 install psycopg psycopg_pool # Or as above, once these enter Debian/Ubuntu + ``` + +2. Build the required oxen Python modules: + + make + +3. Set up a postgresql database for the files to live in. Note that this can be *large* because + file content is stored in the database, so ensure it is on a filesystem with lots of available + storage. + + A quick setup, if you've never used it before, is: + + ```bash + sudo apt install postgresql-server postgresql-client # Install server and client + sudo su - postgres # Change to postgres system user + createuser YOURUSER # Replace with your username, *NOT* root + createdb -O YOURUSER sessionfiles # Creates an empty database for session files, owned by you + exit # Exit the postgres shell, return to your user + + # Test that postgresql lets us connect to the database: + echo "select 'hello'" | psql sessionfiles + # Should should you "ok / ---- / hello"; if it gives an error then something is wrong. + + # Load the database structure (run this from the session-file-server dir): + psql -f schema.pgsql sessionfiles + + # The 'sessionfiles' database is now ready to go. + ``` + +4. Copy `config.py.sample` to `config.py` and edit as needed. In particular you'll need to edit the + `pgsql_connect_opts` variable to specify database connection parameters. + +5. Set up the application to run via wsgi. The setup I use is: + + 1. Install `uwsgi-emperor` and `uwsgi-plugin-python3` + + 1. Configure it by adding `cap = setgid,setuid` and `emperor-tyrant = true` into + `/etc/uwsgi-emperor/emperor.ini` + + 1. Create a file `/etc/uwsgi-emperor/vassals/sfs.ini` with content: + + ```ini + [uwsgi] + chdir = /home/YOURUSER/session-file-server + socket = sfs.wsgi + chmod-socket = 660 + plugins = python3,logfile + processes = 4 + manage-script-name = true + mount = /=fileserver:app + + logger = file:logfile=/home/YOURUSER/session-file-server/sfs.log + ``` + + You will need to change the `chdir` and `logger` paths to match where you have set up the + code. + +6. Run: + + ```bash + sudo chown YOURUSER:www-data /etc/uwsgi-emperor/vassals/sfs.ini + ``` + + Because of the configuration you added in step 5, the ownership of the `sfs.ini` determines the + user and group the program runs as. Also note that uwsgi sensibly refuses to run as root, but if + you are contemplating running this program in the first place then hopefully you knew not to do + that anyway. + +7. Set up nginx or apache2 to serve HTTP or HTTPS requests that are handled by the file server. + - For nginx you want this snippet added to your `/etc/nginx/sites-enabled/SITENAME` file + (SITENAME can be `default` if you will only use the web server for the Session file server).: + + ```nginx + location / { + uwsgi_pass unix:///home/YOURUSER/session-file-server/sfs.wsgi; + include uwsgi_params; + } + ``` + + - If you prefer to use Apache then you want to use a + + ```apache + ProxyPass / unix:/home/YOURUSER/session-file-server/sfs.wsgi|uwsgi://uwsgi-session-file-server/ + ``` + + directive in `` section serving the site. + +8. If you want to use HTTPS then set it up in nginx or apache and put the above directives in the + location for the HTTPS server. This will work but is *not* required for Session and does not + enhance the security because requests are always onion encrypted; the extra layer of HTTPS + encryption adds nothing (and makes requests marginally slower). + +9. Restart the web server and UWSGI emperor: `systemctl restart nginx uwsgi-emperor` + +10. In the future, if you update the file server code and want to restart it, you can just `touch + /etc/uwsgi-emperor/vassals/` — uwsgi-emperor watches the files for modifications and restarts + gracefully upon modifications (or in this case simply touching, which updates the file's + modification time without changing its content). diff --git a/config.py.sample b/config.py.sample new file mode 100644 index 0000000..3e906e0 --- /dev/null +++ b/config.py.sample @@ -0,0 +1,22 @@ +from config_base import * + +# Configuration options +# +# This file overrides things set in config_base.py; put local modifications here so that on upgrades +# you don't have to merge new changes added to the base config. This file (when copied to +# local_config.py) is ignored by git. + +# Example config override: +#BACKWARDS_COMPAT_IDS = False + +# This one is pretty much always needed. For a local DB you'll need at least the dbname; for a +# remote DB you'll need more. See psycopg documentation for details. +pgsql_connect_opts = { + "dbname": "sessionfiles", +} + +# Log level: +# +#import logging +#log_level = logging.INFO + diff --git a/config_base.py b/config_base.py new file mode 100644 index 0000000..f00ed66 --- /dev/null +++ b/config_base.py @@ -0,0 +1,42 @@ +# Configuration options +# + +import logging + + +# This sucks: current versions of Session are entirely inflexible as to the data received: they +# *must* get back an integer value for the id, and shove the integer into a double which means we +# can only (perfectly) represent integers from [0, 2^53]. +BACKWARDS_COMPAT_IDS = True + + +# Use this bit suffix in generated backwards compatible integer IDs. This is intended to avoid +# synchronization conflicts when setting up multi-master database synchronization. The bits added +# here (which must be an array of 0 or 1s) will be hard-coded into the most significant bits of the +# value, then the remaining 53-bit determined randomly. E.g. 1 reserved bit is enough for 2 +# servers, 2 is enough for 4, etc. Each server in a cluster should have a different bit pattern +# with exactly the same number of fixed bits. Should be empty for a single server file server. +BACKWARDS_COMPAT_IDS_FIXED_BITS = [] + +# Maximum file size we will accept, in bytes. This should generally be the same as Session's value, +# and has to be small enough that it can fit, post-base64 encoding + onion wrapping, into the 10MB +# size limit of storage server messages. +MAX_FILE_SIZE = 6_000_000 + +# Same as above, but for a base64-encoded string +MAX_FILE_SIZE_B64 = 8_000_000 + +# File expiry, in a postgresql-compatible duration relative to `now()`. Be aware if using `days` or +# larger units that postgresql days and months are variable: a day could be 23-25 hours (if it +# crosses a DST change), and a month could be 28-31 days ± 1 hour. If you need a precise interval, +# use a precise unit. +FILE_EXPIRY = '3 weeks' + + +# postgresql connect options +pgsql_connect_opts = { + "dbname": "sessionfiles", +} + +# The log level +log_level = logging.WARN diff --git a/doc/api.yaml b/doc/api.yaml new file mode 100644 index 0000000..7eaa1f4 --- /dev/null +++ b/doc/api.yaml @@ -0,0 +1,260 @@ +openapi: 3.0.1 +info: + title: Session File Server + description: > + API documentation for the Session file server. This is the API that + [Session](https://getsession.org) and related tools use to interface with encrypted, stored + files that are sent to and retrieved from the file server via onion requests. + contact: + name: The Oxen Project + email: team@oxen.io + url: https://getsession.org + license: + name: GPL v3.0 + url: https://www.gnu.org/licenses/gpl-3.0.en.html + version: "3.0" +externalDocs: + description: Find out more about the Oxen project + url: http://oxen.io +paths: + /file: + post: + summary: "Uploads a file to the file server." + description: > + Uploads an opaque file (typically encrypted) to the file server. This takes the file body + as binary. + + + This endpoint de-duplicates: that is, uploading an identical file body (which also implies + identical encryption) will *not* store the file a second time: instead it just updates the + file expiry. + requestBody: + description: The file content, in bytes. + required: true + content: + '*/*': + {} + responses: + 200: + description: File successfully stored + content: + application/json: + schema: + type: object + properties: + id: + type: string + description: > + Random string id of the file on the server to be used in the `/file/ID` + endpoint for retrieval. Will contain only path-safe characters from + `[a-zA-Z0-9_-]`. + + + Currently this identifier is a 44 character value (264 bits, in base64 + encoding, chosen to be the smallest padding-free base64 encodable size >= 256 + bits), but that may change in future versions and should not be relied upon. + 413: + description: > + Invalid upload size. Returns for an invalid size (i.e. greater than the current limit + of 6MB; *note: 6MB != 6MiB*). + content: {} + + + /file/{fileId}: + get: + summary: Retrieve a stored file. + description: > + Retrieves a file stored on the file server. The file is returned as binary. + parameters: + - name: fileId + in: path + description: "The file ID of the uploaded file." + required: true + schema: + type: string + responses: + 200: + description: File successfully retrieved. + content: + application/octet-stream: + schema: + type: string + format: binary + 404: + description: The file was not found or has expired. + content: {} + + /file/{fileId}/info: + get: + summary: Retrieves metadata of a stored file. + description: > + Returns information about a file without actually returning the file content itself. + parameters: + - $ref: "#/file/~1file~1%7BfileId%7D/parameters/0" + responses: + 200: + description: File metadata retrieved. + content: + application/json: + schema: + type: object + properties: + size: + type: integer + format: int64 + description: Size of the file contents, in bytes. + uploaded: + type: number + format: double + description: The unix timestamp when the file was uploaded. + expires: + type: number + format: double + description: > + The unix timestamp when the file is scheduled to be removed. + 404: + description: The file was not found or has expired. + content: {} + + /session_version: + get: + summary: Retrieves the latest Session release version. + deprecated: True + description: > + Returns the current version of session for one of the three platforms (desktop, ios, or + android); this is effectively proxying (and caching) the response from the github release + page. + + + Note that the value is cached and can be up to 30 minutes out of date normally, and up to 24 + hours out of date if we cannot reach the Github API for some reason. + parameters: + - name: platform + in: query + required: true + description: The session platform to query. + schema: + type: string + format: int32 + enum: ["desktop", "android", "ios"] + responses: + 200: + description: Version retrieved. + content: + application/json: + schema: + type: object + properties: + status_code: > + The value 200. Included for backwards compatibility, and may be removed + someday. + result: + type: string + description: The Session version. + updated: + type: number + format: double + description: > + The unix timestamp when this version was retrieved from Github; this can be up + to 24 hours ago in case of consistent fetch errors, though normally will be + within the last 30 minutes. + 404: + description: "No such platform: the `platform` value was invalid." + content: {} + 502: + description: > + Bad gateway. Returned if the current version could not be successfuly retrieved from + Github within the last 24 hours. + content: {} + + /files: + post: + deprecated: true + summary: Uploads a file to the file server wastefully. + description: > + Uploads an opaque file (typically encrypted) to the file server. This takes the file body + as a json parameter, encoded in base64. It is mainly provided for backwards compatibility: + see the `/file` endpoint which uses 25% less data by avoiding an unnecessary extra layer of + base64 encoding. + + + This endpoint also always returns the file id as an integer in the range [0, 2^53], and does + not de-duplicate identical uploads. + + + This is deprecated and will be removed in the future once all known users have migrated to + the `/file` endpoint. + requestBody: + required: true + content: + application/json: + schema: + type: object + required: [file] + properties: + file: + type: string + format: byte + description: The file content (typically encrypted), in base64 encoding. + responses: + 200: + description: File successfully stored + content: + application/json: + schema: + type: object + properties: + id: + type: integer + format: int64 + description: > + Random id of the file on the server to be used in the `/files/ID` + endpoint for retrieval. Will be a value between 1 and 2^53. + + + This endpoint is deprecated for Session clients that would break with a + non-integer identifier; the more efficient and robust `/file` endpoint should + be used instead. + + 413: + description: > + Invalid upload size. Returns for an invalid size (i.e. greater than the current limit + of 6MB). Note that the size here refers to the size in decoded bytes, not the size of + the base64 encoded value; in base64 encoded bytes the limit is 8MB. + content: {} + + 507: + description: > + Insufficient storage. This is returned if the file server is unable to find a suitable + random id for the upload. + content: {} + + + /files/{fileId}: + get: + deprecated: true + summary: Retrieve a stored file wastefully. + description: > + Retrieves a file stored on the file server. The file is returned wrapped in an unnecessary + layer of JSON and base64, for backwards compatibility. + parameters: + - $ref: "#/file/~1file~1%7BfileId%7D/parameters/0" + responses: + 200: + description: File successfully retrieved. + content: + application/json: + schema: + type: object + properties: + status_code: + type: integer + format: int32 + description: > + The value 200. Included for backwards compatibility. + result: + type: string + format: byte + description: The file content, encoded in base64. + +# vim:sw=2:et:tw=100 diff --git a/fileserver.py b/fileserver.py new file mode 100644 index 0000000..8a0e6d1 --- /dev/null +++ b/fileserver.py @@ -0,0 +1,259 @@ +#!/usr/bin/env python3 + +import flask +from flask import request, g +import base64 +import coloredlogs +from hashlib import blake2b +import json +import logging +import psycopg +from psycopg_pool import ConnectionPool +import requests +import secrets +from werkzeug.local import LocalProxy + +import config +from timer import timer + +# error status codes: +HTTP_ERROR_PAYLOAD_TOO_LARGE = 413 +HTTP_ERROR_INSUFFICIENT_STORAGE = 507 +HTTP_ERROR_INTERNAL_SERVER_ERROR = 500 +HTTP_BAD_GATEWAY = 502 +HTTP_BAD_REQUEST = 400 +HTTP_NOT_FOUND = 404 + + +if config.BACKWARDS_COMPAT_IDS: + assert all(x in (0, 1) for x in config.BACKWARDS_COMPAT_IDS_FIXED_BITS) + BACKWARDS_COMPAT_MSB = sum( + y << x for x, y in enumerate(reversed(config.BACKWARDS_COMPAT_IDS_FIXED_BITS))) + BACKWARDS_COMPAT_RANDOM_BITS = 53 - len(config.BACKWARDS_COMPAT_IDS_FIXED_BITS) + +app = flask.Flask(__name__) + +psql_pool = ConnectionPool(min_size=2, max_size=32, **config.pgsql_connect_opts, autocommit=True) + +coloredlogs.install(level=config.log_level, milliseconds=True, isatty=True) + + +def get_psql_conn(): + if 'psql' not in g: + g.psql = psql_pool.getconn() + + return g.psql + + +@app.teardown_appcontext +def release_psql_conn(exception): + psql = g.pop('psql', None) + + if psql is not None: + psql_pool.putconn(psql) + + +psql = LocalProxy(get_psql_conn) + + +@timer(15) +def periodic(signum): + with app.app_context(), psql, psql.cursor() as cur: + cur.execute("DELETE FROM files WHERE expiry <= NOW()") + psql.commit() + + # NB: we do this infrequently (once every 30 minutes, per project) because Github rate + # limits if you make more than 60 requests in an hour. + # Limit to 1 because, if there are more than 1 outdated, it doesn't hurt anything to delay + # the next one by 30 seconds (and avoids triggering github rate limiting). + cur.execute(""" + SELECT project, version FROM release_versions + WHERE updated < NOW() + '30 minutes ago' LIMIT 1""") + row = cur.fetchone() + if row: + project, old_v = row + v = requests.get( + 'https://api.github.com/repos/{}/releases/latest'.format(project), + timeout=5 + ).json()['tag_name'] + if v != old_v: + logging.info("{} latest release version changed from {} to {}".format( + project, old_v, v)) + cur.execute(""" + UPDATE release_versions SET updated = NOW(), version = %s + WHERE project = %s""", (v, project)) + + +def error_resp(code): + """ + Simple JSON error response to send back, embedded as `status_code` and also as the HTTP response + code. + """ + return flask.Response( + json.dumps({'status_code': code}), + status=code, + mimetype='application/json') + + +def generate_file_id(data): + """ + Generate a file ID by blake2b hashing the file body, then using a 33-byte digest encoded into 44 + base64 chars. (Ideally would be 32, but that would result in base64 padding, so increased to 33 + to fit perfectly). + """ + return base64.urlsafe_b64encode( + blake2b(data, digest_size=33, salt=b'SessionFileSvr\0\0').digest()).decode() + + +@app.route('/file', methods=['POST']) +def submit_file(*, body=None, deprecated=False): + if body is None: + body = request.data + + if not 0 < len(body) <= config.MAX_FILE_SIZE: + logging.warn("Rejecting upload of size {} ∉ (0, {}]".format( + len(body), config.MAX_FILE_SIZE)) + return error_resp(HTTP_ERROR_PAYLOAD_TOO_LARGE) + + id = None + try: + if config.BACKWARDS_COMPAT_IDS: + done = False + for attempt in range(25): + + id = (BACKWARDS_COMPAT_MSB << BACKWARDS_COMPAT_RANDOM_BITS + | secrets.randbits(BACKWARDS_COMPAT_RANDOM_BITS)) + if not deprecated: + id = str(id) # New ids are always strings; legacy requests require an integer + try: + with psql.cursor() as cur: + cur.execute( + "INSERT INTO files (id, data, expiry) VALUES (%s, %s, NOW() + %s)", + (id, body, config.FILE_EXPIRY)) + except psycopg.errors.UniqueViolation: + continue + done = True + break + + if not done: + logging.error( + "Tried 25 random IDs and got all constraint failures, something getting wrong!") + return error_resp(HTTP_ERROR_INSUFFICIENT_STORAGE) + + else: + with psql.transaction(), psql.cursor() as cur: + id = generate_file_id(body) + try: + # Don't pass the data yet because we might be de-duplicating + with psql.transaction(): + cur.execute( + "INSERT INTO files (id, data, expiry) VALUES (%s, '', NOW() + %s)", + (id, config.FILE_EXPIRY)) + except psycopg.errors.UniqueViolation: + # Found a duplicate id, so de-duplicate by just refreshing the expiry + cur.execute( + "UPDATE files SET uploaded = NOW(), expiry = NOW() + %s WHERE id = %s", + (config.FILE_EXPIRY, id)) + else: + cur.execute("UPDATE files SET data = %s WHERE id = %s", (body, id)) + + except Exception as e: + logging.error("Failed to insert file: {}".format(e)) + return error_resp(HTTP_ERROR_INTERNAL_SERVER_ERROR) + + response = {"id": id} + if deprecated: + response['status_code'] = 200 + return flask.jsonify(response) + + +@app.route('/files', methods=['POST']) +def submit_file_old(): + input = request.json() + if input is None or 'file' not in input: + logging.warn("Invalid request: did not find json with a 'file' property") + return error_resp(HTTP_BAD_REQUEST) + + body = input['file'] + if not 0 < len(body) <= config.MAX_FILE_SIZE_B64: + logging.warn("Rejecting upload of b64-encoded size {} ∉ (0, {}]".format( + len(body), config.MAX_FILE_SIZE_B64)) + return error_resp(HTTP_ERROR_PAYLOAD_TOO_LARGE) + + # base64.b64decode is picky about padding (but not, by default, about random non-alphabet + # characters in the middle of the data, wtf!) + while len(body) % 4 != 0: + body += '=' + body = base64.b64decode(body, validate=True) + + return submit_file(body=body) + + +@app.route('/file/') +def get_file(id): + with psql.cursor() as cur: + cur.execute("SELECT data FROM files WHERE id = %s", (id,), binary=True) + row = cur.fetchone() + if row: + response = flask.make_response(row[0].tobytes()) + response.headers.set('Content-Type', 'application/octet-stream') + return response + else: + logging.warn("File '{}' does not exist".format(id)) + return error_resp(HTTP_NOT_FOUND) + + +@app.route('/files/') +def get_file_old(id): + with psql.cursor() as cur: + cur.execute("SELECT data FROM files WHERE id = %s", (id,), binary=True) + row = cur.fetchone() + if row: + return flask.jsonify({ + "status_code": 200, + "result": base64.b64encode(row[0]) + }) + else: + logging.warn("File '{}' does not exist".format(id)) + return error_resp(HTTP_NOT_FOUND) + + +@app.route('/file//info') +def get_file_info(id): + with psql.cursor() as cur: + cur.execute("SELECT length(data), uploaded, expiry FROM files WHERE id = %s", (id,)) + row = cur.fetchone() + if row: + return flask.jsonify({ + "size": row[0], + "uploaded": row[1].timestamp(), + "expires": row[2].timestamp() + }) + else: + logging.warn("File '{}' does not exist".format(id)) + return error_resp(HTTP_NOT_FOUND) + + +@app.route('/session_version') +def get_session_version(): + platform = request.args['platform'] + + if platform not in ('desktop', 'android', 'ios'): + logging.warn("Invalid session platform '{}'".format(platform)) + return error_resp(HTTP_NOT_FOUND) + project = 'oxen-io/session-' + platform + + with psql.cursor() as cur: + cur.execute(""" + SELECT version, updated FROM release_versions + WHERE project = %s AND updated >= NOW() + '24 hours ago' + """, (project,)) + row = cur.fetchone() + if row is None: + logging.warn("{} version is more than 24 hours stale!".format(project)) + return error_resp(HTTP_BAD_GATEWAY) + return flask.jsonify({ + "status_code": 200, + "updated": row[1].timestamp(), + "result": row[0] + }) diff --git a/import.py b/import.py new file mode 100644 index 0000000..c74cada --- /dev/null +++ b/import.py @@ -0,0 +1,88 @@ +#!/usr/bin/env python3 + +import psycopg +import sys +import os +import os.path +from datetime import datetime + +import config + +psql = psycopg.connect(**config.pgsql_connect_opts, autocommit=True) + +if len(sys.argv) != 2 or sys.argv[1].startswith('-'): + print("Usage: {} /path/to/session-open-group-server".format(sys.argv[0]), file=sys.stderr) + sys.exit(1) + +filesdir = sys.argv[1] + '/files/main_files' + +if not os.path.isdir(filesdir): + print("Error: {} does not exist or is not a directory".format(filesdir), file=sys.stderr) + sys.exit(2) + +cur = psql.cursor() + +count = 0 +committed_size = 0 +skipped = 0 +skipped_size = 0 +started = datetime.now() +window = [(0, started)] +total_files = sum(1 for _ in os.scandir(filesdir)) +for dentry in os.scandir(filesdir): + if not dentry.name.isdigit() or not dentry.is_file(): + print("\nWARNING: {} doesn't look like an old file server upload, skipping.".format( + dentry.name), + file=sys.stderr) + continue + + stat = dentry.stat() + size = stat.st_size + row = cur.execute("SELECT length(data) FROM files WHERE id = %s", (dentry.name,)).fetchone() + if row: + if size != row[0]: + print(("\nWARNING: Skipping duplicate id {} with mismatched size " + "(expected {} ≠ actual {})").format(dentry.name, size, row[0])) + skipped += 1 + skipped_size += size + + else: + + uploaded = datetime.fromtimestamp(stat.st_mtime) + with open(dentry.path, mode='rb') as f: + data = f.read() + + cur.execute( + """ + INSERT INTO files (id, data, uploaded, expiry) + VALUES (%s, %b, %s, %s + %s) + """, + (dentry.name, data, uploaded, uploaded, config.FILE_EXPIRY)) + count += 1 + committed_size += size + + now = datetime.now() + if (now - window[-1][1]).total_seconds() > 0.5: + if len(window) >= 10: + window.pop(0) + mb = committed_size / 1_000_000 + window.append((mb, now)) + speed = ((window[-1][0] - window[0][0]) / (window[-1][1] - window[0][1]).total_seconds() + if len(window) > 1 else 0) + print(("\rImported {:,} (new: {:,}, skipped: {:,}) / {:,} files containing " + "{:,.1f}MB new ({:,.2f}MB/s), {:,.1f}MB skipped data").format( + count + skipped, count, skipped, total_files, + mb, speed, skipped_size / 1_000_000 + ), end='', flush=True) + + +duration = (datetime.now() - started).total_seconds() +print(""" + +Import finished: imported {:,} files containing {:,d} bytes of data in {:,.2f} seconds ({:,.2f}MB/s) + +Skipped {:,} already-existing files containing {:,} bytes + +""".format( + count, committed_size, duration, committed_size / 1_000_000 / duration, + skipped, skipped_size)) diff --git a/schema.pgsql b/schema.pgsql new file mode 100644 index 0000000..9c16bbd --- /dev/null +++ b/schema.pgsql @@ -0,0 +1,30 @@ +BEGIN; + +CREATE TABLE files ( + id VARCHAR(44) PRIMARY KEY CHECK(id ~ '^[a-zA-Z0-9_-]+$'), + data BYTEA NOT NULL, + uploaded TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(), + expiry TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW() + '30 days' +); + +/* Disable default compression of data because we expect to always be given encrypted (and therefore + * uncompressable) data: */ +ALTER TABLE files ALTER COLUMN data SET STORAGE EXTERNAL; + +CREATE INDEX files_expiry ON files(expiry); + +CREATE TABLE release_versions ( + project varchar(50) PRIMARY KEY, + version varchar(25) NOT NULL, + updated TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW() +); + +-- Abritrary version values at the (approx) time this was written; this don't really matter as +-- they'll get updated within a first few seconds of initial startup. +INSERT INTO release_versions (project, version, updated) VALUES ('oxen-io/session-desktop', 'v1.7.3', '2021-10-14Z'); +INSERT INTO release_versions (project, version, updated) VALUES ('oxen-io/session-android', '1.11.11', '2021-10-14Z'); +INSERT INTO release_versions (project, version, updated) VALUES ('oxen-io/session-ios', '1.11.17', '2021-10-14Z'); + +COMMIT; + +-- vim:ft=sql diff --git a/timer.py b/timer.py new file mode 100644 index 0000000..126dec3 --- /dev/null +++ b/timer.py @@ -0,0 +1,34 @@ +import logging + +class timer: + """Wrapper around a uwsgi timer that fails gracefully when we aren't under uwsgi. When such a + failure occurs the timer does not run.""" + def __init__(self, secs): + try: + import uwsgi + self.secs = secs + except ModuleNotFoundError: + import sys + logging.error(""" + WARNING: + + uwsgidecorators not installed or not running under uwsgi. + File cleanup and session version updating will not be enabled! + """) + self.secs = None + + def __call__(self, f): + if self.secs is None: + return + import uwsgi + signum = None + for n in range(256): + if not uwsgi.signal_registered(n): + signum = n + break + if signum is None: + raise RuntimeError("Could not find a free uwsgi signal slot") + uwsgi.register_signal(signum, '', f) + uwsgi.add_timer(signum, self.secs) + return f +