SURVIVOR: getenv WebAuth Module
About getenv
basics
Module Type Scheduler Remote
webauth Yes No
syntax
     authmodule getenv {
       [groupvar <string>]
       [uservar <string>]
     }
 

Dependencies

  • None

Arguments

Name Type Value
groupvar optional string The variable name from which to obtain the authenticated user's group memberships. The groups are expected to be in a space separated list.
uservar optional string, default is REMOTE_USER The variable name from which to obtain the authenticated username.

Description

The getenv module bases authentication on strings obtained from environment variables. This is useful with a webserver's native authentication system, for example.

If the variable specified by uservar is not defined or is empty, authentication will fail, otherwise authentication will be considered successful.

Examples

  1. To obtain the username authenticated by an Apache module:
         authmodule getenv {}
         
  2. To obtain groups from the variable AUTHZ:
         authmodule getenv {
           groupvar AUTHZ
         }
         

$Date: 2006/11/19 22:54:02 $
$Revision: 0.3 $
keywords
groupvar
uservar