Openfire: Custom Database Integration Guide

# Custom Database Integration Guide

## Introduction

This document provides instructions for integrating Openfire authentication, users, and groups with your custom database tables. This is useful when your users already have accounts in an external system and you do not wish to duplicate those accounts in Openfire. If your user information is available via an LDAP directory rather than custom database tables, see the LDAP guide.

Simple integration with a custom database lets users authenticate using their existing username and password. Optionally, you can configure Openfire to load user profile and group information from your custom database. Any group in Openfire can be designated as a shared group, which means that you can pre-populate user's rosters using groups.

Topics that are covered in this document:

## Background

The integration requires that you enter customized database queries to access your database. You'll need to be familiar with your database table structure and simple SQL. Your custom database can be a different database on a different server from the Openfire database -- you'll enter database connection information as part of the configuration.

## Configuration

In order to configure your server to integrate with your custom database tables:

1. Stop Openfire.
2. Edit `conf/openfire.xml` in your Openfire installation folder as described below using your favorite editor.
3. Restart Openfire.

### Database Connection Settings

You must specify the connection string for your database as well as the JDBC driver.

jdbcProvider.driver
  the class name of the JDBC driver used to connect to your custom database. The driver must also be in the Openfire classpath (for example, by placing it into the "lib/" directory of your Openfire installation. See the database guide for common driver names for major databases.
jdbcProvider.connectionString
  the full connection string for the database. Please consult your database driver documentation for syntax. Warning: it's common for connection string to contain "&" characters. That character has special meaning in XML, so you should escape it using "&amp;".

Below is a sample config file section (note: the "..." sections in the examples indicate areas where the rest of the config file would exist):

Example database config in openfire.xml

    <jive>
      ...
      <jdbcProvider>
        <driver>com.mysql.jdbc.Driver</driver>
        <connectionString>jdbc:mysql://localhost/dbname?user=username&amp;password=secret</connectionString>
      </jdbcProvider>
      ...
    </jive>

## Authentication Integration

The simplest possible integration with a custom external database is authentication integration. Use the following settings to enable authentication integration.

- provider.auth.className -- set the value to `org.jivesoftware.openfire.auth.JDBCAuthProvider`.
- jdbcAuthProvider.passwordSQL -- the SQL String to select a user's password. The SQL statement should contain a single "?" character, which will be dynamically replaced with a username when being executed.
- jdbcAuthProvider.passwordType -- the type of the password. Valid values are:
  - plain (the password is stored as plain text)
  - md5 (the password is stored as a hex-encoded MD5 hash)
  - sha1 (the password is stored as a hex-encoded SHA-1 hash)
  - sha256 (the password is stored as a hex-encoded SHA-256 hash)
  - sha512 (the password is stored as a hex-encoded SHA-512 hash)
  If this value is not set, the password type is assumed to be plain.

Example JDBC authentication configuration in openfire.xml

    <jive>
      ...
      <provider>
        <auth>
          <className>org.jivesoftware.openfire.auth.JDBCAuthProvider</className>
        </auth>
      </provider>
      <jdbcAuthProvider>
         <passwordSQL>SELECT password FROM user_account WHERE username=?</passwordSQL>
         <passwordType>plain</passwordType>
       </jdbcAuthProvider>
       ...
      </jive>

You'll most likely want to change which usernames are authorized to login to the admin console. By default, only the user with username "admin" is allowed to login. However, you may have different users in your LDAP directory that you'd like to be administrators. The list of authorized usernames is controlled via the `admin.authorizedUsernames` property. For example, to let the usernames "joe" and "jane" login to the admin console:

Usage of 'authorizedUsernames' in openfire.xml

    <jive>
          ...
          <admin>
            ...
            <authorizedUsernames>joe, jane</authorizedUsernames>
          </admin>

          ...
        </jive>

Another option is to use an AdminProvider. AdminProvider instances are responsible for listing the administrators users dynamically. The default use the `authorizedUsernames` setting previously explained. JDBCAdminProvider allows to list the administrators from a SQL query. For example:

Example JDBC Admin config in openfire.xml

    <jive>
      ...
      <provider>
        ...
        <admin>
          <className>org.jivesoftware.openfire.admin.JDBCAdminProvider</className>
        </admin>
        ...
      </provider>
      <jdbcAdminProvider>
        <getAdminsSQL>SELECT userid FROM user_account WHERE administrator='Y'</getAdminsSQL>
      </jdbcAdminProvider>
      ...
    </jive>

## User Integration

Optionally, Openfire can load user data from your custom database. If you enable user integration you must also enable authentication integration (see above). Use the following settings to enable user integration.

provider.user.className
  set the value to `org.jivesoftware.openfire.user.JDBCUserProvider`.
jdbcUserProvider.loadUserSQL
  the SQL statement to load the name and email address of a user (in that order) given a username. The SQL statement should contain a single "?" character, which will be dynamically replaced with a username when being executed.
jdbcUserProvider.userCountSQL
  the SQL statement to load the total number of users in the database.
jdbcUserProvider.allUsersSQL
  the SQL statement to load all usernames in the database.
jdbcUserProvider.searchSQL
  the SQL statement fragment used to search your database for users. the statement should end with "WHERE" -- the username, name, and email fields will then be dynamically appended to the statement depending on the search. If this value is not set, searching will not be enabled.
usernameField
  the name of the username database field, which will be used for searches.
nameField
  the name of the name database field, which will be used for searches.
emailField
  the name of the email database field, which will be used for searches.

Below is a sample config file section. Note that the single provider section must include all providers that should be configured:

Configuration to obtain users from a JDBC source

    <jive>
      ...
      <provider>
        <auth>
          <className>org.jivesoftware.openfire.auth.JDBCAuthProvider</className>
        </auth>
        <user>
          <className>org.jivesoftware.openfire.user.JDBCUserProvider</className>
        </user>
      </provider>
      <jdbcAuthProvider>
         <passwordSQL>SELECT password FROM user_account WHERE username=?</passwordSQL>
         <passwordType>plain</passwordType>
      </jdbcAuthProvider>
      <jdbcUserProvider>
         <loadUserSQL>SELECT name,email FROM myUser WHERE username=?</loadUserSQL>
         <userCountSQL>SELECT COUNT(*) FROM myUser</userCountSQL>
         <allUsersSQL>SELECT username FROM myUser</allUsersSQL>
         <searchSQL>SELECT username FROM myUser WHERE</searchSQL>
         <usernameField>username</usernameField>
         <nameField>name</nameField>
         <emailField>email</emailField>
      </jdbcUserProvider>
       ...
     </jive>

### Group Integration

Openfire can load group data from your custom database. If you enable group integration you must also enable authentication integration; you'll also likely want to enable user integration (see above). Use the following settings to enable group integration.

provider.group.className
  set the value to `org.jivesoftware.openfire.group.JDBCGroupProvider`.
jdbcGroupProvider.groupCountSQL
  the SQL statement to load the total number of groups in the database.
jdbcGroupProvider.allGroupsSQL
  the SQL statement to load all groups in the database.
jdbcGroupProvider.userGroupsSQL
  the SQL statement to load all groups for a particular user. The SQL statement should contain a single "?" character, which will be dynamically replaced with a username when being executed.
jdbcGroupProvider.descriptionSQL
  the SQL statement to load the description of a group. The SQL statement should contain a single "?" character, which will be dynamically replaced with a group name when being executed.
jdbcGroupProvider.loadMembersSQL
  the SQL statement to load all members in a group. The SQL statement should contain a single "?" character, which will be dynamically replaced with a group name when being executed.
jdbcGroupProvider.loadAdminsSQL
  the SQL statement to load all administrators in a group. The SQL statement should contain a single "?" character, which will be dynamically replaced with a group name when being executed.

Below is a sample config file section. Note that the single provider section must include all providers that should be configured:

Configuration to obtain users, groups and authentication from a JDBC source

    <jive>
      ...
      <provider>
        <auth>
          <className>org.jivesoftware.openfire.auth.JDBCAuthProvider</className>
        </auth>
        <user>
          <className>org.jivesoftware.openfire.user.JDBCUserProvider</className>
        </user>
        <group>
          <className>org.jivesoftware.openfire.group.JDBCGroupProvider</className>
        </group>
      </provider>
      <jdbcAuthProvider>
         <passwordSQL>SELECT password FROM user_account WHERE username=?</passwordSQL>
         <passwordType>plain</passwordType>
      </jdbcAuthProvider>
      <jdbcUserProvider>
         <loadUserSQL>SELECT name,email FROM myUser WHERE username=?</loadUserSQL>
         <userCountSQL>SELECT COUNT(*) FROM myUser</userCountSQL>
         <allUsersSQL>SELECT username FROM myUser</allUsersSQL>
         <searchSQL>SELECT username FROM myUser WHERE</searchSQL>
         <usernameField>username</usernameField>
         <nameField>name</nameField>
         <emailField>email</emailField>
      </jdbcUserProvider>
      <jdbcGroupProvider>
           <groupCountSQL>SELECT count(*) FROM myGroups</groupCountSQL>
           <allGroupsSQL>SELECT groupName FROM myGroups</allGroupsSQL>
           <userGroupsSQL>SELECT groupName FROM myGroupUsers WHERE username=?</userGroupsSQL>
           <descriptionSQL>SELECT groupDescription FROM myGroups WHERE groupName=?</descriptionSQL>
           <loadMembersSQL>SELECT username FROM myGroupUsers WHERE groupName=? AND isAdmin='N'</loadMembersSQL>
           <loadAdminsSQL>SELECT username FROM myGroupUsers WHERE groupName=? AND isAdmin='Y'</loadAdminsSQL>
      </jdbcGroupProvider>
      ...
    </jive>