Use Built-in Database

EMQX provides users with a low-cost, out-of-the-box authorization rule storage method through the built-in database. You can use the built-in database (Mnesia) as a data source by setting it up through the Dashboard or configuration files, and add relevant authorization check rules through the Dashboard or HTTP API.

Prerequisite

Knowledge about basic EMQX authorization concepts

Configure with Dashboard

1. On EMQX Dashboard, click Access Control -> Authorization on the left navigation tree to enter the Authorization page.

2. Click Create at the top right corner, select Built-in Database as Backend, and click Next.

   

3. As built-in database authorization does not require configuration parameters, you can click Create to finish.

Configure with Configuration File

The built-in database authorizer is identified by type built_in_database.

Sample configuration:

{
    type = built_in_database
    enable = true
}

• type: The data source type of the authorization checker; fill in built_in_database here.

• enable: Whether to activate this checker; optional values: true, false.

Create Authorization Rules

You can create authorization rules through Dashboard or API.

Create with Dashboard

On the Authorization page in Dashboard, click the Permissions button in the Actions column of the Built-in Database backend.

You can set authorization checks based on the client ID, username, or topic as needed.

• Client ID: See the Client ID tab, specify the client that this rule applies to.
• Username: See the Username tab, specify the user that this rule applies to.
• Permission: Whether to allow or deny a certain type of operation request from the current client/user; optional values: Allow, Deny.
• Action: Configure the operation corresponding to this rule; optional values: Publish, Subscribe, Publish & Subscribe.
• Topic: Configure the topic corresponding to this rule.

EMQX supports configuring multiple authorization check rules for a single client or user, and you can adjust the execution order and priority of different rules through the Move Up and Move Down buttons on the page.

If you want to configure authorization check rules for multiple clients or users at the same time, you can import the relevant configuration through the HTTP API.

Create with API

Rules are also managed through /api/v5/authorization/sources/built_in_database APIs.

To manage authorization rules via API for the Built-in Database backend, follow these steps:

Step 1: Obtain Authentication Token

You need to authenticate with the EMQX Dashboard to obtain a token for API access:

export EMQX_TOKEN=$(curl --silent -X 'POST' "http://localhost:18083/api/v5/login" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"username": "admin","password": "public"}' | jq -r ".token")

Step 2: Create the Built-in Database Authorization Source

curl -X 'POST' \
  'http://localhost:18083/api/v5/authorization/sources' \
  -H "Authorization: Bearer $EMQX_TOKEN" \
  -H 'Accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
        "enable": true,
        "max_rules": 100,
        "type": "built_in_database"
  }'

Step 3: Create Authorization Rules

You can create rules for:

• A specific client by client ID:

  curl -X 'POST' \
    'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/clients' \
    -H "Authorization: Bearer $EMQX_TOKEN" \
    -H 'Accept: */*' \
    -H 'Content-Type: application/json' \
    -d '[
    {
      "clientid": "client1",
      "rules": [
        {
          "action": "publish",
          "permission": "allow",
          "topic": "test/topic/1"
        },
        {
          "action": "subscribe",
          "permission": "allow",
          "topic": "test/topic/2"
        },
        {
          "action": "all",
          "permission": "deny",
          "topic": "eq test/#"
        }
      ]
    }
  ]'

• A specific client by username:

  curl -X 'POST' \
    'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/users' \
    -H "Authorization: Bearer $EMQX_TOKEN" \
    -H 'Accept: */*' \
    -H 'Content-Type: application/json' \
    -d '[
    {
      "username": "user1",
      "rules": [
        {
          "action": "publish",
          "permission": "allow",
          "topic": "test/topic/1"
        },
        {
          "action": "subscribe",
          "permission": "allow",
          "topic": "test/topic/2"
        },
        {
          "action": "all",
          "permission": "deny",
          "topic": "eq test/#"
        }
      ]
    }
  ]'

• All clients globally:

  curl -X 'POST' \
    'http://localhost:18083/api/v5/authorization/sources/built_in_database/rules/all' \
    -H "Authorization: Bearer $EMQX_TOKEN" \
    -H 'Accept: */*' \
    -H 'Content-Type: application/json' \
    -d '{
    "rules": [
      {
        "action": "publish",
        "permission": "allow",
        "topic": "test/topic/1"
      },
      {
        "action": "subscribe",
        "permission": "allow",
        "topic": "test/topic/2"
      },
      {
        "action": "all",
        "permission": "deny",
        "topic": "eq test/#"
      }
    ]
  }'

Each rule includes:

• permission: Whether to allow or deny the operation; values: allow, deny.
• action: Operation type; values: publish, subscribe, or all.
• topic: Topic filter; supports topic placeholders.
• qos: (Optional) An array of QoS levels this rule applies to, e.g., [0, 1]. Defaults to all QoS levels.
• retain: (Optional) Whether the rule applies to retained messages; values: true, false. Defaults to allow retained messages.