## ProFTPD module `mod_auth`

This module is contained in the `mod_auth.c` file for ProFTPD 1.3.x, and is compiled by default.

## Directives

- DefaultRoot
- UserPassword

## DefaultRoot

Syntax: DefaultRoot path [group-expression]
Default: None
Context: server config, `<VirtualHost>`, `<Global>`
Module: mod_auth
Compatibility: 1.2.0rc1

The `DefaultRoot` directive is used to `chroot()` the session process for the connecting client. A fuller explanation can be found in the Chroot howto.

## UserPassword

Syntax: UserPassword user encrypted-password
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`
Module: mod_auth
Compatibility: 0.99.0pl5 and later

The `UserPassword` directive creates a password for a particular user; this configured password will override the user's normal password in `/etc/passwd` (or whichever auth module handles that user). Note that the user configured is a real user, and not a `UserAlias`.

The encrypted-password parameter is a string which has been passed through the standard Unix `crypt(3)` function. Do not use a cleartext password. To obtain this encrypted-password value, you can use the `ftpasswd` script's `--hash` option, e.g.:

      # ftpasswd --hash

      Password:
      Re-type password:

      ftpasswd: $1$EsnXxyD6$tsO2YwTAT/Tl5u1NYPHIw1

Example configuration:

      # Override user bob's password with a hash version of "password"
      UserPassword bob $1$EsnXxyD6$tsO2YwTAT/Tl5u1NYPHIw1

## Installation

The `mod_auth` module is compiled by default.

Author: $Author: castaglia $
Last Updated: $Date: 2011/04/06 17:54:27 $

© Copyright 2002-2011
All Rights Reserved