diff -r 000000000000 -r 6f7a81934006 authenticate/vauthenticate.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/authenticate/vauthenticate.html Wed Jan 16 22:39:43 2008 +0100 @@ -0,0 +1,122 @@ + +
++
+vauthenticate - Authenticate a virtual user + +
+
+vauthenticate + + + +
+
+vauthenticate 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 + +
+The domain name, user name, and pass phrase are passed to +vauthenticate on standard input each seperated by a NUL byte. + +
+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: + +
+The base user's numerical user ID. + +
+The base user's numerical group ID. + +
+The base user's name. + +
+The base user's home directory. + +
+The virtual user's mailbox directory, relative to HOME. + +
+The virtual user's name. + +
+
+None + +
+
+Returns 0 if authentication succeeds, and non-zero otherwise. + +
+
+vmailmgr(7)
+
+
+
+Although the output from vauthenticate 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. + +
+
+This program will not authenticate non-virtual users. + +
+
+Bruce Guenter <bruceg@em.ca> + + +