$Revision: 1.4 $
$Date: 2004/08/24 08:58:29 $
User's Guide
Overview
This module export functions necessary for group membership checking. There is a
database table that contains list of users and groups they belong to. The table is used
by functions of this module.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
A database module.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>db_url</varname> (string)
&url; of the database table to be used.
Default value is mysql://serro:47serro11@localhost/ser
.
Set <varname>db_url</varname> parameter
...
modparam("group", "db_url", "mysql://username:password@dbhost/ser")
...
<varname>table</varname> (string)
Name of the table holding groups and their members.
Default value is grp
.
Set <varname>table</varname> parameter
...
modparam("group", "table", "grp_table")
...
<varname>user_column</varname> (string)
Name of the column holding usernames.
Default value is username
.
Set <varname>user_column</varname> parameter
...
modparam("group", "user_column", "user")
...
<varname>domain_column</varname> (string)
Name of the column holding domains.
Default value is domain
.
Set <varname>domain_column</varname> parameter
...
modparam("group", "domain_column", "realm")
...
<varname>group_column</varname> (string)
Name of the column holding groups.
Default value is grp
.
Set <varname>group_column</varname> parameter
...
modparam("group", "group_column", "grp")
...
<varname>use_domain</varname> (integer)
If set to 1 then username@domain will be used for lookup, if set to 0 then only
username will be used.
Default value is 0 (no).
Set <varname>use_domain</varname> parameter
...
modparam("group", "use_domain", 1)
...
Exported Functions
<function moreinfo="none">is_user_in(URI, group)</function>
The function returns true if username in the given &uri; is member of the given
group and false if not.
Meaning of the parameters is as follows:
&uri; - &uri; whose username and optionally domain to be
used, this can be one of:
Request-URI - Use Request-URI username and (optionally) domain.
To - Use To username and (optionally) domain.
From - Use From username and (optionally) domain.
Credentials - Use digest credentials username.
group - Name of the group to check.
<function>is_user_in</function> usage
...
if (is_user_in("Request-URI", "ld")) {
...
};
...