1 =head1 NAME

     2 

     3 vauthenticate - Authenticate a virtual user

     4 

     5 =head1 SYNOPSIS

     6 

     7 B<vauthenticate>

     8 

     9 =head1 DESCRIPTION

    10 

    11 F<vauthenticate> reads a domain name, user name, and pass phrase from

    12 standard input, and authenticates the virtual user.  If authentication

    13 is successful, it prints out information about the virtual user on

    14 stdout

    15 

    16 The domain name, user name, and pass phrase are passed to

    17 F<vauthenticate> on standard input each seperated by a NUL byte.

    18 

    19 The output consists of a series of lines containing an identifier, an

    20 equal sign, and the data for that identifier, terminated by a newline.

    21 The identifiers are:

    22 

    23 =over 4

    24 

    25 =item UID

    26 

    27 The base user's numerical user ID.

    28 

    29 =item GID

    30 

    31 The base user's numerical group ID.

    32 

    33 =item USER

    34 

    35 The base user's name.

    36 

    37 =item HOME

    38 

    39 The base user's home directory.

    40 

    41 =item MAILDIR

    42 

    43 The virtual user's mailbox directory, relative to C<HOME>.

    44 

    45 =item VUSER

    46 

    47 The virtual user's name.

    48 

    49 =back

    50 

    51 =head1 OPTIONS

    52 

    53 None

    54 

    55 =head1 RETURN VALUE

    56 

    57 Returns 0 if authentication succeeds, and non-zero otherwise.

    58 

    59 =head1 SEE ALSO

    60 

    61 vmailmgr(7)

    62 

    63 =head1 CAVEATS

    64 

    65 Although the output from F<vauthenticate> appears to be suitable for

    66 using as shell input, care must be taken to escape characters that

    67 would cause the shell to misbehave, such as semicolons.

    68 

    69 =head1 RESTRICTIONS

    70 

    71 This program will not authenticate non-virtual users.

    72 

    73 =head1 AUTHOR

    74 

    75 Bruce Guenter <bruceg@em.ca>