auth_getuserinfo.3

   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
   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_GETUSERINFO" "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_getuserinfo - Obtain account information
  18 .SH "SYNOPSIS"
  19 .sp
  20 .RS 4
  21 .nf
  22 #include <courierauth\.h>
  23 .fi
  24 .RE
  25 .HP 24
  26 .BI "int rc=auth_getuserinfo(const\ char\ *" "userid" ", int\ " "(*callback_func)" "(struct\ authinfo\ *,\ void\ *), void\ *" "callback_arg" ");"
  27 .SH "DESCRIPTION"
  28 .PP
  29 If
  30 \fIuserid\fR
  31 is a valid account name, retrieve the account particulars and invoke
  32 \fIcallback_func\fR\.
  33 .SH "RETURNS"
  34 .PP
  35
  36 \fBcallback_func\fR
  37 will be invoked if
  38 \fIuserid\fR
  39 exists, and
  40 \fBcallback_func\fR\'s return value becomes the return value from
  41 \fBauth_getuserinfo\fR
  42 (which should be 0, by convention)\.
  43 \fBcallback_func\fR
  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
  46 \fIuserid\fR
  47 does not exist\.
  48 .PP
  49 The second argument to
  50 \fBcallback_func\fR
  51 will be
  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:
  53 .PP
  54 \fBExample\ 1.\ struct authinfo\fR
  55 .sp
  56 .RS 4
  57 .nf
  58 struct authinfo {
  59         const char *sysusername;
  60         const uid_t *sysuserid;
  61         gid_t sysgroupid;
  62         const char *homedir;
  63
  64         const char *address;
  65         const char *fullname;
  66         const char *maildir;
  67         const char *quota;
  68         const char *passwd;
  69         const char *clearpasswd;
  70
  71         const char *options;
  72
  73         } ;
  74 .fi
  75 .RE
  76 .PP
  77 Description of the above fields:
  78 .PP
  79 address
  80 .RS 4
  81 The authenticated login ID\.
  82 .RE
  83 .PP
  84 sysusername
  85 .RS 4
  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
  89 sysuserid
  90 and
  91 sysgroupid\.
  92 .RE
  93 .PP
  94 sysuserid
  95 .RS 4
  96
  97 sysuserid
  98 may be
  99 NULL
 100 if
 101 sysusername
 102 is initialized, otherwise it\'s a pointer to the account\'s numeric userid\.
 103 .RE
 104 .PP
 105 sysgroupid
 106 .RS 4
 107 Account\'s numeric groupid\.
 108 sysgroupid
 109 is only used when
 110 sysusername
 111 is
 112 NULL\.
 113 .RE
 114 .PP
 115 fullname
 116 .RS 4
 117 This is the account\'s full name\. This field is optional, it may be
 118 NULL\.
 119 .RE
 120 .PP
 121 homedir
 122 .RS 4
 123 The account\'s home directory\. This field cannot be
 124 NULL\.
 125 .RE
 126 .PP
 127 maildir
 128 .RS 4
 129 The pathname to the account\'s mailbox\. This field is optional, it can be
 130 NULL
 131 in which case the default location is assumed\.
 132 .RE
 133 .PP
 134 quota
 135 .RS 4
 136 Optional maildir quota on the account\'s mailbox (and
 137 NULL
 138 if no quota is set)\.
 139 .RE
 140 .PP
 141 passwd
 142 .RS 4
 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:
 145 .sp
 146 .RS 4
 147 \h'-04'\(bu\h'+03'A traditional triple\-DES crypted password, or a MD5+salt\-hashed password, as used in Linux\.
 148 .RE
 149 .sp
 150 .RS 4
 151 \h'-04'\(bu\h'+03'
 152 \(lq{MD5}\(rq
 153 followed by a base64\-encoded MD5 hash of the password\.
 154 .RE
 155 .sp
 156 .RS 4
 157 \h'-04'\(bu\h'+03'
 158 \(lq{SHA}\(rq
 159 followed by a base64\-encoded SHA1 hash of the password\.
 160 .RE
 161 .RE
 162 .PP
 163 clearpasswd
 164 .RS 4
 165 The account\'s cleartext password, if available\. If the account has an encrypted password defined, this field can be set to
 166 NULL\.
 167 .RE
 168 .PP
 169 options
 170 .RS 4
 171 A comma\-separated list of miscellaneous account options\. See below for more information\.
 172 .RE
 173 .SS "Account options"
 174 .PP
 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
 178 settings\.
 179 .sp
 180 .it 1 an-trap
 181 .nr an-no-space-flag 1
 182 .nr an-break-flag 1
 183 .br
 184 Note
 185 .PP
 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\.
 187 .PP
 188 The following options are recognized by the various Courier packages:
 189 .sp
 190 .it 1 an-trap
 191 .nr an-no-space-flag 1
 192 .nr an-break-flag 1
 193 .br
 194 Note
 195 .PP
 196 The application is responsible for enforcing all the
 197 \(lqdisabled\(rq
 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
 202 \fBcallback_func\fR
 203 should check for this condition, and return a negative return code\.
 204 .PP
 205 disableimap=\fIn\fR
 206 .RS 4
 207 If "n" is 1, IMAP access to this account should be disabled\.
 208 .RE
 209 .PP
 210 disablepop3=\fIn\fR
 211 .RS 4
 212 If "n" is 1, POP3 access to this account should be disabled\.
 213 .RE
 214 .PP
 215 disablewebmail=\fIn\fR
 216 .RS 4
 217 If "n" is 1, webmail access to this account should be disabled\.
 218 .RE
 219 .PP
 220 disableshared=\fIn\fR
 221 .RS 4
 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\.
 223 .RE
 224 .PP
 225 group=\fIname\fR
 226 .RS 4
 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\.
 230 .sp
 231 The access group name
 232 \(lqadministrators\(rq
 233 is a reserved group\. All accounts in the
 234 administrators
 235 group automatically receive all rights to all accessible folders\.
 236 .sp
 237 .it 1 an-trap
 238 .nr an-no-space-flag 1
 239 .nr an-break-flag 1
 240 .br
 241 Note
 242 This option may be specified multiple times to specify that the account belongs to multiple account groups\.
 243 .RE
 244 .PP
 245 sharedgroup=\fIname\fR
 246 .RS 4
 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\.
 248 .sp
 249 For technical reasons, group names may not include comma, tab, "/" or "|" characters\.
 250 .RE
 251 .SH "SEE ALSO"
 252 .PP
 253
 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]\.
 260 .SH "NOTES"
 261 .IP " 1." 4
 262 \fBauthlib\fR(3)
 263 .RS 4
 264 \%authlib.html
 265 .RE
 266 .IP " 2." 4
 267 \fBauth_generic\fR(3)
 268 .RS 4
 269 \%auth_generic.html
 270 .RE
 271 .IP " 3." 4
 272 \fBauth_login\fR(3)
 273 .RS 4
 274 \%auth_login.html
 275 .RE
 276 .IP " 4." 4
 277 \fBauth_enumerate\fR(3)
 278 .RS 4
 279 \%auth_enumerate.html
 280 .RE
 281 .IP " 5." 4
 282 \fBauth_passwd\fR(3)
 283 .RS 4
 284 \%auth_passwd.html
 285 .RE
 286 .IP " 6." 4
 287 \fBauth_getoption\fR(3)
 288 .RS 4
 289 \%auth_getoption.html
 290 .RE