diff options
| -rw-r--r-- | .build.yml | 38 | ||||
| -rw-r--r-- | Cargo.lock | 35 | ||||
| -rw-r--r-- | Cargo.toml | 40 | ||||
| -rw-r--r-- | LICENSE | 661 | ||||
| -rw-r--r-- | Makefile | 61 | ||||
| -rw-r--r-- | clippy.toml | 2 | ||||
| -rwxr-xr-x | scripts/sign.sh | 18 | ||||
| -rw-r--r-- | src/configuration.rs | 44 | ||||
| -rw-r--r-- | src/error.rs | 20 | ||||
| -rw-r--r-- | src/handshake.rs | 630 | ||||
| -rw-r--r-- | src/lib.rs | 26 | ||||
| -rw-r--r-- | src/main.rs | 39 |
12 files changed, 1585 insertions, 29 deletions
diff --git a/.build.yml b/.build.yml new file mode 100644 index 0000000..e8a78a0 --- /dev/null +++ b/.build.yml @@ -0,0 +1,38 @@ +image: archlinux +packages: + - make + - minisign + - rsync + - coreutils + - lld + - rustup + - aarch64-linux-gnu-gcc + - tar + - gzip +sources: + - git@git.sr.ht:~rbdr/linea-caliente +secrets: + - a1e0e3da-c1ad-473a-ad69-8878f267a628 + - deedaf0c-1534-445d-a9b8-0910b22478b4 + - f80356df-eb81-487f-8739-fbf08bf204dc + - 05763ec6-2f17-46b5-90f6-963482975b8b +tasks: + - set_rust: | + cd linea-caliente + make set_rust + - install_binstall: | + curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash + - install_coverage_tool: | + cargo binstall cargo-tarpaulin --no-confirm + - install_builders: | + cargo binstall cargo-generate-rpm --no-confirm + cargo binstall cargo-deb --no-confirm + - configure_linker: | + cd linea-caliente + mkdir -p .cargo + echo '[target.aarch64-unknown-linux-gnu]' > .cargo/config.toml + echo 'linker = "aarch64-linux-gnu-gcc"' >> .cargo/config.toml + echo 'rustflags = ["-C", "link-arg=-fuse-ld=lld"]' >> .cargo/config.toml + - package: | + cd linea-caliente + make ci @@ -3,35 +3,42 @@ version = 4 [[package]] -name = "linea_caliente" -version = "0.1.0" +name = "lexopt" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fa0e2a1fcbe2f6be6c42e342259976206b383122fc152e872795338b5a3f3a7" + +[[package]] +name = "linea-caliente" +version = "1.0.0" dependencies = [ + "lexopt", "thiserror", ] [[package]] name = "proc-macro2" -version = "1.0.93" +version = "1.0.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "60946a68e5f9d28b0dc1c21bb8a97ee7d018a8b322fa57838ba31cc878e22d99" +checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de" dependencies = [ "unicode-ident", ] [[package]] name = "quote" -version = "1.0.38" +version = "1.0.40" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc" +checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d" dependencies = [ "proc-macro2", ] [[package]] name = "syn" -version = "2.0.98" +version = "2.0.106" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "36147f1a48ae0ec2b5b3bc5b537d267457555a10dc06f3dbc8cb11ba3006d3b1" +checksum = "ede7c438028d4436d71104916910f5bb611972c5cfd7f89b8300a8186e6fada6" dependencies = [ "proc-macro2", "quote", @@ -40,18 +47,18 @@ dependencies = [ [[package]] name = "thiserror" -version = "2.0.11" +version = "2.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d452f284b73e6d76dd36758a0c8684b1d5be31f92b89d07fd5822175732206fc" +checksum = "3467d614147380f2e4e374161426ff399c91084acd2363eaf549172b3d5e60c0" dependencies = [ "thiserror-impl", ] [[package]] name = "thiserror-impl" -version = "2.0.11" +version = "2.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "26afc1baea8a989337eeb52b6e72a039780ce45c3edfcc9c5b9d112feeb173c2" +checksum = "6c5e1be1c48b9172ee610da68fd9cd2770e7a4056cb3fc98710ee6906f0c7960" dependencies = [ "proc-macro2", "quote", @@ -60,6 +67,6 @@ dependencies = [ [[package]] name = "unicode-ident" -version = "1.0.16" +version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a210d160f08b701c8721ba1c726c11662f877ea6b7094007e1ca9a1041945034" +checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512" @@ -1,19 +1,43 @@ [package] -name = "linea_caliente" -version = "0.1.0" -edition = "2021" +name = "linea-caliente" +version = "1.0.0" +edition = "2024" license = "AGPL-3.0-or-later" -description = "A hotline protocol library" -homepage = "https://r.bdr.sh/hotline.html" -authors = ["Rubén Beltrán del Río <linea_caliente@r.bdr.sh>"] +description = "A hotline protocol server and library." +homepage = "https://r.bdr.sh/linea_caliente.html" +authors = ["Rubén Beltrán del Río <linea.caliente@r.bdr.sh>"] [dependencies] -thiserror = "2.0.11" +lexopt = "0.3.1" +thiserror = "2.0.16" + +[dev-dependencies] [profile.release] strip = true lto = true panic = "abort" +[package.metadata.generate-rpm] +assets = [ + { source = "target/release/linea-caliente", dest = "/usr/bin/linea-caliente", mode = "755" }, + { source = "man/linea-caliente.1", dest = "/usr/share/man/man1/linea-caliente.1", mode = "644" }, +] + +[package.metadata.deb] +assets = [ + ["target/release/linea-caliente", "/usr/bin/linea-caliente", "755" ], + ["man/linea-caliente.1", "/usr/share/man/man1/linea-caliente.1", "644" ], +] + [lints.clippy] -pedantic = "warn" +pedantic = { level = "warn", priority = -1 } +all = "deny" +unwrap_used = "deny" +expect_used = "deny" +panic = "deny" +indexing_slicing = "deny" +unreachable = "deny" +undocumented_unsafe_blocks = "deny" +unwrap_in_result = "deny" +ok_expect = "deny" @@ -0,0 +1,661 @@ +GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + linea-caliente, a hotline protocol server and library + Copyright (C) 2025 Ruben Beltran del Rio + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +<https://www.gnu.org/licenses/>. @@ -1,6 +1,15 @@ profile := dev target = $(shell rustc -vV | grep host | awk '{print $$2}') -app_name := page +architectures := x86_64-unknown-linux-gnu aarch64-unknown-linux-gnu +app_name := linea-caliente +deploy_host := deploy@conchos.bdr.sh +deploy_path := /srv/http/build.r.bdr.sh/$(app_name) + +define sign_and_deploy + @./scripts/sign.sh "$(1)" "$(channel)" "$(architecture)" + rsync -avz $(1) $(deploy_host):$(deploy_path) + rsync -avz $(1).minisig $(deploy_host):$(deploy_path) +endef default: build @@ -25,12 +34,52 @@ format: lint: cargo fmt -- --check && cargo clippy -release: - cargo publish +release: rpm tar deb + @$(eval filename := $(app_name)-$(target)-$(channel)) + +$(architectures): +ifneq ($(channel),) + $(MAKE) -e channel=$(channel) -e target=$@ release +else + $(MAKE) -e target=$@ build +endif + +deb: build +ifeq ($(findstring linux,$(target)),linux) + @$(eval filename := $(app_name)-$(target)-$(channel)) + cargo deb --profile $(profile) --target $(target) + mv target/$(target)/debian/*.deb $(filename).deb + @$(call sign_and_deploy,$(filename).deb) +endif + +rpm: build +ifeq ($(findstring linux,$(target)),linux) + @$(eval filename := $(app_name)-$(target)-$(channel)) + cargo generate-rpm --profile $(profile) --target $(target) + mv target/$(target)/generate-rpm/*.rpm $(filename).rpm + @$(call sign_and_deploy,$(filename).rpm) +endif + +tar: build + @$(eval filename := $(app_name)-$(target)-$(channel)) + tar -czvf $(filename).tar.gz -C target/$(target)/$(profile)/ $(app_name) + @$(call sign_and_deploy,$(filename).tar.gz) + +package: $(architectures) + +mac: + @$(eval mac_architectures := x86_64-apple-darwin aarch64-apple-darwin) +ifeq ($(tag),) + $(MAKE) -e profile=release -e architectures='$(mac_architectures)' -e channel=unstable package +else + $(MAKE) -e profile=release -e architectures='$(mac_architectures)' -e channel=$(tag) package +endif ci: lint coverage -ifneq (,$(findstring refs/tags/,$(GIT_REF))) - $(MAKE) release +ifeq ($(GIT_REF),refs/heads/main) + $(MAKE) -e profile=release -e channel=unstable package +else ifneq (,$(findstring refs/tags/,$(GIT_REF))) + $(MAKE) -e profile=release -e channel=$(subst refs/tags/,,$(GIT_REF)) package endif -.PHONY: default set_rust prepare build test coverage format lint release ci +.PHONY: default build $(architectures) rpm package prepare set_rust ci release test coverage format diff --git a/clippy.toml b/clippy.toml new file mode 100644 index 0000000..0358cdb --- /dev/null +++ b/clippy.toml @@ -0,0 +1,2 @@ +allow-unwrap-in-tests = true +allow-expect-in-tests = true diff --git a/scripts/sign.sh b/scripts/sign.sh new file mode 100755 index 0000000..b3bfe47 --- /dev/null +++ b/scripts/sign.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash + +set +x +if [ $# -ne 3 ]; then + echo "Usage: $0 <file> <channel> <architecture>" + exit 1 +fi + +FILE="$1" +VERSION="$2" +PLATFORM="$3" +COMMENT="Version: ${VERSION}, File: $(basename ${FILE}) Built on: $(date +'%Y-%m-%d %H:%M'), Platform: ${PLATFORM}" + +if [ -f ~/.minisign/minisign.pass ]; then + cat ~/.minisign/minisign.pass | minisign -Sm "${FILE}" -t "${COMMENT}" +else + minisign -Sm "${FILE}" -t "${COMMENT}" +fi diff --git a/src/configuration.rs b/src/configuration.rs new file mode 100644 index 0000000..f74d96f --- /dev/null +++ b/src/configuration.rs @@ -0,0 +1,44 @@ +use lexopt::{Parser, prelude::*}; + +const DEFAULT_ADDRESS: &str = "127.0.0.1:5500"; + +#[derive(Clone)] +pub struct Configuration { + pub address: String, +} + +impl Default for Configuration { + fn default() -> Self { + Self::new() + } +} + +impl Configuration { + #[must_use] + pub fn new() -> Self { + let mut address = DEFAULT_ADDRESS.to_string(); + + let mut parser = Parser::from_env(); + + while let Ok(Some(argument)) = parser.next() { + match argument { + Short('l') | Long("listen-address") => { + if let Ok(value) = parser.value().and_then(|v| v.parse()) { + address = value; + } else { + eprintln!("Warning: Invalid listen address ignored."); + } + } + Long("help") => { + println!("Usage: linea-caliente [-l|--listen-address=LISTEN_ADDRESS]"); + std::process::exit(0); + } + _ => { + eprintln!("Warning: Unknown argument ignored"); + } + } + } + + Configuration { address } + } +} diff --git a/src/error.rs b/src/error.rs new file mode 100644 index 0000000..c07b418 --- /dev/null +++ b/src/error.rs @@ -0,0 +1,20 @@ +use std::io; +use thiserror::Error; + +#[derive(Error, Debug)] +pub enum HotlineError { + #[error("client disconnected")] + Disconnected(#[from] io::Error), + #[error("handshake failed")] + HandshakeFailed, + #[error("invalid protocol ID")] + InvalidProtocolId, + #[error("unsupported version: {0}")] + UnsupportedVersion(u16), + #[error("incomplete handshake data")] + IncompleteHandshake, + #[error("server rejected handshake")] + ServerRejected, + #[error("invalid server response")] + InvalidServerResponse, +} diff --git a/src/handshake.rs b/src/handshake.rs new file mode 100644 index 0000000..9927181 --- /dev/null +++ b/src/handshake.rs @@ -0,0 +1,630 @@ +use crate::error::HotlineError; +use std::io::{Read, Write}; + +const PROTOCOL_ID: &[u8; 4] = b"TRTP"; +const HANDSHAKE_REQUEST_SIZE: usize = 12; +const HANDSHAKE_RESPONSE_SIZE: usize = 8; + +#[derive(Debug, Clone, PartialEq)] +pub struct HandshakeRequest { + pub protocol_id: [u8; 4], + pub sub_protocol_id: u32, + pub version: u16, + pub sub_version: u16, +} + +#[derive(Debug, Clone, PartialEq)] +pub struct HandshakeResponse { + pub protocol_id: [u8; 4], + pub error_code: u32, +} + +impl HandshakeRequest { + #[must_use] + pub fn new(sub_protocol_id: u32, sub_version: u16) -> Self { + HandshakeRequest { + protocol_id: *PROTOCOL_ID, + sub_protocol_id, + version: 1, + sub_version, + } + } + + /// # Errors + /// + /// Returns error if unable to read handshake data from stream + pub fn parse(mut reader: impl Read) -> Result<Self, HotlineError> { + let mut buffer = [0u8; HANDSHAKE_REQUEST_SIZE]; + reader.read_exact(&mut buffer).map_err(|e| match e.kind() { + std::io::ErrorKind::UnexpectedEof => HotlineError::IncompleteHandshake, + _ => HotlineError::Disconnected(e), + })?; + + let protocol_id = [buffer[0], buffer[1], buffer[2], buffer[3]]; + let sub_protocol_id = u32::from_be_bytes([buffer[4], buffer[5], buffer[6], buffer[7]]); + let version = u16::from_be_bytes([buffer[8], buffer[9]]); + let sub_version = u16::from_be_bytes([buffer[10], buffer[11]]); + + Ok(HandshakeRequest { + protocol_id, + sub_protocol_id, + version, + sub_version, + }) + } + + #[must_use] + pub fn is_valid(&self) -> bool { + self.protocol_id == *PROTOCOL_ID && self.version == 1 + } + + /// Validates the handshake request and returns specific error information. + /// + /// # Errors + /// + /// Returns specific validation errors for debugging + pub fn validate(&self) -> Result<(), HotlineError> { + if self.protocol_id != *PROTOCOL_ID { + return Err(HotlineError::InvalidProtocolId); + } + + if self.version != 1 { + return Err(HotlineError::UnsupportedVersion(self.version)); + } + + Ok(()) + } + + /// # Errors + /// + /// Returns error if unable to write handshake data to stream + pub fn write_to(self, mut writer: impl Write) -> Result<(), HotlineError> { + let mut buffer = [0u8; HANDSHAKE_REQUEST_SIZE]; + + buffer[0..4].copy_from_slice(&self.protocol_id); + buffer[4..8].copy_from_slice(&self.sub_protocol_id.to_be_bytes()); + buffer[8..10].copy_from_slice(&self.version.to_be_bytes()); + buffer[10..12].copy_from_slice(&self.sub_version.to_be_bytes()); + + writer.write_all(&buffer)?; + writer.flush()?; + + Ok(()) + } +} + +impl HandshakeResponse { + #[must_use] + pub fn new(error_code: u32) -> Self { + HandshakeResponse { + protocol_id: *PROTOCOL_ID, + error_code, + } + } + + #[must_use] + pub fn success() -> Self { + Self::new(0) + } + + #[must_use] + pub fn error() -> Self { + Self::new(1) + } + + /// # Errors + /// + /// Returns error if unable to read handshake response from stream + pub fn parse(mut reader: impl Read) -> Result<Self, HotlineError> { + let mut buffer = [0u8; HANDSHAKE_RESPONSE_SIZE]; + reader.read_exact(&mut buffer).map_err(|e| match e.kind() { + std::io::ErrorKind::UnexpectedEof => HotlineError::IncompleteHandshake, + _ => HotlineError::Disconnected(e), + })?; + + let protocol_id = [buffer[0], buffer[1], buffer[2], buffer[3]]; + let error_code = u32::from_be_bytes([buffer[4], buffer[5], buffer[6], buffer[7]]); + + Ok(HandshakeResponse { + protocol_id, + error_code, + }) + } + + #[must_use] + pub fn is_success(&self) -> bool { + self.protocol_id == *PROTOCOL_ID && self.error_code == 0 + } + + /// # Errors + /// + /// Returns error if unable to write handshake response to stream + pub fn write_to(self, mut writer: impl Write) -> Result<(), HotlineError> { + let mut buffer = [0u8; HANDSHAKE_RESPONSE_SIZE]; + + buffer[0..4].copy_from_slice(&self.protocol_id); + buffer[4..8].copy_from_slice(&self.error_code.to_be_bytes()); + + writer.write_all(&buffer)?; + writer.flush()?; + + Ok(()) + } +} + +/// # Errors +/// +/// Returns error if handshake fails or stream I/O fails +pub fn accept_handshake(mut stream: impl Read + Write) -> Result<HandshakeRequest, HotlineError> { + let request = HandshakeRequest::parse(&mut stream)?; + + let validation_result = request.validate(); + + let response = match validation_result { + Ok(()) => HandshakeResponse::success(), + Err(_) => HandshakeResponse::error(), + }; + + response.write_to(&mut stream)?; + + validation_result?; + + Ok(request) +} + +/// # Errors +/// +/// Returns error if handshake is rejected by server or stream I/O fails +pub fn initiate_handshake( + mut stream: impl Read + Write, + sub_protocol_id: u32, + sub_version: u16, +) -> Result<(), HotlineError> { + let request = HandshakeRequest::new(sub_protocol_id, sub_version); + request.write_to(&mut stream)?; + + let response = HandshakeResponse::parse(&mut stream)?; + + if response.protocol_id != *PROTOCOL_ID { + return Err(HotlineError::InvalidServerResponse); + } + + if response.error_code != 0 { + return Err(HotlineError::ServerRejected); + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::io::Cursor; + + #[test] + fn test_valid_handshake_request() { + let mut data = Vec::new(); + data.extend_from_slice(b"TRTP"); + data.extend_from_slice(&0x1234_5678_u32.to_be_bytes()); + data.extend_from_slice(&1u16.to_be_bytes()); + data.extend_from_slice(&0x9ABCu16.to_be_bytes()); + + let request = HandshakeRequest::parse(Cursor::new(data)).unwrap(); + + assert_eq!(request.protocol_id, *b"TRTP"); + assert_eq!(request.sub_protocol_id, 0x1234_5678); + assert_eq!(request.version, 1); + assert_eq!(request.sub_version, 0x9ABC); + assert!(request.is_valid()); + } + + #[test] + fn test_invalid_protocol_id() { + let mut data = Vec::new(); + data.extend_from_slice(b"XXXX"); + data.extend_from_slice(&0u32.to_be_bytes()); + data.extend_from_slice(&1u16.to_be_bytes()); + data.extend_from_slice(&0u16.to_be_bytes()); + + let request = HandshakeRequest::parse(Cursor::new(data)).unwrap(); + assert!(!request.is_valid()); + } + + #[test] + fn test_handshake_response_write() { + let response = HandshakeResponse::success(); + let mut buffer = Vec::new(); + + response.write_to(&mut buffer).unwrap(); + + assert_eq!(buffer.len(), 8); + assert_eq!(&buffer[0..4], b"TRTP"); + assert_eq!( + u32::from_be_bytes([buffer[4], buffer[5], buffer[6], buffer[7]]), + 0 + ); + } + + #[test] + fn test_full_handshake_success() { + // Use a wrapper that implements both Read and Write + struct TestStream { + read_data: Cursor<Vec<u8>>, + write_data: Vec<u8>, + } + + impl Read for TestStream { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + self.read_data.read(buf) + } + } + + impl Write for TestStream { + fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { + self.write_data.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + let mut request_data = Vec::new(); + request_data.extend_from_slice(b"TRTP"); + request_data.extend_from_slice(&0u32.to_be_bytes()); + request_data.extend_from_slice(&1u16.to_be_bytes()); + request_data.extend_from_slice(&0u16.to_be_bytes()); + + let stream = Cursor::new(request_data); + + let mut test_stream = TestStream { + read_data: stream, + write_data: Vec::new(), + }; + + let result = accept_handshake(&mut test_stream); + assert!(result.is_ok()); + + let request = result.unwrap(); + assert_eq!(request.protocol_id, *b"TRTP"); + assert_eq!(request.version, 1); + + // Check response was written + assert_eq!(test_stream.write_data.len(), 8); + assert_eq!(&test_stream.write_data[0..4], b"TRTP"); + assert_eq!( + u32::from_be_bytes([ + test_stream.write_data[4], + test_stream.write_data[5], + test_stream.write_data[6], + test_stream.write_data[7] + ]), + 0 + ); + } + + #[test] + fn test_handshake_request_new() { + let request = HandshakeRequest::new(0x1234_5678, 0x9ABC); + + assert_eq!(request.protocol_id, *b"TRTP"); + assert_eq!(request.sub_protocol_id, 0x1234_5678); + assert_eq!(request.version, 1); + assert_eq!(request.sub_version, 0x9ABC); + assert!(request.is_valid()); + } + + #[test] + fn test_handshake_request_write() { + let request = HandshakeRequest::new(0x1234_5678, 0x9ABC); + let mut buffer = Vec::new(); + + request.write_to(&mut buffer).unwrap(); + + assert_eq!(buffer.len(), 12); + assert_eq!(&buffer[0..4], b"TRTP"); + assert_eq!( + u32::from_be_bytes([buffer[4], buffer[5], buffer[6], buffer[7]]), + 0x1234_5678 + ); + assert_eq!(u16::from_be_bytes([buffer[8], buffer[9]]), 1); + assert_eq!(u16::from_be_bytes([buffer[10], buffer[11]]), 0x9ABC); + } + + #[test] + fn test_handshake_response_parse() { + let mut data = Vec::new(); + data.extend_from_slice(b"TRTP"); + data.extend_from_slice(&0u32.to_be_bytes()); + + let response = HandshakeResponse::parse(Cursor::new(data)).unwrap(); + + assert_eq!(response.protocol_id, *b"TRTP"); + assert_eq!(response.error_code, 0); + assert!(response.is_success()); + } + + #[test] + fn test_handshake_response_parse_error() { + let mut data = Vec::new(); + data.extend_from_slice(b"TRTP"); + data.extend_from_slice(&1u32.to_be_bytes()); + + let response = HandshakeResponse::parse(Cursor::new(data)).unwrap(); + + assert_eq!(response.protocol_id, *b"TRTP"); + assert_eq!(response.error_code, 1); + assert!(!response.is_success()); + } + + #[test] + fn test_initiate_handshake_success() { + struct MockStream { + read_data: Cursor<Vec<u8>>, + write_data: Vec<u8>, + } + + impl Read for MockStream { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + self.read_data.read(buf) + } + } + + impl Write for MockStream { + fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { + self.write_data.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + // Prepare server response (success) + let mut response_data = Vec::new(); + response_data.extend_from_slice(b"TRTP"); + response_data.extend_from_slice(&0u32.to_be_bytes()); + + let mut mock_stream = MockStream { + read_data: Cursor::new(response_data), + write_data: Vec::new(), + }; + + let result = initiate_handshake(&mut mock_stream, 0x1234_5678, 0x9ABC); + assert!(result.is_ok()); + + // Check that request was sent correctly + assert_eq!(mock_stream.write_data.len(), 12); + assert_eq!(&mock_stream.write_data[0..4], b"TRTP"); + assert_eq!( + u32::from_be_bytes([ + mock_stream.write_data[4], + mock_stream.write_data[5], + mock_stream.write_data[6], + mock_stream.write_data[7] + ]), + 0x1234_5678 + ); + assert_eq!( + u16::from_be_bytes([mock_stream.write_data[8], mock_stream.write_data[9]]), + 1 + ); + assert_eq!( + u16::from_be_bytes([mock_stream.write_data[10], mock_stream.write_data[11]]), + 0x9ABC + ); + } + + #[test] + fn test_initiate_handshake_server_rejection() { + struct MockStream { + read_data: Cursor<Vec<u8>>, + write_data: Vec<u8>, + } + + impl Read for MockStream { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + self.read_data.read(buf) + } + } + + impl Write for MockStream { + fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { + self.write_data.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + // Prepare server response (error) + let mut response_data = Vec::new(); + response_data.extend_from_slice(b"TRTP"); + response_data.extend_from_slice(&1u32.to_be_bytes()); + + let mut mock_stream = MockStream { + read_data: Cursor::new(response_data), + write_data: Vec::new(), + }; + + let result = initiate_handshake(&mut mock_stream, 0x1234_5678, 0x9ABC); + assert!(result.is_err()); + + match result.unwrap_err() { + HotlineError::ServerRejected => {} + _ => panic!("Expected ServerRejected error"), + } + } + + #[test] + fn test_client_server_interaction() { + // Test individual components work together correctly + // First, simulate what a client sends + let request = HandshakeRequest::new(0x1234_5678, 0x1234); + let mut request_buffer = Vec::new(); + request.write_to(&mut request_buffer).unwrap(); + + // Then test server can parse it and respond + let parsed_request = HandshakeRequest::parse(Cursor::new(&request_buffer)).unwrap(); + assert_eq!(parsed_request.sub_protocol_id, 0x1234_5678); + assert_eq!(parsed_request.sub_version, 0x1234); + assert!(parsed_request.is_valid()); + + // Server creates response + let response = HandshakeResponse::success(); + let mut response_buffer = Vec::new(); + response.write_to(&mut response_buffer).unwrap(); + + // Client can parse server response + let parsed_response = HandshakeResponse::parse(Cursor::new(&response_buffer)).unwrap(); + assert!(parsed_response.is_success()); + } + + #[test] + fn test_invalid_protocol_id_specific_error() { + let mut data = Vec::new(); + data.extend_from_slice(b"XXXX"); // Invalid protocol + data.extend_from_slice(&0u32.to_be_bytes()); + data.extend_from_slice(&1u16.to_be_bytes()); + data.extend_from_slice(&0u16.to_be_bytes()); + + let request = HandshakeRequest::parse(Cursor::new(data)).unwrap(); + + match request.validate().unwrap_err() { + HotlineError::InvalidProtocolId => {} + _ => panic!("Expected InvalidProtocolId error"), + } + } + + #[test] + fn test_unsupported_version_specific_error() { + let mut data = Vec::new(); + data.extend_from_slice(b"TRTP"); + data.extend_from_slice(&0u32.to_be_bytes()); + data.extend_from_slice(&2u16.to_be_bytes()); // Version 2 instead of 1 + data.extend_from_slice(&0u16.to_be_bytes()); + + let request = HandshakeRequest::parse(Cursor::new(data)).unwrap(); + + match request.validate().unwrap_err() { + HotlineError::UnsupportedVersion(version) => assert_eq!(version, 2), + _ => panic!("Expected UnsupportedVersion error"), + } + } + + #[test] + fn test_incomplete_handshake_request() { + // Only 8 bytes instead of 12 + let incomplete_data = vec![0x54, 0x52, 0x54, 0x50, 0x00, 0x00, 0x00, 0x00]; + + let result = HandshakeRequest::parse(Cursor::new(incomplete_data)); + + match result.unwrap_err() { + HotlineError::IncompleteHandshake => {} + _ => panic!("Expected IncompleteHandshake error"), + } + } + + #[test] + fn test_incomplete_handshake_response() { + // Only 4 bytes instead of 8 + let incomplete_data = vec![0x54, 0x52, 0x54, 0x50]; + + let result = HandshakeResponse::parse(Cursor::new(incomplete_data)); + + match result.unwrap_err() { + HotlineError::IncompleteHandshake => {} + _ => panic!("Expected IncompleteHandshake error"), + } + } + + #[test] + fn test_invalid_server_response() { + struct MockStream { + read_data: Cursor<Vec<u8>>, + write_data: Vec<u8>, + } + + impl Read for MockStream { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + self.read_data.read(buf) + } + } + + impl Write for MockStream { + fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { + self.write_data.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + // Invalid server response with wrong protocol ID + let mut response_data = Vec::new(); + response_data.extend_from_slice(b"XXXX"); // Wrong protocol + response_data.extend_from_slice(&0u32.to_be_bytes()); + + let mut mock_stream = MockStream { + read_data: Cursor::new(response_data), + write_data: Vec::new(), + }; + + let result = initiate_handshake(&mut mock_stream, 0x1234_5678, 0x9ABC); + + match result.unwrap_err() { + HotlineError::InvalidServerResponse => {} + _ => panic!("Expected InvalidServerResponse error"), + } + } + + #[test] + fn test_accept_handshake_with_specific_errors() { + struct TestStream { + read_data: Cursor<Vec<u8>>, + write_data: Vec<u8>, + } + + impl Read for TestStream { + fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { + self.read_data.read(buf) + } + } + + impl Write for TestStream { + fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> { + self.write_data.extend_from_slice(buf); + Ok(buf.len()) + } + + fn flush(&mut self) -> std::io::Result<()> { + Ok(()) + } + } + + // Test with invalid protocol ID + let mut request_data = Vec::new(); + request_data.extend_from_slice(b"XXXX"); + request_data.extend_from_slice(&0u32.to_be_bytes()); + request_data.extend_from_slice(&1u16.to_be_bytes()); + request_data.extend_from_slice(&0u16.to_be_bytes()); + + let mut test_stream = TestStream { + read_data: Cursor::new(request_data), + write_data: Vec::new(), + }; + + let result = accept_handshake(&mut test_stream); + + match result.unwrap_err() { + HotlineError::InvalidProtocolId => {} + _ => panic!("Expected InvalidProtocolId error"), + } + } +} @@ -1,2 +1,26 @@ -pub mod field; +pub mod error; +pub mod handshake; +// pub mod field; // pub mod transactions; + +use crate::error::HotlineError; +use crate::handshake::accept_handshake; + +use std::net::TcpStream; + +/// Get the stream and act as a server. If you want to act as a client, you +/// will have to write your own handler. +/// +/// # Errors +/// +/// Returns error if handshake fails or stream I/O fails +pub fn handle_client(mut stream: TcpStream) -> Result<(), HotlineError> { + let handshake_request = accept_handshake(&mut stream)?; + + eprintln!( + "Handshake successful with sub_protocol_id: 0x{:08X}, sub_version: {}", + handshake_request.sub_protocol_id, handshake_request.sub_version + ); + + Ok(()) +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..d676896 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,39 @@ +// These modules are "Server" modules. They're not necessary for the +// library, and we expect the library clients handle it as makes sense +// in their own processes. +pub mod configuration; + +use configuration::Configuration; +use linea_caliente::handle_client; + +use std::io::Result; +use std::net::TcpListener; +use std::thread; + +/// Spawns a server and hands over connections to the hotline library. +fn main() -> Result<()> { + let configuration = Configuration::new(); + + let listener = TcpListener::bind(&configuration.address)?; + eprintln!( + "Linea Caliente listening on address {}.", + configuration.address + ); + + for stream in listener.incoming() { + match stream { + Ok(stream) => { + thread::spawn(move || { + if let Err(error) = handle_client(stream) { + eprintln!("Error handling client: {error}"); + } + }); + } + Err(error) => { + eprintln!("Connection failed: {error}"); + } + } + } + + Ok(()) +} |