X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/d9898ee81388d1eff40cf71e85d9ce9b5c1401fe..695608b498ca4b23715af3d33c137ba177740fda:/auth_generic.html?ds=sidebyside diff --git a/auth_generic.html b/auth_generic.html index 4d31547..786ea0b 100644 --- a/auth_generic.html +++ b/auth_generic.html @@ -6,7 +6,7 @@ information. -->

Name

auth_generic — Generic authentication request

Synopsis


#include <courierauth.h>
-

int rc=auth_generic(const char * service,
 const char * authtype,
 const char * authdata,
 int (* callback_func,
 void * callback_arg);

DESCRIPTION

+

int rc=auth_generic(const char * service,
 const char * authtype,
 const char * authdata,
 int  (*callback_func)(struct authinfo *, void *),
 void * callback_arg);

DESCRIPTION

auth_generic processes a generic authentication request. You do not want to use this function. You really want to use @@ -34,7 +34,7 @@ newline character. followed by a second newline character. The base64-encoded string consists of the responding userid, a space character, then the response to the challenge expressed as hexadecimal -digits.

RETURNS

+digits.

RETURNS

callback_func will be invoked if auth_generic succeeds, and callback_func's return value becomes @@ -47,7 +47,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;
@@ -100,7 +100,7 @@ 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 @@ -144,7 +144,7 @@ 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.