├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ └── CI.yml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SiteShield.lua └── docs └── siteshield.svg /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: [ main ] 5 | pull_request: 6 | branches: [ main ] 7 | workflow_dispatch: 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: luacheck 13 | uses: nebularg/actions-luacheck@v1.1.0 14 | with: 15 | args: '-qo 011' 16 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 11 | build. 12 | 2. Update the README.md with details of changes to the interface, this includes new environment 13 | variables, exposed ports, useful file locations and container parameters. 14 | 15 | ## Code of Conduct 16 | 17 | ### Our Pledge 18 | 19 | In the interest of fostering an open and welcoming environment, we as 20 | contributors and maintainers pledge to making participation in our project and 21 | our community a harassment-free experience for everyone, regardless of age, body 22 | size, disability, ethnicity, gender identity and expression, level of experience, 23 | nationality, personal appearance, race, religion, or sexual identity and 24 | orientation. 25 | 26 | ### Our Standards 27 | 28 | Examples of behavior that contributes to creating a positive environment 29 | include: 30 | 31 | * Using welcoming and inclusive language 32 | * Being respectful of differing viewpoints and experiences 33 | * Gracefully accepting constructive criticism 34 | * Focusing on what is best for the community 35 | * Showing empathy towards other community members 36 | 37 | Examples of unacceptable behavior by participants include: 38 | 39 | * The use of sexualized language or imagery and unwelcome sexual attention or 40 | advances 41 | * Trolling, insulting/derogatory comments, and personal or political attacks 42 | * Public or private harassment 43 | * Publishing others' private information, such as a physical or electronic 44 | address, without explicit permission 45 | * Other conduct which could reasonably be considered inappropriate in a 46 | professional setting 47 | 48 | ### Our Responsibilities 49 | 50 | Project maintainers are responsible for clarifying the standards of acceptable 51 | behavior and are expected to take appropriate and fair corrective action in 52 | response to any instances of unacceptable behavior. 53 | 54 | Project maintainers have the right and responsibility to remove, edit, or 55 | reject comments, commits, code, wiki edits, issues, and other contributions 56 | that are not aligned to this Code of Conduct, or to ban temporarily or 57 | permanently any contributor for other behaviors that they deem inappropriate, 58 | threatening, offensive, or harmful. 59 | 60 | ### Scope 61 | 62 | This Code of Conduct applies both within project spaces and in public spaces 63 | when an individual is representing the project or its community. Examples of 64 | representing a project or community include using an official project e-mail 65 | address, posting via an official social media account, or acting as an appointed 66 | representative at an online or offline event. Representation of a project may be 67 | further defined and clarified by project maintainers. 68 | 69 | ### Enforcement 70 | 71 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 72 | reported by contacting the project team at [INSERT EMAIL ADDRESS]. All 73 | complaints will be reviewed and investigated and will result in a response that 74 | is deemed necessary and appropriate to the circumstances. The project team is 75 | obligated to maintain confidentiality with regard to the reporter of an incident. 76 | Further details of specific enforcement policies may be posted separately. 77 | 78 | Project maintainers who do not follow or enforce the Code of Conduct in good 79 | faith may face temporary or permanent repercussions as determined by other 80 | members of the project's leadership. 81 | 82 | ### Attribution 83 | 84 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 85 | available at [http://contributor-covenant.org/version/1/4][version] 86 | 87 | [homepage]: http://contributor-covenant.org 88 | [version]: http://contributor-covenant.org/version/1/4/ 89 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

SiteShield OpenResty

4 |

Advanced Layer 7 HTTP(s) DDoS Mitigation module for OpenResty ("dynamic web platform based on NGINX and LuaJIT")

5 |

6 |

7 | 8 |

