Basic external auth policy

Basic authentication sends encoded user credentials in a standard header within the request. Then, Gloo Mesh authenticates the request against a dictionary of usernames and passwords that are written in the external auth policy. If the credentials in the request header match the policy, the request is sent to the destination. If not, Gloo Mesh Gateway returns a 401 response.

You might use basic auth for testing environments, such as when you release a new API method or version to a small number of known users.

Before you begin link

1. Complete the multicluster getting started guide to set up the following testing environment.

   • Three clusters along with environment variables for the clusters and their Kubernetes contexts.
   • The Gloo meshctl CLI, along with other CLI tools such as kubectl and istioctl.
   • The Gloo management server in the management cluster, and the Gloo agents in the workload clusters.
   • Istio installed in the workload clusters.
   • A simple Gloo workspace setup.
2. Install Bookinfo and other sample apps.

3. Make sure that the external auth service is installed and running. If not, install the external auth service.

     kubectl get pods --context ${REMOTE_CONTEXT1} -A -l app=ext-auth-service
     

4. Make sure that you have the following CLI tools, or something comparable:

   • htpasswd to generate hashed, salted passwords.
   • base64 to encode strings.

Configure basic external auth policies link

You can apply a basic external auth policy at the route or destination level. For more information, see Applying policies.

1. Generate a salt and hashed password for your user credentials. The following example uses the htpasswd tool for a user named user.

     htpasswd -nbm user password
     

   Example output:

     user:$apr1$TYiryv0/$8BvzLUO9IfGPGGsPnAgSu1
     

2. Retrieve the salt and hashed password from the output of the previous step.
   • Salt: TYiryv0/
   • Hashed password: 8BvzLUO9IfGPGGsPnAgSu1
3. Review the following sample configuration file.

      apiVersion: security.policy.gloo.solo.io/v2
      kind: ExtAuthPolicy
      metadata:
        annotations:
          cluster.solo.io/cluster: ""
        name: basic-auth
        namespace: bookinfo
      spec:
        applyToDestinations:
        - port:
            number: 9080
          selector:
            labels:
              app: ratings
        config:
          glooAuth:
            configs:
            - basicAuth:
                apr:
                  users:
                    user:
                      hashedPassword: 8BvzLUO9IfGPGGsPnAgSu1
                      salt: TYiryv0/
          server:
            name: default-server
      

Review the following table to understand this configuration. For more information, see the API docs.

Apply external auth to external services link

The following example is for an external auth policy that applies to an external service. Note that this policy requires different routing table and external auth server resources, as well as an external service.

  apiVersion: security.policy.gloo.solo.io/v2
kind: ExtAuthPolicy
metadata:
  annotations:
    cluster.solo.io/cluster: ""
  name: httpbin-basic-auth
  namespace: bookinfo
spec:
  applyToRoutes:
  - route:
      labels:
        route: external-service
  config:
    glooAuth:
      configs:
      - basicAuth:
          apr:
            users:
              user:
                hashedPassword: 8BvzLUO9IfGPGGsPnAgSu1
                salt: TYiryv0/
    server:
      name: default-server
  

  apiVersion: admin.gloo.solo.io/v2
kind: ExtAuthServer
metadata:
  annotations:
    cluster.solo.io/cluster: ""
  name: default-server
  namespace: bookinfo
spec:
  destinationServer:
    port:
      number: 8083
    ref:
      cluster: cluster-1
      name: ext-auth-service
      namespace: gloo-mesh-addons
  

  apiVersion: networking.gloo.solo.io/v2
kind: ExternalService
metadata:
  annotations:
    cluster.solo.io/cluster: ""
  name: external-service
  namespace: bookinfo
spec:
  hosts:
  - httpbin.solo
  ports:
  - name: http
    number: 8080
    protocol: HTTP
  

  apiVersion: networking.gloo.solo.io/v2
kind: RouteTable
metadata:
  annotations:
    cluster.solo.io/cluster: ""
  name: external-service-northsouth
  namespace: bookinfo
spec:
  defaultDestination:
    kind: EXTERNAL_SERVICE
    port:
      number: 8080
    ref:
      name: external-service
      namespace: bookinfo
  hosts:
  - www.example.com
  http:
  - forwardTo: {}
    labels:
      "no": auth
    matchers:
    - headers:
      - name: noauth
        value: "true"
    name: external-service-no-auth
  - forwardTo: {}
    labels:
      route: external-service
    name: external-service-northsouth
  virtualGateways:
  - name: istio-ingressgateway
  

Verify basic external auth policies link

1. Make sure that the external auth service is installed and running. If not, install the external auth service.

     kubectl get pods --context ${REMOTE_CONTEXT1} -A -l app=ext-auth-service
     

