Knowledge Base

Using Remote Authentication

Article ID: 379
Last updated: 05 May, 2021

Remote authentication allows you to integrate your organization's authentication system with KBPublisher.

Before you start:

  • We assume that you have some experience with PHP and with the system you are connecting to.

Steps to enable Remote Authentication​

  • Click on Settings -> Authentication Provider -> Remote 
  • Check Enable Remote Authentication checkbox (make sure that $conf['auth_remote'] in the file admin/ is set to 1)
  • Set required values for constants in file admin/lib/custom/remote_auth.php
  • Customize the _remoteDoAuth function in the file admin/lib/custom/remote_auth.php to authenticate the username and password passed to it against your own authentication system
  • Rename the function _remoteDoAuth to remoteDoAuth

Quick summary of the process

  • End user goes to site
  • Remote Authentication checks for valid user credentials
    • If auto-authentication is set, does this automatically
    • If auto-authentication is not set, user logs in first
  • KBPublisher authenticates the user .

KBPublisher public view

Customizing the remoteDoAuth function

In your installation there is a folder admin/lib/custom. Within that folder is a file called remote_auth.php. This file contains the _remoteDoAuth function. Customize this function to do authentication against your internal system by using the username and password provided.

Here is a simple example of the function customized to authenticate against a MySQL database:

function remoteDoAuth($username, $password) {

    $user = false;
    $db = &DBUtil::connect($conf);

    $sql = "SELECT 1 FROM ss_user WHERE username = '%s' AND password = '%s'";
    $sql = sprintf($sql, $username, $password);
    $result = &$db->Execute($sql) or die(db_error($sql, false, $db));

    // if found
    if($result->RecordCount() == 1) {
        $user = 1; // assign a user id, this user id should exists in kb user table

    return $user;

 Also see examples in attached files.

Tracking logins

You can see how your remote authentication works in logs Logs/Logins

For debugging every last login is logged to a file called last_remote_login.log in the KBPublisher cache directory (APP_CACHE_DIR in admin/ ).
For example: /home/username/ kb_cache/last_remote_login.log

Article ID: 379
Last updated: 05 May, 2021
Revision: 6
Views: 6339
Comments: 0