CSSM_DL_Authenticate

Purpose

This function allows the caller to provide authentication credentials to the DL module at a time other than data store creation, deletion, open, import, and export. AccessRequest defines the type of access to be associated with the caller. If the authentication credentials apply to access and use of a DL module in general, then the data store handle specified in the DLDBHandle must be NULL. When the authorization credentials are applied to a specific data store, the handle for that data store must be specified in the DLDBHandle pair.

Format

CSSM_RETURN CSSMAPI CSSM_DL_Authenticate
                (CSSM_DL_DB_HANDLE DLDBHandle,
                const CSSM_DB_ACCESS_TYPE_PTR AccessRequest,
                const CSSM_USER_AUTHENTICATION_PTR UserAuthentication)

Parameters

Input

DLDBHandle: The handle pair that describes the DL module used to perform this function and the data store to which access is being requested. If the form of authentication being requested is authentication to the DL module in general, then the data store handle must be NULL.
AccessRequest: An indicator of the requested access mode for the data store or DL module in general.
UserAuthentication: The caller's credential as required for obtaining authorized access to the data store or to the DL module in general.

Return Value

A CSSM_OK return value signifies that the function completed successfully. When CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.