X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/781cfcb8fd50934c470e0dabf79d32ab333dec68..f77892e671e1261ec26e5133f86b8a52635f3dd2:/auth_login.html diff --git a/auth_login.html b/auth_login.html index b3af3e5..36c55fb 100644 --- a/auth_login.html +++ b/auth_login.html @@ -1,19 +1,19 @@ -auth_login

Name

auth_login — Validate a userid and password

Synopsis


+-->

Name

auth_login — Validate a userid and password

Synopsis


#include <courierauth.h>
-

int rc=auth_login(const char * service,
 const char * userid,
 const char * password,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

+

int rc=auth_login(const char *service,
 const char *userid,
 const char *password,
 int (*callback_func)(struct authinfo *, void *),
 void *callback_arg);
 

DESCRIPTION

auth_login verifies whether userid exists, and whether it's password is correct. service specifies which so-called "service" is -being authenticated; like “imap” or “pop3”. +being authenticated; like “imap” or “pop3”. service may or may not be used by the Courier -authentication library's configured back-end module.

RETURNS

+authentication library's configured back-end module.

RETURNS

callback_func will be invoked if auth_login succeeds, and callback_func's return value becomes @@ -26,7 +26,7 @@ return value indicates that this request was processed, but it failed.

The second argument to callback_func will be callback_arg, which is not interpreted by this function in any way. -The first argument will be a pointer to the following structure:

Example 1. struct authinfo

+The first argument will be a pointer to the following structure:
 
Example 1. struct authinfo
 struct authinfo {
 	const char *sysusername;
 	const uid_t *sysuserid;
@@ -44,7 +44,7 @@ struct authinfo {
 
 	} ;
 


-Description of the above fields:
address

+Description of the above fields:
address

 The authenticated login ID.
sysusername

 The authenticated account's userid and groupid can be looked up in the
 password file using address.
@@ -68,62 +68,67 @@ if no quota is set).
passwd

 The account's encrypted password, if available.
 If the account has a cleartext password defined, this field
 can be set to NULL.
-The encrypted password can take several formats:
  • 
+The encrypted password can take several formats:
    • 
 A traditional triple-DES crypted password, or a MD5+salt-hashed password,
-as used in Linux.
    • 
-“{MD5}” followed by a base64-encoded MD5 hash
-of the password.
    • 
-“{SHA}” followed by a base64-encoded SHA1 hash
+as used in Linux.
    • 
+“{MD5}” followed by a base64-encoded MD5 hash
+of the password.
    • 
+“{SHA}” followed by a base64-encoded SHA1 hash
 of the password.
clearpasswd

 The account's cleartext password, if available.
 If the account has an encrypted password defined, this field
 can be set to NULL.
options

 A comma-separated list of miscellaneous account options.
-See below for more information.
 
Account options

+See below for more information.
 
Account options

 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 NULL.
+options, the option string will be a NULL value.
 Otherwise it will be a comma-separated list of
-“option=value”
+“option=value”
 settings.
Note

-This is the account option implementation
-that's used by Courier, Courier-IMAP, and
+The application is responsible for actually implementing the
+options.
+For example,
+sn authentication request for service “imap”, for example,
+will succeed provided that the userid and the password are valid,
+even if “disableimap=1” is set.
+The application's callback_func should check for this
+condition, and return a negative return code.
Note

+The following list of account options is a combined list of implemented
+options supported 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.

 The following options are recognized by the various Courier
-packages:
Note

-The application is responsible for enforcing all the “disabled”
-option.
-An authentication request for service “imap”, for example,
-will succeed provided that the userid and the password are valid,
-even if “disableimap=1” is set.
-The application's callback_func should check for this
-condition, and return a negative return code.
disableimap=n

+packages:
disableimap=n

 If "n" is 1, IMAP access to this account should be disabled.
disablepop3=n

-If "n" is 1, POP3 access to this account should be disabled.
disablewebmail=n

+If "n" is 1, POP3 access to this account should be disabled.
disableinsecureimap=n

+If "n" is 1, unencrypted IMAP access to this account should be disabled.
disableinsecurepop3=n

+If "n" is 1, unencrypted POP3 access to this account should be disabled.
disablewebmail=n

 If "n" is 1, webmail access to this account should be disabled.
disableshared=n

 If "n" is 1, this account should not have access to shared folders or be able
 to share its own folders with other people.
group=name

-This account is a member of access group
+This option is used by Courier-IMAP in calculating access control lists.
+This option places the account as a member of access group
 name.
 Instead of granting access rights on individual mail folders to individual
 accounts, the access rights can be granted to an access group
-“name”, and all members of this group get the specified access
+“name”, and all members of this group get the specified access
 rights.

-The access group name “administrators” is a reserved group.
+The access group name “administrators” is a reserved group.
 All accounts in the administrators group automatically
 receive all rights to all accessible folders.
Note

 This option may be specified multiple times to specify that the account
 belongs to multiple account groups.
sharedgroup=name

+Another option used by Courier-IMAP.
 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.

 For technical reasons, group names may not include comma, tab, "/" or "|"
-characters.
 
SEE ALSO

+characters.

SEE ALSO

authlib(3), auth_generic(3),