Anyone have working examples of how one might go about *debugging* a userdb/passdb LUA script for authentication?
Howdy,
I've been working on upgrading the version cPanel ships to Dovecot 2.4. It appears that the "dict" driver for passdb/authdb has been removed per your documentation, with a recommendation to use a lua script instead.
As such I've followed the online documentation to do so and wound up with a userdb/passdb section that looks like so:
passdb cpauthd { driver = lua lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua lua_settings { socket = /usr/local/cpanel/var/cpdoveauthd.sock } result_internalfail = continue result_failure = return-fail } userdb cpauthd { driver = lua lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua }
My prospective lua script only takes from the socket arg passed in and reads from the socket, delivering back the same kind of answer we would have previously got from the auth dict driver (converting password_key/user_key to auth_passdb/userdb_get_cache_key in script as appears to be suggested).
Unfortunately, I'm thinking that this entire setup is being ignored, as when I do:
doveadm -D -o auth_debug=yes auth lookup
for a user I know to be valid on the system with the previous 2.3 setup, I don't even see any indication that the lua authentication database is even consulted.
Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Started passdb lookup Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb: Connecting Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Client connected (fd=9) Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): auth input: Jul 18 12:32:30 Error: auth-master: passdb lookup(zippy@cptest.local): Auth PASS lookup failed Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): auth PASS input: Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Passdb lookup failed Jul 18 12:32:30 Error: cmd auth lookup: passdb lookup failed for zippy@cptest.local Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Disconnected: Connection closed (fd=9)
Similarly, in my lua script, I try to use the "dovecot.auth.log_debug/log_info" etc. functions in documentation within the scope of auth_passdb_lookup or auth_userdb_lookup, yet I never see any debug prints even if I add a debug line to the start of the function to indicate entry.
What I would like to know is whether there is some debug flag I'm missing to see the routing from config -> lua script. Does this actually exist? I didn't see anything enlightening in the man pages or online documentation. Hopefully I'm just missing something simple.
Cheers,
Thomas "Andy" Baugh | Software Development Engineer IV andy.baugh@webpros.com www.webpros.com
Incidentally, I did wind up answering my own question. All lua failures get logged to the maillog, so it was in fact something simple 🙂
From: Andy Baugh <andy.baugh@webpros.com> Sent: Friday, July 18, 2025 3:31 PM To: dovecot@dovecot.org <dovecot@dovecot.org> Subject: Anyone have working examples of how one might go about *debugging* a userdb/passdb LUA script for authentication?
Howdy,
I've been working on upgrading the version cPanel ships to Dovecot 2.4. It appears that the "dict" driver for passdb/authdb has been removed per your documentation, with a recommendation to use a lua script instead.
As such I've followed the online documentation to do so and wound up with a userdb/passdb section that looks like so:
passdb cpauthd { driver = lua lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua lua_settings { socket = /usr/local/cpanel/var/cpdoveauthd.sock } result_internalfail = continue result_failure = return-fail }
userdb cpauthd { driver = lua lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua }
My prospective lua script only takes from the socket arg passed in and reads from the socket, delivering back the same kind of answer we would have previously got from the auth dict driver (converting password_key/user_key to auth_passdb/userdb_get_cache_key in script as appears to be suggested).
Unfortunately, I'm thinking that this entire setup is being ignored, as when I do:
doveadm -D -o auth_debug=yes auth lookup
for a user I know to be valid on the system with the previous 2.3 setup, I don't even see any indication that the lua authentication database is even consulted.
Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Started passdb lookup Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb: Connecting Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Client connected (fd=9) Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): auth input: Jul 18 12:32:30 Error: auth-master: passdb lookup(zippy@cptest.local): Auth PASS lookup failed Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): auth PASS input: Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Passdb lookup failed Jul 18 12:32:30 Error: cmd auth lookup: passdb lookup failed for zippy@cptest.local Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Disconnected: Connection closed (fd=9)
Similarly, in my lua script, I try to use the "dovecot.auth.log_debug/log_info" etc. functions in documentation within the scope of auth_passdb_lookup or auth_userdb_lookup, yet I never see any debug prints even if I add a debug line to the start of the function to indicate entry.
What I would like to know is whether there is some debug flag I'm missing to see the routing from config -> lua script. Does this actually exist? I didn't see anything enlightening in the man pages or online documentation. Hopefully I'm just missing something simple.
Cheers,
Thomas "Andy" Baugh | Software Development Engineer IV andy.baugh@webpros.com www.webpros.com<http://www.webpros.com>
Incidentally, I did wind up answering my own question. All lua failures get logged to the maillog, so it was in fact something simple ****
From: Andy Baugh <andy.baugh@webpros.com> Sent: Friday, July 18, 2025 3:31 PM To: dovecot@dovecot.org <dovecot@dovecot.org> Subject: Anyone have working examples of how one might go about *debugging* a userdb/passdb LUA script for authentication?
Howdy,
I've been working on upgrading the version cPanel ships to Dovecot 2.4. It appears that the "dict" driver for passdb/authdb has been removed per your documentation, with a recommendation to use a lua script instead.
As such I've followed the online documentation to do so and wound up with a userdb/passdb section that looks like so:
passdb cpauthd { driver = lua lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua lua_settings { socket = /usr/local/cpanel/var/cpdoveauthd.sock } result_internalfail = continue result_failure = return-fail }
userdb cpauthd {
driver = lua
lua_file = /usr/local/cpanel/etc/dovecot/cpauthd.lua}
My prospective lua script only takes from the socket arg passed in and reads from the socket, delivering back the same kind of answer we would have previously got from the auth dict driver (converting password_key/user_key to auth_passdb/userdb_get_cache_key in script as appears to be suggested).
Unfortunately, I'm thinking that this entire setup is being ignored, as when I do:
doveadm -D -o auth_debug=yes auth lookup
for a user I know to be valid on the system with the previous 2.3 setup, I don't even see any indication that the lua authentication database is even consulted.
Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Started passdb lookup Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb: Connecting Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Client connected (fd=9) Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): auth input: Jul 18 12:32:30 Error: auth-master: passdb lookup(zippy@cptest.local): Auth PASS lookup failed Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): auth PASS input: Jul 18 12:32:30 Debug: auth-master: passdb lookup(zippy@cptest.local): Passdb lookup failed Jul 18 12:32:30 Error: cmd auth lookup: passdb lookup failed for zippy@cptest.local Jul 18 12:32:30 Debug: auth-master: conn unix:/var/run/dovecot/auth-userdb (pid=800187,uid=0): Disconnected: Connection closed (fd=9)
Similarly, in my lua script, I try to use the "dovecot.auth.log_debug/log_info" etc. functions in documentation within the scope of auth_passdb_lookup or auth_userdb_lookup, yet I never see any debug prints even if I add a debug line to the start of the function to indicate entry.
What I would like to know is whether there is some debug flag I'm missing to see the routing from config -> lua script. Does this actually exist? I didn't see anything enlightening in the man pages or online documentation. Hopefully I'm just missing something simple.
Cheers,
Thomas "Andy" Baugh | Software Development Engineer IV andy.baugh@webpros.com [1]www.webpros.com
References
Visible links
participants (1)
-
Andy Baugh