Key Authentication

1. Create a new key-auth plugin.

    echo "
    apiVersion: configuration.konghq.com/v1
    kind: KongPlugin
    metadata:
      name: key-auth
      namespace: kong
      annotations:
        kubernetes.io/ingress.class: kong
    plugin: key-auth
    " | kubectl apply -f -
   

   Copied!

   Next, apply the KongPlugin resource by annotating the KongKongservice resource:

    kubectl annotate -n kong  service konghq.com/plugins=rate-limit-5-min,proxy-cache-all-endpoints,key-auth --overwrite
   

   Copied!

2. Test that the API is secure by sending a request using curl -i $PROXY_IP/anything:

    curl -i $PROXY_IP/anything 
   

   Copied!

   This request returns a 401 error with the message Unauthorized.

   You should see the response:

    HTTP/1.1 401 Unauthorized
    Date: Wed, 11 Jan 2044 18:33:46 GMT
    Content-Type: application/json; charset=utf-8
    WWW-Authenticate: Key realm="kong"
    Content-Length: 45
    X-Kong-Response-Latency: 1
    Server: kong/3.9.1
   
    {
      "message":"No API key found in request"
    }
   

   Copied!

Key authentication in Kong Gateway works by using the Consumer entity. Keys are assigned to Consumers, and client applications present the key within the requests they make.

Keys are stored as Kubernetes Secrets and Consumers are managed with the KongConsumer CRD.

1. Create a new Secret labeled to use key-auth credential type:

    echo '
    apiVersion: v1
    kind: Secret
    metadata:
       name: alex-key-auth
       namespace: kong
       labels:
          konghq.com/credential: key-auth
    stringData:
       key: hello_world
    ' | kubectl apply -f -
   

   Copied!

2. Create a new Consumer and attach the credential:

    echo "
    apiVersion: configuration.konghq.com/v1
    kind: KongConsumer
    metadata:
      name: alex
      namespace: kong
      annotations:
        kubernetes.io/ingress.class: kong
    username: alex
    credentials:
    - alex-key-auth
    spec:
      controlPlaneRef:
        type: konnectNamespacedRef
        konnectNamespacedRef:
          name: gateway-control-plane
    " | kubectl apply -f -
   

   Copied!

3. Make a request to the API and provide your apikey:

     curl "$PROXY_IP/anything" \
         -H "apikey:hello_world"
   

   Copied!

   The results will return successfully.