Integrate with MongoDB

EMQX supports integrating with MongoDB for password authentication. EMQX MongoDB authenticator currently supports connecting to MongoDB running in three different modes, which are Single, Replica SetIntegrate with MongoDB - 图1 (opens new window) and ShardingIntegrate with MongoDB - 图2 (opens new window). This section gives detailed instructions on the data schema supported and on how to configure with EMQX Dashboard and configuration file.

TIP

Data Schema and Query Statement

EMQX MongoDB authenticator supports storing authentication data as MongoDB documents. Users need to provide a query statement template and ensure the following fields are included:

  • password_hash: required; password (in plain text or hashed) stored in the database; this field supports renaming;
  • salt: optional; salt = "" or just remove this field to indicate no salt value will be added; this field supports renaming;
  • is_superuser: optional; flag if the current client is a superuser; default: false; this field supports renaming.

For example, if we want to add a document for a superuser (is_superuser: true) with username user123, password secret, suffixed salt slat_foo123, and password hash sha256, the query statement should be:

  1. > db.mqtt_user.insertOne(
  2.   {
  3.       "username": "emqx_u",
  4.       "salt": "slat_foo123",
  5.       "is_superuser": true,
  6.       "password_hash": "44edc2d57cde8d79c98145003e105b90a14f1460b79186ea9cfe83942fc5abb5"
  7.   }
  8. );
  9. {
  10.   "acknowledged" : true,
  11.   "insertedId" : ObjectId("631989e20a33e26b05b15abe")
  12. }

TIP

When there is a significant number of users in the system, please optimize and index the tables to be queried beforehand to shorten the query response time and reduce the load for EMQX.

For this MongoDB data schema, the corresponding Dashboard configuration parameters are:

  • Password Hash: sha256
  • Salt Position: suffix
  • Collection: mqtt_user
  • Filter: { username = "${username}" }
  • Password Hash field: password_hash
  • Salt Field: salt
  • is_superuser Field： is_superuser

Configure with Dashboard

You can use EMQX Dashboard to configure how to use MongoDB for password authentication.

On EMQX DashboardIntegrate with MongoDB - 图3 (opens new window), click Access Control -> Authentication on the left navigation tree to enter the Authentication page. Click Create at the top right corner, then click to select Password-Based as Mechanism, and MongoDB as Backend, this will lead us to the Configuration tab, as shown below.

Authenticate with MondoDB

Follow the instruction below on how to configure:

Connect: Fill in the information needed to connect MongoDB.

  • MongoDB Mode: Select how MongoDB is deployed, including Single, Replica Set and Sharding.

  • Server: Specify the MongoDB server address that EMQX is to connect, if MongoDB Mode is set to Replica Set or Sharding, you will need to input all MondoDB servers (separated with a ,) that EMQX is to connect.

  • Replica Set Name: Specify the Replica Set name to use; type: strings; only needed if you set MongoDB Mode to Replica Set.

  • Database: MongoDB database name; Data type: strings.

  • Collection: Name of MongoDB collection where authentication rules are stored; Data type: strings.

  • Username (optional): Specify MongoDB user name.

  • Password (optional): Specify MongoDB user password.

  • Read Mode (optional): Only needed if you set MongoDB Mode to Replica Set; Default: master; Options: master, slave_ok.

    • master: Indicate each query in a sequence must only read fresh data (from a master/primary server). If the connected server is not a master then the first read will fail, and the remaining operations will be aborted.
    • slave_ok: Indicate every query is allowed to read stale data from a slave/secondary (or fresh data from a master).
  • Write Mode (optional): Only needed if you set MongoDB Mode to Replica Set; Options: unsafe, safe; Default: safe.

TLS Configuration: Turn on the toggle switch if you want to enable TLS. For more information on enabling TLS, see Network and TLS.

Connection Configuration: Set the concurrent connections and waiting time before a connection is timed out.

  • Pool size (optional): Input an integer value to define the number of concurrent connections from an EMQX node to a MongoDB server. Default: 8.
  • Connect Timeout (optional): Specify the waiting period before EMQX assumes the connection is timed out. Units supported include milliseconds, second, minute, and hour.

Authentication configuration: Fill in the authentication-related settings:

  • Password Hash Field: Specify the field name of the password.
  • Password Hash: Select the Hash function for storing the password in the database, for example, plain, md5, sha, bcrypt, pbkdf2. There are some extra items to be configured based on the function you selected:
    • If plain, md5, sha, sha256 or sha512 are selected, you also need to configure:
      • Salt Position: Specify the way (suffix, prefix, or disable) to add salt (random data) to the password. You can keep the default value unless you are migrating user credentials from external storage into EMQX built-in database. Note: If plain is selected, the Salt Position should be disable.
    • If bcrypt is selected, you also need to configure:
      • Salt Rounds: Specify the calculation times of Hush function (2^Salt Rounds). Default value: 10; Value range 4~31. You are recommended to use a higher value for better protection. Note: Increasing the cost factor by 1 doubles the necessary time.
    • If pkbdf2 is selected, you also need to configure:
      • Pseudorandom Function: Specify the Hush functions to generate the key, such as sha256.
      • Iteration Count: Specify the iteration times; Default: 4096
      • Derived Key Length (optional): Specify the generated key length. You can leave this field blank, then the key length will be determined by the pseudorandom function you selected.
  • Salt Field: Salt field in MongoDB.
  • is_superuser Field: Specify if the user is a super user.
  • Filter: A map interpreted as MongoDB selector for credential lookup. Placeholders are supported.

Now we can click Create to finish the settings.

Configure with Configuration Items

You can configure the EMQX MongoDB authenticator with EMQX configuration items.

Below are code examples you may refer to:

  1. {
  2.   mechanism = password_based
  3.   backend = mongodb
  4.   enable = true
  6.   password_hash_algorithm {
  7.     name = sha256
  8.     salt_position = suffix
  9.   }
  11.   collection = "mqtt_user"
  12.   filter { username = "${username}" }
  14.   mongo_type = single
  15.   server = "127.0.0.1:27017"
  17.   database = "mqtt"
  18.   username = "emqx"
  19.   password = "secret"
  20. }
  1. {
  2.   mechanism = password_based
  3.   backend = mongodb
  4.   enable = true
  6.   password_hash_algorithm {
  7.     name = sha256
  8.     salt_position = suffix
  9.   }
  11.   collection = "mqtt_user"
  12.   filter { username = "${username}" }
  14.   mongo_type = rs
  15.   servers = "10.123.12.10:27017,10.123.12.11:27017,10.123.12.12:27017"
  16.   replica_set_name = "rs0"
  18.   database = "mqtt"
  19.   username = "emqx"
  20.   password = "secret"
  21. }
  1. {
  2.   mechanism = password_based
  3.   backend = mongodb
  4.   enable = true
  6.   password_hash_algorithm {
  7.     name = sha256
  8.     salt_position = suffix
  9.   }
  11.   collection = "mqtt_user"
  12.   filter { username = "${username}" }
  14.   mongo_type = sharded
  15.   servers = "10.123.12.10:27017,10.123.12.11:27017,10.123.12.12:27017"
  17.   database = "mqtt"
  18.   username = "emqx"
  19.   password = "secret"
  20. }