├── .github └── workflows │ └── docker-image.yml ├── Dockerfile ├── LICENSE ├── README.md ├── config.yaml.example ├── main.py ├── natter.py └── requirements.txt /.github/workflows/docker-image.yml: -------------------------------------------------------------------------------- 1 | name: Docker Image CI 2 | 3 | on: 4 | push: 5 | branches: ["main"] 6 | pull_request: 7 | branches: ["main"] 8 | workflow_dispatch: 9 | 10 | jobs: 11 | docker: 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - name: Check out 16 | uses: actions/checkout@v4 17 | 18 | - name: Set up QEMU 19 | uses: docker/setup-qemu-action@v3 20 | 21 | - name: Set up Docker Buildx 22 | uses: docker/setup-buildx-action@v3 23 | 24 | - name: Login to DockerHub 25 | uses: docker/login-action@v3 26 | with: 27 | username: ${{ secrets.DOCKERHUB_USERNAME }} 28 | password: ${{ secrets.DOCKERHUB_TOKEN }} 29 | 30 | - name: Build and push 31 | uses: docker/build-push-action@v5 32 | with: 33 | context: . 34 | push: true 35 | platforms: linux/amd64, linux/arm/v7 36 | tags: taskmgr818/hath-with-natter:latest 37 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine as builder 2 | 3 | ARG TARGETPLATFORM 4 | 5 | RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \ 6 | wget https://github.com/james58899/hath-rust/releases/latest/download/hath-rust-x86_64-unknown-linux-gnu -O /tmp/hath-rust; \ 7 | elif [ "$TARGETPLATFORM" = "linux/arm/v7" ]; then \ 8 | wget https://github.com/james58899/hath-rust/releases/latest/download/hath-rust-armv7-unknown-linux-gnueabihf -O /tmp/hath-rust; \ 9 | fi 10 | 11 | 12 | FROM python:slim 13 | 14 | WORKDIR /hath 15 | 16 | COPY --from=builder /tmp/hath-rust . 17 | COPY . . 18 | 19 | RUN chmod a+x hath-rust \ 20 | && chmod a+x natter.py \ 21 | && chmod a+x main.py \ 22 | && pip3 install --no-cache-dir -r requirements.txt 23 | 24 | ENTRYPOINT ["/hath/main.py"] 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # hath-with-natter 2 | 用于在NAT1（全锥型）网络运行Hentai@Home 3 | 4 | ## 使用方法 5 | ### 填写配置信息 6 | * 下载[config.yaml.example](https://github.com/taskmgr818/hath-with-natter/raw/main/config.yaml.example) 7 | * 删除`.example`后缀 8 | * 填写配置信息 9 | ### 运行程序 10 | #### 使用 Docker 运行（仅Linux） 11 | 执行 12 | ```text 13 | docker run --net host -v /yourconfigpath.yaml:/hath/config.yaml -v /yourhathpath/:/hath/hath/ --name hath-with-natter taskmgr818/hath-with-natter 14 | ``` 15 | #### 使用 Python 运行 16 | * 安装依赖 17 | * 下载对应平台的[可执行文件](https://github.com/james58899/hath-rust/releases/latest)，更名为`hath-rust`（Linux）或`hath-rust.exe`（Windows），并移动至项目文件夹 18 | * 运行`main.py` 19 | ## 注意事项 20 | * 需自行配置代理服务器，用于与e-hentai.org通信 21 | * 需启用Upnp或DMZ（二者不可同时开启） 22 | ## 参考项目 23 | * [MikeWang000000/Natter](https://github.com/MikeWang000000/Natter) 24 | * [james58899/hath-rust](https://github.com/james58899/hath-rust) 25 | -------------------------------------------------------------------------------- /config.yaml.example: -------------------------------------------------------------------------------- 1 | # e-hentai的Cookie及客户端ID/Key, 用于通知服务器端口变动 2 | access_info: 3 | ipb_member_id: 4 | ipb_pass_hash: 5 | client_id: 6 | client_key: 7 | proxy: 8 | # 是否使用代理与e-hentai.org通信 9 | enable: True 10 | # 是否使用代理下载缓存 11 | cache_download: False 12 | # 设置代理服务器的 URL，支持 http 和 socks5 协议 13 | url: http://127.0.0.1:8080 14 | hath-rust: 15 | force_background_scan: True 16 | # 日志等级 (0:Debug 1:Info 2:Warn 3:Error 4:Off) 17 | log_level: 0 18 | # 指定RPC服务器IP (可选) 19 | rpc_server_ip: 20 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import os 4 | import re 5 | import sys 6 | import time 7 | import socket 8 | import signal 9 | import logging 10 | import subprocess 11 | import httpx 12 | import yaml 13 | from natter import natter 14 | 15 | 16 | def load_config(config_file): 17 | with open(config_file, "r", encoding="utf-8") as file: 18 | return yaml.safe_load(file) 19 | 20 | 21 | class HathRustClient: 22 | def __init__(self, client_id, client_key, path): 23 | self.client_id = client_id 24 | self.client_key = client_key 25 | self.path = path 26 | self._write_client_login() 27 | 28 | def _write_client_login(self): 29 | client_login_path = os.path.join(self.path, "hath", "data") 30 | if not os.path.exists(client_login_path): 31 | os.makedirs(client_login_path) 32 | with open(os.path.join(client_login_path, "client_login"), "w") as f: 33 | content = f"{self.client_id}-{self.client_key}" 34 | f.write(content) 35 | 36 | def start( 37 | self, 38 | log_level, 39 | force_background_scan, 40 | rpc_server_ip, 41 | enable_proxy, 42 | proxy_url, 43 | inner_port, 44 | ): 45 | hath_rust_name = "hath-rust" if os.name == "posix" else "hath-rust.exe" 46 | cmd = [ 47 | os.path.join(self.path, hath_rust_name), 48 | "--cache-dir", 49 | os.path.join(self.path, "hath", "cache"), 50 | "--data-dir", 51 | os.path.join(self.path, "hath", "data"), 52 | "--download-dir", 53 | os.path.join(self.path, "hath", "download"), 54 | "--log-dir", 55 | os.path.join(self.path, "hath", "log"), 56 | "--temp-dir", 57 | os.path.join(self.path, "hath", "tmp"), 58 | "--port", 59 | inner_port, 60 | ] 61 | if enable_proxy: 62 | cmd.extend(["--proxy", proxy_url]) 63 | if force_background_scan: 64 | cmd.append("--force-background-scan") 65 | if log_level > 0: 66 | cmd.append(f"-{'q' * log_level}") 67 | if rpc_server_ip: 68 | cmd.extend(["--rpc-server-ip", rpc_server_ip]) 69 | self.process = subprocess.Popen(cmd) 70 | 71 | def stop(self): 72 | self.process.terminate() 73 | time.sleep(30) 74 | 75 | 76 | def update_port( 77 | ipb_member_id, ipb_pass_hash, client_id, enable_proxy, proxy_url, outer_port 78 | ): 79 | url = f"https://e-hentai.org/hentaiathome.php?cid={client_id}&act=settings" 80 | cookies = {"ipb_member_id": str(ipb_member_id), "ipb_pass_hash": ipb_pass_hash} 81 | proxy = proxy_url if enable_proxy else None 82 | 83 | while True: 84 | try: 85 | html_content = httpx.get(url, cookies=cookies, proxy=proxy).text 86 | except Exception as e: 87 | logging.error(e) 88 | continue 89 | # 判断客户端是否关闭（能否更改端口） 90 | if re.search(r'name="f_port".*disabled="disabled"', html_content) is None: 91 | break 92 | time.sleep(15) 93 | 94 | data = {} 95 | # 获取原有配置 96 | matches1 = re.findall(r'name="([^"]*)" value="([^"]*)"', html_content) 97 | for match in matches1: 98 | data[match[0]] = match[1] 99 | matches2 = re.findall(r'name="([^"]*)" checked="checked"', html_content) 100 | for match in matches2: 101 | data[match] = "on" 102 | 103 | data["f_port"] = outer_port 104 | 105 | while True: 106 | try: 107 | httpx.post(url, data=data, cookies=cookies, proxy=proxy) 108 | except Exception as e: 109 | logging.error(e) 110 | continue 111 | break 112 | 113 | 114 | def keep_alive(outer_ip, outer_port): 115 | retries = 0 116 | while retries < 3: 117 | time.sleep(15) 118 | try: 119 | with socket.create_connection((outer_ip, outer_port), timeout=3): 120 | retries = 0 121 | except: 122 | retries += 1 123 | 124 | 125 | def wait_for_network(): 126 | while True: 127 | try: 128 | with socket.create_connection(("223.5.5.5", 80), timeout=3): 129 | break 130 | except: 131 | time.sleep(15) 132 | 133 | 134 | def main(): 135 | logging.basicConfig( 136 | level=logging.INFO, 137 | format="%(asctime)s - %(levelname)s - %(message)s", 138 | datefmt="%Y-%m-%d %H:%M:%S", 139 | ) 140 | 141 | path = os.path.dirname(os.path.realpath(__file__)) 142 | 143 | config = load_config(os.path.join(path, "config.yaml")) 144 | 145 | hathrustclient = HathRustClient( 146 | config["access_info"]["client_id"], 147 | config["access_info"]["client_key"], 148 | path, 149 | ) 150 | 151 | while True: 152 | inner_port, outer_ip, outer_port, upnp = natter() 153 | try: 154 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as server: 155 | server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 156 | server.bind(("0.0.0.0", inner_port)) 157 | server.listen(5) 158 | 159 | with socket.create_connection((outer_ip, outer_port), timeout=3): 160 | pass 161 | except: 162 | logging.error("打洞失败，请检查NAT类型") 163 | upnp.clear() 164 | sys.exit(0) 165 | 166 | update_port( 167 | config["access_info"]["ipb_member_id"], 168 | config["access_info"]["ipb_pass_hash"], 169 | config["access_info"]["client_id"], 170 | config["proxy"]["enable"], 171 | config["proxy"]["url"], 172 | str(outer_port), 173 | ) 174 | 175 | hathrustclient.start( 176 | config["hath-rust"]["log_level"], 177 | config["hath-rust"]["force_background_scan"], 178 | config["hath-rust"]["rpc_server_ip"], 179 | config["proxy"]["cache_download"], 180 | config["proxy"]["url"], 181 | str(inner_port), 182 | ) 183 | 184 | def signal_handler(signum, frame): 185 | upnp.clear() 186 | hathrustclient.stop() 187 | sys.exit(0) 188 | 189 | signal.signal(signal.SIGTERM, signal_handler) 190 | 191 | time.sleep(60) 192 | keep_alive(outer_ip, outer_port) 193 | 194 | logging.info("连接断开，即将重新启动") 195 | wait_for_network() 196 | upnp.clear() 197 | hathrustclient.stop() 198 | 199 | 200 | if __name__ == "__main__": 201 | main() 202 | -------------------------------------------------------------------------------- /natter.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | """ 4 | Natter - https://github.com/MikeWang000000/Natter 5 | Copyright (C) 2023 MikeWang000000 6 | 7 | This program is free software: you can redistribute it and/or modify 8 | it under the terms of the GNU General Public License as published by 9 | the Free Software Foundation, either version 3 of the License, or 10 | (at your option) any later version. 11 | 12 | This program is distributed in the hope that it will be useful, 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | GNU General Public License for more details. 16 | 17 | You should have received a copy of the GNU General Public License 18 | along with this program. If not, see . 19 | """ 20 | 21 | import os 22 | import re 23 | import sys 24 | import time 25 | import random 26 | import socket 27 | import struct 28 | import logging 29 | 30 | __version__ = "2.1.1" 31 | 32 | 33 | logging.basicConfig( 34 | level=logging.INFO, 35 | format="%(asctime)s [%(levelname)s] %(message)s", 36 | datefmt="%Y-%m-%d %H:%M:%S", 37 | ) 38 | 39 | 40 | class StunClient(object): 41 | class ServerUnavailable(Exception): 42 | pass 43 | 44 | def __init__(self, stun_server_list): 45 | self.stun_server_list = stun_server_list 46 | self.source_host = "0.0.0.0" 47 | self.source_port = 0 48 | 49 | def get_mapping(self): 50 | first = self.stun_server_list[0] 51 | while True: 52 | try: 53 | return self._get_mapping() 54 | except StunClient.ServerUnavailable as ex: 55 | logging.warning( 56 | "stun: STUN server %s is unavailable: %s" 57 | % (addr_to_uri(self.stun_server_list[0]), ex) 58 | ) 59 | self.stun_server_list.append(self.stun_server_list.pop(0)) 60 | if self.stun_server_list[0] == first: 61 | logging.error("stun: No STUN server is available right now") 62 | # force sleep for 10 seconds, then try the next loop 63 | time.sleep(10) 64 | 65 | def _get_mapping(self): 66 | # ref: https://www.rfc-editor.org/rfc/rfc5389 67 | socket_type = socket.SOCK_STREAM 68 | stun_host, stun_port = self.stun_server_list[0] 69 | sock = socket.socket(socket.AF_INET, socket_type) 70 | socket_set_opt( 71 | sock, 72 | reuse=True, 73 | bind_addr=(self.source_host, self.source_port), 74 | timeout=3, 75 | ) 76 | try: 77 | sock.connect((stun_host, stun_port)) 78 | inner_addr = sock.getsockname() 79 | self.source_host, self.source_port = inner_addr 80 | sock.send( 81 | struct.pack( 82 | "!LLLLL", 83 | 0x00010000, 84 | 0x2112A442, 85 | 0x4E415452, 86 | random.getrandbits(32), 87 | random.getrandbits(32), 88 | ) 89 | ) 90 | buff = sock.recv(1500) 91 | ip = port = 0 92 | payload = buff[20:] 93 | while payload: 94 | attr_type, attr_len = struct.unpack("!HH", payload[:4]) 95 | if attr_type in [1, 32]: 96 | _, _, port, ip = struct.unpack("!BBHL", payload[4 : 4 + attr_len]) 97 | if attr_type == 32: 98 | port ^= 0x2112 99 | ip ^= 0x2112A442 100 | break 101 | payload = payload[4 + attr_len :] 102 | else: 103 | raise ValueError("Invalid STUN response") 104 | outer_addr = socket.inet_ntop(socket.AF_INET, struct.pack("!L", ip)), port 105 | logging.debug( 106 | "stun: Got address %s from %s, source %s" 107 | % ( 108 | addr_to_uri(outer_addr), 109 | addr_to_uri((stun_host, stun_port)), 110 | addr_to_uri(inner_addr), 111 | ) 112 | ) 113 | return inner_addr, outer_addr 114 | except (OSError, ValueError, struct.error, socket.error) as ex: 115 | raise StunClient.ServerUnavailable(ex) 116 | finally: 117 | sock.close() 118 | 119 | 120 | def keep_alive(host, port, source_host, source_port): 121 | sock_type = socket.SOCK_STREAM 122 | sock = socket.socket(socket.AF_INET, sock_type) 123 | socket_set_opt( 124 | sock, 125 | reuse=True, 126 | bind_addr=(source_host, source_port), 127 | timeout=3, 128 | ) 129 | sock.connect((host, port)) 130 | logging.debug("keep-alive: Connected to host %s" % (addr_to_uri((host, port)))) 131 | sock.sendall( 132 | ( 133 | "HEAD /natter-keep-alive HTTP/1.1\r\n" 134 | "Host: %s\r\n" 135 | "User-Agent: curl/8.0.0 (Natter)\r\n" 136 | "Accept: */*\r\n" 137 | "Connection: keep-alive\r\n" 138 | "\r\n" % host 139 | ).encode() 140 | ) 141 | buff = b"" 142 | try: 143 | while True: 144 | buff = sock.recv(4096) 145 | if not buff: 146 | raise OSError("Keep-alive server closed connection") 147 | except socket.timeout as ex: 148 | if not buff: 149 | raise ex 150 | logging.debug("keep-alive: OK") 151 | 152 | 153 | class UPnPService(object): 154 | def __init__(self, device): 155 | self.device = device 156 | self.service_type = None 157 | self.service_id = None 158 | self.scpd_url = None 159 | self.control_url = None 160 | self.eventsub_url = None 161 | self._sock_timeout = 3 162 | 163 | def __repr__(self): 164 | return "" % ( 165 | repr(self.service_type), 166 | repr(self.service_id), 167 | ) 168 | 169 | def is_valid(self): 170 | if self.service_type and self.service_id and self.control_url: 171 | return True 172 | return False 173 | 174 | def is_forward(self): 175 | if ( 176 | self.service_type 177 | in ( 178 | "urn:schemas-upnp-org:service:WANIPConnection:1", 179 | "urn:schemas-upnp-org:service:WANIPConnection:2", 180 | "urn:schemas-upnp-org:service:WANPPPConnection:1", 181 | ) 182 | and self.service_id 183 | and self.control_url 184 | ): 185 | return True 186 | return False 187 | 188 | def forward_port(self, host, port, dest_host, dest_port, duration=0): 189 | if not self.is_forward(): 190 | raise NotImplementedError( 191 | "Unsupported service type: %s" % self.service_type 192 | ) 193 | 194 | proto = "TCP" 195 | ctl_hostname, ctl_port, ctl_path = split_url(self.control_url) 196 | descpt = "Natter" 197 | content = ( 198 | '\r\n' 199 | '\r\n' 201 | " \r\n" 202 | ' \r\n' 203 | " %s\r\n" 204 | " %s\r\n" 205 | " %s\r\n" 206 | " %s\r\n" 207 | " %s\r\n" 208 | " 1\r\n" 209 | " %s\r\n" 210 | " %d\r\n" 211 | " \r\n" 212 | " \r\n" 213 | "\r\n" 214 | % ( 215 | self.service_type, 216 | host, 217 | port, 218 | proto, 219 | dest_port, 220 | dest_host, 221 | descpt, 222 | duration, 223 | ) 224 | ) 225 | content_len = len(content.encode()) 226 | data = ( 227 | "POST %s HTTP/1.1\r\n" 228 | "Host: %s:%d\r\n" 229 | "User-Agent: curl/8.0.0 (Natter)\r\n" 230 | "Accept: */*\r\n" 231 | 'SOAPAction: "%s#AddPortMapping"\r\n' 232 | "Content-Type: text/xml\r\n" 233 | "Content-Length: %d\r\n" 234 | "Connection: close\r\n" 235 | "\r\n" 236 | "%s\r\n" 237 | % ( 238 | ctl_path, 239 | ctl_hostname, 240 | ctl_port, 241 | self.service_type, 242 | content_len, 243 | content, 244 | ) 245 | ).encode() 246 | sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 247 | socket_set_opt( 248 | sock, 249 | timeout=self._sock_timeout, 250 | ) 251 | sock.connect((ctl_hostname, ctl_port)) 252 | sock.sendall(data) 253 | response = b"" 254 | while True: 255 | buff = sock.recv(4096) 256 | if not buff: 257 | break 258 | response += buff 259 | sock.close() 260 | r = response.decode("utf-8", "ignore") 261 | errno = errmsg = "" 262 | m = re.search(r"([^<]*?)", r) 263 | if m: 264 | errno = m.group(1).strip() 265 | m = re.search(r"([^<]*?)", r) 266 | if m: 267 | errmsg = m.group(1).strip() 268 | if errno or errmsg: 269 | logging.error( 270 | "upnp: Error from service %s of device %s: [%s] %s" 271 | % (self.service_type, self.device, errno, errmsg) 272 | ) 273 | return False 274 | return True 275 | 276 | 277 | class UPnPDevice(object): 278 | def __init__(self, ipaddr, xml_urls): 279 | self.ipaddr = ipaddr 280 | self.xml_urls = xml_urls 281 | self.services = [] 282 | self.forward_srv = None 283 | self._sock_timeout = 3 284 | 285 | def __repr__(self): 286 | return "" % (repr(self.ipaddr),) 287 | 288 | def _load_services(self): 289 | if self.services: 290 | return 291 | services_d = {} # service_id => UPnPService() 292 | for url in self.xml_urls: 293 | sd = self._get_srv_dict(url) 294 | services_d.update(sd) 295 | self.services.extend(services_d.values()) 296 | for srv in self.services: 297 | if srv.is_forward(): 298 | self.forward_srv = srv 299 | break 300 | 301 | def _http_get(self, url): 302 | hostname, port, path = split_url(url) 303 | sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 304 | socket_set_opt( 305 | sock, 306 | timeout=self._sock_timeout, 307 | ) 308 | sock.connect((hostname, port)) 309 | data = ( 310 | "GET %s HTTP/1.1\r\n" 311 | "Host: %s\r\n" 312 | "User-Agent: curl/8.0.0 (Natter)\r\n" 313 | "Accept: */*\r\n" 314 | "Connection: close\r\n" 315 | "\r\n" % (path, hostname) 316 | ).encode() 317 | sock.sendall(data) 318 | response = b"" 319 | while True: 320 | buff = sock.recv(4096) 321 | if not buff: 322 | break 323 | response += buff 324 | sock.close() 325 | if not response.startswith(b"HTTP/"): 326 | raise ValueError("Invalid response from HTTP server") 327 | s = response.split(b"\r\n\r\n", 1) 328 | if len(s) != 2: 329 | raise ValueError("Invalid response from HTTP server") 330 | return s[1] 331 | 332 | def _get_srv_dict(self, url): 333 | try: 334 | xmlcontent = self._http_get(url).decode("utf-8", "ignore") 335 | except (OSError, socket.error, ValueError) as ex: 336 | logging.error("upnp: failed to load service from %s: %s" % (url, ex)) 337 | return 338 | services_d = {} 339 | srv_str_l = re.findall(r"([\s\S]+?)", xmlcontent) 340 | for srv_str in srv_str_l: 341 | srv = UPnPService(self) 342 | m = re.search(r"([^<]*?)", srv_str) 343 | if m: 344 | srv.service_type = m.group(1).strip() 345 | m = re.search(r"([^<]*?)", srv_str) 346 | if m: 347 | srv.service_id = m.group(1).strip() 348 | m = re.search(r"([^<]*?)", srv_str) 349 | if m: 350 | srv.scpd_url = full_url(m.group(1).strip(), url) 351 | m = re.search(r"([^<]*?)", srv_str) 352 | if m: 353 | srv.control_url = full_url(m.group(1).strip(), url) 354 | m = re.search(r"([^<]*?)", srv_str) 355 | if m: 356 | srv.eventsub_url = full_url(m.group(1).strip(), url) 357 | if srv.is_valid(): 358 | services_d[srv.service_id] = srv 359 | return services_d 360 | 361 | 362 | class UPnPClient(object): 363 | def __init__(self): 364 | self.ssdp_addr = ("239.255.255.250", 1900) 365 | self.router = None 366 | self._sock_timeout = 1 367 | self._fwd_host = None 368 | self._fwd_port = None 369 | self._fwd_dest_host = None 370 | self._fwd_dest_port = None 371 | self._fwd_started = False 372 | 373 | def discover_router(self): 374 | router_l = [] 375 | try: 376 | devs = self._discover() 377 | for dev in devs: 378 | if dev.forward_srv: 379 | router_l.append(dev) 380 | except (OSError, socket.error) as ex: 381 | logging.error("upnp: failed to discover router: %s" % ex) 382 | if not router_l: 383 | self.router = None 384 | elif len(router_l) > 1: 385 | logging.warning("upnp: multiple routers found: %s" % (router_l,)) 386 | self.router = router_l[0] 387 | else: 388 | self.router = router_l[0] 389 | return self.router 390 | 391 | def _discover(self): 392 | sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) 393 | socket_set_opt( 394 | sock, 395 | reuse=True, 396 | timeout=self._sock_timeout, 397 | ) 398 | dat01 = ( 399 | "M-SEARCH * HTTP/1.1\r\n" 400 | "ST: ssdp:all\r\n" 401 | "MX: 2\r\n" 402 | 'MAN: "ssdp:discover"\r\n' 403 | "HOST: %s:%d\r\n" 404 | "\r\n" % self.ssdp_addr 405 | ).encode() 406 | 407 | dat02 = ( 408 | "M-SEARCH * HTTP/1.1\r\n" 409 | "ST: upnp:rootdevice\r\n" 410 | "MX: 2\r\n" 411 | 'MAN: "ssdp:discover"\r\n' 412 | "HOST: %s:%d\r\n" 413 | "\r\n" % self.ssdp_addr 414 | ).encode() 415 | 416 | sock.sendto(dat01, self.ssdp_addr) 417 | sock.sendto(dat02, self.ssdp_addr) 418 | 419 | upnp_urls_d = {} 420 | while True: 421 | try: 422 | buff, addr = sock.recvfrom(4096) 423 | m = re.search(r"LOCATION: *(http://[^\[]\S+)\s+", buff.decode("utf-8")) 424 | if not m: 425 | continue 426 | ipaddr = addr[0] 427 | location = m.group(1) 428 | logging.debug("upnp: Got URL %s" % location) 429 | if ipaddr in upnp_urls_d: 430 | upnp_urls_d[ipaddr].add(location) 431 | else: 432 | upnp_urls_d[ipaddr] = set([location]) 433 | except socket.timeout: 434 | break 435 | 436 | devs = [] 437 | for ipaddr, urls in upnp_urls_d.items(): 438 | d = UPnPDevice(ipaddr, urls) 439 | d._load_services() 440 | devs.append(d) 441 | 442 | return devs 443 | 444 | def forward(self, host, port, dest_host, dest_port): 445 | if not self.router: 446 | raise RuntimeError("No router is available") 447 | self.router.forward_srv.forward_port(host, port, dest_host, dest_port) 448 | self._fwd_host = host 449 | self._fwd_port = port 450 | self._fwd_dest_host = dest_host 451 | self._fwd_dest_port = dest_port 452 | self._fwd_started = True 453 | 454 | def clear(self): 455 | if self._fwd_started: 456 | self.router.forward_srv.forward_port( 457 | self._fwd_host, 458 | self._fwd_port, 459 | self._fwd_dest_host, 460 | self._fwd_dest_port, 461 | 1, 462 | ) 463 | 464 | 465 | def socket_set_opt(sock, reuse=False, bind_addr=None, timeout=-1): 466 | if reuse: 467 | if hasattr(socket, "SO_REUSEADDR"): 468 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) 469 | if hasattr(socket, "SO_REUSEPORT"): 470 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) 471 | if bind_addr is not None: 472 | sock.bind(bind_addr) 473 | if timeout != -1: 474 | sock.settimeout(timeout) 475 | return sock 476 | 477 | 478 | def check_docker_network(): 479 | if not sys.platform.startswith("linux"): 480 | return 481 | if not os.path.exists("/.dockerenv"): 482 | return 483 | if not os.path.isfile("/sys/class/net/eth0/address"): 484 | return 485 | fo = open("/sys/class/net/eth0/address", "r") 486 | macaddr = fo.read().strip() 487 | fo.close() 488 | hostname = socket.gethostname() 489 | try: 490 | ipaddr = socket.gethostbyname(hostname) 491 | except socket.gaierror: 492 | logging.warning("check-docket-network: Cannot resolve hostname `%s`" % hostname) 493 | return 494 | docker_macaddr = "02:42:" + ":".join(["%02x" % int(x) for x in ipaddr.split(".")]) 495 | if macaddr == docker_macaddr: 496 | raise RuntimeError("Docker's `--net=host` option is required.") 497 | 498 | if not os.path.isfile("/proc/sys/kernel/osrelease"): 499 | return 500 | fo = open("/proc/sys/kernel/osrelease", "r") 501 | uname_r = fo.read().strip() 502 | fo.close() 503 | uname_r_sfx = uname_r.rsplit("-").pop() 504 | if ( 505 | uname_r_sfx.lower() in ["linuxkit", "wsl2"] 506 | and hostname.lower() == "docker-desktop" 507 | ): 508 | raise RuntimeError("Network from Docker Desktop is not supported.") 509 | 510 | 511 | def split_url(url): 512 | m = re.match(r"^http://([^\[\]:/]+)(?:\:([0-9]+))?(/\S*)?$", url) 513 | if not m: 514 | raise ValueError("Unsupported URL: %s" % url) 515 | hostname, port_str, path = m.groups() 516 | port = 80 517 | if port_str: 518 | port = int(port_str) 519 | if not path: 520 | path = "/" 521 | return hostname, port, path 522 | 523 | 524 | def full_url(u, refurl): 525 | if not u.startswith("/"): 526 | return u 527 | hostname, port, _ = split_url(refurl) 528 | return "http://%s:%d" % (hostname, port) + u 529 | 530 | 531 | def addr_to_str(addr): 532 | return "%s:%d" % addr 533 | 534 | 535 | def addr_to_uri(addr): 536 | return "tcp://%s:%d" % addr 537 | 538 | 539 | def natter(): 540 | sys.tracebacklimit = 0 541 | 542 | stun_list = [ 543 | "fwa.lifesizecloud.com", 544 | "global.turn.twilio.com", 545 | "turn.cloudflare.com", 546 | "stun.isp.net.au", 547 | "stun.nextcloud.com", 548 | "stun.freeswitch.org", 549 | "stun.voip.blackberry.com", 550 | "stunserver.stunprotocol.org", 551 | "stun.sipnet.com", 552 | "stun.radiojar.com", 553 | "stun.sonetel.com", 554 | "stun.telnyx.com", 555 | ] 556 | 557 | stun_srv_list = [] 558 | for item in stun_list: 559 | l = item.split(":", 2) + ["3478"] 560 | stun_srv_list.append( 561 | (l[0], int(l[1])), 562 | ) 563 | 564 | # 565 | # Natter 566 | # 567 | logging.info("Natter v%s" % __version__) 568 | 569 | check_docker_network() 570 | 571 | stun = StunClient(stun_srv_list) 572 | 573 | natter_addr, outer_addr = stun.get_mapping() 574 | inner_ip, inner_port = natter_addr 575 | outer_ip, outer_port = outer_addr 576 | 577 | keepalive_srv = "www.baidu.com" 578 | keepalive_port = 80 579 | keep_alive(keepalive_srv, keepalive_port, inner_ip, inner_port) 580 | 581 | # UPnP 582 | upnp_router = None 583 | 584 | upnp = UPnPClient() 585 | logging.info("Scanning UPnP Devices...") 586 | try: 587 | upnp_router = upnp.discover_router() 588 | except (OSError, socket.error, ValueError) as ex: 589 | logging.error("upnp: failed to discover router: %s" % ex) 590 | 591 | if upnp_router: 592 | logging.info("[UPnP] Found router %s" % upnp_router.ipaddr) 593 | try: 594 | upnp.forward("", inner_port, inner_ip, inner_port) 595 | except (OSError, socket.error, ValueError) as ex: 596 | logging.error("upnp: failed to forward port: %s" % ex) 597 | 598 | return inner_port, outer_ip, outer_port, upnp 599 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyyaml 2 | httpx[socks] --------------------------------------------------------------------------------