├── LICENSE ├── README.md ├── browser_asks.png ├── browser_certs.png ├── docker-compose.yml ├── nginx ├── conf.d │ └── site.example.conf ├── fastcgi.conf ├── nginx.conf ├── proxy.conf ├── ssl.conf └── ssl │ ├── ca │ ├── ca.cnf │ └── certificates │ │ └── .gitkeep │ ├── clean.sh │ ├── clients │ ├── client.cnf │ ├── client.tpl │ ├── p12 │ │ └── .gitkeep │ └── passwords.txt │ ├── create_ca.sh │ ├── create_client.sh │ ├── create_tls.sh │ ├── revoke_client.sh │ └── tls │ ├── tls.cnf │ └── tls.tpl └── site_accessed.png /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 | # Authenticating reverse proxy on docker using client certificate authentication 2 | 3 | ## What is Reverse Proxy Auth 4 | **Nginx** can easily be configured to act as a **reverse proxy** in order to externaly expose on the same point different web services hosted internaly. 5 | 6 | To restrict the access to the content hosted behind the proxy, it is possible to require the users to provide a **personal certificate**. Using this mechanism, you ensure only **trusted users are allowed** to access protected services. 7 | 8 | This project provides all the tools needed to easily setup and configure the reverse proxy and the client certificates. 9 | 10 | 11 | 12 | ## 1. Preparation 13 | This project requires Docker and Docker-compose to be installed. 14 | The docker-compose.yml file describes the architecture of the project. 15 | Alternatively, you can use the provided files on a regular Nginx server to use the same mechanism without Docker. 16 | 17 | **Files:** 18 | The `nginx/nginx.conf` file is configured to run Nginx using default configuration. 19 | 20 | The `nginx/fastcgi.conf` file is the default configuration for FastCGI. 21 | 22 | The `nginx/proxy.conf` file contains the parameters to optimize the proxy role of Nginx. 23 | 24 | The `nginx/ssl.conf` file is configured to use strong encryption protocols and ciphers. It also add security mechanisms through headers. 25 | 26 | The `nginx/conf.d/site.example.conf` is configured to listen on ports **80** and **443** and requires clients to use a certificate to authenticate themself. If a client is successfully authenticated, it is redirected to the webapp docker machine. 27 | 28 | 29 | #### Architecture: 30 | client [certificate] -> front [CA + proxy] -> webapp [website] 31 | 32 | 33 | ### 1.1 Server initialization 34 | - Go to `nginx/ssl` : `$ cd nginx/ssl` 35 | - Edit the `ca/ca.cnf` file to reflect your organization values in the `[ ca_dn ]` part. 36 | - Create the certificate authority (CA): `$ ./create_ca.sh`. The file `create_ca.sh` should then by set to mode 000 in order to avoid erasing the issued CA. 37 | - Edit the `tls/tls.tpl` file to reflect your organization subdomain values in the `[ default ]` part. 38 | - Create a certificate for the front website `$ ./create_tls.sh site.example`. The DNS name of the website can differ but you have to edit the file generated in `nginx/conf.d` to match the actual name. 39 | Alternatively, you can buy a certificate from a recognized issuer or get one for free using Let's Encrypt. 40 | - Edit the `client/client.tpl` file to reflect organization values in the `[ client_dn ]` part. You don't need to change the email address, this will be done by the script. 41 | - Create a client `$ ./create_client.sh firstname lastname client@site.example` 42 | The newly created certificate is located in `clients/p12` and protected by a password added to the `clients/passwords.txt` file. 43 | 44 | 45 | - Go to `nginx/conf.d` : `$ cd ../conf.d` 46 | - Open the `site.example.conf` to adjust the following parameters : 47 | - Change the `site.example` value after `server_name` to match your website's URL (2 times). 48 | - Change the values after `ssl_certificate` and `ssl_certificate_key` to match your website's certificate. 49 | - Change the `http://protectedapp;` value after `proxy_pass` to match your docker application's name or its address (domain name or IP). 50 | - **Optional**: change the log's name after `access_log`. 51 | - **Optional**: change the file's name, as long as its extension is ".conf". 52 | 53 | ### 1.2 Client side initialization 54 | In your browser, to go the *settings* -> *certificate* part. It can have different names, such as "manage certificates" or "view certificates". 55 | 56 | This part has 4 sections: "Your certificates", "People", "Servers" and "Authorities". 57 | 58 | In the "Your certificates", click "import" and select the .p12 file issued for you. The browser asks for a password which has been assigned during the certificate creation. 59 | 60 | **Optional**: In the "Authorities", import the "ca.crt" certificate. Check "Trust this CA to identify websites". You don't have to do this if your website certificate has been issued by a recognized issuer. 61 | 62 | Then, validate/exit the certificate manager part. 63 | 64 | ![alt text](browser_certs.png) 65 | 66 | ### 1.3 Testing the service 67 | - In the root directory, where the "docker-compose.yml" is located, run `$ docker-compose up`. 68 | - Edit the `/etc/hosts` file using sudo `$ sudo nano /etc/root`. Add the following new line: `127.0.0.1 site.example` or whatever name you chose for your website. 69 | - Open you browser, go to https://site.example. The browser should ask for permissions to use your user certificate. Validate the request. 70 | 71 | ![alt text](browser_asks.png) 72 | 73 | If your browser raises a TLS warning, ignore it and "accept the risk". 74 | 75 | If everything went well, you should see a page displaying "NGINX" and various info such as "Server address" and "Server name". 76 | 77 | ![alt text](site_accessed.png) 78 | 79 | 80 | ### 1.4 Revocation 81 | To revoke a client, run `$ ./revoke_client firstname lastname` and check the certificate has been moved to `clients/revoked`. 82 | 83 | Revoked files are visible by possessing a `200122103242Z,cessationOfOperation` string in the 3rd column of `nginx/ssl/ca/ca.db`. 84 | 85 | Users possessing revoked certificated can not authenticate themself anymore on the proxy. 86 | 87 | 88 | ## 3. Troubleshoot 89 | ### 3.1 Firefox does not ask for the certificate 90 | Go to `about:config` and set `security.osclientcerts.autoload` to `true`. 91 | 92 | ### 3.2 The browser does not accept the password 93 | The password may be wrong. Check the associated password in `passwords.txt` or regenerate a certificate. 94 | 95 | ### 3.3 I get an error 400 "No required SSL certificate was sent" 96 | You have not imported your certificate in your browser or the domain linked to the certificate is wrong. 97 | 98 | ### 3.4 I can no longer access the website using my certificate 99 | Your certificate may be revoked. Check the `revoked` folder. 100 | 101 | ### 3.5 That does not work 102 | Have you tried rebooting ? 103 | 104 | Credits: 105 | - Docker: [https://www.docker.com/](https://www.docker.com/) 106 | - Docker-compose: [https://docs.docker.com/compose/](https://docs.docker.com/compose/) 107 | - Nginx: [https://www.nginx.com/](https://www.nginx.com/) 108 | - OpenSSL [https://www.openssl.org/](https://www.openssl.org/) 109 | 110 | Coming later: 111 | - LDAP based Two Factors Authentication 112 | - Web interface to manage the PKI 113 | -------------------------------------------------------------------------------- /browser_asks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Orange-Cyberdefense/reverse-proxy-auth/e9c5f87000c8d7fb0fa0d85699478f69cbd89a0e/browser_asks.png -------------------------------------------------------------------------------- /browser_certs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Orange-Cyberdefense/reverse-proxy-auth/e9c5f87000c8d7fb0fa0d85699478f69cbd89a0e/browser_certs.png -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3' 2 | services: 3 | proxy: 4 | image: nginx 5 | container_name: proxy 6 | ports: 7 | - "80:80" 8 | - "443:443" 9 | volumes: 10 | - ./nginx:/etc/nginx 11 | cap_add: 12 | - NET_ADMIN 13 | # MUST run defined hosts before running nginx 14 | depends_on: 15 | - protectedapp 16 | 17 | protectedapp: 18 | image: nginxdemos/hello 19 | container_name: protectedapp 20 | expose: ["80", "443"] 21 | cap_add: 22 | - NET_ADMIN 23 | -------------------------------------------------------------------------------- /nginx/conf.d/site.example.conf: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80 default_server; 3 | server_name site.example; 4 | 5 | # redirection to HTTPS 6 | return 301 https://$host$request_uri; 7 | } 8 | 9 | server { 10 | listen 443 ssl default_server; 11 | server_name site.example; 12 | proxy_ssl_server_name on; 13 | 14 | # must use HTTPS to use cert authent 15 | ssl_certificate /etc/nginx/ssl/tls/site.example.crt; 16 | ssl_certificate_key /etc/nginx/ssl/tls/site.example.key; 17 | 18 | # client part 19 | ssl_client_certificate /etc/nginx/ssl/ca/ca.crt; 20 | ssl_crl /etc/nginx/ssl/ca/ca.crl; 21 | ssl_verify_client on; 22 | 23 | access_log /var/log/nginx/site.example; 24 | 25 | location / { 26 | # deny access if not compliant 27 | if ($ssl_client_verify != SUCCESS) { 28 | return 403; 29 | } 30 | 31 | # HTTP proxy stuff for web servers behind 32 | proxy_set_header Host $host; 33 | proxy_set_header X-Real-IP $remote_addr; 34 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 35 | proxy_set_header X-Forwarded-Proto $scheme; 36 | 37 | # Fix the "It appears that your reverse proxy set up is broken" error. 38 | proxy_pass http://protectedapp; 39 | proxy_read_timeout 90; 40 | 41 | # web sockets 42 | proxy_http_version 1.1; 43 | proxy_set_header Upgrade $http_upgrade; 44 | proxy_set_header Connection $connection_upgrade; 45 | 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /nginx/fastcgi.conf: -------------------------------------------------------------------------------- 1 | 2 | fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 3 | fastcgi_param QUERY_STRING $query_string; 4 | fastcgi_param REQUEST_METHOD $request_method; 5 | fastcgi_param CONTENT_TYPE $content_type; 6 | fastcgi_param CONTENT_LENGTH $content_length; 7 | 8 | fastcgi_param SCRIPT_NAME $fastcgi_script_name; 9 | fastcgi_param REQUEST_URI $request_uri; 10 | fastcgi_param DOCUMENT_URI $document_uri; 11 | fastcgi_param DOCUMENT_ROOT $document_root; 12 | fastcgi_param SERVER_PROTOCOL $server_protocol; 13 | fastcgi_param REQUEST_SCHEME $scheme; 14 | fastcgi_param HTTPS $https if_not_empty; 15 | 16 | fastcgi_param GATEWAY_INTERFACE CGI/1.1; 17 | fastcgi_param SERVER_SOFTWARE nginx/$nginx_version; 18 | 19 | fastcgi_param REMOTE_ADDR $remote_addr; 20 | fastcgi_param REMOTE_PORT $remote_port; 21 | fastcgi_param SERVER_ADDR $server_addr; 22 | fastcgi_param SERVER_PORT $server_port; 23 | fastcgi_param SERVER_NAME $server_name; 24 | 25 | # PHP only, required if PHP was built with --enable-force-cgi-redirect 26 | fastcgi_param REDIRECT_STATUS 200; 27 | -------------------------------------------------------------------------------- /nginx/nginx.conf: -------------------------------------------------------------------------------- 1 | user www-data; 2 | worker_processes 5; ## Default: 1 3 | error_log /var/log/nginx/error.log; 4 | pid /run/nginx.pid; 5 | worker_rlimit_nofile 8192; 6 | 7 | events { 8 | worker_connections 4096; ## Default: 1024 9 | } 10 | 11 | 12 | http { 13 | 14 | include /etc/nginx/proxy.conf; 15 | include /etc/nginx/fastcgi.conf; 16 | include /etc/nginx/ssl.conf; 17 | index index.html index.htm index.php; 18 | 19 | default_type application/octet-stream; 20 | log_format main '$remote_addr - $remote_user [$time_local] "$request" ' 21 | '$status $body_bytes_sent "$http_referer" ' 22 | '"$http_user_agent" "$http_x_forwarded_for"'; 23 | access_log /var/log/nginx/access.log main; 24 | 25 | server_tokens off; 26 | 27 | sendfile on; 28 | tcp_nopush on; 29 | keepalive_timeout 65; 30 | server_names_hash_bucket_size 128; # this seems to be required for some vhosts 31 | 32 | # required 33 | map $http_upgrade $connection_upgrade { 34 | default upgrade; 35 | '' close; 36 | } 37 | 38 | include /etc/nginx/conf.d/*.conf; 39 | } 40 | -------------------------------------------------------------------------------- /nginx/proxy.conf: -------------------------------------------------------------------------------- 1 | proxy_redirect off; 2 | proxy_set_header Host $host; 3 | proxy_set_header X-Real-IP $remote_addr; 4 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 5 | client_max_body_size 10m; 6 | client_body_buffer_size 128k; 7 | proxy_connect_timeout 90; 8 | proxy_send_timeout 90; 9 | proxy_read_timeout 90; 10 | proxy_buffers 32 4k; 11 | -------------------------------------------------------------------------------- /nginx/ssl.conf: -------------------------------------------------------------------------------- 1 | ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; 2 | ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384; 3 | ssl_prefer_server_ciphers on; 4 | ssl_session_cache shared:SSL:10m; 5 | #ssl_dhparam /etc/ssl/dhparam.pem; 6 | ssl_ecdh_curve secp384r1; 7 | add_header Strict-Transport-Security "max-age=63072000; includeSubdomains; "; 8 | -------------------------------------------------------------------------------- /nginx/ssl/ca/ca.cnf: -------------------------------------------------------------------------------- 1 | [ default ] 2 | caName = ca 3 | caDir = ./ca 4 | 5 | [ req ] 6 | default_bits = 4096 7 | default_md = sha256 8 | prompt = no 9 | encrypt_key = yes 10 | utf8 = yes 11 | distinguished_name = ca_dn 12 | req_extensions = ca_reqext 13 | 14 | [ ca_dn ] 15 | 0.domainComponent = "example" 16 | 1.domainComponent = "site" 17 | organizationName = "Your Organization" 18 | organizationalUnitName = "You Organization site.example CA" 19 | commonName = "You Organization site.example" 20 | 21 | [ ca_reqext ] 22 | keyUsage = critical,keyCertSign,cRLSign 23 | basicConstraints = critical,CA:true 24 | subjectKeyIdentifier = hash 25 | 26 | [ ca ] 27 | default_ca = root_ca # The default CA section 28 | 29 | [ root_ca ] 30 | certificate = $caDir/$caName.crt # The CA cert 31 | private_key = $caDir/$caName.key # CA private key 32 | new_certs_dir = $caDir/certificates # Certificate archive 33 | serial = $caDir/$caName.crt.srl # Serial number file 34 | crlnumber = $caDir/$caName.crl.srl # CRL number file 35 | database = $caDir/$caName.db # Index file 36 | unique_subject = no # Require unique subject 37 | default_days = 3652 # How long to certify for 38 | default_md = sha256 # MD to use 39 | policy = match_pol # Default naming policy 40 | email_in_dn = no # Add email to cert DN 41 | preserve = no # Keep passed DN ordering 42 | name_opt = ca_default # Subject DN display options 43 | cert_opt = ca_default # Certificate display options 44 | copy_extensions = none # Copy extensions from CSR 45 | x509_extensions = signing_ca_ext # Default cert extensions 46 | default_crl_days = 365 # How long before next CRL 47 | crl_extensions = crl_ext # CRL extensions 48 | 49 | # Naming policies control which parts of a DN end up in the certificate and 50 | # under what circumstances certification should be denied. 51 | 52 | [ match_pol ] 53 | domainComponent = supplied # 'simple.org' 54 | organizationName = supplied # 'Simple Inc' 55 | organizationalUnitName = optional # Included if present 56 | commonName = supplied # Must be present 57 | 58 | [ any_pol ] 59 | domainComponent = optional 60 | countryName = optional 61 | stateOrProvinceName = optional 62 | localityName = optional 63 | organizationName = optional 64 | organizationalUnitName = optional 65 | commonName = optional 66 | emailAddress = optional 67 | 68 | [ root_ca_ext ] 69 | keyUsage = critical,keyCertSign,cRLSign 70 | basicConstraints = critical,CA:true 71 | extendedKeyUsage = serverAuth,clientAuth 72 | subjectKeyIdentifier = hash 73 | authorityKeyIdentifier = keyid:always 74 | 75 | [ client_ext ] 76 | keyUsage = critical,digitalSignature,keyEncipherment 77 | basicConstraints = CA:false 78 | extendedKeyUsage = serverAuth,clientAuth 79 | subjectKeyIdentifier = hash 80 | authorityKeyIdentifier = keyid:always 81 | 82 | [ server_ext ] 83 | keyUsage = critical,digitalSignature,keyEncipherment 84 | basicConstraints = CA:false 85 | extendedKeyUsage = serverAuth,clientAuth 86 | subjectKeyIdentifier = hash 87 | authorityKeyIdentifier = keyid:always 88 | 89 | 90 | 91 | # CRL extensions exist solely to point to the CA certificate that has issued 92 | # the CRL. 93 | 94 | [ crl_ext ] 95 | authorityKeyIdentifier = keyid:always 96 | -------------------------------------------------------------------------------- /nginx/ssl/ca/certificates/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Orange-Cyberdefense/reverse-proxy-auth/e9c5f87000c8d7fb0fa0d85699478f69cbd89a0e/nginx/ssl/ca/certificates/.gitkeep -------------------------------------------------------------------------------- /nginx/ssl/clean.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # prevention message 3 | read -p "This will delete all existing generated files. Are you sure ? " -n 1 -r 4 | echo # (optional) move to a new line 5 | if [[ ! $REPLY =~ ^[Yy]$ ]] 6 | then 7 | exit 1 8 | fi 9 | 10 | echo "Cleaning the files to reset the project.." 11 | 12 | echo "> Cleaning CA" 13 | cd ca 14 | rm *.old 15 | rm *.srl 16 | rm *.attr 17 | rm *.crt 18 | rm *.csr 19 | rm *.db 20 | rm *.key 21 | rm *.crl 22 | rm *password.txt 23 | rm certificates/* 24 | cd .. 25 | chmod 755 create_ca.sh 26 | echo "Done" 27 | echo "" 28 | 29 | echo "> Cleaning TLS" 30 | cd tls 31 | rm *.crt 32 | rm *.csr 33 | rm *.key 34 | cd .. 35 | echo "Done" 36 | echo "" 37 | 38 | echo "> Cleaning clients" 39 | cd clients 40 | rm *.crt 41 | rm *.csr 42 | rm *.key 43 | echo "" > passwords.txt 44 | rm p12/*.p12 45 | cd .. 46 | echo "Done" 47 | -------------------------------------------------------------------------------- /nginx/ssl/clients/client.cnf: -------------------------------------------------------------------------------- 1 | [ req ] 2 | default_bits = 4096 # RSA key size 3 | encrypt_key = no # Protect private key 4 | default_md = sha256 # MD to use 5 | utf8 = yes # Input is UTF-8 6 | string_mask = utf8only # Emit UTF-8 strings 7 | prompt = no # Prompt for DN 8 | distinguished_name = client_dn # DN template 9 | req_extensions = client_reqext # Desired extensions 10 | 11 | [ client_dn ] 12 | 0.domainComponent = "example" 13 | 1.domainComponent = "site" 14 | C = FR 15 | O = Your Organisation 16 | CN = client_test 17 | ST= IDF 18 | L= Paris 19 | OU= Entity 20 | emailAddress= client@site.example 21 | 22 | 23 | [ client_reqext ] 24 | keyUsage = critical,digitalSignature,keyEncipherment,nonRepudiation 25 | extendedKeyUsage = emailProtection,clientAuth 26 | subjectKeyIdentifier = hash 27 | subjectAltName = email:client@site.example 28 | -------------------------------------------------------------------------------- /nginx/ssl/clients/client.tpl: -------------------------------------------------------------------------------- 1 | [ req ] 2 | default_bits = 4096 # RSA key size 3 | encrypt_key = no # Protect private key 4 | default_md = sha256 # MD to use 5 | utf8 = yes # Input is UTF-8 6 | string_mask = utf8only # Emit UTF-8 strings 7 | prompt = no # Prompt for DN 8 | distinguished_name = client_dn # DN template 9 | req_extensions = client_reqext # Desired extensions 10 | 11 | [ client_dn ] 12 | 0.domainComponent = "example" 13 | 1.domainComponent = "site" 14 | C = FR 15 | O = Your Organisation 16 | CN = FIRSTNAME_LASTNAME 17 | ST= IDF 18 | L= Paris 19 | OU= Entity 20 | emailAddress= EMAIL 21 | 22 | 23 | [ client_reqext ] 24 | keyUsage = critical,digitalSignature,keyEncipherment,nonRepudiation 25 | extendedKeyUsage = emailProtection,clientAuth 26 | subjectKeyIdentifier = hash 27 | subjectAltName = email:EMAIL 28 | -------------------------------------------------------------------------------- /nginx/ssl/clients/p12/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Orange-Cyberdefense/reverse-proxy-auth/e9c5f87000c8d7fb0fa0d85699478f69cbd89a0e/nginx/ssl/clients/p12/.gitkeep -------------------------------------------------------------------------------- /nginx/ssl/clients/passwords.txt: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /nginx/ssl/create_ca.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | dir=./ca 3 | PASS=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 20 | head -n 1) 4 | 5 | # prevention message 6 | read -p "This will delete all existing CA files. Are you sure ? " -n 1 -r 7 | echo # (optional) move to a new line 8 | if [[ ! $REPLY =~ ^[Yy]$ ]] 9 | then 10 | exit 1 11 | fi 12 | 13 | # cleaning 14 | cd $dir 15 | rm *.old 16 | rm *.srl 17 | rm *.attr 18 | rm *.crt 19 | rm *.csr 20 | rm *.db 21 | rm *.key 22 | rm *.crl 23 | rm *password.txt 24 | rm certificates/* 25 | 26 | 27 | # initialize 28 | cp /dev/null ca.db 29 | cp /dev/null ca.db.attr 30 | echo '01' > ca.crt.srl 31 | echo '01' > ca.crl.srl 32 | if [ ! -d "$dir/certificates" ] 33 | then 34 | mkdir certificates 35 | fi 36 | cd .. 37 | echo "Cleaning done" 38 | 39 | # generate the things 40 | openssl req -new -config $dir/ca.cnf -out $dir/ca.csr -keyout $dir/ca.key -passout pass:$PASS 41 | openssl ca -selfsign -config $dir/ca.cnf -batch -in $dir/ca.csr -out $dir/ca.crt -extensions root_ca_ext -passin pass:$PASS 42 | # generating the crl list of revoked certficiates 43 | openssl ca -gencrl -config $dir/ca.cnf -out $dir/ca.crl -passin pass:$PASS 44 | echo $PASS > $dir/ca_key_password.txt 45 | echo "Generating certificate done. The key is protected by the password $PASS" 46 | echo "$ ls -l $dir" 47 | ls -l $dir 48 | 49 | # locking the script in order to protect the CA 50 | echo "Locking create_ca.sh to avoid accident" 51 | chmod 000 create_ca.sh 52 | -------------------------------------------------------------------------------- /nginx/ssl/create_client.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | dir=./clients 3 | ca=./ca 4 | 5 | # enough args 6 | if [ $# -lt 3 ]; 7 | then 8 | printf "Usage: firstname lastname email@address\n" 9 | exit 0 10 | fi 11 | 12 | if [ ! -d "$dir/p12" ] 13 | then 14 | mkdir $dir/p12 15 | fi 16 | 17 | # string conversion 18 | FIRSTNAME=$(echo $1 | iconv -f utf8 -t ascii//TRANSLIT) 19 | LASTNAME=$(echo $2 | iconv -f utf8 -t ascii//TRANSLIT) 20 | EMAIL=$3 21 | CAPASS=$(cat ./ca/ca_key_password.txt) 22 | fullname="${FIRSTNAME}_${LASTNAME}" 23 | password=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 20 | head -n 1) 24 | 25 | EXISTING_CLIENT=clients/${FIRSTNAME}_${LASTNAME}.crt 26 | if [ -f "$EXISTING_CLIENT" ]; then 27 | echo "Client $FIRSTNAME $LASTNAME already exists. If you want to reissue a certificate, revoke the old one first using revoke_client.sh, then issue a new one." 28 | echo "Quitting" 29 | exit 0 30 | fi 31 | 32 | # generating the configuration file from the template, replacing variables 33 | sed "s/FIRSTNAME/$FIRSTNAME/g" $dir/client.tpl > $dir/client.cnf 34 | sed -i "s/LASTNAME/$LASTNAME/g" $dir/client.cnf 35 | sed -i "s/EMAIL/$EMAIL/g" $dir/client.cnf 36 | 37 | # creating the client key + csr using a password 38 | openssl req -new -config $dir/client.cnf -out $dir/$fullname.csr -keyout $dir/$fullname.key -passout pass:$password 39 | 40 | # creating the crt using extensions 41 | openssl ca -config $ca/ca.cnf -in $dir/$fullname.csr -out $dir/$fullname.crt -extensions client_ext -passin pass:$CAPASS -batch 42 | 43 | # creating the .p12 file for clients using a password 44 | openssl pkcs12 -export -name "$FIRSTNAME $LASTNAME" -inkey $dir/$fullname.key -in $dir/$fullname.crt -out $dir/p12/$fullname.p12 -passout pass:$password -passin pass:$password 45 | 46 | echo "Client $FIRSTNAME $LASTNAME created. The p12 file is located in $dir/p12/$fullname.p12 and protected with the password $password" 47 | echo $FIRSTNAME $LASTNAME: $password >> $dir/passwords.txt 48 | echo "Password added to $dir/passwords.txt" 49 | -------------------------------------------------------------------------------- /nginx/ssl/create_tls.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | dir=./tls 3 | ca=./ca 4 | CAPASS=$(cat ./ca/ca_key_password.txt) 5 | 6 | if [ $# -lt 1 ]; 7 | then 8 | echo "Usage: sub.domain.tld" 9 | exit 0 10 | fi 11 | 12 | DNSNAME=$1 13 | sed "s/DNSNAME_TOCHANGE/$1/g" $dir/tls.tpl > $dir/tls.cnf 14 | 15 | openssl req -new -config $dir/tls.cnf -out $dir/$DNSNAME.csr -keyout $dir/$DNSNAME.key 16 | openssl ca -config $ca/ca.cnf -batch -in $dir/$DNSNAME.csr -out $dir/$DNSNAME.crt -extensions server_ext -passin pass:$CAPASS -------------------------------------------------------------------------------- /nginx/ssl/revoke_client.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | dir=./clients 3 | ca=./ca 4 | 5 | # enough args 6 | if [ $# -lt 2 ]; 7 | then 8 | echo "Usage: firstname lastname" 9 | exit 0 10 | fi 11 | 12 | # string conversion 13 | FIRSTNAME=$(echo $1 | iconv -f utf8 -t ascii//TRANSLIT) 14 | LASTNAME=$(echo $2 | iconv -f utf8 -t ascii//TRANSLIT) 15 | EMAIL=$3 16 | CAPASS=$(cat ./ca/ca_key_password.txt) 17 | fullname="${FIRSTNAME}_${LASTNAME}" 18 | 19 | # prevention message 20 | read -p "This will revoke the certificate for $FIRSTNAME $LASTNAME. Are you sure ? " -n 1 -r 21 | echo # (optional) move to a new line 22 | if [[ ! $REPLY =~ ^[Yy]$ ]] 23 | then 24 | exit 1 25 | fi 26 | 27 | # get the pem number from the db 28 | cert_number=$(grep $fullname $ca/ca.db | cut -d$'\t' -f 4) 29 | if [ -z "$cert_number" ] 30 | then 31 | echo "User $FIRSTNAME $LASTNAME not found" 32 | echo "Quitting" 33 | exit 0 34 | fi 35 | 36 | # revoke the certificate with the reason "cessationOfOperation" 37 | openssl ca -config $ca/ca.cnf -revoke $ca/certificates/$cert_number.pem -crl_reason cessationOfOperation -passin pass:$CAPASS 38 | 39 | # generating the crl list of revoked certficiates 40 | openssl ca -gencrl -config $ca/ca.cnf -out $ca/ca.crl -passin pass:$CAPASS 41 | 42 | if [ ! -d "$dir/revoked" ] 43 | then 44 | mkdir $dir/revoked 45 | fi 46 | 47 | mv $dir/p12/$fullname.p12 $dir/revoked/ 48 | -------------------------------------------------------------------------------- /nginx/ssl/tls/tls.cnf: -------------------------------------------------------------------------------- 1 | # Template file for generating csr file 2 | # OpenSSL SUCKS to use environment variable 3 | 4 | [ default ] 5 | SAN = DNS:site.example # Default value 6 | 7 | [ req ] 8 | default_bits = 4096 # RSA key size 9 | encrypt_key = no # Protect private key 10 | default_md = sha256 # MD to use 11 | utf8 = yes # Input is UTF-8 12 | string_mask = utf8only # Emit UTF-8 strings 13 | prompt = no # Don't prompt for DN 14 | distinguished_name = server_dn # DN section 15 | req_extensions = server_reqext # Desired extensions 16 | 17 | [ server_dn ] 18 | 0.domainComponent = "example" 19 | 1.domainComponent = "site" 20 | organizationName = "Your Organization" 21 | organizationalUnitName = "Entity" 22 | commonName = "site.example" 23 | emailAddress = "admin@site.example" 24 | 25 | 26 | [ server_reqext ] 27 | keyUsage = critical,digitalSignature,keyEncipherment 28 | extendedKeyUsage = serverAuth,clientAuth 29 | subjectKeyIdentifier = hash 30 | subjectAltName = DNS:site.example 31 | -------------------------------------------------------------------------------- /nginx/ssl/tls/tls.tpl: -------------------------------------------------------------------------------- 1 | # Template file for generating csr file 2 | # OpenSSL SUCKS to use environment variable 3 | 4 | [ default ] 5 | SAN = DNS:site.example # Default value 6 | 7 | [ req ] 8 | default_bits = 4096 # RSA key size 9 | encrypt_key = no # Protect private key 10 | default_md = sha256 # MD to use 11 | utf8 = yes # Input is UTF-8 12 | string_mask = utf8only # Emit UTF-8 strings 13 | prompt = no # Don't prompt for DN 14 | distinguished_name = server_dn # DN section 15 | req_extensions = server_reqext # Desired extensions 16 | 17 | [ server_dn ] 18 | 0.domainComponent = "example" 19 | 1.domainComponent = "site" 20 | organizationName = "Your Organization" 21 | organizationalUnitName = "Entity" 22 | commonName = "DNSNAME_TOCHANGE" 23 | emailAddress = "admin@site.example" 24 | 25 | 26 | [ server_reqext ] 27 | keyUsage = critical,digitalSignature,keyEncipherment 28 | extendedKeyUsage = serverAuth,clientAuth 29 | subjectKeyIdentifier = hash 30 | subjectAltName = DNS:DNSNAME_TOCHANGE 31 | -------------------------------------------------------------------------------- /site_accessed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Orange-Cyberdefense/reverse-proxy-auth/e9c5f87000c8d7fb0fa0d85699478f69cbd89a0e/site_accessed.png --------------------------------------------------------------------------------