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