Set Up API Authentication

For security, you should only allow authenticated and authorized consumers to access your APIs. API7 Gateway provides several plugins to enable authentication and authorization.

Authentication plugins act as locks on your APIs, while consumer credentials serve as the keys to unlock them. Consumers are usually created after APIs are published. In API7 Gateway, you need a unique username and at least one credential to set up a consumer.

This guide walks you through enabling a simple key-based authentication using the key-auth plugin.

Prerequisite(s)

1. Install API7 Enterprise.
2. Have a running API on the gateway group.

Add a Consumer with Key Authentication

A consumer is an entity that consumes your APIs. This example will create a consumer named Alice.

Dashboard

1. Select the gateway group where your service is published.
2. Select Consumers from the side navigation bar.
3. Click Add Consumer.
4. From the dialog box, do the following:

• In the Name field, enter Alice.
• Click Add.

5. In the consumer you just created under the Plugins field, search for the key-auth plugin.
6. Click the Plus icon (+).
7. In the dialog box do the following:

• Add the following configuration to the JSON Editor:

  {
    "key": "secret-key"
  }

• Click Enable.

ADC

To use ADC to create a consumer, create the following configuration:

adc-consumer.yaml

consumers:
  - username: Alice
    plugins:
      key-auth:
        _meta:
          disable: false
        key: secret-key

Synchronize the configuration to API7 Gateway:

adc sync -f adc-consumer.yaml

Ingress Controller

Create a Kubernetes manifest file to configure a consumer using the ApisixConsumer custom resource:

consumer.yaml

apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
  name: alice
  # namespace: api7    # replace with your namespace
spec:
  authParameter:
    keyAuth:
      value:
        key: "secret-key"

Apply the configurations to your cluster:

kubectl apply -f consumer.yaml

Enable Key Authentication for APIs

For a Service

To use key authentication for all routes in a service, enable the key-auth plugin on the service.

note

You cannot enable other authentication plugins on a route if you have enabled the key-auth plugin on the service.

Dashboard

1. Select Published Services of your gateway group from the side navigation bar, then select the service you want to modify, for example, httpbin with version 1.0.0.
2. Select Plugins from the side navigation bar, then click Enable Plugin.
3. Search for the key-auth plugin, then click Enable.
4. In the dialog box do the following:

• Add the following configuration to the JSON Editor:

  {
  }

• Click Enable.

ADC

Update the service configuration to use key authentication:

adc-service.yaml

services:
  - name: httpbin
    upstream:
      name: default
      scheme: http
      nodes:
        - host: httpbin.org
          port: 80
          weight: 100
    plugins:
      key-auth:
        _meta:
          disable: false
    routes:
      - uris:
          - /ip
        name: get-ip
        methods:
          - GET

Synchronize the configuration to API7 Enterprise:

adc sync -f adc-consumer.yaml -f adc-service.yaml

note

ADC uses the configuration files as the single source of truth. So make sure to pass both the consumer and service configuration files to the adc sync command for both configurations to take effect.

Ingress Controller

ApisixService custom resource is not yet available.

For a Single Route

Dashboard

To use key authentication for a specific route, enable the key-auth plugin on the route instead of the service.

1. Select Published Services of your gateway group from the side navigation bar, then select the service you want to modify, for example, httpbin with version 1.0.0.
2. Under the published service, select Routes from the side navigation bar.
3. Select your target route, for example, get-ip.
4. In the Plugin field, click Enable Plugin.
5. Search for the key-auth plugin, then click Enable.
6. In the dialog box do the following:

• Add the following configuration to the JSON Editor:

  {
  }

• Click Enable.

ADC

Update the route configuration to use key authentication:

adc-route.yaml

services:
  - name: httpbin
    upstream:
      name: default
      scheme: http
      nodes:
        - host: httpbin.org
          port: 80
          weight: 100
    routes:
      - uris:
          - /ip
        name: get-ip
        methods:
          - GET
        plugins:
          key-auth:
            _meta:
              disable: false

Synchronize the configuration to API7 Gateway:

adc sync -f adc-consumer.yaml -f adc-route.yaml

note

ADC uses the configuration files as the single source of truth. So make sure to pass both the consumer and service configuration files to the adc sync command for both configurations to take effect.

Ingress Controller

Create a Kubernetes manifest file for a route, where key authentication is enabled:

httpbin-route.yaml

apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
  name: get-ip
  # namespace: api7    # replace with your namespace
spec:
  http:
    - name: get-ip
      match:
        paths:
          - /ip
        methods:
          - GET
      backends:
        - serviceName: httpbin
          servicePort: 80
      authentication:
        enable: true
        type: keyAuth

Apply the configurations to your cluster:

kubectl apply -f httpbin-route.yaml

Validate

Follow the steps below to validate the key authentication.

Send a Request without a Key

Send a request without the apikey header:

curl -i "http://127.0.0.1:9080/ip"  

Since the key is not provided, you will receive an HTTP/1.1 401 Unauthorized response with the following request body:

{"message":"Missing API key found in request"}

Send a Request with a Wrong Key

Send a request with a wrong key in the apikey header:

curl -i "http://127.0.0.1:9080/ip" -H "apikey: wrongkey" 

Since the key is wrong, you will receive an HTTP/1.1 401 Unauthorized response with the following request body:

{"message":"Invalid API key in request"}

Send a Request with the Correct Key

Send a request with the correct key in the apikey header:

curl -i "http://127.0.0.1:9080/ip" -H "apikey: secret-key" 

With the correct key in the request, you will receive an HTTP/1.1 200 OK response with the following request body:

{
  "origin": "192.168.0.102, 35.259.159.12"
}

Additional Resource(s)

• Key Concepts
  • Services
  • Routes
  • Plugins
• API Consumption
  • Manage Consumer Credentials
  • Apply list-based access control