API Key authentication with rate limiting

The API key authentication enables a Role-Based Access Control (RBAC) and a rate-limiting mechanism based on an API key passed by the client. For the desired endpoints, KrakenD rejects requests from users that do not provide a valid key, are trying to access a resource with insufficient permissions for the user’s role, or are exceeding the defined quota.

The authentication is granular and works per-endpoint, meaning that you can combine public endpoints (no API Key needed) and private endpoints in the same configuration.

The API Key component requires you to declare at least two different blocks of configuration:

1. The declaration of all known users and roles, placed at the root’s extra_config middleware section.
2. The association of which endpoints are protected, placed at each endpoint.

Declaring API Key users and roles

The first block of configuration declares how KrakenD retrieves keys, which ones are available, and the roles recognized by the system. The API keys configuration requires at least the keys attribute with a list of objects declaring each client’s key and roles. The configuration is as follows:

{
  "version": 3,
  "extra_config": {
    "auth/api-keys": {
      "strategy": "header",
      "identifier": "Authorization",
      "keys": [
        {
          "key": "4d2c61e1-34c4-e96c-9456-15bd983c5019",
          "roles": ["role1", "role2"],
          "@description": "ACME Inc."
        },
        {
          "key": "58427514-be32-0b52-b7c6-d01fada30497",
          "roles": ["role1","role3"],
          "@description": "Administrators Inc."
        }
      ]
    }
  }
}

The configuration attributes are:

It is also shown in the example a @description attribute to help you identify who this key belongs to. This attribute is metadata and unneeded by KrakenD, but it easies the administration of keys. Use attributes starting with @ to place comments in the file.

Protecting endpoints by API Key

Now that all users and roles are declared, it’s time to reference them in the endpoints. You must include the namespace auth/api-keys in its extra_config for all the endpoints needing API Key validation. Any endpoints not having the namespace are not API Key protected. For example, the endpoints could look like this:

{
  "endpoint": "/admin",
  "backend": [
    {
      "url_pattern": "/__debug/admin",
      "host": [
        "http://localhost:8080"
      ]
    }
  ],
  "extra_config": {
    "auth/api-keys": {
      "roles": [
        "admin"
      ],
      "client_max_rate": 5
    }
  }
}

The endpoint configuration accepts the following parameters:

Here is a full example of two different API Keys that can access three different endpoints:

{
  "version": 3,
  "extra_config": {
    "auth/api-keys": {
      "keys": [
        {
          "@description": "ACME Inc.",
          "key": "4d2c61e1-34c4-e96c-9456-15bd983c5019",
          "roles": ["user", "whitelabel"]
        },
        {
          "@description": "Administrators Inc.",
          "key": "58427514-be32-0b52-b7c6-d01fada30497",
          "roles": ["admin", "user"]
        }
      ]
    }
  },
  "endpoints": [
    {
      "endpoint": "/public",
      "backend": [
        {
          "url_pattern": "/__debug/public",
          "host": [
            "http://localhost:8080"
          ]
        }
      ]
    },
    {
      "endpoint": "/admin",
      "backend": [
        {
          "url_pattern": "/__debug/admin",
          "host": [
            "http://localhost:8080"
          ]
        }
      ],
      "extra_config": {
        "auth/api-keys": {
          "roles": [
            "admin"
          ],
          "client_max_rate": 5
        }
      }
    },
    {
      "endpoint": "/user",
      "backend": [
        {
          "url_pattern": "/__debug/user",
          "host": [
            "http://localhost:8080"
          ]
        }
      ],
      "extra_config": {
        "auth/api-keys": {
          "roles": [
            "user"
          ]
        }
      }
    }
  ]
}

Authenticating requests using API Key

When you don’t set any strategy in the configuration clients, clients need to make requests to KrakenD adding the Authorization: Bearer or Authorization: Basic header. The value inside the header must strictly match the API key defined in the configuration.

Using Bearer

The format of the header is as follows:

Authorization: Bearer YOUR-KEY

For instance, having declared in the configuration a key 4d2c61e1-34c4-e96c-9456-15bd983c5019 that should be capable of seeing /foo, you should make a call like this:

Using Basic authentication instead of Bearer

Another way of authenticating is using Basic authentication. It does not present any benefit compared to Bearer other than backward compatibility with legacy implementations.

