auth_login.3

   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. -->
   4 .\"     Title: auth_login
   5 .\"    Author:
   6 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   7 .\"      Date: 08/23/2008
   8 .\"    Manual: Double Precision, Inc.
   9 .\"    Source: Double Precision, Inc.
  10 .\"
  11 .TH "AUTH_LOGIN" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
  12 .\" disable hyphenation
  13 .nh
  14 .\" disable justification (adjust text to left margin only)
  15 .ad l
  16 .SH "NAME"
  17 auth_login - Validate a userid and password
  18 .SH "SYNOPSIS"
  19 .sp
  20 .RS 4
  21 .nf
  22 #include <courierauth\.h>
  23 .fi
  24 .RE
  25 .HP 18
  26 .BI "int rc=auth_login(const\ char\ *" "service" ", const\ char\ *" "userid" ", const\ char\ *" "password" ", int\ " "(*callback_func)" "(struct\ authinfo\ *,\ void\ *), void\ *" "callback_arg" ");"
  27 .SH "DESCRIPTION"
  28 .PP
  29
  30 \fBauth_login\fR
  31 verifies whether
  32 \fIuserid\fR
  33 exists, and whether it\'s
  34 \fIpassword\fR
  35 is correct\.
  36 \fIservice\fR
  37 specifies which so\-called "service" is being authenticated; like
  38 \(lqimap\(rq
  39 or
  40 \(lqpop3\(rq\.
  41 \fIservice\fR
  42 may or may not be used by the Courier authentication library\'s configured back\-end module\.
  43 .SH "RETURNS"
  44 .PP
  45
  46 \fBcallback_func\fR
  47 will be invoked if
  48 \fBauth_login\fR
  49 succeeds, and
  50 \fBcallback_func\fR\'s return value becomes the return value from
  51 \fBauth_login\fR
  52 (which should be 0, by convention)\.
  53 \fBcallback_func\fR
  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\.
  56 .PP
  57 The second argument to
  58 \fBcallback_func\fR
  59 will be
  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:
  61 .PP
  62 \fBExample\ 1.\ struct authinfo\fR
  63 .sp
  64 .RS 4
  65 .nf
  66 struct authinfo {
  67         const char *sysusername;
  68         const uid_t *sysuserid;
  69         gid_t sysgroupid;
  70         const char *homedir;
  71
  72         const char *address;
  73         const char *fullname;
  74         const char *maildir;
  75         const char *quota;
  76         const char *passwd;
  77         const char *clearpasswd;
  78
  79         const char *options;
  80
  81         } ;
  82 .fi
  83 .RE
  84 .PP
  85 Description of the above fields:
  86 .PP
  87 address
  88 .RS 4
  89 The authenticated login ID\.
  90 .RE
  91 .PP
  92 sysusername
  93 .RS 4
  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
  97 sysuserid
  98 and
  99 sysgroupid\.
 100 .RE
 101 .PP
 102 sysuserid
 103 .RS 4
 104
 105 sysuserid
 106 may be
 107 NULL
 108 if
 109 sysusername
 110 is initialized, otherwise it\'s a pointer to the account\'s numeric userid\.
 111 .RE
 112 .PP
 113 sysgroupid
 114 .RS 4
 115 Account\'s numeric groupid\.
 116 sysgroupid
 117 is only used when
 118 sysusername
 119 is
 120 NULL\.
 121 .RE
 122 .PP
 123 fullname
 124 .RS 4
 125 This is the account\'s full name\. This field is optional, it may be
 126 NULL\.
 127 .RE
 128 .PP
 129 homedir
 130 .RS 4
 131 The account\'s home directory\. This field cannot be
 132 NULL\.
 133 .RE
 134 .PP
 135 maildir
 136 .RS 4
 137 The pathname to the account\'s mailbox\. This field is optional, it can be
 138 NULL
 139 in which case the default location is assumed\.
 140 .RE
 141 .PP
 142 quota
 143 .RS 4
 144 Optional maildir quota on the account\'s mailbox (and
 145 NULL
 146 if no quota is set)\.
 147 .RE
 148 .PP
 149 passwd
 150 .RS 4
 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:
 153 .sp
 154 .RS 4
 155 \h'-04'\(bu\h'+03'A traditional triple\-DES crypted password, or a MD5+salt\-hashed password, as used in Linux\.
 156 .RE
 157 .sp
 158 .RS 4
 159 \h'-04'\(bu\h'+03'
 160 \(lq{MD5}\(rq
 161 followed by a base64\-encoded MD5 hash of the password\.
 162 .RE
 163 .sp
 164 .RS 4
 165 \h'-04'\(bu\h'+03'
 166 \(lq{SHA}\(rq
 167 followed by a base64\-encoded SHA1 hash of the password\.
 168 .RE
 169 .RE
 170 .PP
 171 clearpasswd
 172 .RS 4
 173 The account\'s cleartext password, if available\. If the account has an encrypted password defined, this field can be set to
 174 NULL\.
 175 .RE
 176 .PP
 177 options
 178 .RS 4
 179 A comma\-separated list of miscellaneous account options\. See below for more information\.
 180 .RE
 181 .SS "Account options"
 182 .PP
 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
 186 settings\.
 187 .sp
 188 .it 1 an-trap
 189 .nr an-no-space-flag 1
 190 .nr an-break-flag 1
 191 .br
 192 Note
 193 .PP
 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\.
 195 .PP
 196 The following options are recognized by the various Courier packages:
 197 .sp
 198 .it 1 an-trap
 199 .nr an-no-space-flag 1
 200 .nr an-break-flag 1
 201 .br
 202 Note
 203 .PP
 204 The application is responsible for enforcing all the
 205 \(lqdisabled\(rq
 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
 210 \fBcallback_func\fR
 211 should check for this condition, and return a negative return code\.
 212 .PP
 213 disableimap=\fIn\fR
 214 .RS 4
 215 If "n" is 1, IMAP access to this account should be disabled\.
 216 .RE
 217 .PP
 218 disablepop3=\fIn\fR
 219 .RS 4
 220 If "n" is 1, POP3 access to this account should be disabled\.
 221 .RE
 222 .PP
 223 disablewebmail=\fIn\fR
 224 .RS 4
 225 If "n" is 1, webmail access to this account should be disabled\.
 226 .RE
 227 .PP
 228 disableshared=\fIn\fR
 229 .RS 4
 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\.
 231 .RE
 232 .PP
 233 group=\fIname\fR
 234 .RS 4
 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\.
 238 .sp
 239 The access group name
 240 \(lqadministrators\(rq
 241 is a reserved group\. All accounts in the
 242 administrators
 243 group automatically receive all rights to all accessible folders\.
 244 .sp
 245 .it 1 an-trap
 246 .nr an-no-space-flag 1
 247 .nr an-break-flag 1
 248 .br
 249 Note
 250 This option may be specified multiple times to specify that the account belongs to multiple account groups\.
 251 .RE
 252 .PP
 253 sharedgroup=\fIname\fR
 254 .RS 4
 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\.
 256 .sp
 257 For technical reasons, group names may not include comma, tab, "/" or "|" characters\.
 258 .RE
 259 .SH "SEE ALSO"
 260 .PP
 261
 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]\.
 268 .SH "NOTES"
 269 .IP " 1." 4
 270 \fBauthlib\fR(3)
 271 .RS 4
 272 \%authlib.html
 273 .RE
 274 .IP " 2." 4
 275 \fBauth_generic\fR(3)
 276 .RS 4
 277 \%auth_generic.html
 278 .RE
 279 .IP " 3." 4
 280 \fBauth_getuserinfo\fR(3)
 281 .RS 4
 282 \%auth_getuserinfo.html
 283 .RE
 284 .IP " 4." 4
 285 \fBauth_enumerate\fR(3)
 286 .RS 4
 287 \%auth_enumerate.html
 288 .RE
 289 .IP " 5." 4
 290 \fBauth_passwd\fR(3)
 291 .RS 4
 292 \%auth_passwd.html
 293 .RE
 294 .IP " 6." 4
 295 \fBauth_getoption\fR(3)
 296 .RS 4
 297 \%auth_getoption.html
 298 .RE