|
1 <HTML> |
|
2 <HEAD> |
|
3 <TITLE>vauthenticate - Authenticate a virtual user</TITLE> |
|
4 <LINK REV="made" HREF="mailto:root@porky.devel.redhat.com"> |
|
5 </HEAD> |
|
6 |
|
7 <BODY> |
|
8 |
|
9 <!-- INDEX BEGIN --> |
|
10 <!-- |
|
11 |
|
12 <UL> |
|
13 |
|
14 <LI><A HREF="#NAME">NAME</A> |
|
15 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A> |
|
16 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A> |
|
17 <LI><A HREF="#OPTIONS">OPTIONS</A> |
|
18 <LI><A HREF="#RETURN_VALUE">RETURN VALUE</A> |
|
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A> |
|
20 <LI><A HREF="#CAVEATS">CAVEATS</A> |
|
21 <LI><A HREF="#RESTRICTIONS">RESTRICTIONS</A> |
|
22 <LI><A HREF="#AUTHOR">AUTHOR</A> |
|
23 </UL> |
|
24 --> |
|
25 <!-- INDEX END --> |
|
26 |
|
27 <P> |
|
28 <H1><A NAME="NAME">NAME</A></H1> |
|
29 <P> |
|
30 vauthenticate - Authenticate a virtual user |
|
31 |
|
32 <P> |
|
33 <HR> |
|
34 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1> |
|
35 <P> |
|
36 <STRONG>vauthenticate</STRONG> |
|
37 |
|
38 |
|
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> |