|
2
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
3 |
<head>
|
|
|
4 |
<title>vauthenticate - Authenticate a virtual user</title>
|
|
|
5 |
<link rev="made" href="mailto:Gentoo@lorien.untroubled.org" />
|
|
|
6 |
</head>
|
|
0
|
7 |
|
|
2
|
8 |
<body style="background-color: white">
|
|
0
|
9 |
|
|
2
|
10 |
<p><a name="__index__"></a></p>
|
|
0
|
11 |
<!-- INDEX BEGIN -->
|
|
|
12 |
<!--
|
|
|
13 |
|
|
2
|
14 |
<ul>
|
|
0
|
15 |
|
|
2
|
16 |
<li><a href="#name">NAME</a></li>
|
|
|
17 |
<li><a href="#synopsis">SYNOPSIS</a></li>
|
|
|
18 |
<li><a href="#description">DESCRIPTION</a></li>
|
|
|
19 |
<li><a href="#options">OPTIONS</a></li>
|
|
|
20 |
<li><a href="#return_value">RETURN VALUE</a></li>
|
|
|
21 |
<li><a href="#see_also">SEE ALSO</a></li>
|
|
|
22 |
<li><a href="#caveats">CAVEATS</a></li>
|
|
|
23 |
<li><a href="#restrictions">RESTRICTIONS</a></li>
|
|
|
24 |
<li><a href="#author">AUTHOR</a></li>
|
|
|
25 |
</ul>
|
|
0
|
26 |
-->
|
|
|
27 |
<!-- INDEX END -->
|
|
|
28 |
|
|
2
|
29 |
<p>
|
|
|
30 |
</p>
|
|
|
31 |
<h1><a name="name">NAME</a></h1>
|
|
|
32 |
<p>vauthenticate - Authenticate a virtual user</p>
|
|
|
33 |
<p>
|
|
|
34 |
</p>
|
|
|
35 |
<hr />
|
|
|
36 |
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
|
|
37 |
<p><strong>vauthenticate</strong></p>
|
|
|
38 |
<p>
|
|
|
39 |
</p>
|
|
|
40 |
<hr />
|
|
|
41 |
<h1><a name="description">DESCRIPTION</a></h1>
|
|
|
42 |
<p><em>vauthenticate</em> reads a domain name, user name, and pass phrase from
|
|
|
43 |
standard input, and authenticates the virtual user. If authentication
|
|
|
44 |
is successful, it prints out information about the virtual user on
|
|
|
45 |
stdout</p>
|
|
|
46 |
<p>The domain name, user name, and pass phrase are passed to
|
|
|
47 |
<em>vauthenticate</em> on standard input each seperated by a NUL byte.</p>
|
|
|
48 |
<p>The output consists of a series of lines containing an identifier, an
|
|
|
49 |
equal sign, and the data for that identifier, terminated by a newline.
|
|
|
50 |
The identifiers are:</p>
|
|
|
51 |
<dl>
|
|
|
52 |
<dt><strong><a name="item_uid">UID</a></strong><br />
|
|
|
53 |
</dt>
|
|
|
54 |
<dd>
|
|
0
|
55 |
The base user's numerical user ID.
|
|
2
|
56 |
</dd>
|
|
|
57 |
<p></p>
|
|
|
58 |
<dt><strong><a name="item_gid">GID</a></strong><br />
|
|
|
59 |
</dt>
|
|
|
60 |
<dd>
|
|
0
|
61 |
The base user's numerical group ID.
|
|
2
|
62 |
</dd>
|
|
|
63 |
<p></p>
|
|
|
64 |
<dt><strong><a name="item_user">USER</a></strong><br />
|
|
|
65 |
</dt>
|
|
|
66 |
<dd>
|
|
0
|
67 |
The base user's name.
|
|
2
|
68 |
</dd>
|
|
|
69 |
<p></p>
|
|
|
70 |
<dt><strong><a name="item_home">HOME</a></strong><br />
|
|
|
71 |
</dt>
|
|
|
72 |
<dd>
|
|
0
|
73 |
The base user's home directory.
|
|
2
|
74 |
</dd>
|
|
|
75 |
<p></p>
|
|
|
76 |
<dt><strong><a name="item_maildir">MAILDIR</a></strong><br />
|
|
|
77 |
</dt>
|
|
|
78 |
<dd>
|
|
|
79 |
The virtual user's mailbox directory, relative to <a href="#item_home"><code>HOME</code></a>.
|
|
|
80 |
</dd>
|
|
|
81 |
<p></p>
|
|
|
82 |
<dt><strong><a name="item_vuser">VUSER</a></strong><br />
|
|
|
83 |
</dt>
|
|
|
84 |
<dd>
|
|
|
85 |
The virtual user's name.
|
|
|
86 |
</dd>
|
|
|
87 |
<p></p></dl>
|
|
|
88 |
<p>
|
|
|
89 |
</p>
|
|
|
90 |
<hr />
|
|
|
91 |
<h1><a name="options">OPTIONS</a></h1>
|
|
|
92 |
<p>None</p>
|
|
|
93 |
<p>
|
|
|
94 |
</p>
|
|
|
95 |
<hr />
|
|
|
96 |
<h1><a name="return_value">RETURN VALUE</a></h1>
|
|
|
97 |
<p>Returns 0 if authentication succeeds, and non-zero otherwise.</p>
|
|
|
98 |
<p>
|
|
|
99 |
</p>
|
|
|
100 |
<hr />
|
|
|
101 |
<h1><a name="see_also">SEE ALSO</a></h1>
|
|
|
102 |
<p><code>vmailmgr(7)</code></p>
|
|
|
103 |
<p>
|
|
|
104 |
</p>
|
|
|
105 |
<hr />
|
|
|
106 |
<h1><a name="caveats">CAVEATS</a></h1>
|
|
|
107 |
<p>Although the output from <em>vauthenticate</em> appears to be suitable for
|
|
|
108 |
using as shell input, care must be taken to escape characters that
|
|
|
109 |
would cause the shell to misbehave, such as semicolons.</p>
|
|
|
110 |
<p>
|
|
|
111 |
</p>
|
|
|
112 |
<hr />
|
|
|
113 |
<h1><a name="restrictions">RESTRICTIONS</a></h1>
|
|
|
114 |
<p>This program will not authenticate non-virtual users.</p>
|
|
|
115 |
<p>
|
|
|
116 |
</p>
|
|
|
117 |
<hr />
|
|
|
118 |
<h1><a name="author">AUTHOR</a></h1>
|
|
|
119 |
<p>Bruce Guenter <<a href="mailto:bruceg@em.ca">bruceg@em.ca</a>></p>
|
|
0
|
120 |
|
|
2
|
121 |
</body>
|
|
0
|
122 |
|
|
2
|
123 |
</html>
|