ProFTPD module mod

ProFTPD module `mod_info`

This module is contained in the mod_info.c and mod_info.h files for ProFTPD 1.2, and is not compiled by default. Installation instructions are discussed here.

The most current version of mod_info can be found at:

  http://www.castaglia.org/proftpd/

Author

Please contact TJ Saunders <tj at castaglia.org> with any questions, concerns, or suggestions regarding this module.

`SITE` Commands

SITE STATUS
SITE WHO

InfoEngine

Syntax: InfoEngine on|off
Default: None
Context: server config, <VirtualHost>, <Global>
Module: mod_info
Compatibility: 1.2.9rc2 and later

The InfoEngine directive enables or disables the module's runtime engine. If it is set to off this module provides no informational services via SITE commands. Use this directive to disable the module instead of commenting out all mod_info directives.

InfoLog

Syntax: InfoLog file|"none"
Default: None
Context: server config, <VirtualHost>, <Global>
Module: mod_info
Compatibility: 1.2.9rc2 and later

The InfoLog directive is used to a specify a log file for mod_info reporting and debugging, and can be done a per-server basis. The file parameter must be the full path to the file to use for logging. Note that this path must not be to a world-writeable directory and, unless AllowLogSymlinks is explicitly set to on (generally a bad idea), the path must not be a symbolic link.

If file is "none", no logging will be done at all; this setting can be used to override an InfoLog setting inherited from a <Global> context.

SITE STATUS

This SITE command displays various information about the server to which the client is connected.

This command can only be used once the client has successfully logged in. When allowing this command to be used, it is best to limit its use to only trusted client, e.g.:

  <Limit SITE_STATUS>
    AllowUser tj
    DenyAll
  </Limit>

Example:

  ftp> quote site status
  214-Server Information
   Server Version: ProFTPD 1.2.9rc2 (CVS)
   Server Built: Thu Jun 26 13:51:19 PDT 2003
   Current Time: Thu Jun 26 13:53:23 2003
   Server Uptime: 7 seconds
 
  Modules:
    mod_core.c
    mod_xfer.c
    mod_auth_unix.c
    mod_auth_file.c
    mod_auth.c
    mod_ls.c
    mod_log.c
    mod_site.c
    mod_auth_pam.c
    mod_info.c
 
  Overall Statistics:
   (unavailable)
 
  Virtual Server Statistics
   (unavailable)

  214 Please contact root@golem.castaglia.org for more information

SITE WHO

This SITE command displays a list of logged in FTP users, similar to the ftpwho output.

This command can only be used once the client has successfully logged in. When allowing this command to be used, it is best to limit its use to only trusted client, e.g.:

  <Limit SITE_WHO>
    AllowUser tj
    DenyAll
  </Limit>

Example:

  ftp> quote site who
  214-Current Sessions:
   tj: (golem.castaglia.org -> 127.0.0.1:21) "SITE who"
  
  214 Please contact root@golem.castaglia.org for more information

Usage

Example configuration:

  <IfModule mod_info.c>
    <Limit SITE_STATUS SITE_WHO>
      AllowUser admin
      DenyAll
    </Limit>
  </IfModule>

Installation

To install mod_info, copy the mod_info.c and mod_info.h files into

  proftpd-dir/contrib/

after unpacking the latest proftpd-1.2 source code. Then follow the usual steps for using third-party modules in proftpd:

  ./configure --with-modules=mod_info
  make
  make install

Author: $Author: tj $
Last Updated: $Date: 2003/06/26 23:29:46 $