mhX_validate_credentials(3xmh) — Subroutines

Name

mhX_validate_credentials − Checks that a specified user’s O/R address entry in the MAILbus 400 MTA’s routing information contains a password and a valid Routing Instruction.

Syntax

OM_return_code = mhX_validate_credentials(session, user_address, password, check_password, diagnostic)

Argument	Data Type	Access
session	OM_private_object	Read
user_address	OM_public_object	Read
password	OM_string	Read
check_password	OM_boolean	Read
diagnostic	OM_enumeration	Write

C Binding

OM_return_code mhX_validate_credentials(session, user_address, password, check_password, diagnostic) OM_private_object session;
OM_object user_address;
OM_string password;
OM_boolean check_password;
OM_enumeration ∗diagnostic;

Arguments

SessionA session previously established between Client and Service.

User AddressExplicitly identifies the user whose O/R address directory entry is to be checked; an instance of the OR Address class.

PasswordThe password associated with the O/R address. A descriptor with a length of zero (0) indicates a null password.

Check PasswordA boolean flag that specifies whether the Service should compare the password supplied with the one in the O/R address entry.

DiagnosticIf the return code is MH_RC_ORIGINATOR_IMPROPER, this diagnostic further describes the condition.

Description

Checks that the Routing Instruction in the user’s O/R address entry specifies that messages destined for the O/R address should be delivered to the application that has opened the current session. This ensures that messaging objects reach the appropriate user. The routing instruction must contain a definitive O/R address, and the routine checks that this matches the user address argument specified in the call. If any of these checks fails, the routine returns the error MH_RC_ORIGINATOR_IMPROPER with a diagnostic code that depends on the problem. Possible values are:

MHX_VCRED_WRONG_ACTION

MHX_VCRED_WRONG_MTA

MHX_VCRED_WRONG_AGENT

MHX_VCRED_WRONG_DEF_ORADDRESS

MHX_VCRED_NO_DEF_ORADDRESS

If the Check Password flag is set to OM_TRUE, the Service compares the password value supplied against the one stored in the directory. If the password does not match, the routine call returns MH_RC_ORIGINATOR_IMPROPER with the diagnostic code MHX_VCRED_PWD_MISMATCH.

If the validation check is successful, the routine returns OM_SUCCESS.

A return code of OM_SYSTEM_ERROR indicates a problem with the directory that may be temporary. The Client should try again.

Note that all arguments are mandatory.

Return Values

OM_MEMORY_INSUFFICIENT

OM_NETWORK_ERROR

MH_RC_NO_SUCH_USER

MH_RC_ORIGINATOR_IMPROPER

OM_SYSTEM_ERROR

MH_RC_WRONG_CLASS

OM_SUCCESS

Plus errors returned from:

om_create

om_put

Examples

    om_status = mhX_validate_credentials ( session,
                                           address,
                                           mts_secret,
                                           OM_TRUE,
                                           &diagnostic );

Museum