1 .\" <!-- $Id: auth_login.sgml,v 1.4 2007/07/21 20:05:53 mrsam Exp $ -->
2 .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
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_LOGIN" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
12 .\" disable hyphenation
14 .\" disable justification (adjust text to left margin only)
17 auth_login - Validate a userid and password
22 #include <courierauth\.h>
26 .BI "int rc=auth_login(const\ char\ *" "service" ", const\ char\ *" "userid" ", const\ char\ *" "password" ", int\ " "(*callback_func)" "(struct\ authinfo\ *,\ void\ *), void\ *" "callback_arg" ");"
33 exists, and whether it\'s
37 specifies which so\-called "service" is being authenticated; like
42 may or may not be used by the Courier authentication library\'s configured back\-end module\.
50 \fBcallback_func\fR\'s return value becomes the return value from
52 (which should be 0, by convention)\.
54 will not be invoked if an error occurs, which is reported by a non\-zero return value from
55 \fBauth_login\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\.
57 The second argument to
60 \fBcallback_arg\fR, which is not interpreted by this function in any way\. The first argument will be a pointer to the following structure:
62 \fBExample\ 1.\ struct authinfo\fR
67 const char *sysusername;
68 const uid_t *sysuserid;
77 const char *clearpasswd;
85 Description of the above fields:
89 The authenticated login ID\.
94 The authenticated account\'s userid and groupid can be looked up in the password file using
95 address\. If this field is
96 NULL, obtain the userid and the groupid from
110 is initialized, otherwise it\'s a pointer to the account\'s numeric userid\.
115 Account\'s numeric groupid\.
125 This is the account\'s full name\. This field is optional, it may be
131 The account\'s home directory\. This field cannot be
137 The pathname to the account\'s mailbox\. This field is optional, it can be
139 in which case the default location is assumed\.
144 Optional maildir quota on the account\'s mailbox (and
146 if no quota is set)\.
151 The account\'s encrypted password, if available\. If the account has a cleartext password defined, this field can be set to
152 NULL\. The encrypted password can take several formats:
155 \h'-04'\(bu\h'+03'A traditional triple\-DES crypted password, or a MD5+salt\-hashed password, as used in Linux\.
161 followed by a base64\-encoded MD5 hash of the password\.
167 followed by a base64\-encoded SHA1 hash of the password\.
173 The account\'s cleartext password, if available\. If the account has an encrypted password defined, this field can be set to
179 A comma\-separated list of miscellaneous account options\. See below for more information\.
181 .SS "Account options"
183 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
184 NULL\. Otherwise it will be a comma\-separated list of
185 \(lq\fIoption\fR=\fIvalue\fR\(rq
189 .nr an-no-space-flag 1
194 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\.
196 The following options are recognized by the various Courier packages:
199 .nr an-no-space-flag 1
204 The application is responsible for enforcing all the
206 option\. An authentication request for service
207 \(lqimap\(rq, for example, will succeed provided that the userid and the password are valid, even if
208 \(lqdisableimap=1\(rq
209 is set\. The application\'s
211 should check for this condition, and return a negative return code\.
215 If "n" is 1, IMAP access to this account should be disabled\.
220 If "n" is 1, POP3 access to this account should be disabled\.
223 disablewebmail=\fIn\fR
225 If "n" is 1, webmail access to this account should be disabled\.
228 disableshared=\fIn\fR
230 If "n" is 1, this account should not have access to shared folders or be able to share its own folders with other people\.
235 This account is a member of access group
236 \fIname\fR\. Instead of granting access rights on individual mail folders to individual accounts, the access rights can be granted to an access group
237 \(lqname\(rq, and all members of this group get the specified access rights\.
239 The access group name
240 \(lqadministrators\(rq
241 is a reserved group\. All accounts in the
243 group automatically receive all rights to all accessible folders\.
246 .nr an-no-space-flag 1
250 This option may be specified multiple times to specify that the account belongs to multiple account groups\.
253 sharedgroup=\fIname\fR
255 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\.
257 For technical reasons, group names may not include comma, tab, "/" or "|" characters\.
262 \fI\fBauthlib\fR(3)\fR\&[1],
263 \fI\fBauth_generic\fR(3)\fR\&[2],
264 \fI\fBauth_getuserinfo\fR(3)\fR\&[3],
265 \fI\fBauth_enumerate\fR(3)\fR\&[4],
266 \fI\fBauth_passwd\fR(3)\fR\&[5],
267 \fI\fBauth_getoption\fR(3)\fR\&[6]\.
275 \fBauth_generic\fR(3)
280 \fBauth_getuserinfo\fR(3)
282 \%auth_getuserinfo.html
285 \fBauth_enumerate\fR(3)
287 \%auth_enumerate.html
295 \fBauth_getoption\fR(3)
297 \%auth_getoption.html