2. Apply the example basic external auth policy and server in the workload cluster. The following example refers directly to the default Gloo Mesh external auth service, but you can also use a virtual destination instead. For more information, see External auth server setup. Note: Change cluster-1 as needed to your cluster’s actual name.

      kubectl apply --context ${REMOTE_CONTEXT1} -f - << EOF
      apiVersion: security.policy.gloo.solo.io/v2
      kind: ExtAuthPolicy
      metadata:
        annotations:
          cluster.solo.io/cluster: ""
        name: basic-auth
        namespace: bookinfo
      spec:
        applyToDestinations:
        - port:
            number: 9080
          selector:
            labels:
              app: ratings
        config:
          glooAuth:
            configs:
            - basicAuth:
                apr:
                  users:
                    user:
                      hashedPassword: 8BvzLUO9IfGPGGsPnAgSu1
                      salt: TYiryv0/
          server:
            name: default-server
      ---
      apiVersion: admin.gloo.solo.io/v2
      kind: ExtAuthServer
      metadata:
        annotations:
          cluster.solo.io/cluster: ""
        name: default-server
        namespace: bookinfo
      spec:
        destinationServer:
          port:
            number: 8083
          ref:
            cluster: cluster-1
            name: ext-auth-service
            namespace: gloo-mesh-addons
      EOF
      

3. View the ext-auth-service deployment logs to verify that the policy was accepted. Look for a message similar to the following: "logger":"extauth","caller":"runner/run.go:179","msg":"got new config". If you don’t see this message, check the management server logs for errors.

     meshctl logs ext-auth --kubecontext $REMOTE_CONTEXT1
     

4. Send an unauthenticated request to the reviews app.

   Use the kubectl debug command to create an ephemeral curl container in the deployment. This way, the curl container inherits any permissions from the app that you want to test. If you don’t run Kubernetes 1.23 or later, you can deploy a separate curl pod or manually add the curl container as shown in the other tab.

     kubectl --context ${REMOTE_CONTEXT1} -n bookinfo debug -i pods/$(kubectl get pod --context ${REMOTE_CONTEXT1} -l app=reviews -A -o jsonpath='{.items[0].metadata.name}') --image=curlimages/curl -- curl -v http://reviews:9080/reviews/1
     

   If the output has an error about EphemeralContainers, see Ephemeral containers don’t work when testing Bookinfo.

   Create a temporary curl pod in the bookinfo namespace, so that you can test the app setup. You can also use this method in Kubernetes 1.23 or later, but an ephemeral container might be simpler, as shown in the other tab.

   1. Create the curl pod.

        kubectl run -it -n bookinfo --context $REMOTE_CONTEXT1 curl \
        --image=curlimages/curl:7.73.0 --rm  -- sh
        

   2. Send a request to the reviews app.

        curl http://reviews:9080/reviews/1 -v
        

   Example output: Notice that the request is denied with a 401 Unauthorized response.

     HTTP/1.1 401 Unauthorized
     

5. Encode the expected user credentials in base64 format.

     echo -n "user:password" | base64
     

   Example output:

     dXNlcjpwYXNzd29yZA==
     

6. Repeat the request to the ratings app, including the authorization header with the user credentials. This time, the request succeeds.

   Use the kubectl debug command to create an ephemeral curl container in the deployment. This way, the curl container inherits any permissions from the app that you want to test. If you don’t run Kubernetes 1.23 or later, you can deploy a separate curl pod or manually add the curl container as shown in the other tab.

     kubectl --context ${REMOTE_CONTEXT1} -n bookinfo debug -i pods/$(kubectl get pod --context ${REMOTE_CONTEXT1} -l app=reviews -A -o jsonpath='{.items[0].metadata.name}') --image=curlimages/curl -- curl -v -H "Authorization: basic dXNlcjpwYXNzd29yZA==" http://reviews:9080/reviews/1
     

   Create a temporary curl pod in the bookinfo namespace, so that you can test the app setup. You can also use this method in Kubernetes 1.23 or later, but an ephemeral container might be simpler, as shown in the other tab.

   1. Create the curl pod.

        kubectl run -it -n bookinfo --context $REMOTE_CONTEXT1 curl \
        --image=curlimages/curl:7.73.0 --rm  -- sh
        

   2. Send a request to the reviews app.

        curl -H "Authorization: basic dXNlcjpwYXNzd29yZA==" http://reviews:9080/reviews/1 -v
        

   3. Exit the temporary pod. The pod deletes itself.

        exit
        

   Example output:

     HTTP/1.1 200 OK
     

7. Optional: Clean up the resources that you created.

     kubectl --context $REMOTE_CONTEXT1 -n bookinfo delete ExtAuthPolicy basic-auth
   kubectl --context $REMOTE_CONTEXT1 -n bookinfo delete ExtAuthServer default-server