abstractMqttDriver-GenericMqttAuthenticator
This is the default authenticator used for connecting to general Mqtt brokers that require authentication either by means of user credentials, mutual TLS authentication with certificates, or a combination of both.
To access these properties, expand , expand a device and double-click authenticator.
| Property | Value | Description |
|---|---|---|
| Broker Endpoint | IP address, URL or host name | Specifies the IP address,
URL or Hostname of the broker. |
| Client ID | text string | Identifies the client to the
server. If not specified, the system generates a unique Client ID. No other client should currently use or in the future use this unique string. If two devices share the same Client ID, Status reports {down} or {fault}, unexpected behaviors happen and communication issues between client and broker result. |
| Broker Port | number | Specifies the port number of
the broker. |
| Callback Router (available under AwsIoTAuthenticator from the palette) | additional properties | Directs a client request
to an appropriate function. A separate topic documents these router
functions. |
| Connection Type | drop-down (defaults to User Login Over SSL) | Defines the type of authentication for this connection. Anonymous establishes a connection with the broker that is not secure. Choosing this type of connection is not recommended and generates a warning message. If you agree, the system logs your choice in its audit file. To use this type of connection, add this information using the security dashboard. Anonymous Over SSL establishes a one-way secure connection using TLS (Transport Layer Security) where the broker is configured with certificates that include keys.Choosing this type of connection, which is secure in only one direction, is not recommended and generates a warning message If you agree, the system logs your choice in its audit file. Using Login Over SSL requires you to enter the username and password for the broker. This is the recommended Connection Type. |
| User name and Password | text | Defines the credentials required by the broker. The broker
may or may not require these credentials. If Connection Type is User Login Over SSL, you must enter the Username and Password. |
| Use Tls Client Auth | true or false (defaults to false) | If set to true, it enables authentication with a client certificate over the transport layer. May be used in conjunction with credentials at the application layer. |
| Certificate Alias And Password | additional properties | Specifies the alias and password of the client certificate to use for authentication with the broker. |
| Cert Signing Config | additional properties | Constitutes the requester component that generates and submits the CSR to send to a Signing Service, and automatically renews the client certificate prior to expiry. |
| Parent Property To Apply Signed Cert | read-only | Specifies the name of the property on the parent to which the certificate alias and password will be written when the CSR has been signed. |
| Cert To Sign And Apply | additional properties | The alias and password of the certificate to use for storing the signed certificate. The alias does not need to exist in the key store prior to onboarding. A recommended alias will be populated by default. |
| Signing Requester Type | drop-down | Lists possible requester types. |
| Signing Requester | additional properties | Constitutes the requester component that generates and submits the CSR. |