Skip to content

Authentication with LDAP Server¤

If clients accessing the broker are managed by an LDAP server, this plugin can verify credentials for client authentication and/or topic-level authorization.

  • amqtt.contrib.ldap.UserAuthLdapPlugin (client authentication)
  • amqtt.contrib.ldap.TopicAuthLdapPlugin (topic authorization)

Authenticate a user with an LDAP directory server.

User Auth¤

Config dataclass ¤

Bases: LdapConfig

Configuration for the User Auth LDAP Plugin.

base_dn instance-attribute ¤
base_dn: str

distinguished name (dn) of the ldap server. e.g. dc=amqtt,dc=io

bind_dn instance-attribute ¤
bind_dn: str

distinguished name (dn) of known, preferably read-only, user. e.g. cn=admin,dc=amqtt,dc=io

bind_password instance-attribute ¤
bind_password: str

password for known, preferably read-only, user

server instance-attribute ¤
server: str

uri formatted server location. e.g ldap://localhost:389

user_attribute instance-attribute ¤
user_attribute: str

attribute in ldap entry to match the username against

Topic Auth (ACL)¤

Config dataclass ¤

Bases: LdapConfig

Configuration for the LDAPAuthPlugin.

base_dn instance-attribute ¤
base_dn: str

distinguished name (dn) of the ldap server. e.g. dc=amqtt,dc=io

bind_dn instance-attribute ¤
bind_dn: str

distinguished name (dn) of known, preferably read-only, user. e.g. cn=admin,dc=amqtt,dc=io

bind_password instance-attribute ¤
bind_password: str

password for known, preferably read-only, user

publish_attribute instance-attribute ¤
publish_attribute: str

LDAP attribute which contains a list of permissible publish topics.

receive_attribute instance-attribute ¤
receive_attribute: str

LDAP attribute which contains a list of permissible receive topics.

server instance-attribute ¤
server: str

uri formatted server location. e.g ldap://localhost:389

subscribe_attribute instance-attribute ¤
subscribe_attribute: str

LDAP attribute which contains a list of permissible subscribe topics.

user_attribute instance-attribute ¤
user_attribute: str

attribute in ldap entry to match the username against