This repository demonstrates how to run a complete private cloud web infrastructure, providing identity management (IdP), MFA-capable authentication, automatic SSL certificate generation and a Web App Firewall. All from your own private infrastructure! Or, if you prefer, run it all in the cloud!
The high-level components are illustrated in the above figure. traefik
routes
all incoming requests based on their HTTP Host
or TCP HostSNI
headers. The
configured Host
rules are used by traefik to request appropriately named SSL
certificates from an ACME compliant issuing CA. Any requests not matching a
configured Host
name will just be presented with a 404
Response. HTTP
requests are then filtered by the modsecurity
Core Rule Set. If all is okay
up until this point, the client will be redirected to a login screen on a
vault
server. Once successfully logged in, the client is issued with a token
valid for the parent domain. This single authentication token can be used for
SSO to any service running on the cluster and routed by traefik.
Each service needs to be configured as per your own requirements. Further, split DNS should be configured on your internal router for your domain, so that services don't attempt to communicate with eachother through your router's WAN IP (which would also require hairpin NAT to be configured on your router).
I would suggest setting up the services in the following order:-
traefik
router.See my notes here- Step CA. See the documentation at certificates.md
Vault
, used as an Identity and OIDC Authentication provider. (It can do a lot more!) See my setup docs, at authentication.mdtraefik-forward-auth
. This is configured alongside the Vault service, as described here- Add separate web services as necessary. An example
whoami
service is available indocker-compose-whoami.yaml
docker
docker-compose
- Your own domain name. You can use any domain name, so long as you can edit the DNS settings on your router, local DNS server, and/or local hosts file.
- For external access, permission to configure a public DNS zone
- A good text editor!
- A bit of time to set up and configure everything.
This project is really just a concept and a bunch of configuration files. None of this would be possible without the backend software that this environment is configured to run. The main components in use here include:-
- docker
- traefik
- traefik-forward-auth by Thom Seddon
- Step CA by smallstep
- Vault by Hashicorp
- Consul by Hashicorp
Countless other backend technologies, standards, RFCs and communities have contributed to make this stack possible.
Without applying a full software license on the documentation and resources made avialable in this repository, which may or may not conflict with the dependent software's licenses (I don't know), use this software architecture AT YOUR OWN RISK. If using this implementation in your own systems, you agree to clauses 15-17 of the Gnu General Public License v3, which state:-
Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM βAS ISβ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.