require_auth

Since: Version 2026.03.04-bb93ecb1

The functionality described in this section requires version 2026.03.04-bb93ecb1 of KumoMTA, or a more recent version.

If true, the proxy server will require RFC 1929 username/password authentication from clients before allowing them to use the proxy.

When enabled, you must also register a handler for the proxy_server_auth_rfc1929 event to validate credentials.

The default is false which allows clients to optionally authenticate.

proxy.start_proxy_listener {
  listen = '0.0.0.0:1080',
  require_auth = true,
}

kumo.on('proxy_server_auth_rfc1929', function(username, password, conn_meta)
  -- Validate credentials
  return username == 'user' and password == 'secret'
end)