9 | 10 | ## Features 11 | 12 | * **Layer 7 DDoS Mitigation** via JavaScript Challenge. 13 | * Firewall 14 | * Allow IP Address (Bypass JavaScript Challenge) 15 | * Block IP Address 16 | * Allow URI (Bypass JavaScript Challenge) 17 | * Block URI 18 | * SEO Optimised (Popular Search Engines Bypass JavaScript Challenge) 19 | * Variable Challenge Authentication Time Window 20 | * Variable Rate limit on Served Challenges 21 | 22 | ## Coming Soon 23 | 24 | * Google Recaptcha Challenge 25 | * Invisible JavaScript Challenge 26 | * On Detection Mitigation (currently Always On) 27 | * Automatic Installer Script (Requires Fresh/Vanilla Install) 28 | 29 | 30 | ## Getting Started 31 | 32 | Below we will go through installing SiteShield-OpenResty on a CentOS 7.9.2009 (Core) linux server, from zero to a fully fledged HTTP reverse proxy, with Layer 7 DDoS Mitigation. 33 | 34 | 35 | ## Prerequisites 36 | 37 | You'll need to install a few dependencies that SiteShield-OpenResty utilises. 38 | 39 | ``` 40 | yum install gcc ipset iptables bind-utils -y 41 | ``` 42 | 43 | ### OpenResty 44 | 45 | ``` 46 | wget https://openresty.org/package/centos/openresty.repo 47 | sudo mv openresty.repo /etc/yum.repos.d/ 48 | yum check-update 49 | yum install openresty -y 50 | useradd -r nginx 51 | ``` 52 | 53 | 54 | ### Redis 55 | 56 | First, install redis server: 57 | 58 | ``` 59 | yum install epel-release -y 60 | yum install redis -y 61 | ``` 62 | 63 | 64 | ### Sockproc 65 | 66 | ``` 67 | wget https://raw.githubusercontent.com/dbContext/sockproc/master/sockproc.c 68 | gcc sockproc.c -o sockproc 69 | ./sockproc /tmp/shell.sock 70 | chmod +x /tmp/shell.sock 71 | ``` 72 | 73 | 74 | ### Shell 75 | 76 | ``` 77 | mkdir /usr/local/openresty/lualib/resty/lua-resty-shell 78 | wget https://raw.githubusercontent.com/dbContext/lua-resty-shell/master/lib/resty/shell.lua 79 | mv shell.lua /usr/local/openresty/lualib/resty/lua-resty-shell 80 | ``` 81 | 82 | 83 | ## Configuring Network Firewall 84 | 85 | By dropping the IP address at the network interface, we're removing the overhead of OpenResty (CPU) processing the bad requests - greatly improving mitigation throughput. 86 | 87 | ``` 88 | ipset create siteshield-droplist hash:ip hashsize 4096 89 | 90 | iptables -I INPUT -m set --match-set siteshield-droplist src -j DROP 91 | iptables -I FORWARD -m set --match-set siteshield-droplist src -j DROP 92 | ``` 93 | 94 | 95 | ## Installing SiteShield 96 | 97 | First, download `SiteShield.lua` to the relevant OpenResty/Nginx Directory. 98 | 99 | ``` 100 | wget https://raw.githubusercontent.com/dbContext/SiteShield-OpenResty/main/SiteShield.lua 101 | mv SiteShield.lua /usr/local/openresty/nginx/conf 102 | ``` 103 | 104 | Lastly, you'll now want to alter your nginx.conf, to utilise `SiteShield.lua`. 105 | 106 | ``` 107 | ... 108 | server { 109 | 110 | ... 111 | 112 | set $auth_time '86400'; # Time User is Authenticated after Challenge in seconds. 113 | set $allow_ip ''; # format: 1.1.1.1;2.2.2.2;3.3.3.3 114 | set $block_ip ''; # format: 4.4.4.4;5.5.5.5;6.6.6.6 115 | set $allow_uri ''; # format: /allow-this-uri;/also/allow/this/uri 116 | set $block_uri ''; # format: /block-this-uri;/also/block/this/uri 117 | set $max_failed_challenge_attempts '5'; # Max Failed Challenge Attempts before IP block. 118 | set $max_time_window_challenges '120'; # Max Challenges Served in Time Window (e.g. 5 Challenges with in 120 seconds.) 119 | 120 | location / { 121 | content_by_lua_file /usr/local/openresty/nginx/conf/SiteShield.lua; 122 | } 123 | 124 | error_page 555 = @backend; 125 | 126 | location @backend { 127 | proxy_set_header Host $host; 128 | proxy_set_header SiteShield-Real-IP $remote_addr; 129 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 130 | proxy_http_version 1.1; 131 | proxy_set_header Connection ''; 132 | proxy_redirect off; 133 | proxy_buffering off; 134 | proxy_pass http://google.com; 135 | } 136 | } 137 | ... 138 | ``` 139 | 140 | 141 | ## Ready to go! 142 | 143 | If everything above went as expected, after restarting the relevant services (commands below), you'll have a HTTP Reverse Proxy with Layer 7 DDoS Mitigation. 144 | 145 | ``` 146 | service redis restart 147 | service openresty restart 148 | ``` 149 | 150 | ## Contributing 151 | 152 | Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. 153 | 154 | 155 | ## Authors 156 | 157 | * **[dbContext](https://github.com/dbContext)** - *Initial work* 158 | 159 | See also the list of [contributors](https://github.com/dbContext/SiteShield-OpenResty/contributors) who participated in this project. 160 | 161 | 162 | ## License 163 | 164 | This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details 165 | 166 | 167 | ## Acknowledgments 168 | 169 | * **[openresty](https://github.com/openresty/openresty)** 170 | * **[redis](https://github.com/redis/redis)** 171 | * **[lua-resty-shell](https://github.com/juce/lua-resty-shell)** 172 | * **[sockproc](https://github.com/juce/sockproc)** 173 | -------------------------------------------------------------------------------- /SiteShield.lua: -------------------------------------------------------------------------------- 1 | local redis = require "resty.redis" 2 | local resty_sha1 = require "resty.sha1" 3 | local str = require "resty.string" 4 | local shell = require "resty.lua-resty-shell.shell" 5 | 6 | local remote_ip = ngx.var.remote_addr 7 | local domain = ngx.var.host 8 | local useragent = ngx.req.get_headers()['User-Agent'] 9 | if useragent == nil then 10 | useragent = "nilua" 11 | end 12 | local uri = ngx.var.request_uri 13 | local auth = 0 14 | local timestamp = 0 15 | local question = 0 16 | local answer = 0 17 | 18 | local sha1 = resty_sha1:new() 19 | local str_hash = sha1:update(remote_ip .. domain .. useragent) 20 | local digest = sha1:final() 21 | local usr_hash = str.to_hex(digest) 22 | 23 | local math_random = math.random 24 | local math_floor = math.floor 25 | local string_gmatch = string.gmatch 26 | local string_find = string.find 27 | local string_sub = string.sub 28 | local string_gsub = string.gsub 29 | local string_char = string.char 30 | 31 | local maxFailedChallengeAttempts = ngx.var.max_failed_challenge_attempts 32 | local maxTimeWindowChallenges = ngx.var.max_time_window_challenges 33 | 34 | local red = redis:new() 35 | local ok, err = red:connect("127.0.0.1", 6379) 36 | if not ok then 37 | ngx.header["Content-type"] = "text/html" 38 | ngx.say("failed to connect to redis, please reload to try again.") 39 | return 40 | end 41 | 42 | local shellSockArgs = { socket = "unix:/tmp/shell.sock" } 43 | 44 | function GENINT() 45 | local randloop = math_random(10) 46 | local genplace 47 | local genanswer = 0 48 | local genstring = "" 49 | local tabbed = "" 50 | local spaced = "" 51 | for i = 0, randloop do 52 | genplace = 0; 53 | local genint = math_floor(math_random(15)) 54 | genanswer = genanswer + genint 55 | while genplace ~= genint do 56 | genplace = genplace + 1 57 | if (math_random(9) > math_random(9)) then 58 | genstring = genstring .. "+(" .. GEN(1) .. ")" 59 | else 60 | local randlooptab = math_floor(math_random(2)) 61 | for i = 0, randlooptab do 62 | tabbed = tabbed .. " " 63 | end 64 | local randloopspace = math_floor(math_random(2)) 65 | for i = 0, randloopspace do 66 | spaced = spaced .. " " 67 | end 68 | genstring = genstring .. "+(" .. GEN(1) .. ")" .. tabbed .. spaced 69 | end 70 | end 71 | end 72 | return genstring, genanswer 73 | end 74 | 75 | function GEN(id) 76 | local gen = ""; 77 | if id == 1 then 78 | local count = math_floor(math_random(2)) 79 | local randcount = math_floor(math_random(count)) 80 | for i = 1, count do 81 | local rand = math_floor(math_random(3)) 82 | if (i == randcount) then 83 | if (rand == 1) then 84 | gen = gen .. "+(" .. math_random(99) + 55 .. " > " .. math_random(34) + 10 .. ")" 85 | end 86 | if (rand == 2) then 87 | gen = gen .. "+(" .. math_random(74) + 5 .. " < " .. math_random(44) + 85 .. ")" 88 | end 89 | if (rand == 3) then 90 | local randint = math_random(149) + 30 91 | gen = gen .. "+(" .. randint .. " == " .. randint .. ")" 92 | end 93 | else 94 | if (rand == 1) then 95 | gen = gen .. "+(" .. math_random(34) + 15 .. " > " .. math_random(64) + 65 .. ")" 96 | end 97 | if (rand == 2) then 98 | gen = gen .. "+(" .. math_random(74) + 55 .. " < " .. math_random(14) + 25 .. ")" 99 | end 100 | if (rand == 3) then 101 | gen = gen .. "+(" .. math_random(74) + 55 .. " == " .. math_random(14) + 24 .. ")" 102 | end 103 | end 104 | end 105 | else 106 | local count = math_floor(math_random(9)) 107 | for i = 0, count do 108 | local rand = math_floor(math_random(3)) 109 | if (rand == 1) then 110 | gen = gen .. "+(" .. math_random(34) + 15 .. " > " .. math_random(64) + 55 .. ")" 111 | end 112 | if (rand == 2) then 113 | gen = gen .. "+(" .. math_random(74) + 45 .. " < " .. math_random(14) + 25 .. ")" 114 | end 115 | if (rand == 3) then 116 | gen = gen .. "+(" .. math_floor(math_random(74) + 35) .. " == " .. math_floor(math_random(14) + 24) .. ")" 117 | end 118 | end 119 | end 120 | return gen 121 | end 122 | 123 | function genString(l) 124 | local s = "" 125 | for i = 1, l do 126 | s = s .. string_char(math_random(97, 122)) 127 | end 128 | return s 129 | end 130 | 131 | function CHALLENGE() 132 | 133 | if (string_find(useragent, "WordPress")) then 134 | shell.execute("ipset add siteshield-droplist " .. remote_ip, shellSockArgs) 135 | red:close() 136 | ngx.header["Content-type"] = "text/html" 137 | ngx.exit(444) 138 | return 139 | end 140 | 141 | if (string_find(useragent, "Googlebot") or 142 | string_find(useragent, "bingbot") or 143 | string_find(useragent, "Yahoo") or 144 | string_find(useragent, "DuckDuckBot")) then 145 | 146 | local getHostname = io.popen("dig -x " .. remote_ip .. " +short") 147 | local resolvedHostname = getHostname:read("*a") 148 | getHostname:close() 149 | 150 | local getIP = io.popen("getent hosts " .. resolvedHostname) 151 | local resolvedIP = getIP:read("*a") 152 | getIP:close() 153 | 154 | if (string_find(resolvedHostname, "google.com") or 155 | string_find(resolvedHostname, "googlebot.com") or 156 | string_find(resolvedHostname, "search.msn.com") or 157 | string_find(resolvedHostname, "crawl.yahoo.net") or 158 | string_find(resolvedHostname, "duckduckbot.duckduckgo.com")) then 159 | 160 | if (string_find(resolvedIP, remote_ip)) then 161 | 162 | red:hmset(usr_hash, "auth", 1, "timestamp", os.time() + 7200, "question", 0, "answer", 0, "hitcount", 0, "hitcounttimestamp", 0, "questionarg", 0, "answerarg", 0) 163 | red:persist(usr_hash) 164 | red:close() 165 | 166 | ngx.header["Content-type"] = "text/html" 167 | ngx.exit(555) 168 | 169 | return 170 | 171 | end 172 | 173 | end 174 | 175 | red:close() 176 | ngx.header["Content-type"] = "text/html" 177 | ngx.exit(444) 178 | return 179 | 180 | end 181 | 182 | local res, err = red:hmget(usr_hash, "hitcount", "hitcounttimestamp") 183 | local hitcount = res[1] 184 | local timestamp = res[2] 185 | 186 | if tonumber(hitcount) == 0 then 187 | red:hmset(usr_hash, "hitcount", 1, "hitcounttimestamp", os.time()) 188 | else 189 | red:hincrby(usr_hash, "hitcount", 1) 190 | if (tonumber(hitcount) >= tonumber(maxFailedChallengeAttempts)) then 191 | local diff = os.time() - timestamp 192 | if (tonumber(diff) <= tonumber(maxTimeWindowChallenges)) then 193 | shell.execute("ipset add siteshield-droplist " .. remote_ip, shellSockArgs) 194 | red:close() 195 | ngx.header["Content-type"] = "text/html" 196 | ngx.exit(444) 197 | return 198 | end 199 | if (tonumber(diff) >= tonumber(maxTimeWindowChallenges)) then 200 | red:hmset(usr_hash, "hitcount", 0, "hitcounttimestamp", 0) 201 | end 202 | end 203 | end 204 | 205 | local jsvar = genString(math_random(15)) 206 | local question = genString(math_random(30)) 207 | local randloop = math_random(5) 208 | local buff = 0 209 | local answertotal = 0 210 | local jstotal = "" 211 | local jstype 212 | 213 | for i = 0, tonumber(randloop) do 214 | local js, jsanswer = GENINT() 215 | if (buff == 0) then 216 | jstotal = jstotal .. "var " .. jsvar .. " = " .. js .. ";" 217 | answertotal = jsanswer 218 | buff = buff + 1 219 | else 220 | local randtype = math_floor(math_random(4)) 221 | if (randtype == 1) then 222 | answertotal = answertotal + jsanswer 223 | jstype = "+" 224 | end 225 | if (randtype == 2) then 226 | answertotal = answertotal - jsanswer 227 | jstype = "-" 228 | end 229 | if (randtype == 3) then 230 | answertotal = answertotal * jsanswer 231 | jstype = "*" 232 | end 233 | if (randtype == 4) then 234 | answertotal = answertotal / jsanswer 235 | jstype = "/" 236 | end 237 | jstotal = jstotal .. jsvar .. jstype .. "= " .. js .. ";" 238 | end 239 | end 240 | 241 | if (string_find(answertotal, "0.")) then 242 | local forceRange = math_floor(math_random(51)) 243 | jstotal = jstotal .. jsvar .. " += " .. forceRange .. ";" 244 | answertotal = answertotal + forceRange 245 | end 246 | 247 | local stringsub = math_floor(math_random(10)) 248 | answertotal = string_sub(answertotal, 0, stringsub) 249 | local reloadtime = math_random(4) * 1000 250 | local expectedAuthenticationTime = math_random(2, 5) * 1000 251 | 252 | red:hmset(usr_hash, "question", question, "answer", answertotal, "eAT", expectedAuthenticationTime, "eATTime", os.time()) 253 | red:close() 254 | 255 | local func_name = genString(math_random(32)) 256 | local response = "DDoS Protection by SiteShield

