Custom DB Auth Backend

All Plugins / Auth / Custom_db

Identity Card

StatusCore
Plugin LabelCustom DB Auth Backend
Short DescriptionAuthenticate users agains your custom DB and table definition.
Plugin Identifierauth.custom_db
AuthorCharles du Jeu
Urldocs/references/plugins/auth/custom_db
Dependencies

Documentation

This plugin allows you to point the authentication operation (does a user exists? check the user password) to a third party, readonly, database.
You can define your own DB connection, and the table characteristics to identify a user: table name, user name field, password field, and password method hashing. Currently supporting clear, md5 and pdbkf2.
Currently this plugin does not support group management.
Should be typically used in a master/slave config, where custom_db is the master and pydio "standard" db is the slave.
MSSql Server: this plugin can support "non-standard" DB driver for MS Sql Server. However, before it can work, you must first download the 2 files DibiMsSqlDriver and DibiMsSqlReflector contained in the folder https://github.com/dg/dibi/tree/master/dibi/drivers and drop them inside the folder INSTALL_PATH/core/drivers/ (you have to create the folder as well).

Plugin parameters

LabelDescriptionTypeDefault
Driver *
pdo_driver
Driver type (do not touch)Hiddenpdo
DSN *
pdo_dsn
Data Source NameStringmysql:host=localhost;dbname=db
User *
pdo_username
User nameString
Password *
pdo_password
User passwordPassword
Driver *
mysql_driver
Driver type (do not touch)Hiddenmysql
Host *
mysql_host
Database serverStringlocalhost
Database *
mysql_database
Database nameStringpydio
User *
mysql_username
User nameString
Password *
mysql_password
User passwordPassword
Driver *
sqlite3_driver
Driver type (do not touch)Hiddensqlite3
formatDate *
sqlite3_formatDate
formatDate (do not touch)Hidden'Y-m-d'
formatDateTime *
sqlite3_formatDateTime
formatDateTime (do not touch)Hidden'Y-m-d H:i:s'
File *
sqlite3_database
Database fileStringAJXP_DATA_PATH/plugins/conf.sql/pydio.db
Driver *
postgre_driver
Driver type (do not touch)Hiddenpostgre
Host *
postgre_host
Database serverStringlocalhost
Database *
postgre_database
Database nameStringpydio
User *
postgre_username
User nameString
Password *
postgre_password
User passwordPassword
Driver *
mssql_driver
Driver type (do not touch)Hiddenmssql
Host *
mssql_host
Database serverStringlocalhost
Database *
mssql_database
Database nameStringpydio
User *
mssql_username
User nameString
Password *
mssql_password
User passwordPassword

Instance parameters

LabelDescriptionTypeDefault
Connection *
SQL_CUSTOM_DRIVER
The Database ConnectionGroup_switch:dibi_providercore
Custom Table Name *
SQL_CUSTOM_TABLE
Name of the custom SQL tableString
Table User Field *
SQL_CUSTOM_TABLE_USER_FIELD
Name of the field to be used as users identifierString
Table Password Field *
SQL_CUSTOM_TABLE_PWD_FIELD
Name of the field containing the passwordString
Table Password Hashing *
SQL_CUSTOM_TABLE_PWD_HASH
How the password is minimaly hashed in the tableSelect (clear, md5, pbkdf2)pbkdf2
Test User
SQL_CUSTOM_TABLE_TEST_USER
Use an existing user ID and click on Test Connexion to verify it is correctly foundString
Test Connection
TEST_SQL
Test the SQL connectionButton
Auth Driver Commons
Auto Create User
AUTOCREATE_AJXPUSER
When set to true, the user object is created automatically if the authentication succeed. Used by remote authentication systems.Booleanfalse
Login Redirect
LOGIN_REDIRECT
If set to a given URL, the login action will not trigger the display of login screen but redirect to this URL.String
Administrator Login
AJXP_ADMIN_LOGIN
For exotic auth drivers, an user ID that must be considered as admin by default.String
Auto apply role
AUTO_APPLY_ROLE
For multiple authentication, apply this role to users authenticated via this driverString