├── .gitignore ├── LICENSE ├── README.md ├── pyproject.toml ├── requirements.txt └── src └── wisp ├── __init__.py ├── server ├── __init__.py ├── __main__.py ├── cli.py ├── connection.py ├── http.py ├── net.py └── ratelimit.py └── util.py /.gitignore: -------------------------------------------------------------------------------- 1 | .venv* 2 | /run*.sh 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | share/python-wheels/ 27 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .nox/ 46 | .coverage 47 | .coverage.* 48 | .cache 49 | nosetests.xml 50 | coverage.xml 51 | *.cover 52 | *.py,cover 53 | .hypothesis/ 54 | .pytest_cache/ 55 | cover/ 56 | 57 | # Translations 58 | *.mo 59 | *.pot 60 | 61 | # Django stuff: 62 | *.log 63 | local_settings.py 64 | db.sqlite3 65 | db.sqlite3-journal 66 | 67 | # Flask stuff: 68 | instance/ 69 | .webassets-cache 70 | 71 | # Scrapy stuff: 72 | .scrapy 73 | 74 | # Sphinx documentation 75 | docs/_build/ 76 | 77 | # PyBuilder 78 | .pybuilder/ 79 | target/ 80 | 81 | # Jupyter Notebook 82 | .ipynb_checkpoints 83 | 84 | # IPython 85 | profile_default/ 86 | ipython_config.py 87 | 88 | # pyenv 89 | # For a library or package, you might want to ignore these files since the code is 90 | # intended to run in multiple environments; otherwise, check them in: 91 | # .python-version 92 | 93 | # pipenv 94 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 95 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 96 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 97 | # install all needed dependencies. 98 | #Pipfile.lock 99 | 100 | # poetry 101 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 102 | # This is especially recommended for binary packages to ensure reproducibility, and is more 103 | # commonly ignored for libraries. 104 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 105 | #poetry.lock 106 | 107 | # pdm 108 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 109 | #pdm.lock 110 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 111 | # in version control. 112 | # https://pdm.fming.dev/#use-with-ide 113 | .pdm.toml 114 | 115 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 116 | __pypackages__/ 117 | 118 | # Celery stuff 119 | celerybeat-schedule 120 | celerybeat.pid 121 | 122 | # SageMath parsed files 123 | *.sage.py 124 | 125 | # Environments 126 | .env 127 | .venv 128 | .pypy_venv 129 | env/ 130 | venv/ 131 | ENV/ 132 | env.bak/ 133 | venv.bak/ 134 | 135 | # Spyder project settings 136 | .spyderproject 137 | .spyproject 138 | 139 | # Rope project settings 140 | .ropeproject 141 | 142 | # mkdocs documentation 143 | /site 144 | 145 | # mypy 146 | .mypy_cache/ 147 | .dmypy.json 148 | dmypy.json 149 | 150 | # Pyre type checker 151 | .pyre/ 152 | 153 | # pytype static type analyzer 154 | .pytype/ 155 | 156 | # Cython debug symbols 157 | cython_debug/ 158 | 159 | # PyCharm 160 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 161 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 162 | # and can be added to the global gitignore or merged into this file. For a more nuclear 163 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 164 | #.idea/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Python Wisp Server 2 | 3 | This is an implementation of a [Wisp](https://github.com/MercuryWorkshop/wisp-protocol) server, written in Python. It follows the Wisp v1 spec completely, including support for UDP connections. 4 | 5 | ## Installation: 6 | ### Install From Source: 7 | Clone this repository and cd into it, then run the following commands: 8 | ``` 9 | python3 -m venv .venv 10 | source .venv/bin/activate 11 | pip3 install -e . 12 | ``` 13 | 14 | ### Install From PyPI: 15 | Run the following command to install this program: 16 | ``` 17 | pip3 install wisp-python 18 | ``` 19 | 20 | ## Running the Server: 21 | For the best performance use [CPython](https://github.com/python/cpython) 3.11 or newer. [PyPy](https://github.com/pypy/pypy) is not recommended as it is a lot slower than CPython here. 22 | 23 | There used to be an experimental "threading" variant of the server. This has been removed due to its instability and difficulty of maintenance. 24 | 25 | To start the server, run `python3 -m wisp.server`. The program accepts the following arguments: 26 | ``` 27 | usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] 28 | [--allow-private] [--log-level LOG_LEVEL] [--threads THREADS] 29 | 30 | A Wisp server implementation, written in Python (v0.7.0) 31 | 32 | options: 33 | -h, --help show this help message and exit 34 | --host HOST The hostname the server will listen on. 35 | --port PORT The TCP port the server will listen on. 36 | --static STATIC Where static files are served from. 37 | --limits Enable rate limits. 38 | --bandwidth BANDWIDTH 39 | Bandwidth limit per IP, in kilobytes per second. 40 | --connections CONNECTIONS 41 | New connections limit per IP. 42 | --window WINDOW Fixed window length for rate limits, in seconds. 43 | --allow-loopback Allow connections to loopback IP addresses. 44 | --allow-private Allow connections to private IP addresses. 45 | --log-level LOG_LEVEL 46 | The log level (either debug, info, warning, error, or critical). 47 | --threads THREADS The number of threads to run the server on. By default it uses all CPU cores. 48 | ``` 49 | 50 | ## Roadmap: 51 | - ~~Rate limits~~ 52 | - JSON based config files 53 | - ~~UDP support~~ 54 | - ~~Ability to block local addresses~~ 55 | - Wisp v2 support 56 | 57 | ## Copyright: 58 | This repository is licensed under the GNU AGPL v3. 59 | 60 | ### Copyright Notice: 61 | ``` 62 | wisp-server-python: a Wisp server implementation written in Python 63 | Copyright (C) 2024 Mercury Workshop 64 | 65 | This program is free software: you can redistribute it and/or modify 66 | it under the terms of the GNU Affero General Public License as published by 67 | the Free Software Foundation, either version 3 of the License, or 68 | (at your option) any later version. 69 | 70 | This program is distributed in the hope that it will be useful, 71 | but WITHOUT ANY WARRANTY; without even the implied warranty of 72 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 73 | GNU Affero General Public License for more details. 74 | 75 | You should have received a copy of the GNU Affero General Public License 76 | along with this program. If not, see . 77 | ``` -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | #run 'python3 -m build' to build the project 2 | #then run 'twine upload dist/*' to publish 3 | 4 | [build-system] 5 | requires = ["setuptools>=61.0", "toml"] 6 | build-backend = "setuptools.build_meta" 7 | 8 | [tool.setuptools] 9 | packages = ["wisp", "wisp.server"] 10 | package-dir = {"" = "src"} 11 | 12 | [project] 13 | name = "wisp-python" 14 | version = "0.7.0" 15 | authors = [ 16 | {name="ading2210"}, 17 | ] 18 | description = "An implementation of a Wisp proxy server in Python" 19 | readme = "README.md" 20 | requires-python = ">=3.9" 21 | classifiers = [ 22 | "Programming Language :: Python :: 3", 23 | "License :: OSI Approved :: GNU Affero General Public License v3", 24 | "Operating System :: OS Independent", 25 | ] 26 | dependencies = [ 27 | "websockets", 28 | "asyncudp", 29 | "uvloop; sys_platform != 'win32' and sys_platform != 'cygwin'" 30 | ] 31 | 32 | [project.urls] 33 | Homepage = "https://github.com/MercuryWorkshop/wisp-server-python" 34 | Issues = "https://github.com/MercuryWorkshop/wisp-server-python/issues" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | websockets 2 | asyncudp 3 | uvloop -------------------------------------------------------------------------------- /src/wisp/__init__.py: -------------------------------------------------------------------------------- 1 | from wisp import server 2 | from wisp import util 3 | 4 | version = util.get_version() -------------------------------------------------------------------------------- /src/wisp/server/__init__.py: -------------------------------------------------------------------------------- 1 | from wisp.server.connection import WispConnection 2 | from wisp.server.connection import WSProxyConnection -------------------------------------------------------------------------------- /src/wisp/server/__main__.py: -------------------------------------------------------------------------------- 1 | from wisp.server import cli 2 | 3 | if __name__ == "__main__": 4 | cli.main() -------------------------------------------------------------------------------- /src/wisp/server/cli.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import argparse 3 | import pathlib 4 | import sys 5 | import logging 6 | import multiprocessing 7 | 8 | try: 9 | import uvloop 10 | use_uvloop = True 11 | except ImportError: 12 | use_uvloop = False 13 | 14 | import wisp 15 | from wisp.server import http 16 | from wisp.server import net 17 | 18 | def run_async(func, *args, **kwargs): 19 | try: 20 | if use_uvloop: 21 | uvloop.run(func(*args, **kwargs)) 22 | else: 23 | #uvloop doesn't support windows at all so we don't need to print the error 24 | if not sys.platform in ("win32", "cygwin"): 25 | logging.error("Importing uvloop failed. Falling back to asyncio, which is slower.") 26 | asyncio.run(func(*args, **kwargs)) 27 | except KeyboardInterrupt: 28 | pass 29 | 30 | def run_http(args): 31 | run_async(http.main, args) 32 | 33 | def main(): 34 | parser = argparse.ArgumentParser( 35 | prog="wisp-server-python", 36 | description=f"A Wisp server implementation, written in Python (v{wisp.version})" 37 | ) 38 | 39 | parser.add_argument("--host", default="127.0.0.1", help="The hostname the server will listen on.") 40 | parser.add_argument("--port", default=6001, help="The TCP port the server will listen on.") 41 | parser.add_argument("--static", help="Where static files are served from.") 42 | parser.add_argument("--limits", action="store_true", help="Enable rate limits.") 43 | parser.add_argument("--bandwidth", default=1000, help="Bandwidth limit per IP, in kilobytes per second.") 44 | parser.add_argument("--connections", default=30, help="New connections limit per IP.") 45 | parser.add_argument("--window", default=60, help="Fixed window length for rate limits, in seconds.") 46 | parser.add_argument("--allow-loopback", action="store_true", help="Allow connections to loopback IP addresses.") 47 | parser.add_argument("--allow-private", action="store_true", help="Allow connections to private IP addresses.") 48 | parser.add_argument("--log-level", default="info", help="The log level (either debug, info, warning, error, or critical).") 49 | parser.add_argument("--threads", default=0, help="The number of threads to run the server on. By default it uses all CPU cores.") 50 | args = parser.parse_args() 51 | 52 | logging.basicConfig( 53 | format="[%(asctime)s] %(levelname)-8s %(message)s", 54 | level=getattr(logging, args.log_level.upper()), 55 | datefmt="%Y/%m/%d - %H:%M:%S" 56 | ) 57 | 58 | logging.info(f"running wisp-server-python v{wisp.version} (async)") 59 | if args.static: 60 | static_path = pathlib.Path(args.static).resolve() 61 | logging.info(f"serving static files from {static_path}") 62 | if args.limits: 63 | logging.info("enabled rate limits") 64 | logging.info(f"listening on {args.host}:{args.port}") 65 | 66 | threads = int(args.threads) 67 | if net.reuse_port_supported(): 68 | if threads == 0: 69 | threads = multiprocessing.cpu_count() 70 | logging.info(f"running using {threads} threads") 71 | 72 | processes = [] 73 | for i in range(0, int(threads)): 74 | process = multiprocessing.Process(target=run_http, args=(args,), daemon=True) 75 | processes.append(process) 76 | process.start() 77 | try: 78 | for process in processes: 79 | process.join() 80 | except KeyboardInterrupt: 81 | pass 82 | 83 | else: 84 | if threads != 0: 85 | logging.warn("the --threads option is not supported on this platform") 86 | run_http(args) -------------------------------------------------------------------------------- /src/wisp/server/connection.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import struct 3 | import os 4 | import logging 5 | 6 | from websockets.exceptions import ConnectionClosed 7 | 8 | from wisp.server import ratelimit 9 | from wisp.server import net 10 | 11 | queue_size = 128 12 | static_path = None 13 | 14 | #wisp packet format definitions 15 | #see https://docs.python.org/3/library/struct.html for what these characters mean 16 | packet_format = " ratelimit.connections_limit: 84 | await self.send_close_packet(stream_id, 0x49) 85 | self.close_stream(stream_id) 86 | return 87 | 88 | #info looks valid - try to open the connection now 89 | try: 90 | if stream_type == 0x01: 91 | connection = net.TCPConnection(hostname, destination_port) 92 | elif stream_type == 0x02: 93 | connection = net.UDPConnection(hostname, destination_port) 94 | else: 95 | raise Exception("Invalid stream type.") 96 | self.active_streams[stream_id]["conn"] = connection 97 | await connection.connect() 98 | 99 | except Exception as e: 100 | logging.warn(f"({self.id}) Creating a new stream to {hostname}:{destination_port} failed: {e}") 101 | await self.send_close_packet(stream_id, 0x42) 102 | self.close_stream(stream_id) 103 | return 104 | 105 | self.active_streams[stream_id]["type"] = stream_type 106 | ws_to_tcp_task = asyncio.create_task(self.task_wrapper(self.stream_ws_to_tcp, stream_id)) 107 | tcp_to_ws_task = asyncio.create_task(self.task_wrapper(self.stream_tcp_to_ws, stream_id)) 108 | self.active_streams[stream_id]["ws_to_tcp_task"] = ws_to_tcp_task 109 | self.active_streams[stream_id]["tcp_to_ws_task"] = tcp_to_ws_task 110 | 111 | ratelimit.inc_client_attr(self.client_ip, "streams") 112 | 113 | async def task_wrapper(self, target_func, *args, **kwargs): 114 | try: 115 | await target_func(*args, **kwargs) 116 | except asyncio.CancelledError as e: 117 | raise e 118 | 119 | async def stream_ws_to_tcp(self, stream_id): 120 | #this infinite loop should get killed by the task.cancel call later on 121 | while True: 122 | stream = self.active_streams[stream_id] 123 | data = await stream["queue"].get() 124 | try: 125 | await stream["conn"].send(data) 126 | except: 127 | break 128 | 129 | #send a CONTINUE packet periodically 130 | stream["packets_sent"] += 1 131 | if stream["packets_sent"] % (queue_size // 4) == 0: 132 | buffer_remaining = stream["queue"].maxsize - stream["queue"].qsize() 133 | continue_payload = struct.pack(continue_format, buffer_remaining) 134 | continue_packet = struct.pack(packet_format, 0x03, stream_id) + continue_payload 135 | await self.ws.send(continue_packet) 136 | 137 | async def stream_tcp_to_ws(self, stream_id): 138 | while True: 139 | stream = self.active_streams[stream_id] 140 | try: 141 | data = await stream["conn"].recv() 142 | except Exception as e: 143 | logging.warn(f"({self.id}) Receiving data from stream failed: {e}") 144 | await self.send_close_packet(stream_id, 0x03) 145 | self.close_stream(stream_id) 146 | return 147 | 148 | if len(data) == 0: #connection closed 149 | break 150 | data_packet = struct.pack(packet_format, 0x02, stream_id) + data 151 | 152 | await ratelimit.limit_client_bandwidth(self.client_ip, len(data_packet), "tcp") 153 | await self.ws.send(data_packet) 154 | 155 | await self.send_close_packet(stream_id, 0x02) 156 | self.close_stream(stream_id) 157 | 158 | async def send_close_packet(self, stream_id, reason): 159 | if not stream_id in self.active_streams: 160 | return 161 | close_payload = struct.pack(close_format, reason) 162 | close_packet = struct.pack(packet_format, 0x04, stream_id) + close_payload 163 | await self.ws.send(close_packet) 164 | 165 | def close_stream(self, stream_id): 166 | if not stream_id in self.active_streams: 167 | return #stream already closed 168 | stream = self.active_streams[stream_id] 169 | if stream["conn"]: 170 | stream["conn"].close() 171 | 172 | #kill the running tasks associated with this stream 173 | if not stream["connect_task"].done(): 174 | stream["connect_task"].cancel() 175 | if stream["ws_to_tcp_task"] is not None and not stream["ws_to_tcp_task"].done(): 176 | stream["ws_to_tcp_task"].cancel() 177 | if stream["tcp_to_ws_task"] is not None and not stream["tcp_to_ws_task"].done(): 178 | stream["tcp_to_ws_task"].cancel() 179 | 180 | del self.active_streams[stream_id] 181 | 182 | async def handle_ws(self): 183 | while True: 184 | try: 185 | data = await self.ws.recv() 186 | except ConnectionClosed: 187 | break 188 | except Exception as e: 189 | logging.warn(f"({self.id}) Receiving data from websocket failed: {e}") 190 | break 191 | 192 | if not isinstance(data, bytes): 193 | continue #ignore non binary frames 194 | 195 | #implement bandwidth limits 196 | await ratelimit.limit_client_bandwidth(self.client_ip, len(data), "ws") 197 | 198 | #get basic packet info 199 | payload = data[5:] 200 | packet_type, stream_id = struct.unpack(packet_format, data[:5]) 201 | 202 | if packet_type == 0x01: #CONNECT packet 203 | connect_task = asyncio.create_task(self.task_wrapper(self.new_stream, stream_id, payload)) 204 | self.active_streams[stream_id] = { 205 | "conn": None, 206 | "type": None, 207 | "queue": asyncio.Queue(queue_size), 208 | "connect_task": connect_task, 209 | "ws_to_tcp_task": None, 210 | "tcp_to_ws_task": None, 211 | "packets_sent": 0 212 | } 213 | 214 | elif packet_type == 0x02: #DATA packet 215 | stream = self.active_streams.get(stream_id) 216 | if not stream: 217 | continue 218 | await stream["queue"].put(payload) 219 | 220 | elif packet_type == 0x04: #CLOSE packet 221 | reason = struct.unpack(close_format, payload)[0] 222 | self.close_stream(stream_id) 223 | 224 | #close all active streams when the websocket disconnects 225 | for stream_id in list(self.active_streams.keys()): 226 | self.close_stream(stream_id) 227 | -------------------------------------------------------------------------------- /src/wisp/server/http.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import pathlib 3 | import mimetypes 4 | import logging 5 | import random 6 | 7 | from websockets.server import serve 8 | 9 | import wisp 10 | from wisp.server import connection 11 | from wisp.server import ratelimit 12 | from wisp.server import net 13 | 14 | async def connection_handler(websocket, path): 15 | client_ip = websocket.remote_address[0] 16 | if client_ip == "127.0.0.1" and "X-Real-IP" in websocket.request_headers: 17 | client_ip = websocket.request_headers["X-Real-IP"] 18 | origin = websocket.request_headers.get("Origin") 19 | 20 | conn_id = "".join(random.choices("1234567890abcdef", k=8)) 21 | logging.info(f"({conn_id}) incoming connection on {path} from {client_ip} (origin: {origin})") 22 | ratelimit.inc_client_attr(client_ip, "streams") 23 | 24 | if path.endswith("/"): 25 | wisp_conn = connection.WispConnection(websocket, path, client_ip, conn_id) 26 | await wisp_conn.setup() 27 | ws_handler = asyncio.create_task(wisp_conn.handle_ws()) 28 | await asyncio.gather(ws_handler) 29 | 30 | else: 31 | stream_count = ratelimit.get_client_attr(client_ip, "streams") 32 | if ratelimit.enabled and stream_count > ratelimit.connections_limit: 33 | return 34 | wsproxy_conn = connection.WSProxyConnection(websocket, path, client_ip) 35 | await wsproxy_conn.setup_connection() 36 | ws_handler = asyncio.create_task(wsproxy_conn.handle_ws()) 37 | tcp_handler = asyncio.create_task(wsproxy_conn.handle_tcp()) 38 | await asyncio.gather(ws_handler, tcp_handler) 39 | 40 | async def static_handler(path, request_headers): 41 | if "Upgrade" in request_headers: 42 | return 43 | 44 | response_headers = [ 45 | ("Server", f"wisp-server-python v{wisp.version}") 46 | ] 47 | target_path = static_path / path[1:] 48 | 49 | if target_path.is_dir(): 50 | target_path = target_path / "index.html" 51 | if not target_path.is_relative_to(static_path): 52 | return 403, response_headers, "403 forbidden".encode() 53 | if not target_path.exists(): 54 | return 404, response_headers, "404 not found".encode() 55 | 56 | mimetype = mimetypes.guess_type(target_path.name)[0] 57 | response_headers.append(("Content-Type", mimetype)) 58 | 59 | static_data = await asyncio.to_thread(target_path.read_bytes) 60 | return 200, response_headers, static_data 61 | 62 | async def main(args): 63 | global static_path 64 | 65 | if args.static: 66 | static_path = pathlib.Path(args.static).resolve() 67 | request_handler = static_handler 68 | mimetypes.init() 69 | else: 70 | request_handler = None 71 | 72 | if args.limits: 73 | ratelimit.enabled = True 74 | ratelimit.connections_limit = int(args.connections) 75 | ratelimit.bandwidth_limit = float(args.bandwidth) 76 | ratelimit.window_size = float(args.window) 77 | 78 | net.block_loopback = not args.allow_loopback 79 | net.block_private = not args.allow_private 80 | 81 | limit_task = asyncio.create_task(ratelimit.reset_limits_timer()) 82 | ws_logger = logging.getLogger("websockets") 83 | ws_logger.setLevel(logging.WARN) 84 | 85 | reuse_port = net.reuse_port_supported() 86 | 87 | async with serve(connection_handler, args.host, int(args.port), reuse_port=reuse_port, process_request=request_handler, compression=None): 88 | await asyncio.Future() -------------------------------------------------------------------------------- /src/wisp/server/net.py: -------------------------------------------------------------------------------- 1 | import asyncudp 2 | import asyncio 3 | import socket 4 | import ipaddress 5 | 6 | #various network utilities and wrappers 7 | 8 | tcp_size = 64*1024 9 | block_loopback = False 10 | block_private = False 11 | 12 | def reuse_port_supported(): 13 | return hasattr(socket, "SO_REUSEPORT") 14 | 15 | def get_ip(host, port, stream_type): 16 | if stream_type == 0x01: 17 | proto = socket.IPPROTO_TCP 18 | else: 19 | proto = socket.IPPROTO_UDP 20 | info = socket.getaddrinfo(host, port, proto=proto) 21 | return info[0][4][0] 22 | 23 | async def get_ip_async(host, port, stream_type): 24 | loop = asyncio.get_running_loop() 25 | return await loop.run_in_executor(None, get_ip, host, port, stream_type) 26 | 27 | def validate_ip(addr_str): 28 | ip_addr = ipaddress.ip_address(addr_str) 29 | if block_loopback and ip_addr.is_loopback: 30 | raise TypeError("Connection to loopback ip address blocked.") 31 | if block_private and ip_addr.is_private and not ip_addr.is_loopback: 32 | raise TypeError("Connection to private ip address blocked.") 33 | 34 | async def validate_hostname(host, port, stream_type): 35 | addr_str = await get_ip_async(host, port, stream_type) 36 | validate_ip(addr_str) 37 | return addr_str 38 | 39 | class TCPConnection: 40 | def __init__(self, hostname, port): 41 | self.hostname = hostname 42 | self.port = port 43 | self.tcp_writer = None 44 | self.tcp_reader = None 45 | 46 | async def connect(self): 47 | addr_str = await validate_hostname(self.hostname, self.port, 0x01) 48 | self.tcp_reader, self.tcp_writer = await asyncio.open_connection(host=addr_str, port=self.port, limit=tcp_size) 49 | 50 | async def recv(self): 51 | return await self.tcp_reader.read(tcp_size) 52 | 53 | async def send(self, data): 54 | self.tcp_writer.write(data) 55 | await self.tcp_writer.drain() 56 | 57 | def close(self): 58 | if self.tcp_writer is None: 59 | return 60 | if self.tcp_writer.is_closing(): 61 | return 62 | self.tcp_writer.close() 63 | 64 | class UDPConnection: 65 | def __init__(self, hostname, port): 66 | self.hostname = hostname 67 | self.port = port 68 | self.socket = None 69 | 70 | async def connect(self): 71 | addr_str = await validate_hostname(self.hostname, self.port, 0x02) 72 | self.socket = await asyncudp.create_socket(remote_addr=(addr_str, self.port)) 73 | 74 | async def recv(self): 75 | data, addr = await self.socket.recvfrom() 76 | return data 77 | 78 | async def send(self, data): 79 | self.socket.sendto(data) 80 | 81 | def close(self): 82 | if self.socket is None: 83 | return 84 | self.socket.close() -------------------------------------------------------------------------------- /src/wisp/server/ratelimit.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import time 3 | 4 | #this file contains some helper functions for rate limiting 5 | #rate limiting uses a fixed window strategy for simplicity 6 | 7 | active_clients = {} 8 | enabled = False 9 | 10 | #max new streams per ip per minute 11 | connections_limit = 30 12 | #bandwidth limits per ip in kilobytes per second 13 | bandwidth_limit = 100 14 | #fixed window size, in seconds 15 | window_size = 60 16 | 17 | #rate limiting helper functions 18 | def init_client(client_ip): 19 | if not client_ip in active_clients: 20 | active_clients[client_ip] = { 21 | "streams": 0, #number of newly created streams 22 | "tcp": 0, #total tcp to ws traffic 23 | "ws": 0, #total ws to tcp traffic 24 | "start": time.time() 25 | } 26 | 27 | def get_client_attr(client_ip, attr): 28 | init_client(client_ip) 29 | return active_clients[client_ip][attr] 30 | 31 | def set_client_attr(client_ip, attr, value): 32 | init_client(client_ip) 33 | active_clients[client_ip][attr] = value 34 | 35 | def inc_client_attr(client_ip, attr, amount=1): 36 | set_client_attr(client_ip, attr, get_client_attr(client_ip, attr) + amount) 37 | 38 | def calculate_client_bandwidth(client_ip, attr): 39 | start_time = get_client_attr(client_ip, "start") 40 | total_data = get_client_attr(client_ip, attr) 41 | now = time.time() 42 | return total_data / (now - start_time) / 1000 43 | 44 | async def limit_client_bandwidth(client_ip, length, attr): 45 | if not enabled: return 46 | inc_client_attr(client_ip, attr, length) 47 | while calculate_client_bandwidth(client_ip, attr) > bandwidth_limit: 48 | await asyncio.sleep(0.01) 49 | 50 | async def reset_limits_timer(): 51 | global active_clients 52 | while True: 53 | active_clients = {} 54 | await asyncio.sleep(window_size) 55 | 56 | def limit_client_bandwidth_sync(client_ip, length, attr): 57 | if not enabled: return 58 | inc_client_attr(client_ip, attr, length) 59 | while calculate_client_bandwidth(client_ip, attr) > bandwidth_limit: 60 | time.sleep(0.01) 61 | 62 | def reset_limits_timer_sync(): 63 | global active_clients 64 | while True: 65 | active_clients = {} 66 | time.sleep(window_size) 67 | -------------------------------------------------------------------------------- /src/wisp/util.py: -------------------------------------------------------------------------------- 1 | import importlib.metadata 2 | 3 | def get_version(): 4 | try: 5 | return importlib.metadata.version("wisp-python") 6 | except TypeError: 7 | return "0.0.0" --------------------------------------------------------------------------------