# Parameters

## `db_url` (string)

This is URL of the database to be used. Value of the parameter depends on the database module used. For example for mysql and postgres modules this is something like mysql://username:password@host:port/database. For dbtext module (which stores data in plaintext files) it is directory in which the database resides.

Default value is "mysql://serro:47serro11@localhost/ser".

### `db_url` parameter usage

    modparam("auth_db", "db_url", "mysql://foo:bar@foobar.org/ser")

## `user_column` (string)

This is the name of the column holding usernames. Default value is fine for most people. Use the parameter if you really need to change it.

Default value is "username".

### `user_column` usage

    modparam("auth_db", "user_column", "user")

## `domain_column` (string)

This is the name of the column holding domains of users. Default value is fine for most people. Use the parameter if you really need to change it.

Default value is "domain".

### `domain_column` usage

    modparam("auth_db", "domain_column", "domain")

## `password_column` (string)

This is the name of the column holding passwords. Passwords can be either stored as plain text or pre-calculated HA1 strings. HA1 strings are MD5 hashes of username, password, and realm. HA1 strings are more safe because the server doesn't need to know plaintext passwords and they cannot be obtained from HA1 strings.

Default value is "ha1".

### `password_column` usage

    modparam("auth_db", "password_column", "password")

## `rpid_column` (string)

This is the name of the column holding information for the Remote-Party-ID header field. Default value is fine for most people. Use the parameter if you really need to change it.

Default value is "rpid".

### `rpid_column` usage

    modparam("auth_db", "rpid_column", "remote_party_id")

## `calculate_ha1` (integer)

This parameter tells server whether it should read plaintext password from the database or HA1 string. If the parameter is set to 1 then the server will assume that the column pointed to by `plain_password_column` contains plaintext passwords and it will calculate HA1 strings on the fly.

If the parameter is set to 0 then the server assumes that the database contains HA1 strings directly and will not calculate them. In this case it will use value of `password_column` as name of column with HA1 password. If username parameter of credentials contains also @domain (some user agents put domain in username parameter), then column pointed to by `password_column_2` parameter will be used instead. This column should also contain HA1 strings but they should be calculated including the domain in the username parameter (as opposed to `password_column` which (when containing HA1 strings) should always contains HA1 strings calculated without domain in username.

This ensures that the authentication will always work when using pre-calculated HA1 string, not depending on the presence of the domain in username.

Default value of this parameter is 0.

### `calculate_ha1`usage

    modparam("auth_db", "calculate_ha1", 1)

## `plain_password_column` (string)

This parameter holds the name of column holding plain text password. This column is used when calculate_ha1 is set.

Default value is "password".

### `plain_password_column` usage

    modparam("auth_db", "plain_password_column", "password")

## `password_column_2` (string)

As described in the previous section this parameter contains name of column holding pre-calculated HA1 string that were calculated including the domain in the username. This parameter is used only when `calculate_ha1` is set to 0 and user agent sends credentials containing the domain in the username.

Default value of the parameter is ha1b.

### `password_column_2` usage

    modparam("auth_db", "password_column_2", "ha1_2")

## `use_rpid` (integer)

This parameter specifies whether the server should fetch a value for the Remote-Party-ID header field from the database.

If the parameter is set to 1 the server expects to find a value for this header in the column specified by the `rpid_column` parameter.

Default value of this parameter is 0.

### `use_rpid`usage

    modparam("auth_db", "use_rpid", 1)