--- title: Egress Gateway with TLS Origination description: Describes how to configure an Egress Gateway to perform TLS origination to external services. weight: 40 keywords: [traffic-management,egress] --- The [TLS Origination for Egress Traffic](/docs/examples/advanced-gateways/egress-tls-origination) example shows how to configure Istio to perform [TLS origination](/help/glossary/#tls-origination) for traffic to an external service. The [Configure an Egress Gateway](/docs/examples/advanced-gateways/egress-gateway) example shows how to configure Istio to direct egress traffic through a dedicated _egress gateway_ service. This example combines the previous two by describing how to configure an egress gateway to perform TLS origination for traffic to external services. ## Before you begin * Setup Istio by following the instructions in the [Installation guide](/docs/setup/). * Start the [sleep]({{< github_tree >}}/samples/sleep) sample which will be used as a test source for external calls. If you have enabled [automatic sidecar injection](/docs/setup/kubernetes/additional-setup/sidecar-injection/#automatic-sidecar-injection), do {{< text bash >}} $ kubectl apply -f @samples/sleep/sleep.yaml@ {{< /text >}} otherwise, you have to manually inject the sidecar before deploying the `sleep` application: {{< text bash >}} $ kubectl apply -f <(istioctl kube-inject -f @samples/sleep/sleep.yaml@) {{< /text >}} Note that any pod that you can `exec` and `curl` from would do. * Create a shell variable to hold the name of the source pod for sending requests to external services. If you used the [sleep]({{}}/samples/sleep) sample, run: {{< text bash >}} $ export SOURCE_POD=$(kubectl get pod -l app=sleep -o jsonpath={.items..metadata.name}) {{< /text >}} * [Deploy Istio egress gateway](/docs/examples/advanced-gateways/egress-gateway/#deploy-istio-egress-gateway). ## Perform TLS origination with an egress gateway This section describes how to perform the same TLS origination as in the [TLS Origination for Egress Traffic](/docs/examples/advanced-gateways/egress-tls-origination/) example, only this time using an egress gateway. Note that in this case the TLS origination will be done by the egress gateway, as opposed to by the sidecar in the previous example. 1. Define a `ServiceEntry` for `edition.cnn.com`: {{< text bash >}} $ kubectl apply -f - <}} 1. Verify that your `ServiceEntry` was applied correctly by sending a request to [http://edition.cnn.com/politics](https://edition.cnn.com/politics). {{< text bash >}} $ kubectl exec -it $SOURCE_POD -c sleep -- curl -sL -o /dev/null -D - http://edition.cnn.com/politics HTTP/1.1 301 Moved Permanently ... location: https://edition.cnn.com/politics ... command terminated with exit code 35 {{< /text >}} Your `ServiceEntry` was configured correctly if you see _301 Moved Permanently_ in the output. 1. Create an egress `Gateway` for _edition.cnn.com_, port 443, and a destination rule for sidecar requests that will be directed to the egress gateway. Choose the instructions corresponding to whether or not you want to enable [mutual TLS Authentication](/docs/tasks/security/mutual-tls/) between the source pod and the egress gateway. {{< idea >}} You may want to enable mutual TLS so the traffic between the source pod and the egress gateway will be encrypted. In addition, mutual TLS will allow the egress gateway to monitor the identity of the source pods and enable Mixer policy enforcement based on that identity. {{< /idea >}} {{< tabset cookie-name="mtls" >}} {{< tab name="mutual TLS enabled" cookie-value="enabled" >}} {{< text_hack bash >}} $ kubectl apply -f - <}} {{< /tab >}} {{< tab name="mutual TLS disabled" cookie-value="disabled" >}} {{< text_hack bash >}} $ kubectl apply -f - <}} {{< /tab >}} {{< /tabset >}} 1. Define a `VirtualService` to direct the traffic through the egress gateway, and a `DestinationRule` to perform TLS origination for requests to `edition.cnn.com`: {{< text bash >}} $ kubectl apply -f - <}} 1. Send an HTTP request to [http://edition.cnn.com/politics](https://edition.cnn.com/politics). {{< text bash >}} $ kubectl exec -it $SOURCE_POD -c sleep -- curl -sL -o /dev/null -D - http://edition.cnn.com/politics HTTP/1.1 200 OK ... content-length: 150793 ... {{< /text >}} The output should be the same as in the [TLS Origination for Egress Traffic](/docs/examples/advanced-gateways/egress-tls-origination/) example, with TLS origination: without the _301 Moved Permanently_ message. 1. Check the log of the `istio-egressgateway` pod and you should see a line corresponding to our request. If Istio is deployed in the `istio-system` namespace, the command to print the log is: {{< text bash >}} $ kubectl logs -l istio=egressgateway -c istio-proxy -n istio-system | tail {{< /text >}} You should see a line similar to the following: {{< text plain>}} "[2018-06-14T13:49:36.340Z] "GET /politics HTTP/1.1" 200 - 0 148528 5096 90 "172.30.146.87" "curl/7.35.0" "c6bfdfc3-07ec-9c30-8957-6904230fd037" "edition.cnn.com" "151.101.65.67:443" {{< /text >}} ### Cleanup the TLS origination example Remove the Istio configuration items you created: {{< text bash >}} $ kubectl delete gateway istio-egressgateway $ kubectl delete serviceentry cnn $ kubectl delete virtualservice direct-cnn-through-egress-gateway $ kubectl delete destinationrule originate-tls-for-edition-cnn-com $ kubectl delete destinationrule egressgateway-for-cnn {{< /text >}} ## Perform mutual TLS origination with an egress gateway Similar to the previous section, this section describes how to configure an egress gateway to perform TLS origination for an external service, only this time using a service that requires mutual TLS. This example is considerably more involved because you need to first: 1. generate client and server certificates 1. deploy an external service that supports the mutual TLS protocol 1. redeploy the egress gateway with the needed mutual TLS certs Only then can you configure the external traffic to go through the egress gateway which will perform TLS origination. ### Generate client and server certificates and keys 1. Clone the repository: {{< text bash >}} $ git clone https://github.com/nicholasjackson/mtls-go-example {{< /text >}} 1. Change directory to the cloned repository: {{< text bash >}} $ cd mtls-go-example {{< /text >}} 1. Generate the certificates for `nginx.example.com`. Use any password with the following command: {{< text bash >}} $ ./generate.sh nginx.example.com password {{< /text >}} Select `y` for all prompts that appear. 1. Move the certificates into the `nginx.example.com` directory: {{< text bash >}} $ mkdir ../nginx.example.com && mv 1_root 2_intermediate 3_application 4_client ../nginx.example.com {{< /text >}} 1. Go back to your previous directory: {{< text bash >}} $ cd .. {{< /text >}} ### Deploy a mutual TLS server To simulate an actual external service that supports the mutual TLS protocol, deploy an [NGINX](https://www.nginx.com) server in your Kubernetes cluster, but running outside of the Istio service mesh, i.e., in a namespace without Istio sidecar proxy injection enabled. 1. Create a namespace to represent services outside the Istio mesh, namely `mesh-external`. Note that the sidecar proxy will not be automatically injected into the pods in this namespace since the automatic sidecar injection was not [enabled](/docs/setup/kubernetes/additional-setup/sidecar-injection/#deploying-an-app) on it. {{< text bash >}} $ kubectl create namespace mesh-external {{< /text >}} 1. Create Kubernetes [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to hold the server's and CA certificates. {{< text bash >}} $ kubectl create -n mesh-external secret tls nginx-server-certs --key nginx.example.com/3_application/private/nginx.example.com.key.pem --cert nginx.example.com/3_application/certs/nginx.example.com.cert.pem $ kubectl create -n mesh-external secret generic nginx-ca-certs --from-file=nginx.example.com/2_intermediate/certs/ca-chain.cert.pem {{< /text >}} 1. Create a configuration file for the NGINX server: {{< text bash >}} $ cat < ./nginx.conf events { } http { log_format main '$remote_addr - $remote_user [$time_local] $status ' '"$request" $body_bytes_sent "$http_referer" ' '"$http_user_agent" "$http_x_forwarded_for"'; access_log /var/log/nginx/access.log main; error_log /var/log/nginx/error.log; server { listen 443 ssl; root /usr/share/nginx/html; index index.html; server_name nginx.example.com; ssl_certificate /etc/nginx-server-certs/tls.crt; ssl_certificate_key /etc/nginx-server-certs/tls.key; ssl_client_certificate /etc/nginx-ca-certs/ca-chain.cert.pem; ssl_verify_client on; } } EOF {{< /text >}} 1. Create a Kubernetes [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/) to hold the configuration of the NGINX server: {{< text bash >}} $ kubectl create configmap nginx-configmap -n mesh-external --from-file=nginx.conf=./nginx.conf {{< /text >}} 1. Deploy the NGINX server: {{< text bash >}} $ kubectl apply -f - <}} 1. Define a `ServiceEntry` and a `VirtualService` for `nginx.example.com` to instruct Istio to direct traffic destined to `nginx.example.com` to your NGINX server: {{< text bash >}} $ kubectl apply -f - <}} #### Deploy a container to test the NGINX deployment 1. Create Kubernetes [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to hold the client's and CA certificates: {{< text bash >}} $ kubectl create secret tls nginx-client-certs --key nginx.example.com/4_client/private/nginx.example.com.key.pem --cert nginx.example.com/4_client/certs/nginx.example.com.cert.pem $ kubectl create secret generic nginx-ca-certs --from-file=nginx.example.com/2_intermediate/certs/ca-chain.cert.pem {{< /text >}} 1. Deploy the [sleep]({{< github_tree >}}/samples/sleep) sample with mounted client and CA certificates to test sending requests to the NGINX server: {{< text bash >}} $ kubectl apply -f - <}} 1. Define an environment variable to hold the name of the `sleep` pod: {{< text bash >}} $ export SOURCE_POD=$(kubectl get pod -l app=sleep -o jsonpath={.items..metadata.name}) {{< /text >}} 1. Use the deployed [sleep]({{< github_tree >}}/samples/sleep) pod to send requests to the NGINX server. Since `nginx.example.com` does not actually exist and therefore DNS cannot resolve it, the following `curl` command uses the `--resolve` option to resolve the hostname manually. The IP value passed in the --resolve option (1.1.1.1 below) is not significant. Any value other than 127.0.0.1 can be used. Normally, a DNS entry exists for the destination hostname and you would not use the `--resolve` option of `curl`. {{< text bash >}} $ kubectl exec -it $SOURCE_POD -c sleep -- curl -v --resolve nginx.example.com:443:1.1.1.1 --cacert /etc/nginx-ca-certs/ca-chain.cert.pem --cert /etc/nginx-client-certs/tls.crt --key /etc/nginx-client-certs/tls.key https://nginx.example.com ... Server certificate: subject: C=US; ST=Denial; L=Springfield; O=Dis; CN=nginx.example.com start date: 2018-08-16 04:31:20 GMT expire date: 2019-08-26 04:31:20 GMT common name: nginx.example.com (matched) issuer: C=US; ST=Denial; O=Dis; CN=nginx.example.com SSL certificate verify ok. > GET / HTTP/1.1 > User-Agent: curl/7.35.0 > Host: nginx.example.com ... < HTTP/1.1 200 OK < Server: nginx/1.15.2 ... Welcome to nginx! ... {{< /text >}} 1. Verify that the server requires the client's certificate: {{< text bash >}} $ kubectl exec -it $(kubectl get pod -l app=sleep -o jsonpath={.items..metadata.name}) -c sleep -- curl -k --resolve nginx.example.com:443:1.1.1.1 https://nginx.example.com 400 No required SSL certificate was sent

400 Bad Request

No required SSL certificate was sent

nginx/1.15.2
{{< /text >}} ### Redeploy the Egress Gateway with the client certificates 1. Create Kubernetes [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to hold the client's and CA certificates. {{< text bash >}} $ kubectl create -n istio-system secret tls nginx-client-certs --key nginx.example.com/4_client/private/nginx.example.com.key.pem --cert nginx.example.com/4_client/certs/nginx.example.com.cert.pem $ kubectl create -n istio-system secret generic nginx-ca-certs --from-file=nginx.example.com/2_intermediate/certs/ca-chain.cert.pem {{< /text >}} 1. Generate the `istio-egressgateway` deployment with a volume to be mounted from the new secrets. Use the same options you used for generating your `istio.yaml`: {{< text bash >}} $ helm template install/kubernetes/helm/istio/ --name istio --namespace istio-system -x charts/gateways/templates/deployment.yaml --set gateways.istio-ingressgateway.enabled=false \ --set gateways.istio-egressgateway.enabled=true \ --set 'gateways.istio-egressgateway.secretVolumes[0].name'=egressgateway-certs \ --set 'gateways.istio-egressgateway.secretVolumes[0].secretName'=istio-egressgateway-certs \ --set 'gateways.istio-egressgateway.secretVolumes[0].mountPath'=/etc/istio/egressgateway-certs \ --set 'gateways.istio-egressgateway.secretVolumes[1].name'=egressgateway-ca-certs \ --set 'gateways.istio-egressgateway.secretVolumes[1].secretName'=istio-egressgateway-ca-certs \ --set 'gateways.istio-egressgateway.secretVolumes[1].mountPath'=/etc/istio/egressgateway-ca-certs \ --set 'gateways.istio-egressgateway.secretVolumes[2].name'=nginx-client-certs \ --set 'gateways.istio-egressgateway.secretVolumes[2].secretName'=nginx-client-certs \ --set 'gateways.istio-egressgateway.secretVolumes[2].mountPath'=/etc/nginx-client-certs \ --set 'gateways.istio-egressgateway.secretVolumes[3].name'=nginx-ca-certs \ --set 'gateways.istio-egressgateway.secretVolumes[3].secretName'=nginx-ca-certs \ --set 'gateways.istio-egressgateway.secretVolumes[3].mountPath'=/etc/nginx-ca-certs > \ ./istio-egressgateway.yaml {{< /text >}} 1. Redeploy `istio-egressgateway`: {{< text bash >}} $ kubectl apply -f ./istio-egressgateway.yaml deployment "istio-egressgateway" configured {{< /text >}} 1. Verify that the key and the certificate are successfully loaded in the `istio-egressgateway` pod: {{< text bash >}} $ kubectl exec -it -n istio-system $(kubectl -n istio-system get pods -l istio=egressgateway -o jsonpath='{.items[0].metadata.name}') -- ls -al /etc/nginx-client-certs /etc/nginx-ca-certs {{< /text >}} `tls.crt` and `tls.key` should exist in `/etc/istio/nginx-client-certs`, while `ca-chain.cert.pem` in `/etc/istio/nginx-ca-certs`. ### Configure mutual TLS origination for egress traffic 1. Create an egress `Gateway` for `nginx.example.com`, port 443, and destination rules and virtual services to direct the traffic through the egress gateway and from the egress gateway to the external service. {{< text bash >}} $ kubectl apply -f - <}} 1. Define a `VirtualService` to direct the traffic through the egress gateway, and a `DestinationRule` to perform mutual TLS origination: {{< text bash >}} $ kubectl apply -f - <}} 1. Send an HTTP request to `http://nginx.example.com`: {{< text bash >}} $ kubectl exec -it $SOURCE_POD -c sleep -- curl -s --resolve nginx.example.com:80:1.1.1.1 http://nginx.example.com Welcome to nginx! ... {{< /text >}} 1. Check the log of the `istio-egressgateway` pod for a line corresponding to our request. If Istio is deployed in the `istio-system` namespace, the command to print the log is: {{< text bash >}} $ kubectl logs -l istio=egressgateway -n istio-system | grep 'nginx.example.com' | grep HTTP {{< /text >}} You should see a line similar to the following: {{< text plain>}} [2018-08-19T18:20:40.096Z] "GET / HTTP/1.1" 200 - 0 612 7 5 "172.30.146.114" "curl/7.35.0" "b942b587-fac2-9756-8ec6-303561356204" "nginx.example.com" "172.21.72.197:443" {{< /text >}} ### Cleanup the mutual TLS origination example 1. Remove created Kubernetes resources: {{< text bash >}} $ kubectl delete secret nginx-server-certs nginx-ca-certs -n mesh-external $ kubectl delete secret nginx-client-certs nginx-ca-certs $ kubectl delete secret nginx-client-certs nginx-ca-certs -n istio-system $ kubectl delete configmap nginx-configmap -n mesh-external $ kubectl delete service my-nginx -n mesh-external $ kubectl delete deployment my-nginx -n mesh-external $ kubectl delete namespace mesh-external $ kubectl delete gateway istio-egressgateway $ kubectl delete serviceentry nginx $ kubectl delete virtualservice direct-nginx-through-egress-gateway $ kubectl delete destinationrule originate-mtls-for-nginx $ kubectl delete destinationrule egressgateway-for-nginx {{< /text >}} 1. Delete the directory of certificates and the repository used to generate them: {{< text bash >}} $ rm -rf nginx.example.com mtls-go-example {{< /text >}} 1. Delete the generated configuration files used in this example: {{< text bash >}} $ rm -f ./nginx.conf ./istio-egressgateway.yaml {{< /text >}} ## Cleanup Delete the `sleep` service and deployment: {{< text bash >}} $ kubectl delete service sleep $ kubectl delete deployment sleep {{< /text >}}