diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 1106352b..5ac221f4 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,45 @@ # wtv minisrv node.js -The ***wtv minisrv***, or "***hacktv_updsrv***" project is a node.js project that provides a mini WebTV Server, with wtv-encryption support for advanced level box access. - +The ***wtv minisrv***, or "***zefie_wtvp_minisrv***" project is a node.js project that provides a mini WebTV Server, aiming for full WTVP (WebTV Protocol) support. This open source server is in alpha status. Use at your own risk. +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) + ### Current status: -- Can encrypt and decrypt SECURE ON and arbitrary encrypted data -- Can handle psuedo encryption (box sends SECURE ON but does not encrypt) +- Supports most known WebTV service encryption scenarios, for full trusted box access - Can handle client "relogin" and "reconnect" events -- Can now use `.async.js` files with asynchronous requests -- Can handle more than one box at a time +- Suports `.async.js` service files with asynchronous requests +- Supports multiple simultaneous users +- WebTV-compatible HTTP Proxy (via minisrv, or using an external proxy for enhanced features (such as [WebOne](https://github.com/atauenis/webone)) ### Current issues: -- May not run on non-development Windows machines (VS2019 with node and python) -- Breaks when two different boxes have the same SSID (spoofing, won't fix (production did it too)) +- May not run on non-development Windows machines (VS2019 with nodejs and python) - Power cycling box and re-connecting via ConnectSetup may invalidate encryption until server is restarted - wtv-update:/update does not yet function as intended +- wtv-flashrom features do not yet function as intended +- HTTPS Proxying untested, likely needs SSL spoofing with self-signed solution + +### Won't fix: +- wtv-encryption stream breaks when two different sessions have the same SSID (eg spoofing, won't fix (production did it too)) +- No intentions to support user accounts, registration, or any form of database system ### Feature Todo: -- Test and enable flashrom flashing functionality (at least for LC2 and higher) +- ~~(maybe) implement HTTP proxy (needs to be able to defluff most of the web, think retro WAP converter)~~ ***Done*** +- ~~(maybe) enable "internet mode" (let user outside of minisrv)~~ ***Done*** +- Flashrom flashing functionality (at least for LC2 and higher) +- SSID/IP black/whitelisting (including tying SSID to an IP or multiple IPs) - (maybe) Proper wtv-star (generic service outage page) support (maybe useful for allowing a unit to multiple sub-minisrvs). -- (maybe) implement HTTP proxy (needs to be able to defluff most of the web, think retro WAP converter) -- (maybe) enable "internet mode" (let user outside of minisrv) - (maybe) wtvchat stuff -- (probably not) url tokenizer +- (probably not) url tokenizer (eg wtv-token-blabla, was mostly to secure service URLs from unintended access, which this server does not aim to do) ### How To Use: - Install [node.js](https://nodejs.org/en/download/). Be sure to say `Yes` when asked about `Chocolatey`. - If you have trouble running it on Windows, try a Linux machine, Windows may need a full development enviroment or extra steps. - Download a snapshot (either of master, or of any commit/branch/relase/tag etc) - Extract zip somewhere and enter that directory with a command prompt -- Enter `hacktv_updsrv` subdirectory -- Verify you are in the same directory as `app.js`, then tun `npm install` -- Check any configuration (services.json) +- Enter `zefie_wtvp_minisrv` subdirectory +- Verify you are in the same directory as `app.js`, then run `npm install` +- Check any configuration, and modify to your liking. Especally `service_ip` (config can be found in `services.json`) - Run `node app.js` - Test with a WebTV Viewer or connect with a real box - To connect with a real box, you will need to open ports in your firewall and have a way to connect your WebTV (and preferably reroute 10.0.0.1 to the server) diff --git a/hacktv_updsrv/ServiceVault/wtv-flashrom/lc2-download-failed.js b/hacktv_updsrv/ServiceVault/wtv-flashrom/lc2-download-failed.js deleted file mode 100644 index de953f1f..00000000 --- a/hacktv_updsrv/ServiceVault/wtv-flashrom/lc2-download-failed.js +++ /dev/null @@ -1,53 +0,0 @@ -headers = `200 OK -Content-type: text/html` - -data =` - - -Updating failed - - - - - - - - - -
- - - - - - - - -
-Updated failed -
-
-
-
- -
- - - - - - - - - - - -
-
- - - -Update failed, gomennasai. - -` \ No newline at end of file diff --git a/hacktv_updsrv/ServiceVault/wtv-home/test.ram b/hacktv_updsrv/ServiceVault/wtv-home/test.ram deleted file mode 100644 index 949393d4..00000000 --- a/hacktv_updsrv/ServiceVault/wtv-home/test.ram +++ /dev/null @@ -1 +0,0 @@ -pnm://192.168.11.188:7070/clients/zefie/wtvrom/Daybreak.ra \ No newline at end of file diff --git a/hacktv_updsrv/package.json b/hacktv_updsrv/package.json deleted file mode 100644 index c5dd664a..00000000 --- a/hacktv_updsrv/package.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "name": "hacktv_updsrv", - "version": "0.7.0", - "description": "hacktv_updsrv", - "main": "app.js", - "author": { - "name": "" - }, - "dependencies": { - "crypto-js": "^4.0.0", - "endianness": "^8.0.2", - "mime-types": "^2.1.31", - "node-crc16": "^2.0.7", - "strftime": "^0.10.0" - } -} diff --git a/hacktv_updsrv.sln b/zefie_wtvp_minisrv.sln similarity index 85% rename from hacktv_updsrv.sln rename to zefie_wtvp_minisrv.sln index 4ccad737..013f2d4a 100644 --- a/hacktv_updsrv.sln +++ b/zefie_wtvp_minisrv.sln @@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.31424.327 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "hacktv_updsrv", "hacktv_updsrv\hacktv_updsrv.njsproj", "{31B77D0C-F03D-43A7-BF7F-FAD7174728BF}" +Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "zefie_wtvp_minisrv", "zefie_wtvp_minisrv\zefie_wtvp_minisrv.njsproj", "{31B77D0C-F03D-43A7-BF7F-FAD7174728BF}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/hacktv_updsrv/.gitignore b/zefie_wtvp_minisrv/.gitignore similarity index 100% rename from hacktv_updsrv/.gitignore rename to zefie_wtvp_minisrv/.gitignore diff --git a/hacktv_updsrv/ServiceDeps/LC2/LC2_OISP_5555732_56k.tok b/zefie_wtvp_minisrv/ServiceDeps/LC2/LC2_OISP_5555732_56k.tok similarity index 100% rename from hacktv_updsrv/ServiceDeps/LC2/LC2_OISP_5555732_56k.tok rename to zefie_wtvp_minisrv/ServiceDeps/LC2/LC2_OISP_5555732_56k.tok diff --git a/hacktv_updsrv/ServiceDeps/LC2/LC2_WTV_18006138199_56k.tok b/zefie_wtvp_minisrv/ServiceDeps/LC2/LC2_WTV_18006138199_56k.tok similarity index 100% rename from hacktv_updsrv/ServiceDeps/LC2/LC2_WTV_18006138199_56k.tok rename to zefie_wtvp_minisrv/ServiceDeps/LC2/LC2_WTV_18006138199_56k.tok diff --git a/hacktv_updsrv/ServiceDeps/LC2/artemis_18004653537.tok b/zefie_wtvp_minisrv/ServiceDeps/LC2/artemis_18004653537.tok similarity index 100% rename from hacktv_updsrv/ServiceDeps/LC2/artemis_18004653537.tok rename to zefie_wtvp_minisrv/ServiceDeps/LC2/artemis_18004653537.tok diff --git a/hacktv_updsrv/ServiceDeps/LC2/artemis_18006138199.tok b/zefie_wtvp_minisrv/ServiceDeps/LC2/artemis_18006138199.tok similarity index 100% rename from hacktv_updsrv/ServiceDeps/LC2/artemis_18006138199.tok rename to zefie_wtvp_minisrv/ServiceDeps/LC2/artemis_18006138199.tok diff --git a/hacktv_updsrv/ServiceLogPost/client-posted wtv-log requests will appear here.txt b/zefie_wtvp_minisrv/ServiceLogPost/client-posted wtv-log requests will appear here.txt similarity index 100% rename from hacktv_updsrv/ServiceLogPost/client-posted wtv-log requests will appear here.txt rename to zefie_wtvp_minisrv/ServiceLogPost/client-posted wtv-log requests will appear here.txt diff --git a/hacktv_updsrv/ServiceVault/wtv-1800/finish-prereg.js b/zefie_wtvp_minisrv/ServiceVault/wtv-1800/finish-prereg.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-1800/finish-prereg.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-1800/finish-prereg.js diff --git a/hacktv_updsrv/ServiceVault/wtv-1800/preregister.js b/zefie_wtvp_minisrv/ServiceVault/wtv-1800/preregister.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-1800/preregister.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-1800/preregister.js diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/MSNLogo.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/MSNLogo.gif new file mode 100644 index 00000000..59b3829d Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/MSNLogo.gif differ diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/S40H1.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/S40H1.gif new file mode 100644 index 00000000..b8973a1b Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/S40H1.gif differ diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Shadow.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Shadow.gif new file mode 100644 index 00000000..42098634 Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Shadow.gif differ diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Spacer.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Spacer.gif new file mode 100644 index 00000000..672c48ff Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/Spacer.gif differ diff --git a/hacktv_updsrv/ServiceVault/wtv-star/images/WebTVLogoJewel.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/WebTVLogoJewel.gif similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-star/images/WebTVLogoJewel.gif rename to zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/WebTVLogoJewel.gif diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/up-arrows.swf b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/up-arrows.swf new file mode 100644 index 00000000..eceece7e Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/ROMCache/up-arrows.swf differ diff --git a/hacktv_updsrv/ServiceVault/wtv-flashrom/get-lc2-page.js b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/get-lc2-page.js similarity index 73% rename from hacktv_updsrv/ServiceVault/wtv-flashrom/get-lc2-page.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/get-lc2-page.js index dd5ff305..51d7b10f 100644 --- a/hacktv_updsrv/ServiceVault/wtv-flashrom/get-lc2-page.js +++ b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/get-lc2-page.js @@ -1,3 +1,8 @@ +// todo, actual file logic +// - ready query param to get flashrom path, check for its existance +// - handle last part to redirect to lc2-download-complete +// - handle failures + headers = `200 OK Content-type: text/html` @@ -44,25 +49,34 @@ Updating now... -Your Internet Receiver is being
updated automagically. +Your Internet Receiver is being
updated automatically.

-This will take forever, and then
your WebTV will reboot.

-
+This will take a while, and then
your unit will reboot.

+`; + +if (flashrom_isboot && flashrom_part == 16) { +data += `

+ The system will pause for about 30 seconds at the end of this + update. Please do not interrupt the system + during this time. + ` +} +data += `

- - + +
    Receiving part `+flashrom_part+` of `+totalprts+`v`+flashrom_version+` (`+flashrom_type+`)        Receiving part ${flashrom_part} of ${flashrom_total_parts}v${flashrom_version} (${flashrom_type})    
+blockurl="wtv-flashrom:/${flashrom_rompath} +lastblock=${flashrom_lastpart} +curblock="${flashrom_part}" +totalblocks="${flashrom_total_parts}"> diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/lc2-download-complete.js b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/lc2-download-complete.js new file mode 100644 index 00000000..07290fdd --- /dev/null +++ b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/lc2-download-complete.js @@ -0,0 +1,107 @@ +headers = `200 OK +Content-type: text/html` + +data = ` + + + +Updating + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+Updating complete +
+
+
+
+ +
+ + + + + + + + + + + +
+ + + +The update is complete.
+

