A mutual TLS (mTLS) system for authenticating users to services that need to be on the internet, but should only be accessible to users that specifically need it. This should be used as a initial security measure on top of normal login to handle multi-factor authentication.
This server contains an API for converting Certificate Signing Requests (CSRs) into client certificates. The user database is PGPs trust database to verify detached signatures of the underlying CSR and generats a new client certificate. This client certificate will have a default lifetime of 18 hours, but can be configured to have a longer time to live (TTL). Admin calls are authenticated against a secondary PGP trust database of signed requests for managing the Certificate Revocation List (CRL).
This project is based on the whitepapers for Beyond Corp, which is Googles Zero Trust Security Model.
Mutual TLS is a sub-category of Mutual Authentication, where the client and server, or server and server are verifying the identity of one another to ensure that both parties should be allowed to access the requested information.
Creating services that inheritely trust no one unless specifically authorized. This provides the basis for a zero trust, multi-factor authentication scheme while also timeboxing access to the requested service in case of compromise or loss of access keys.
| Parameter | Description | Default |
|---|---|---|
| CONFIG_PATH | The path to the config file | config.ini |
| PROTOCOL | The protocol the server runs as | http |
| FQDN | The Fully Qualified Domain Name | localhost |
| CA_KEY_PASSWORD | The password for the CA Key | |
| SEED_ON_INIT | Seed gpg trust store on init | 1 |
| Section | Field | Description |
|---|---|---|
| mtls | min_lifetime | Minimum lifetime of a Client Certificate in seconds. |
| mtls | max_lifetime | Maximum lifetime of a Client Certificate in seconds. 0 means this is disabled |
| ca | key | The path to the CA key |
| ca | cert | The path to the CA Certificate |
| ca | alternate_name | Alternate DNS name that can be comma separated for multiples |
| gnupg | user | Path to the user GNUPGHOME |
| gnupg | admin | Path to the admin GNUPGHOME |
| storage | engine | The engine type for storage: sqlite3 or postgres |
| storage.sqlite3 | db_path | Path to the sqlite3 database file |
| storage.postgres | database | Database name |
| storage.postgres | user | Database user |
| storage.postgres | password | Database password |
| storage.postgres | host | Database host |
-
Download the package
git clone https://github.com/drGrove/mtls-server
-
Install Packages
make setup
-
Run the server (This requires docker)
make run-prod
- make
- pipenv
- docker
-
Install the git hooks, generate base secrets for testing and install dependencies
make setup-dev cp config.ini.example config.ini
-
Edit the config to have the issuer name and alternate names your service is creating client certificates for.
-
Run the service. This will not have some of the final checkers as those are handled in nginx as nginx is the primary test case for this.
make run
-
Check the final build. This will allow you to test all configurations end to end and ensure that you're able to hit the test endpoint
/test/with your new client certificate. You should be testing this against mtls-client for integration testing. More details on how your system is modified to handle these certificates will be found there.