<HTML>
<HEAD>
<TITLE>vauthenticate - Authenticate a virtual user</TITLE>
<LINK REV="made" HREF="mailto:root@porky.devel.redhat.com">
</HEAD>
<BODY>
<!-- INDEX BEGIN -->
<!--
<UL>
<LI><A HREF="#NAME">NAME</A>
<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
<LI><A HREF="#OPTIONS">OPTIONS</A>
<LI><A HREF="#RETURN_VALUE">RETURN VALUE</A>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
<LI><A HREF="#CAVEATS">CAVEATS</A>
<LI><A HREF="#RESTRICTIONS">RESTRICTIONS</A>
<LI><A HREF="#AUTHOR">AUTHOR</A>
</UL>
-->
<!-- INDEX END -->
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
vauthenticate - Authenticate a virtual user
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
<STRONG>vauthenticate</STRONG>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
<EM>vauthenticate</EM> reads a domain name, user name, and pass phrase from standard input, and
authenticates the virtual user. If authentication is successful, it prints
out information about the virtual user on stdout
<P>
The domain name, user name, and pass phrase are passed to
<EM>vauthenticate</EM> on standard input each seperated by a NUL byte.
<P>
The output consists of a series of lines containing an identifier, an equal
sign, and the data for that identifier, terminated by a newline. The
identifiers are:
<DL>
<DT><STRONG><A NAME="item_UID">UID</A></STRONG><DD>
<P>
The base user's numerical user ID.
<DT><STRONG><A NAME="item_GID">GID</A></STRONG><DD>
<P>
The base user's numerical group ID.
<DT><STRONG><A NAME="item_USER">USER</A></STRONG><DD>
<P>
The base user's name.
<DT><STRONG><A NAME="item_HOME">HOME</A></STRONG><DD>
<P>
The base user's home directory.
<DT><STRONG><A NAME="item_MAILDIR">MAILDIR</A></STRONG><DD>
<P>
The virtual user's mailbox directory, relative to <A HREF="#item_HOME">HOME</A>.
<DT><STRONG><A NAME="item_VUSER">VUSER</A></STRONG><DD>
<P>
The virtual user's name.
</DL>
<P>
<HR>
<H1><A NAME="OPTIONS">OPTIONS</A></H1>
<P>
None
<P>
<HR>
<H1><A NAME="RETURN_VALUE">RETURN VALUE</A></H1>
<P>
Returns 0 if authentication succeeds, and non-zero otherwise.
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<CODE>vmailmgr(7)</CODE>
<P>
<HR>
<H1><A NAME="CAVEATS">CAVEATS</A></H1>
<P>
Although the output from <EM>vauthenticate</EM> appears to be suitable for using as shell input, care must be taken to
escape characters that would cause the shell to misbehave, such as
semicolons.
<P>
<HR>
<H1><A NAME="RESTRICTIONS">RESTRICTIONS</A></H1>
<P>
This program will not authenticate non-virtual users.
<P>
<HR>
<H1><A NAME="AUTHOR">AUTHOR</A></H1>
<P>
Bruce Guenter <<A HREF="mailto:bruceg@em.ca">bruceg@em.ca</A>>
</BODY>
</HTML>