DocsEmissary-ingressBasic authentication (for Emissary-ingress)
Basic authentication (for Emissary-ingress)
Emissary-ingress can authenticate incoming requests before routing them to a backing service. In this tutorial, we'll configure Emissary-ingress to use an external third party authentication service. We're assuming also that you are running the quote application in your cluster as described in the Emissary-ingress tutorial.
Before you get started
This tutorial assumes you have already followed the Emissary-ingress Installation guide. If you haven't done that already, you should do so now.
Once complete, you'll have a Kubernetes cluster running Emissary-ingress. Let's walk through adding authentication to this setup.
1. Deploy the authentication service
Emissary-ingress delegates the actual authentication logic to a third party authentication service. We've written a simple authentication service that:
- listens for requests on port 3000;
- expects all URLs to begin with
- performs HTTP Basic Auth for all URLs starting with
/backend/get-quote/(other URLs are always permitted);
- accepts only user
- makes sure that the
x-qotm-sessionheader is present, generating a new one if needed.
Emissary-ingress routes all requests through the authentication service: it relies on the auth service to distinguish between requests that need authentication and those that do not. If Emissary-ingress cannot contact the auth service, it will return a 503 for the request; as such, it is very important to have the auth service running before configuring Emissary-ingress to use it.
Here's the YAML we'll start with:
Note that the cluster does not yet contain any Emissary-ingress AuthService definition. This is intentional: we want the service running before we tell Emissary-ingress about it.
The YAML above is published at getambassador.io, so if you like, you can just do
to spin everything up. (Of course, you can also use a local file, if you prefer.)
Wait for the pod to be running before continuing. The output of
kubectl get pods should look something like
Note that the
READY field says
1/1 which means the pod is up and running.
2. Configure Emissary-ingress authentication
Once the auth service is running, we need to tell Emissary-ingress about it. The easiest way to do that is point it to the
example-auth service with the following:
This configuration tells Emissary-ingress about the auth service, notably that it needs the
/extauth prefix, and that it's OK for it to pass back the
x-qotm-session header. Note that
allowed_*_headers are optional.
If the auth service uses a framework like Gorilla Toolkit which enforces strict slashes as HTTP path separators, it is possible to end up with an infinite redirect where the auth service's framework redirects any request with non-conformant slashing. This would arise if the above example had
path_prefix: "/extauth/", the auth service would see a request for
/extauth//backend/get-quote/ which would then be redirected to
/extauth/backend/get-quote/ rather than actually be handled by the authentication handler. For this reason, remember that the full path of the incoming request including the leading slash, will be appended to
path_prefix regardless of non-conformant slashing.
You can apply this file from getambassador.io with
or, again, apply it from a local file if you prefer.
Note that the cluster does not yet contain any Emissary-ingress AuthService definition.
3. Test authentication
curl to a protected URL:
We get a 401 since we haven't authenticated.
If we authenticate to the service, we will get a quote successfully:
For more details about configuring authentication, see the
External filter documentation.