/mtls-demo

Primary LanguagePython

Sample mTLS demo application

This project aims to demonstrate how to deploy a secure application onto AWS Cloud, using Client Certificate Authentication, also known as "Mutual TLS" or mTLS. It deploys a simple Spring Boot REST application using different 3 approaches, and 2 different reverse proxies:

Architecture

The high level diagram bellow illustrates the 3 different approaches; The difference between them lies on the <group> and <proxy> items, and on the way that the ELB (actually a Network Load Balancer) component is deployed and managed.

Application Architecture

Envoy@EKS

  • Group: Kubernetes Pod
  • Proxy: Envoy, configured as a sidecar within the Pod.
  • ELB: Deployed by a "LoadBalancer" Kubernetes service explicitly created by the CDK stack.

Envoy@EC2

  • Group: service shared network, created by docker-compose
  • Proxy: Envoy, configured as the shared network owner
  • ELB: Explicitly created by the CDK stack.

Ingress Controller@EKS

  • Group: Kubernetes Pod
  • Proxy: Kubernetes Ingress Controller, implemented with NGINX
  • ELB: Deployed automatically and managed by the NGINX Ingress controller.

Pre-Requisites

In order to build and deploy this demo you'll need the following tools:

  • Build

    • Java SDK 8
    • Maven
    • Docker
    • Docker Compose
    • OpenSSL

  • Deploy

    • Configured AWS cli
    • Python 3.6+
    • OpenSSL
    • AWS CDK

Since the instructions for installing those items varies according to a number of options, this demo assumes that you know what you're doing and knows how to install those tools on your system.

DISCLAIMER: This not a production ready system. It is meant only to educate in terms of what can be achieved with the components aforementioned. In order to understand AWS best practices to production topologies, please refer to AWS Well Architected Framework

Building and Deploying

Generating the certificate files

There's a helper script generate-certs.sh on the root folder of the project. You'll need those certs for either building the Envoy docker image, or deploying the solution. This is a mandatory step  

Building

You don't need to build the docker images (envoy and web) for deploying this solution, as they are already deployed onto Docker hub. But, if you want to do that, there's a helper script build.sh for it.

Deploying the solution

This solution adopts the Infrastructure as Code paradigm, and was built using AWS CDK. You can see the source code inside the cdk folder. The following files were created, for deploying:

There's a helper deploy.sh script on the root folder of this project to execute all the necessary steps for deploying this solution onto AWS Cloud.

If you're deploying using the image from Docker Hub, you can download the client certificates from here