Choose Connect Now if you
want to connect to ${services_configured.config.service_name}. +

Press the power button to switch
off your unit. +
+

+ + + +
+ + +
+ + + +
+ + +
+ + + + +
+ + + + + +
+ + + + + +
+ +
+
+
+ +` \ No newline at end of file diff --git a/hacktv_updsrv/ServiceVault/wtv-flashrom/lc2-download-failed.html b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/lc2-download-failed.html similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-flashrom/lc2-download-failed.html rename to zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/lc2-download-failed.html diff --git a/hacktv_updsrv/ServiceVault/wtv-flashrom/willie.async.js b/zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/willie.async.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-flashrom/willie.async.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-flashrom/willie.async.js diff --git a/hacktv_updsrv/ServiceVault/wtv-head-waiter/finalize-security.js b/zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/finalize-security.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-head-waiter/finalize-security.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/finalize-security.js diff --git a/hacktv_updsrv/ServiceVault/wtv-head-waiter/login-stage-two.js b/zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/login-stage-two.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-head-waiter/login-stage-two.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/login-stage-two.js diff --git a/hacktv_updsrv/ServiceVault/wtv-head-waiter/login.js b/zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/login.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-head-waiter/login.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/login.js diff --git a/hacktv_updsrv/ServiceVault/wtv-head-waiter/ssl-cert.der b/zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/ssl-cert.der similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-head-waiter/ssl-cert.der rename to zefie_wtvp_minisrv/ServiceVault/wtv-head-waiter/ssl-cert.der diff --git a/hacktv_updsrv/ServiceVault/wtv-home/home.js b/zefie_wtvp_minisrv/ServiceVault/wtv-home/home.js similarity index 91% rename from hacktv_updsrv/ServiceVault/wtv-home/home.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-home/home.js index 7fe374f2..ae471606 100644 --- a/hacktv_updsrv/ServiceVault/wtv-home/home.js +++ b/zefie_wtvp_minisrv/ServiceVault/wtv-home/home.js @@ -38,14 +38,12 @@ data += `width=250 bgcolor=#444444 text=#ffdd33 cursor=#cc9933 selected>

