Modules/sqlauth

1.1 Configuration

To use this module you must define a tag as shown below:

<sqlauth usertable="testusers"
        dbid="1"
        userfield="username"
        passfield="password"
        killreason="Access denied"
        encryption=""
        allowpattern="Guest*"
        verbose="1">

The variables in the tag have the following meanings:

• dbid - The database id which this module is to use. Please see the documentation of the m_sql module for more details.
• usertable - The table name which contains the users
• userfield - The field name within the database which contains the username
• passfield - The field name within the database which contains the password
• killreason - The reason to give when disconnecting a user who provides invalid credentials. You should usually place a url to your registration system here so that users may register, or contact details of who to gain access from.
• encryption - This variable indicates which encryption method is used on the password. If it is defined but set to an empty value no encryption is used (e.g. passwords are assumed to be plaintext, case insensitive). Common values for this when it is defined are "md5" and "passwd". Please note that this field allows for two ways to define an encryption type. The first way is to just put the name of a php function which takes one parameter, e.g. "md5" or "passwd". The second way, if you want to define a php function which takes a salt like "encrypt", is to place a bracket in the function, e.g: ENCRYPT('MYSALT',. This, when expanded, would be: ENCRYPT('MYSALT','USERPASS').
• allowpattern - If defined, this is a pattern which if matched will automatically allow the nick onto irc without checking it against the database.
• verbose - This variable if set to 'yes' will notify opers of failed connections to the server if they have the usermode +s.

For a list of settings which are known to work with certain popular software, please see our Integrating m_sqlauth.so with other software page.

1.2 Configuration

<sqlauth dbid="1"
        query="SELECT username FROM testusers WHERE username='$nick' AND password='$md5pass' LIMIT 1"
        killreason="Access denied"
        allowpattern="Guest*"
        verbose="1">

The variables in the tag have the following meanings:

• dbid - The database id which this module is to use. Please see the documentation of the m_sql module for more details.
• killreason - The reason to give when disconnecting a user who provides invalid credentials. You should usually place a url to your registration system here so that users may register, or contact details of who to gain access from.
• allowpattern - If defined, this is a pattern which if matched will automatically allow the nick onto irc without checking it against the database.
• verbose - This variable if set to 'yes' will notify opers of failed connections to the server if they have the usermode +s.

For a list of settings which are known to work with certain popular software, please see our Integrating m_sqlauth.so with other software page.

• query - This contains a freeform query, which can be used to match a user. The SQL query may return any of the variables below, which are replaced in the query before dispatching it to the SQL provider module. If the query returns one or more rows, the user is considered to be authenticated. If the query errors, or contains no result rows the user is considered to not be authenticated.

PASS :password

<disabled commands="NICK">

This module is an 'extra' module. This means that by default it is not compiled when you type make to build your IRCd. To enable this module follow these steps.