Perform an authentication check.

format

int POPSTORE_user_pw_check (user_context, password, password_len, auth_type, challenge, challenge_len, response, response_len) POPSTORE_user_context *user_context; char *password; int password_len; int auth_mechanism; char *challenge; int challenge_len; char *response; int response_len;

Arguments

user_context

User context to authenticate the password against. Used for input only.

password

Plain text password to authenticate against the user context. Used for input only.

password_len

Length in bytes of the plain text password string, password . Used for input only.

auth_mechanism

Authentication mechanism to use to check the password. Used for input only.

challenge

Challenge string presented as part of a challenge-response authentication mechanism. Used for input only.

challenge_len

Length in bytes of the challenge string, challenge . Used for input only.

response

Response to the challenge. Used for input only.

response_len

Length in bytes of the response string, response . Used for input only.

Description

To authenticate a user against the information contained in a user profile, call POPSTORE_user_pw_check supplying the authentication mechanism to use and the authentication credentials:

auth_mechanism	Required authentication credentials
POPSTORE_AUTH_MECH_PLAIN	Password supplied in the clear; supply the password and password_len arguments; challenge and response arguments are ignored.

If the authentication credentials are verified to be correct and the account is not marked DISUSER, a status of POPSTORE_SUCCESS is returned. Otherwise, a status of POPSTORE_DISUSERD or POPSTORE_NOMATCH is returned. Note that the value of the field user_context->profile->password is encrypted and as such applications cannot directory validate popstore passwords.

Return Values

POPSTORE_SUCCESS	Authentication successful.
POPSTORE_DISUSERD	Account is marked DISUSER; authentication failed.
POPSTORE_NOMATCH	Authentication failed; invalid password.
POPSTORE_NULLCONTEXT	user_context argument had a null value.
POPSTORE_NULLPROFILE	user_context->profile is null.