NAME

CSSM_ModuleInstall

SYNOPSIS

CSSM_RETURN CSSMAPI CSSM_ModuleInstall
    (const char *ModuleName,
    const char *ModuleFileName,
    const char *ModulePathName,
    const CSSM_GUID_PTR GUID,
    const CSSM_MODULE_INFO_PTR ModuleDescription,
    const void * Reserved1,
    const CSSM_DATA_PTR Reserved2)

DESCRIPTION

This function registers the module with CSSM. CSSM adds the module's descriptive information to its persistent registry. This makes the service module available for use on the local system. The function accepts as input the name and unique identifier for the module, the location executable code for the module, and a digitally-signed list of capabilities supported by the module. The capabilities list includes flags describing the module's attach time policy. The module's attach time procedure requirements are defined by its MODULE_FLAGS that control authentication. In addition to the module-declared policy, CSSM always enforces its internal policy requiring authentication. CSSM evaluates its policy based on CSSM-selected public root keys as points of trust. The service module policy can require application authentication based on a set of module-selected public root keys as point of trust. A copy of these module-selected keys are included in the CSSM_MODULE_INFO structure. The effective module policy definition must be included in the module's signed credentials. The registry copy is only informational. The installation process records the module name and module info in the CSSM Registry, making the module available for use by applications.

PARAMETERS

ModuleName (input)

The name of the module.

ModuleFileName (input)

The name of the file that implements the module.

ModulePathName (input)

The path to the file that implements the module.

GUID (input)

A pointer to the CSSM_GUID structure containing the global unique identifier for the module.

ModuleDescription (input)

A pointer to the CSSM_MODULE_INFO structure containing a description of the module.

Reserved1 (input)

Reserve data for the function.

Reserved2 (input)

Reserve data for the function.

RETURN VALUE

A CSSM_OK return value signifies that information has been updated. If CSSM_FAIL is returned, an error has occurred. Use CSSM_GetError to obtain the error code.

ERRORS

CSSM_INVALID_POINTER

Invalid pointer.

CSSM_REGISTRY_ERROR

Error in the registry.

SEE ALSO

CSSM_ModuleUninstall