The difference is that clients must pass the key in base64:

Authorization: Basic base64(YOUR-KEY:)

Notice that the encoding of the key contains an ending :. The final colon prevents your client from being asked for a password.

Basic authentication example

Repeating the previous Bearer example, let’s connect using Basic authentication now. The firs step is to base64-encode:

And then pass the header_

You can also not do the base64 encoding if you use a client with regular basic auth implemented, which will encode automatically (again, notice the : at the end of the key):

In case you forget the colon : you’ll be prompted for the password (when there isn’t):

Using a custom Authorization header

Using the identifier option, you can replace Authorization with any other header. But in all cases, whatever header you choose, the Bearer or the Basic must be part of the header as described above.

For instance:

{
  "auth/api-keys": {
    "strategy": "header",
    "identifier": "X-Key"
  }
}

Clients will need to make calls like

Passing the API key using a query string

If you set the strategy to query_string, clients can directly pass the key on the URL using ’ ?key=xxxx`. For instance:

You can set a different identifier section instead of key to something else. For instance, let’s use ?mycustomapikey=xxxx:

{
  "auth/api-keys": {
    "strategy": "query_string",
    "identifier": "mycustomapikey",
    "keys": [{}]
  }
}

A configuration like the above will require users to make calls like this:

Complete API Key configuration example

The following configuration snippet is fully functional. Run KrakenD with the debug flag (krakend run -d) to test it locally, as it uses itself as a backend. Explanation below:

{
    "version": 3,
    "extra_config": {
        "auth/api-keys": {
            "keys": [
                {
                    "@description": "ACME Inc.",
                    "key": "4d2c61e1-34c4-e96c-9456-15bd983c5019",
                    "roles": [
                        "user",
                        "whitelabel"
                    ]
                },
                {
                    "@description": "Administrators Inc.",
                    "key": "58427514-be32-0b52-b7c6-d01fada30497",
                    "roles": [
                        "admin",
                        "user"
                    ]
                }
            ]
        }
    },
    "endpoints": [
        {
            "endpoint": "/public",
            "backend": [
                {
                    "url_pattern": "/__debug/public",
                    "host": [
                        "http://localhost:8080"
                    ]
                }
            ]
        },
        {
            "endpoint": "/admin",
            "backend": [
                {
                    "url_pattern": "/__debug/admin",
                    "host": [
                        "http://localhost:8080"
                    ]
                }
            ],
            "extra_config": {
                "auth/api-keys": {
                    "roles": [
                        "admin"
                    ]
                }
            }
        },
        {
            "endpoint": "/user",
            "backend": [
                {
                    "url_pattern": "/__debug/user",
                    "host": [
                        "http://localhost:8080"
                    ]
                }
            ],
            "extra_config": {
                "auth/api-keys": {
                    "roles": [
                        "user"
                    ]
                }
            }
        }
    ]
}

In this example, we have enabled two different API users. One with key 4d2c61e1-34c4-e96c-9456-15bd983c5019 (let’s say a customer of ACME Inc.) and another one with the key 58427514-be32-0b52-b7c6-d01fada30497 (an administrator of my company).

Both users share the role users, and they can access all the protected endpoints as this role is included. Nevertheless, the /admin endpoint is reachable by the administrator only, as the role “admin” is required.

The endpoint /public is always accessible, with or without the Authorization header, as it does not include the API key middleware configuration.

And now some sample interactions:

Onboard new API key customers without restarts

As the KrakenD configuration is static and does not change until you restart the process or you do a deployment, you might find it inconvenient to onboard new customers with new API keys, and you don’t want to be restarting the server every time. The following advice can be handy.

Instead of waiting for user registration in your system to insert a new API key, create a pool of available API keys. KrakenD has a constant performance, so it doesn’t change if you have 100 keys or 1 million.

An easy way to generate API keys could be as follows:

If you want to generate several keys and write part of the configuration file, you could use something like:

Then you would use the output above to create a partial file api-keys.json that would be used on KrakenD with Flexible Configuration.

Finally, your backend should have this list somewhere, and when a new user registers, you assign one of the free keys to the new user. You can deploy from time to time when you are running out of API keys in the pool or if you want to write the assignation in the configuration.