zefie's server only

-Music Collection
-Matt Test
+zefie's stuff and things

Test Stuff (probably broken)

HackTV Updater Test
Ultra Willies
Disconnect and go to HackTV Home
- ` \ No newline at end of file diff --git a/hacktv_updsrv/ServiceVault/wtv-home/splash.txt b/zefie_wtvp_minisrv/ServiceVault/wtv-home/splash.txt similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-home/splash.txt rename to zefie_wtvp_minisrv/ServiceVault/wtv-home/splash.txt diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-home/zefie.html b/zefie_wtvp_minisrv/ServiceVault/wtv-home/zefie.html new file mode 100644 index 00000000..8a3f7f7f --- /dev/null +++ b/zefie_wtvp_minisrv/ServiceVault/wtv-home/zefie.html @@ -0,0 +1,18 @@ + + +zefie's playground + + + + +

zefie's playgrounf

+Moved these off the main page to clean it up :)
+The stuff on this page is probably useless to you so why not move it off the main page. + +
    +
  • Music Collection
  • +
  • Matt Test
  • +
      + + + \ No newline at end of file diff --git a/hacktv_updsrv/ServiceVault/wtv-log/log.js b/zefie_wtvp_minisrv/ServiceVault/wtv-log/log.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-log/log.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-log/log.js diff --git a/hacktv_updsrv/ServiceVault/wtv-star/images/HackTVLogo.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-star/images/HackTVLogo.gif similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-star/images/HackTVLogo.gif rename to zefie_wtvp_minisrv/ServiceVault/wtv-star/images/HackTVLogo.gif diff --git a/hacktv_updsrv/ServiceVault/wtv-star/images/HackTVLogoJewel.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-star/images/HackTVLogoJewel.gif similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-star/images/HackTVLogoJewel.gif rename to zefie_wtvp_minisrv/ServiceVault/wtv-star/images/HackTVLogoJewel.gif diff --git a/zefie_wtvp_minisrv/ServiceVault/wtv-star/images/WebTVLogoJewel.gif b/zefie_wtvp_minisrv/ServiceVault/wtv-star/images/WebTVLogoJewel.gif new file mode 100644 index 00000000..ec3e51dd Binary files /dev/null and b/zefie_wtvp_minisrv/ServiceVault/wtv-star/images/WebTVLogoJewel.gif differ diff --git a/hacktv_updsrv/ServiceVault/wtv-tricks/access.js b/zefie_wtvp_minisrv/ServiceVault/wtv-tricks/access.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-tricks/access.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-tricks/access.js diff --git a/hacktv_updsrv/ServiceVault/wtv-tricks/blastcache.js b/zefie_wtvp_minisrv/ServiceVault/wtv-tricks/blastcache.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-tricks/blastcache.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-tricks/blastcache.js diff --git a/hacktv_updsrv/ServiceVault/wtv-tricks/go-offline.js b/zefie_wtvp_minisrv/ServiceVault/wtv-tricks/go-offline.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-tricks/go-offline.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-tricks/go-offline.js diff --git a/hacktv_updsrv/ServiceVault/wtv-update/content/diskmaps/htvupdate.txt b/zefie_wtvp_minisrv/ServiceVault/wtv-update/content/diskmaps/htvupdate.txt similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/content/diskmaps/htvupdate.txt rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/content/diskmaps/htvupdate.txt diff --git a/hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/Games/Games.html b/zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/Games/Games.html similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/Games/Games.html rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/Games/Games.html diff --git a/hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/Games/cSetup.html b/zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/Games/cSetup.html similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/Games/cSetup.html rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/Games/cSetup.html diff --git a/hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/MattMan/Tricks/tricks.html b/zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/MattMan/Tricks/tricks.html similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/content/htvupdate/MattMan/Tricks/tricks.html rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/content/htvupdate/MattMan/Tricks/tricks.html diff --git a/hacktv_updsrv/ServiceVault/wtv-update/sync.js b/zefie_wtvp_minisrv/ServiceVault/wtv-update/sync.js similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/sync.js rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/sync.js diff --git a/hacktv_updsrv/ServiceVault/wtv-update/update.html b/zefie_wtvp_minisrv/ServiceVault/wtv-update/update.html similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/update.html rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/update.html diff --git a/hacktv_updsrv/ServiceVault/wtv-update/updatesuccess.txt b/zefie_wtvp_minisrv/ServiceVault/wtv-update/updatesuccess.txt similarity index 100% rename from hacktv_updsrv/ServiceVault/wtv-update/updatesuccess.txt rename to zefie_wtvp_minisrv/ServiceVault/wtv-update/updatesuccess.txt diff --git a/hacktv_updsrv/app.js b/zefie_wtvp_minisrv/app.js similarity index 83% rename from hacktv_updsrv/app.js rename to zefie_wtvp_minisrv/app.js index 85b7ed9e..f87ec4cd 100644 --- a/hacktv_updsrv/app.js +++ b/zefie_wtvp_minisrv/app.js @@ -7,7 +7,7 @@ const strftime = require('strftime'); const net = require('net'); const CryptoJS = require('crypto-js'); const mime = require('mime-types'); -const crc16 = require('node-crc16'); +const { crc16 } = require('easy-crc'); var WTVSec = require('./wtvsec.js'); var zdebug = true; @@ -76,23 +76,22 @@ function getFileExt(path) { return path.reverse().split(".")[0].reverse(); } -function doErrorPage(code) { - var headers, data = null; +function doErrorPage(code, data = null) { + var headers = null; switch (code) { case 404: - data = "The service could not find the requested page."; - headers = "404 "+data+"\r\n"; + if (data === null) data = "The service could not find the requested page."; + headers = "404 " + data + "\r\n"; headers += "Content-Type: text/html\r\n"; break; case 400: - data = "An internal server error has occured."; - headers = "400 HackTV ran into a technical problem.\r\n"; + if (data === null) data = "HackTV ran into a technical problem."; + headers = "400 " + data + "\r\n"; headers += "Content-Type: text/html\r\n"; break; default: // what we send when we did not detect a wtv-url. // e.g. when a pc browser connects - data = "Hello, stranger!"; headers = "HTTP/1.1 200 OK\r\n"; headers += "Content-Type: text/html\r\n"; break; @@ -258,7 +257,7 @@ async function processURL(socket, request_headers) { var urlToPath = service_vault_dir.replace(/\\/g, "/") + "/" + service_name + "/" + shortURL.split(':/')[1]; console.log(" * Incoming headers on socket ID", socket.id, request_headers); processPath(socket, urlToPath, request_headers, query, service_name); - } else if (shortURL.indexOf('http://') >= 0) { + } else if (shortURL.indexOf('http://') >= 0 || shortURL.indexOf('https://') >= 0) { doHTTPProxy(socket, request_headers); } else { // error reading headers (no request_url provided) @@ -271,8 +270,106 @@ async function processURL(socket, request_headers) { } } -async function doHTTPProxy(socket, headers_obj) { - console.log(socket.id, headers_obj); +async function doHTTPProxy(socket, request_headers) { + console.log(socket.id, request_headers); + var request_type = request_headers['request'].indexOf('https://') ? 'http' : 'https' + switch (request_type) { + case "https": + var proxy_agent = https; + break; + case "http": + var proxy_agent = http; + break; + } + + var request_data = new Array(); + request_data['method'] = request_headers['request'].split(' ')[0]; + var request_url_split = request_headers['request'].split(' ')[1].split('/'); + request_data['host'] = request_url_split[2]; + if (request_data['host'].indexOf(':') > 0) { + request_data['port'] = request_data['host'].split(':')[1]; + request_data['host'] = request_data['host'].split(':')[0]; + } else { + if (request_type === 'https') request_data['port'] = 443; + else request_data['port'] = 80; + } + for (var i = 0; i < 3; i++) request_url_split.shift(); + request_data['path'] = "/" + request_url_split.join('/'); + + if (request_data['method'] && request_data['host'] && request_data['path']) { + + var options = { + host: request_data['host'], + port: request_data['port'], + path: request_data['path'], + method: request_data['method'], + headers: { + "User-Agent": request_headers['User-Agent'] || "WebTV" + } + } + + if (request_headers['post_data']) { + if (request_headers['Content-type']) options.headers['Content-type'] = request_headers['Content-type']; + if (request_headers['Content-length']) options.headers['Content-length'] = request_headers['Content-length']; + } + + if (services_configured.services[request_type].use_external_proxy && services_configured.services[request_type].external_proxy_port) { + options.host = services_configured.services[request_type].external_proxy_host; + options.port = services_configured.services[request_type].external_proxy_port; + options.path = request_headers['request'].split(' ')[1]; + options.headers['Host'] = request_data['host']; + } + const req = proxy_agent.request(options, function (res) { + var data = []; + + res.on('data', d => { + data.push(d); + }) + + res.on('error', function (err) { + console.log(" * Unhandled Proxy Request Error:", err); + }); + + res.on('end', function () { + var data_hex = Buffer.concat(data).toString('hex'); + + console.log(` * Proxy Request ${request_type.toUpperCase()} ${res.statusCode} for ${request_headers['request']}`) + var headers = new Array(); + headers['http_response'] = res.statusCode + " " + res.statusMessage; + headers['wtv-connection-close'] = false; + if (res.headers['server']) headers['Server'] = res.headers['server']; + if (res.headers['connection']) headers['Connection'] = res.headers['connection'] == "close" ? "Keep-Alive" : "Close"; + if (res.headers['date']) headers['Date'] = res.headers['date']; + if (res.headers['content-type']) headers['Content-type'] = res.headers['content-type']; + if (res.headers['cookie']) headers['Cookie'] = res.headers['cookie']; + // content-length is best auto-calculated + //if (res.headers['content-length']) headers['Content-Length'] = res.headers['content-length']; + if (res.headers['vary']) headers['Vary'] = res.headers['vary']; + if (res.headers['location']) headers['Location'] = res.headers['location']; + if (data_hex.substring(0, 8) == "0d0a0d0a") data_hex = data_hex.substring(8); + if (data_hex.substring(0, 4) == "0a0a") data_hex = data_hex.substring(4); + sendToClient(socket, headers, Buffer.from(data_hex,'hex')); + }); + }).on('error', function (err) { + var errpage, headers, data = null; + if (err.code == "ENOTFOUND") { + errpage = doErrorPage(400,`The publisher ${err.hostname} is unknown.`); + } else { + console.log(" * Unhandled Proxy Request Error:", err); + errpage = doErrorPage(400); + } + headers = errpage[0]; + data = errpage[1]; + sendToClient(socket, headers, data); + });; + if (request_headers['post_data']) { + req.write(Buffer.from(request_headers['post_data'].toString(CryptoJS.enc.Hex), 'hex'), function () { + req.end(); + }); + } else { + req.end(); + } + } } async function headerStringToObj(headers, response = false) { @@ -378,7 +475,7 @@ async function sendToClient(socket, headers_obj, data) { socket_session_data[socket.id].buffer = null; if (socket_session_data[socket.id].close_me) socket.end(); if (headers_obj['Connection']) { - if (headers_obj['Connection'].toLowerCase() == "close") { + if (headers_obj['Connection'].toLowerCase() == "close" && !headers['wtv-connection-close'] == "false") { socket.destroy(); } } @@ -482,7 +579,7 @@ async function processRequest(socket, data_hex, returnHeadersBeforeSecure = fals } if (returnHeadersBeforeSecure) { - headers = await checkForPostData(socket, headers, data, data_hex, returnHeadersBeforeSecure); + headers = await checkForPostData(socket, headers, data, data_hex); return headers; } @@ -535,7 +632,7 @@ async function processRequest(socket, data_hex, returnHeadersBeforeSecure = fals } } } - headers = await checkForPostData(socket, headers, data); + headers = await checkForPostData(socket, headers, data, data_hex); if (!headers['request_url']) { // still no url, likely lost encryption stream, tell client to relog socket_session_data[socket.id].secure = false; @@ -559,7 +656,7 @@ Content-type: text/html`; } } -async function checkForPostData(socket, headers, data) { +async function checkForPostData(socket, headers, data, data_hex) { if (headers['request']) { if (headers['request'].substring(0, 4) == "POST") { if (data_hex.indexOf("0d0a0d0a") != -1) { @@ -612,7 +709,8 @@ async function cleanupSocket(socket) { async function handleSocket(socket) { // create unique socket id with client address and port - socket.id = parseInt(crc16.checkSum(Buffer.from(String(socket.remoteAddress) + String(socket.remotePort), "utf8")).toString("hex"), 16); + + socket.id = parseInt(crc16('CCITT-FALSE', Buffer.from(String(socket.remoteAddress) + String(socket.remotePort), "utf8")).toString(16), 16); socket_session_data[socket.id] = []; socket.setEncoding('hex'); //set data encoding (either 'ascii', 'utf8', or 'base64') socket.on('data', function (data_hex) { @@ -625,9 +723,10 @@ async function handleSocket(socket) { }); socket.on('timeout', async function () { - socket.setTimeout(0); // start the async chain - processRequest(this, socket_session_data[socket.id].buffer.toString(CryptoJS.enc.Hex)); + if (socket_session_data[socket.id].buffer) { + processRequest(this, socket_session_data[socket.id].buffer.toString(CryptoJS.enc.Hex)); + } }); socket.on('error', (err) => { diff --git a/hacktv_updsrv/package-lock.json b/zefie_wtvp_minisrv/package-lock.json similarity index 58% rename from hacktv_updsrv/package-lock.json rename to zefie_wtvp_minisrv/package-lock.json index 29ba1225..6bc8c08e 100644 --- a/hacktv_updsrv/package-lock.json +++ b/zefie_wtvp_minisrv/package-lock.json @@ -1,19 +1,19 @@ { - "name": "hacktv_updsrv", - "version": "0.5.2", + "name": "zefie_wtvp_minisrv", + "version": "0.7.2", "lockfileVersion": 1, "requires": true, "dependencies": { - "buffer-factory": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/buffer-factory/-/buffer-factory-1.0.8.tgz", - "integrity": "sha512-EkUcaWsg7Vw+bfpGrpqzDIV4u3FksbHy0I0x9IZogqtCh9rZ5IHPTs/1QtZNNm/8BOeznUKTXIA72sVXEmFREQ==" - }, "crypto-js": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.0.0.tgz", "integrity": "sha512-bzHZN8Pn+gS7DQA6n+iUmBfl0hO5DJq++QP3U6uTucDtk/0iGpXd/Gg7CGR0p8tJhofJyaKoWBuJI4eAO00BBg==" }, + "easy-crc": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/easy-crc/-/easy-crc-0.0.2.tgz", + "integrity": "sha512-h6eqIdhJRe0p271/xZJbM/0klCi13mW5IB7ZEzEGH11yV4QXWAkD4yPErz0fXdhFrd6sZ4Q1k5Iky2kMsMNePw==" + }, "endianness": { "version": "8.0.2", "resolved": "https://registry.npmjs.org/endianness/-/endianness-8.0.2.tgz", @@ -32,20 +32,6 @@ "mime-db": "1.48.0" } }, - "node-addon-api": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-3.0.0.tgz", - "integrity": "sha512-sSHCgWfJ+Lui/u+0msF3oyCgvdkhxDbkCS6Q8uiJquzOimkJBvX6hl5aSSA7DR1XbMpdM8r7phjcF63sF4rkKg==" - }, - "node-crc16": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/node-crc16/-/node-crc16-2.0.7.tgz", - "integrity": "sha512-dbLudH39wvydMXsT5E/jdyEP0t/kO3EOFQawVeBk3cJP23+jL4feoCWF2kMThEvijrEt2isFx2XzYjLkf0h8+g==", - "requires": { - "buffer-factory": "1.0.8", - "node-addon-api": "3.0.0" - } - }, "strftime": { "version": "0.10.0", "resolved": "https://registry.npmjs.org/strftime/-/strftime-0.10.0.tgz", diff --git a/zefie_wtvp_minisrv/package.json b/zefie_wtvp_minisrv/package.json new file mode 100644 index 00000000..273dd83b --- /dev/null +++ b/zefie_wtvp_minisrv/package.json @@ -0,0 +1,31 @@ +{ + "name": "zefie_wtvp_minisrv", + "version": "0.7.2", + "description": "WebTV Service (WTVP) Emulation Server", + "main": "app.js", + "homepage": "https://github.com/zefie/zefie_wtvp_minisrv", + "license": "GPL3", + "author": { + "name": "zefie", + "email": "zefie@zefie.net", + "url": "https://zef.pw/" + }, + "bugs": { + "url": "https://github.com/zefie/zefie_wtvp_minisrv/issues" + }, + "funding": { + "type": "patreon", + "url": "https://www.patreon.com/zefie" + }, + "repository": { + "type": "git", + "url": "https://github.com/zefie/zefie_wtvp_minisrv.git" + }, + "dependencies": { + "crypto-js": "^4.0.0", + "easy-crc": "0.0.2", + "endianness": "^8.0.2", + "mime-types": "^2.1.31", + "strftime": "^0.10.0" + } +} diff --git a/hacktv_updsrv/services.json b/zefie_wtvp_minisrv/services.json similarity index 79% rename from hacktv_updsrv/services.json rename to zefie_wtvp_minisrv/services.json index 0d5fb469..b24ecdb9 100644 --- a/hacktv_updsrv/services.json +++ b/zefie_wtvp_minisrv/services.json @@ -1,10 +1,11 @@ { "config": { - "service_ip": "192.168.11.8" + "service_ip": "192.168.11.8", + "service_name": "HackTV" }, "services": { - "wtv-1800": { + "host": null, "port": 1615, "connections": 1 }, @@ -45,7 +46,11 @@ }, "http": { "port": 1650, - "connections": 3 + "connections": 3, + "use_external_proxy": false, + "external_proxy_host": null, + "external_proxy_port": 8080 + } } } diff --git a/hacktv_updsrv/wtvsec.js b/zefie_wtvp_minisrv/wtvsec.js similarity index 100% rename from hacktv_updsrv/wtvsec.js rename to zefie_wtvp_minisrv/wtvsec.js diff --git a/hacktv_updsrv/hacktv_updsrv.njsproj b/zefie_wtvp_minisrv/zefie_wtvp_minisrv.njsproj similarity index 84% rename from hacktv_updsrv/hacktv_updsrv.njsproj rename to zefie_wtvp_minisrv/zefie_wtvp_minisrv.njsproj index ce1ce0b2..389a659a 100644 --- a/hacktv_updsrv/hacktv_updsrv.njsproj +++ b/zefie_wtvp_minisrv/zefie_wtvp_minisrv.njsproj @@ -2,7 +2,7 @@ 14.0 $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - hacktv_updsrv + zefie_wtvp_minisrv hacktv_updsrv @@ -10,7 +10,8 @@ Debug 2.0 31b77d0c-f03d-43a7-bf7f-fad7174728bf - . + + app.js False @@ -34,12 +35,21 @@ Code + - + + + + + + + + + @@ -67,6 +77,7 @@ +