├── .gitignore ├── LICENSE ├── README.md ├── config.ts ├── denoscuri.ts ├── errors.ts ├── request.ts ├── response.ts ├── server.ts ├── status.ts ├── tsconfig.json └── utils.ts /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # Snowpack dependency directory (https://snowpack.dev/) 45 | web_modules/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | .parcel-cache 78 | 79 | # Next.js build output 80 | .next 81 | out 82 | 83 | # Nuxt.js build / generate output 84 | .nuxt 85 | dist 86 | 87 | # Gatsby files 88 | .cache/ 89 | # Comment in the public line in if your project uses Gatsby and not Next.js 90 | # https://nextjs.org/blog/next-9-1#public-directory-support 91 | # public 92 | 93 | # vuepress build output 94 | .vuepress/dist 95 | 96 | # Serverless directories 97 | .serverless/ 98 | 99 | # FuseBox cache 100 | .fusebox/ 101 | 102 | # DynamoDB Local files 103 | .dynamodb/ 104 | 105 | # TernJS port file 106 | .tern-port 107 | 108 | # Stores VSCode versions used for testing VSCode extensions 109 | .vscode-test 110 | 111 | # yarn v2 112 | .yarn/cache 113 | .yarn/unplugged 114 | .yarn/build-state.yml 115 | .yarn/install-state.gz 116 | .pnp.* 117 | 118 | # denoscuri config 119 | config.json 120 | 121 | # test directories 122 | public_* 123 | 124 | # test certs/keys 125 | *.pem 126 | 127 | # package lock is only for deno plugin stuff 128 | package-lock.json -------------------------------------------------------------------------------- /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 637 | by 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 | # Denoscuri 2 | A simple [Gemini] server written using [Deno] and [Typescript]. 3 | 4 | ## Features: 5 | * Virtual host support 6 | * Static file serving 7 | * Visiting a directory serves index.gmi or index.gemini if it exists 8 | * Returns a gemtext listing of the directory if no index file exists 9 | * Request, response, and error logging 10 | 11 | ## Planned features: 12 | * Redirect/"Gone" support 13 | * Psuedo-CGI using dynamic import of typescript files 14 | * Input/query support 15 | * Breakout into libraries 16 | 17 | ## Unsupported features (likely won't implement): 18 | * Proxying 19 | * Rate limiting 20 | * Client certificates - subject to change, pending Deno support for them 21 | 22 | ## Configuration 23 | Create a configuration with one or more server blocks: 24 | ```json 25 | { 26 | "servers": [ 27 | { 28 | "hostname": "host_one", 29 | "port": 5555, 30 | "certFile": "/var/gemini/certs/host_one_cert.pem", 31 | "keyFile": "/var/gemini/certs/host_one_key.pem", 32 | "documentRoot": "/var/gemini/host_one", 33 | "logFile": "/var/gemini/logs/host_one.log" 34 | }, 35 | { 36 | "hostname": "host_two", 37 | "certFile": "/var/gemini/certs/host_two_cert.pem", 38 | "keyFile": "/var/gemini/certs/host_two_key.pem", 39 | "documentRoot": "/var/gemini/host_two", 40 | "logFile": "/var/gemini/logs/host_two.log", 41 | "requireCRLF": false 42 | } 43 | ] 44 | } 45 | ``` 46 | 47 | `port`, `requireCRLF`, and `logFile` are optional configuration items, which 48 | will default to `1965`, `true`, and `./.log`, respectively, if they 49 | are not present. All other options are required. 50 | 51 | ## Running 52 | Requires installation of [Deno]. 53 | 54 | ### Using local copy 55 | Clone the repository, then run the following commands, substituting 56 | appropriate values for the allow-read and allow-write parameters and passing 57 | the path to your config file: 58 | 59 | `deno run --allow-net --allow-read=/var/gemini --allow-write=/var/gemini/logs denoscuri.ts /var/gemini/config.json` 60 | 61 | ### Using an auto-fetched copy 62 | To fetch the latest version from master and run it: 63 | 64 | `deno run --allow-net --allow-read=/var/gemini --allow-write=/var/gemini/logs https://raw.githubusercontent.com/caranatar/denoscuri/master/denoscuri.ts /var/gemini/config.json` 65 | 66 | To fetch a tagged version (such as the current one): 67 | 68 | `deno run --allow-net --allow-read=/var/gemini --allow-write=/var/gemini/logs https://raw.githubusercontent.com/caranatar/denoscuri/v0.1.0/denoscuri.ts /var/gemini/config.json` 69 | 70 | ## Trivia 71 | "Denoscuri" is a portmanteau of Deno and Dioscuri - the Greek name for the 72 | twins Castor and Pollux, who became the constellation Gemini 73 | 74 | [Gemini]: https://gemini.circumlunar.space/ 75 | [Deno]: https://deno.land/ 76 | [Typescript]: https://www.typescriptlang.org/ -------------------------------------------------------------------------------- /config.ts: -------------------------------------------------------------------------------- 1 | import { canonicalize } from "./utils.ts"; 2 | 3 | /// Interface for a server config block 4 | interface IServerConfig { 5 | /// The hostname for this virtual host 6 | hostname: string; 7 | /// Option port to listen on (default: 1965) 8 | port?: number; 9 | /// Server certificate 10 | certFile: string; 11 | /// Server private key 12 | keyFile: string; 13 | /// Filesystem location of the root for the server 14 | documentRoot: string; 15 | /// If true, reject requests ending in only '\n' (default: true) 16 | requireCRLF?: boolean; 17 | /// Log file location (default: ./.log) 18 | logFile?: string; 19 | /// Redirects 20 | redirects?: { 21 | /// If true, this is a permanent redirect (default: false) 22 | permanent?: boolean; 23 | /// The source directory or file. Does not support wildcards 24 | source: string; 25 | /// The destination to redirect to 26 | destination: string; 27 | }[]; 28 | /// List of resources to mark as Gone 29 | goners?: [string]; 30 | } 31 | 32 | /** 33 | * Interface for the config file. 34 | * 35 | * The IServerConfig members are duplicated here due to a typescript issue I 36 | * couldn't figure out another way to work around. 37 | */ 38 | interface IConfig { 39 | servers: { 40 | hostname: string; 41 | port?: number; 42 | certFile: string; 43 | keyFile: string; 44 | documentRoot: string; 45 | requireCRLF?: boolean; 46 | logFile?: string; 47 | redirects?: { 48 | permanent?: boolean; 49 | source: string; 50 | destination: string; 51 | }[]; 52 | goners?: [string]; 53 | }[]; 54 | } 55 | 56 | /// Concrete server config 57 | export class ServerConfig { 58 | public hostname: string; 59 | public port: number; 60 | public certFile: string; 61 | public keyFile: string; 62 | public documentRoot: string; 63 | public requireCRLF: boolean; 64 | public logFile: string; 65 | public redirects: Record; 66 | public goners: string[]; 67 | 68 | constructor(c: IServerConfig) { 69 | this.hostname = c.hostname; 70 | this.port = c.port || 1965; 71 | this.certFile = c.certFile; 72 | this.keyFile = c.keyFile; 73 | this.documentRoot = c.documentRoot; 74 | this.requireCRLF = c.requireCRLF === false ? false : true; 75 | this.logFile = c.logFile || `./${this.hostname}.log`; 76 | this.redirects = {}; 77 | c.redirects?.forEach((r) => { 78 | const permanent = r.permanent || false; 79 | const destination = canonicalize(r.destination); 80 | const source = canonicalize(r.source); 81 | this.redirects[source] = { permanent, destination }; 82 | }); 83 | this.goners = c.goners ? c.goners.map((g) => canonicalize(g)) : []; 84 | } 85 | } 86 | 87 | /// Concrete config file 88 | export class Config { 89 | public servers: Array; 90 | constructor(c: IConfig) { 91 | this.servers = c.servers.map((s: IServerConfig) => new ServerConfig(s)); 92 | } 93 | 94 | static async fromConfigFile(configFile: string): Promise { 95 | const config: IConfig = JSON.parse(new TextDecoder("utf-8").decode(await Deno.readFile(configFile))); 96 | return new Config(config); 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /denoscuri.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Denoscuri A simple [Gemini] server written using [Deno] and [Typescript]. 3 | * 4 | * # Features: 5 | * * Virtual host support 6 | * * Static file serving 7 | * * Visiting a directory serves index.gmi or index.gemini if it exists 8 | * * Returns a gemtext listing of the directory if no index file exists 9 | * * Request, response, and error logging 10 | * 11 | * # Planned features: 12 | * * Redirect/"Gone" support 13 | * * Psuedo-CGI using dynamic import of typescript files 14 | * * Input/query support 15 | * * Breakout into libraries 16 | * 17 | * # Unsupported features (likely won't implement): 18 | * * Proxying 19 | * * Rate limiting 20 | * * Client certificates - subject to change, pending Deno support for them 21 | * 22 | * # Configuration 23 | * Create a configuration with one or more server blocks: 24 | * ```json 25 | * { 26 | * "servers": [ 27 | * { 28 | * "hostname": "host_one", 29 | * "port": 5555, 30 | * "certFile": "/var/gemini/certs/host_one_cert.pem", 31 | * "keyFile": "/var/gemini/certs/host_one_key.pem", 32 | * "documentRoot": "/var/gemini/host_one", 33 | * "logFile": "/var/gemini/logs/host_one.log" 34 | * }, 35 | * { 36 | * "hostname": "host_two", 37 | * "certFile": "/var/gemini/certs/host_two_cert.pem", 38 | * "keyFile": "/var/gemini/certs/host_two_key.pem", 39 | * "documentRoot": "/var/gemini/host_two", 40 | * "logFile": "/var/gemini/logs/host_two.log", 41 | * "requireCRLF": false 42 | * } 43 | * ] 44 | * } 45 | * ``` 46 | * 47 | * `port`, `requireCRLF`, and `logFile` are optional configuration items, which 48 | * will default to `1965`, `true`, and the `./.log`, respectively, if 49 | * they are not present. All other options are required. 50 | * 51 | * # Running 52 | * Requires installation of [Deno]. 53 | * 54 | * ## Using local copy 55 | * Clone the repository, then run the following commands, substituting 56 | * appropriate values for the allow-read and allow-write parameters and passing 57 | * the path to your config file: 58 | * 59 | * `deno run --allow-net --allow-read=/var/gemini --allow-write=/var/gemini/logs denoscuri.ts /var/gemini/config.json` 60 | * 61 | * ## Using an auto-fetched copy 62 | * TODO 63 | * 64 | * # Trivia 65 | * "Denoscuri" is a portmanteau of Deno and Dioscuri - the Greek name for the 66 | * twins Castor and Pollux, who became the constellation Gemini 67 | * 68 | * [Gemini]: https://gemini.circumlunar.space/ 69 | * [Deno]: https://deno.land/ 70 | * [Typescript]: https://www.typescriptlang.org/ 71 | */ 72 | import { Config } from "./config.ts"; 73 | import { Server } from "./server.ts"; 74 | import * as log from "https://deno.land/std/log/mod.ts"; 75 | 76 | // Ensure a config file was passed in 77 | const configFile = Deno.args[0] || null; 78 | if (!configFile) { 79 | console.error("Must supply a config file"); 80 | Deno.exit(1); 81 | } 82 | 83 | // Parse the config 84 | const config: Config = await Config.fromConfigFile(configFile); 85 | 86 | // Create the default console logger 87 | const logHandlers: any = { 88 | console: new log.handlers.ConsoleHandler("DEBUG"), 89 | }; 90 | 91 | // Create object to hold virtual-server-specific loggers 92 | const loggers: any = {}; 93 | 94 | // For each configured server, create a file handler and logger for it 95 | config.servers.forEach((c) => { 96 | logHandlers[`${c.hostname}_file`] = new log.handlers.FileHandler("INFO", { 97 | filename: c.logFile, 98 | }); 99 | loggers[`${c.hostname}`] = { 100 | level: "DEBUG", 101 | handlers: ["console", `${c.hostname}_file`], 102 | }; 103 | }); 104 | 105 | // Setup the loggers 106 | const logSetup = { 107 | handlers: logHandlers, 108 | loggers: loggers, 109 | }; 110 | await log.setup(logSetup); 111 | 112 | // Start each server 113 | config.servers.forEach((c) => { 114 | const server = new Server(c); 115 | server.start(); 116 | }); 117 | 118 | 119 | -------------------------------------------------------------------------------- /errors.ts: -------------------------------------------------------------------------------- 1 | import { StatusCode } from "./status.ts"; 2 | 3 | /// Abstract base error with a stupid name to avoid conflict with built-in Error 4 | export abstract class DError { 5 | /// Requires a message and Gemini status code 6 | constructor(public message: string, 7 | public code: StatusCode) { } 8 | } 9 | 10 | /// Unexpected line ending (e.g., server requires '\r\n' but received '\n') 11 | export class LineEndingError extends DError { 12 | constructor(expected: string) { 13 | super(`Server expects ${expected} line endings`, 14 | StatusCode.BAD_REQUEST); 15 | } 16 | } 17 | 18 | /// Requested resource does not exist 19 | export class NotFoundError extends DError { 20 | constructor(path: string) { 21 | super(`${path} does not exist`, 22 | StatusCode.NOT_FOUND); 23 | } 24 | } 25 | 26 | /// Insufficient permissions to access requested resource 27 | export class ForbiddenError extends DError { 28 | constructor(path: string) { 29 | super(`you do not have permissions to access ${path}`, 30 | StatusCode.NOT_FOUND); 31 | } 32 | } 33 | 34 | /// Proxy request received, but proxying is unsupported 35 | export class ProxyRefusedError extends DError { 36 | constructor(url: string) { 37 | super(`this server does not support proxying ${url}`, 38 | StatusCode.PROXY_REQUEST_REFUSED); 39 | } 40 | } 41 | 42 | /// Resource is Gone 43 | export class GoneError extends DError { 44 | constructor(path: string) { 45 | super(`${path} is Gone. Doneso. Caput.`, 46 | StatusCode.GONE); 47 | } 48 | } 49 | 50 | /// Temporary or permanent redirect 51 | export class RedirectError extends DError { 52 | constructor(path: string, permanent: boolean) { 53 | super(`${path}`, 54 | permanent ? StatusCode.REDIRECT_PERMANENT : StatusCode.REDIRECT_TEMPORARY); 55 | } 56 | } 57 | 58 | /// Catch-all internal error. Bad news. 59 | export class InternalError extends DError { 60 | public error: Error; 61 | 62 | constructor(e: Error) { 63 | super("An internal error occurred", 64 | StatusCode.PERMANENT_FAILURE); 65 | this.error = e; 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /request.ts: -------------------------------------------------------------------------------- 1 | import { urlParse } from 'https://deno.land/x/url_parse/mod.ts'; 2 | 3 | /// The necessary components of a parsed request 4 | export class GeminiRequest { 5 | /// The protocol (gemini:, http:, etc...) 6 | public protocol: string; 7 | /// The requested hostname 8 | public hostname: string; 9 | /// The requested path (/, /a/b/c, /x.gmi, etc...) 10 | public path: string; 11 | /// Optional params after a ?. Currently unused. 12 | public params?: URLSearchParams; 13 | 14 | /// Parses a request from the given string 15 | constructor(input: string) { 16 | const url = urlParse(input); 17 | this.protocol = url.protocol || "gemini:"; 18 | this.hostname = url.hostname; 19 | this.path = url.pathname || "/"; 20 | if (url.search) { 21 | this.params = url.searchParams; 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /response.ts: -------------------------------------------------------------------------------- 1 | import { StatusCode } from "./status.ts"; 2 | import { extname } from "https://deno.land/std/path/mod.ts"; 3 | import { lookup } from "https://deno.land/x/media_types/mod.ts"; 4 | import { NotFoundError, ForbiddenError, DError, InternalError } from "./errors.ts"; 5 | 6 | /** 7 | * Response header, consisting of a status code and "meta" string. 8 | */ 9 | export class ResponseHeader { 10 | constructor(public code: StatusCode, public meta: string) { 11 | } 12 | 13 | /** 14 | * Encode the header into a byte array 15 | */ 16 | public encode(): Uint8Array { 17 | return new TextEncoder().encode(`${this.code} ${this.meta}\r\n`); 18 | } 19 | 20 | /** 21 | * Create a new header with the Success (20) status and given mime type 22 | */ 23 | public static ok(mime: string): ResponseHeader { 24 | return new ResponseHeader(StatusCode.SUCCESS, mime); 25 | } 26 | } 27 | 28 | /** 29 | * Response body (which is just a byte array) 30 | */ 31 | export class ResponseBody { 32 | constructor(public contents: Uint8Array) { 33 | } 34 | } 35 | 36 | /** 37 | * A server response, with a required header and an optional body. No body is 38 | * present in the event of an error. 39 | */ 40 | export class GeminiResponse { 41 | constructor(public header: ResponseHeader, public body?: ResponseBody) { 42 | } 43 | 44 | /** 45 | * Encode whole response as a byte array 46 | */ 47 | public encode(): Uint8Array { 48 | const header = this.header.encode(); 49 | 50 | if (!this.body) return header; 51 | 52 | const body = this.body.contents; 53 | const encoded = new Uint8Array(header.length + body.length); 54 | encoded.set(header); 55 | encoded.set(body, header.length); 56 | return encoded; 57 | } 58 | 59 | /** 60 | * Creates a new Success (code 20) response with the given mime type and body 61 | */ 62 | public static ok(mime: string, body: ResponseBody) { 63 | return new GeminiResponse(ResponseHeader.ok(mime), body); 64 | } 65 | } 66 | 67 | /** 68 | * Helper methods for building responses from an error or path 69 | */ 70 | export class ResponseBuilder { 71 | public static async buildFromError(e: DError): Promise { 72 | return new GeminiResponse(new ResponseHeader(e.code, e.message)); 73 | } 74 | 75 | /** 76 | * Builds a response from a given url path. If it matches a file, return the 77 | * file with the appropriate mime type. If it matches a directory, return 78 | * index.gmi or index.gemini if it exists, otherwise return a gemtext document 79 | * representing a listing of the directory. 80 | * 81 | * Can throw the following: 82 | * NotFoundError - file or directory not found 83 | * ForbiddenError - permissions error 84 | * InternalError - some unknown error was caught 85 | */ 86 | public static async buildFromPath(docRoot: string, path: string): Promise { 87 | // Get the named path on the filesystem 88 | const filePath = [docRoot, path].join(''); 89 | try { 90 | // Get the fileinfo 91 | const pathInfo = await Deno.stat(filePath); 92 | 93 | if (pathInfo.isFile) { 94 | // If it's a path, get the mime type 95 | let mime; 96 | const extension = extname(filePath); 97 | if (extension === ".gmi" || extension === ".gemini") { 98 | mime = "text/gemini"; 99 | } else { 100 | mime = lookup(filePath); 101 | } 102 | 103 | // Read the contents of the file 104 | const contents = await Deno.readFile(filePath); 105 | 106 | // Create and return the response 107 | const body = new ResponseBody(contents); 108 | return GeminiResponse.ok(mime || "text/utf-8", body); 109 | } else if (pathInfo.isDirectory) { 110 | // Build a listing of entries in the directory in case there's no index. 111 | // Start with .. since it won't show up otherwise. 112 | const listing = [".."]; 113 | for await (const entry of Deno.readDir(filePath)) { 114 | if (entry.isFile && (entry.name === "index.gmi" || entry.name === "index.gemini")) { 115 | // Found an index file, return it 116 | return ResponseBuilder.buildFromPath(docRoot, [path, entry.name].join('/')); 117 | } else { 118 | // Add this non-index-file into the listing 119 | listing.push(entry.name + (entry.isDirectory ? "/" : "")); 120 | } 121 | } 122 | 123 | // We didn't find an index file, so let's turn the directory listing into 124 | // a list of gemtext links 125 | const links = listing.sort().map((entry) => { 126 | const relPath = [path, entry].join("/").replaceAll("//", "/"); 127 | return "=> " + relPath + " " + relPath; 128 | }); 129 | 130 | // Encode the listing and return the response 131 | const response = new TextEncoder().encode([`Listing of ${path}\n`, ...links].join("\n")); 132 | return GeminiResponse.ok("text/gemini", new ResponseBody(response)); 133 | } 134 | } catch (e) { 135 | if (e.name === "NotFound") { 136 | // Thrown by Deno.stat if the path doesn't exist 137 | throw new NotFoundError(path); 138 | } else if (e.name === "PermissionDenied") { 139 | // Thrown by Deno.stat if there's a permission error 140 | throw new ForbiddenError(path); 141 | } else { 142 | // ??? Just in case there's another error 143 | throw new InternalError(e); 144 | } 145 | } 146 | 147 | // ??? In case the entry isn't a file or directory? I don't think this should 148 | // happen because symlinks are followed? 149 | throw new NotFoundError(path); 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /server.ts: -------------------------------------------------------------------------------- 1 | import { ServerConfig } from "./config.ts"; 2 | import { GeminiRequest } from "./request.ts"; 3 | import { ResponseBuilder } from "./response.ts"; 4 | import { LineEndingError, ProxyRefusedError, GoneError, RedirectError } from "./errors.ts"; 5 | import { Logger, getLogger } from "https://deno.land/std/log/mod.ts"; 6 | import { StatusCode } from "./status.ts"; 7 | 8 | /// A Denoscuri virtual server, which receives and services incoming requests 9 | export class Server { 10 | /// The configuration for this server 11 | config: ServerConfig; 12 | /// This server's logger 13 | logger: Logger; 14 | 15 | /// Creates a new server from the given config 16 | constructor(c: ServerConfig) { 17 | this.config = c; 18 | this.logger = getLogger(this.config.hostname); 19 | } 20 | 21 | /// Starts the server 22 | public async start(): Promise { 23 | // Create a TLS socket 24 | const listener = Deno.listenTls({ 25 | hostname: this.config.hostname, 26 | port: this.config.port, 27 | certFile: this.config.certFile, 28 | keyFile: this.config.keyFile 29 | }); 30 | 31 | this.logger.info("♊ Listening on " + this.config.hostname + ":" + this.config.port); 32 | 33 | // Loop until the server is killed 34 | while (true) { 35 | try { 36 | for await (const conn of listener) { 37 | this.handle_connection(conn); 38 | } 39 | } catch (err) { 40 | if (err.name === 'BadResource') { 41 | // Ugly but expected when a connection is closed 42 | } else { 43 | // Because this error occurs outside of the connection servicing code 44 | // we cannot send a response to it 45 | this.logger.critical(`Unexpected error in Server::start ${err}`); 46 | } 47 | } 48 | } 49 | } 50 | 51 | /// Receives a request and then responds appropriately 52 | async handle_connection(conn: Deno.Conn) { 53 | // A request can only be 1024 bytes plus two bytes for CRLF. Technically, 54 | // this allows for a 1025 byte request if requireCRLF is false in the server 55 | // config, but such a server is already noncompliant with the standard :) 56 | let buffer = new Uint8Array(1026); 57 | const count = await conn.read(buffer); 58 | 59 | // Nothing received. Don't reply. 60 | if (!count) return; 61 | 62 | // Get the actual request contents 63 | const msg = buffer.subarray(0, count); 64 | 65 | // Parse the request then build a response, including if an error occurred 66 | const res = await this.parse_request(msg) 67 | .then(async (req) => this.goner_check(req)) 68 | .then(async (req) => this.redirect_check(req)) 69 | .then(async (req) => ResponseBuilder.buildFromPath(this.config.documentRoot, req.path)) 70 | .catch(async (e) => { 71 | if (e.code === StatusCode.PERMANENT_FAILURE) { 72 | this.logger.critical(`Internal error: ${e.error}`); 73 | } 74 | return ResponseBuilder.buildFromError(e); 75 | }); 76 | 77 | this.logger.debug(`Sending response header: ${JSON.stringify(res.header)}`); 78 | 79 | // Write the response 80 | await conn.write(res.encode()); 81 | 82 | // Close the connection 83 | conn.close(); 84 | } 85 | 86 | /// Parses the incoming request into a GeminiRequest object 87 | async parse_request(buffer: Uint8Array): Promise { 88 | // Decode the request as UTF-8 89 | const req_str = new TextDecoder("utf-8").decode(buffer); 90 | this.logger.debug(() => `Received request: ${req_str.replace("\r", "\\r").replace("\n", "\\n")}`); 91 | 92 | // Check for valid line ending in request 93 | if ((this.config.requireCRLF && req_str.substr(-2) !== "\r\n") 94 | || req_str.substr(-1) !== "\n") { 95 | throw new LineEndingError(this.config.requireCRLF ? "\\r\\n" : "\\n"); 96 | } 97 | 98 | // Create the actual request object 99 | const req = new GeminiRequest(req_str); 100 | 101 | // Check for unsupported proxying 102 | if (req.hostname !== this.config.hostname || req.protocol !== "gemini:") { 103 | throw new ProxyRefusedError(req_str); 104 | } 105 | 106 | // Return the request 107 | return req; 108 | } 109 | 110 | /// Checks if the incoming request is for a resource marked Gone 111 | async goner_check(req: GeminiRequest): Promise { 112 | if (this.config.goners.length === 0) return req; 113 | 114 | const goner = this.config.goners.filter((g) => req.path.startsWith(g)); 115 | 116 | if (goner.length !== 0) { 117 | throw new GoneError(req.path); 118 | } else { 119 | return req; 120 | } 121 | } 122 | 123 | async redirect_check(req: GeminiRequest): Promise { 124 | for (const k in this.config.redirects) { 125 | if (req.path.startsWith(k)) { 126 | const r = this.config.redirects[k]; 127 | const path = req.path.replace(k, r.destination); 128 | throw new RedirectError(path, r.permanent); 129 | } 130 | } 131 | return req; 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /status.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Gemini status codes. 3 | * See: gemini://gemini.circumlunar.space/docs/specification.gmi 4 | */ 5 | export enum StatusCode { 6 | INPUT = 10, 7 | INPUT_SENSITIVE = 11, 8 | SUCCESS = 20, 9 | REDIRECT_TEMPORARY = 30, 10 | REDIRECT_PERMANENT = 31, 11 | TEMPORARY_FAILURE = 40, 12 | SERVER_UNAVAILABLE = 41, 13 | CGI_ERROR = 42, 14 | PROXY_ERROR = 43, 15 | SLOW_DOWN = 44, 16 | PERMANENT_FAILURE = 50, 17 | NOT_FOUND = 51, 18 | GONE = 52, 19 | PROXY_REQUEST_REFUSED = 53, 20 | BAD_REQUEST = 54, 21 | CLIENT_CERT_REQUIRED = 60, 22 | CLIENT_CERT_UNAUTHORIZED = 61, 23 | CLIENT_CERT_INVALID = 62 24 | } 25 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "allowJs": false, 4 | "allowNonTsExtensions": true, 5 | "checkJs": false, 6 | "esModuleInterop": true, 7 | "jsx": "react", 8 | "module": "esnext", 9 | "resolveJsonModule": true, 10 | "strict": true, 11 | "removeComments": true, 12 | "target": "esnext", 13 | "plugins": [ 14 | { 15 | "name": "typescript-deno-plugin" 16 | } 17 | ] 18 | } 19 | } -------------------------------------------------------------------------------- /utils.ts: -------------------------------------------------------------------------------- 1 | export function canonicalize(url: string): string { 2 | let canon: String = url; 3 | 4 | if (!canon.startsWith('/')) { 5 | canon = '/' + url; 6 | } 7 | 8 | if (canon.endsWith('/')) { 9 | canon = canon.substr(0, canon.length - 1); 10 | } 11 | 12 | return canon.valueOf(); 13 | } 14 | --------------------------------------------------------------------------------