<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>vauthenticate - Authenticate a virtual user</title>
<link rev="made" href="mailto:Gentoo@lorien.untroubled.org" />
</head>
<body style="background-color: white">
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<!--
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#options">OPTIONS</a></li>
<li><a href="#return_value">RETURN VALUE</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#caveats">CAVEATS</a></li>
<li><a href="#restrictions">RESTRICTIONS</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
-->
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>vauthenticate - Authenticate a virtual user</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>vauthenticate</strong></p>
<p>
</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>
<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>
<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:</p>
<dl>
<dt><strong><a name="item_uid">UID</a></strong><br />
</dt>
<dd>
The base user's numerical user ID.
</dd>
<p></p>
<dt><strong><a name="item_gid">GID</a></strong><br />
</dt>
<dd>
The base user's numerical group ID.
</dd>
<p></p>
<dt><strong><a name="item_user">USER</a></strong><br />
</dt>
<dd>
The base user's name.
</dd>
<p></p>
<dt><strong><a name="item_home">HOME</a></strong><br />
</dt>
<dd>
The base user's home directory.
</dd>
<p></p>
<dt><strong><a name="item_maildir">MAILDIR</a></strong><br />
</dt>
<dd>
The virtual user's mailbox directory, relative to <a href="#item_home"><code>HOME</code></a>.
</dd>
<p></p>
<dt><strong><a name="item_vuser">VUSER</a></strong><br />
</dt>
<dd>
The virtual user's name.
</dd>
<p></p></dl>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<p>None</p>
<p>
</p>
<hr />
<h1><a name="return_value">RETURN VALUE</a></h1>
<p>Returns 0 if authentication succeeds, and non-zero otherwise.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><code>vmailmgr(7)</code></p>
<p>
</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>
<p>
</p>
<hr />
<h1><a name="restrictions">RESTRICTIONS</a></h1>
<p>This program will not authenticate non-virtual users.</p>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Bruce Guenter <<a href="mailto:bruceg@em.ca">bruceg@em.ca</a>></p>
</body>
</html>