1 .\" <!-- $Id: auth_getuserinfo.sgml,v 1.4 2007/07/21 20:05:53 mrsam Exp $ -->
2 .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: auth_getuserinfo
6 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
11 .TH "AUTH_GETUSERINFO" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
12 .\" disable hyphenation
14 .\" disable justification (adjust text to left margin only)
17 auth_getuserinfo - Obtain account information
22 #include <courierauth\.h>
26 .BI "int rc=auth_getuserinfo(const\ char\ *" "userid" ", int\ " "(*callback_func)" "(struct\ authinfo\ *,\ void\ *), void\ *" "callback_arg" ");"
31 is a valid account name, retrieve the account particulars and invoke
40 \fBcallback_func\fR\'s return value becomes the return value from
41 \fBauth_getuserinfo\fR
42 (which should be 0, by convention)\.
44 will not be invoked if an error occurs, which is reported by a non\-zero return value from
45 \fBauth_getuserinfo\fR\. By convention, a positive return value indicates an internal, temporary failure, such as the authentication daemon process not running; a negative return value indicates that this request was processed, but it failed (probably because
49 The second argument to
52 \fBcallback_arg\fR, which is not interpreted by this function in any way\. The first argument will be a pointer to the following structure:
54 \fBExample\ 1.\ struct authinfo\fR
59 const char *sysusername;
60 const uid_t *sysuserid;
69 const char *clearpasswd;
77 Description of the above fields:
81 The authenticated login ID\.
86 The authenticated account\'s userid and groupid can be looked up in the password file using
87 address\. If this field is
88 NULL, obtain the userid and the groupid from
102 is initialized, otherwise it\'s a pointer to the account\'s numeric userid\.
107 Account\'s numeric groupid\.
117 This is the account\'s full name\. This field is optional, it may be
123 The account\'s home directory\. This field cannot be
129 The pathname to the account\'s mailbox\. This field is optional, it can be
131 in which case the default location is assumed\.
136 Optional maildir quota on the account\'s mailbox (and
138 if no quota is set)\.
143 The account\'s encrypted password, if available\. If the account has a cleartext password defined, this field can be set to
144 NULL\. The encrypted password can take several formats:
147 \h'-04'\(bu\h'+03'A traditional triple\-DES crypted password, or a MD5+salt\-hashed password, as used in Linux\.
153 followed by a base64\-encoded MD5 hash of the password\.
159 followed by a base64\-encoded SHA1 hash of the password\.
165 The account\'s cleartext password, if available\. If the account has an encrypted password defined, this field can be set to
171 A comma\-separated list of miscellaneous account options\. See below for more information\.
173 .SS "Account options"
175 Depending on the configuration of the Courier authentication library, accounts may have individual options associated with them\. If the authentication library configuration does not implement account options, the option string will be
176 NULL\. Otherwise it will be a comma\-separated list of
177 \(lq\fIoption\fR=\fIvalue\fR\(rq
181 .nr an-no-space-flag 1
186 This is the account option implementation that\'s used by Courier, Courier\-IMAP, and SqWebMail packages\. Some of the following information is obviously not applicable for a particular package\. The inapplicable bits should be obvious\.
188 The following options are recognized by the various Courier packages:
191 .nr an-no-space-flag 1
196 The application is responsible for enforcing all the
198 option\. An authentication request for service
199 \(lqimap\(rq, for example, will succeed provided that the userid and the password are valid, even if
200 \(lqdisableimap=1\(rq
201 is set\. The application\'s
203 should check for this condition, and return a negative return code\.
207 If "n" is 1, IMAP access to this account should be disabled\.
212 If "n" is 1, POP3 access to this account should be disabled\.
215 disablewebmail=\fIn\fR
217 If "n" is 1, webmail access to this account should be disabled\.
220 disableshared=\fIn\fR
222 If "n" is 1, this account should not have access to shared folders or be able to share its own folders with other people\.
227 This account is a member of access group
228 \fIname\fR\. Instead of granting access rights on individual mail folders to individual accounts, the access rights can be granted to an access group
229 \(lqname\(rq, and all members of this group get the specified access rights\.
231 The access group name
232 \(lqadministrators\(rq
233 is a reserved group\. All accounts in the
235 group automatically receive all rights to all accessible folders\.
238 .nr an-no-space-flag 1
242 This option may be specified multiple times to specify that the account belongs to multiple account groups\.
245 sharedgroup=\fIname\fR
247 Append "name" to the name of the top level virtual shared folder index file\. This setting restricts which virtual shared folders this account could possibly access (and that\'s on top of whatever else the access control lists say)\. See the virtual shared folder documentation for more information\.
249 For technical reasons, group names may not include comma, tab, "/" or "|" characters\.
254 \fI\fBauthlib\fR(3)\fR\&[1],
255 \fI\fBauth_generic\fR(3)\fR\&[2],
256 \fI\fBauth_login\fR(3)\fR\&[3],
257 \fI\fBauth_enumerate\fR(3)\fR\&[4],
258 \fI\fBauth_passwd\fR(3)\fR\&[5],
259 \fI\fBauth_getoption\fR(3)\fR\&[6]\.
267 \fBauth_generic\fR(3)
277 \fBauth_enumerate\fR(3)
279 \%auth_enumerate.html
287 \fBauth_getoption\fR(3)
289 \%auth_getoption.html