Authenticating Request.

DDoS Protection by Site Shield

" 257 | 258 | ngx.header["Content-type"] = "text/html" 259 | ngx.say(response) 260 | return 261 | 262 | end 263 | 264 | function AUTH() 265 | if (string_find(useragent, "WordPress")) then 266 | shell.execute("ipset add siteshield-droplist " .. remote_ip, shellSockArgs) 267 | red:close() 268 | ngx.header["Content-type"] = "text/html" 269 | ngx.exit(444) 270 | return 271 | end 272 | 273 | local res, err = red:hmget(usr_hash, "hitcount", "hitcounttimestamp") 274 | local hitcount = res[1] 275 | local timestamp = res[2] 276 | 277 | if tonumber(hitcount) == 0 then 278 | red:hmset(usr_hash, "hitcount", 1, "hitcounttimestamp", os.time()) 279 | else 280 | red:hincrby(usr_hash, "hitcount", 1) 281 | if (tonumber(hitcount) >= tonumber(maxFailedChallengeAttempts)) then 282 | local diff = os.time() - timestamp 283 | if (tonumber(diff) <= tonumber(maxTimeWindowChallenges)) then 284 | shell.execute("ipset add siteshield-droplist " .. remote_ip, shellSockArgs) 285 | red:close() 286 | ngx.header["Content-type"] = "text/html" 287 | ngx.exit(444) 288 | return 289 | end 290 | if (tonumber(diff) >= tonumber(maxTimeWindowChallenges)) then 291 | red:hmset(usr_hash, "hitcount", 0, "hitcounttimestamp", 0) 292 | end 293 | end 294 | end 295 | 296 | local res, err = red:hmget(usr_hash, "question", "answer", "eAT", "eATTime") 297 | local correctQuestion = "" 298 | local correctAnswer = "" 299 | local eAT = ""; 300 | local eATTime = ""; 301 | 302 | if res then 303 | correctQuestion = res[1] 304 | correctAnswer = res[2] 305 | eAT = tonumber(res[3]) 306 | eATTime = res[4] 307 | end 308 | 309 | local expectedDiff = tonumber((os.time() - eATTime) * 1000) 310 | local eATSec = tonumber(eAT + 1000) 311 | if (expectedDiff < eAT or expectedDiff > eATSec) then 312 | red:close() 313 | ngx.header["Content-type"] = "text/html" 314 | ngx.say("Authentication failed, please reload.") 315 | return 316 | end 317 | 318 | local get_args = ngx.req.get_uri_args(2) 319 | local getQuestion = "" 320 | local getAnswer = "" 321 | 322 | for key, val in pairs(get_args) do 323 | if (key == "q") then 324 | getQuestion = val 325 | end 326 | if (key == "a") then 327 | getAnswer = val 328 | end 329 | end 330 | 331 | if (getQuestion == "" or 332 | getAnswer == "" or 333 | getQuestion ~= correctQuestion or 334 | getAnswer ~= correctAnswer) then 335 | red:close() 336 | ngx.header["Content-type"] = "text/html" 337 | ngx.say("Authentication failed, please reload.") 338 | return 339 | end 340 | 341 | local authenticationTime = tonumber(ngx.var.auth_time) 342 | 343 | red:hmset(usr_hash, "auth", 1, "timestamp", os.time() + authenticationTime, "question", 0, "answer", 0, "hitcount", 0, "hitcounttimestamp", 0, "questionarg", 0, "answerarg", 0) 344 | red:persist(usr_hash) 345 | red:close() 346 | 347 | ngx.header["Content-type"] = "text/html" 348 | ngx.say("success") 349 | return 350 | end 351 | 352 | local allowIPs = ngx.var.allow_ip 353 | 354 | for IP in string_gmatch(allowIPs, '([^;]+)') do 355 | if (remote_ip == IP) then 356 | red:close() 357 | ngx.header["Content-type"] = "text/html" 358 | ngx.exit(555) 359 | return 360 | end 361 | end 362 | 363 | local blockIPs = ngx.var.block_ip 364 | 365 | for IP in string_gmatch(blockIPs, '([^;]+)') do 366 | if (remote_ip == IP) then 367 | red:close() 368 | ngx.header["Content-type"] = "text/html" 369 | ngx.exit(403) 370 | return 371 | end 372 | end 373 | 374 | local allowURIs = ngx.var.allow_uri 375 | 376 | for get_uri in string_gmatch(allowURIs, '([^;]+)') do 377 | if (get_uri == uri) then 378 | red:close() 379 | ngx.header["Content-type"] = "text/html" 380 | ngx.exit(555) 381 | return 382 | end 383 | end 384 | 385 | local blockURIs = ngx.var.block_uri 386 | 387 | for get_uri in string_gmatch(blockURIs, '([^;]+)') do 388 | if (get_uri == uri) then 389 | red:close() 390 | ngx.header["Content-type"] = "text/html" 391 | ngx.exit(403) 392 | return 393 | end 394 | end 395 | 396 | local res, err = red:get(usr_hash) 397 | 398 | if (res == ngx.null) then 399 | red:hmset(usr_hash, "auth", 0, "timestamp", 0, "question", 0, "answer", 0, "hitcount", 0, "hitcounttimestamp", 0) 400 | red:expire(usr_hash, 300) 401 | auth = 0 402 | timestamp = 0 403 | question = 0 404 | answer = 0 405 | CHALLENGE() 406 | return 407 | end 408 | 409 | if (res ~= ngx.null) then 410 | local res, err = red:hmget(usr_hash, "auth", "timestamp") 411 | if res then 412 | auth = res[1] 413 | timestamp = res[2] 414 | end 415 | end 416 | 417 | if (tonumber(auth) == 1) then 418 | if (tonumber(timestamp) < os.time()) then 419 | red:hmset(usr_hash, "auth", 0, "timestamp", 0, "question", 0, "answer", 0, "hitcount", 0, "hitcounttimestamp", 0) 420 | CHALLENGE() 421 | return 422 | end 423 | red:close() 424 | ngx.header["Content-type"] = "text/html" 425 | ngx.exit(555) 426 | return 427 | end 428 | 429 | if (tonumber(auth) == 0) then 430 | if (string_find(uri, "/SiteShield/Authenticate")) then 431 | AUTH() 432 | return 433 | end 434 | if (uri == "/favicon.ico") then 435 | red:close() 436 | ngx.header["Content-type"] = "text/html" 437 | ngx.exit(503) 438 | return 439 | end 440 | CHALLENGE() 441 | return 442 | end 443 | -------------------------------------------------------------------------------- /docs/siteshield.svg: -------------------------------------------------------------------------------- 1 | --------------------------------------------------------------------------------