|
 HP Open Source Security for OpenVMS Volume 1:... |
 API Functions |
|
|
| |
| Library Description Errors | Parameters Return Value See Also |
API:CSSM_RETURN CSSMAPI CSSM_TP_ReceiveConfirmation(CSSM_TP_HANDLE TPHandle,const CSSM_DATA *ReferenceIdentifier,CSSM_TP_CONFIRM_RESPONSE_PTR *Responses,sint32 *ElapsedTime)SPI:CSSM_RETURN CSSMTPI TP_ReceiveConfirmation(CSSM_TP_HANDLE TPHandle,const CSSM_DATA *ReferenceIdentifier,CSSM_TP_CONFIRM_RESPONSE_PTR *Responses,sint32 *ElapsedTime)
LIBRARY Common Security Services Manager library (
cdsa$incssm300_shr.exe) PARAMETERS TPHandle (input) | ||
| The handle that describes the certification authoritymodule used to perform this function. | |
ReferenceIdentifier (input) | ||
| A reference identifier that uniquely identifiesa set of service requests and the results created in response tothose requests. | |
Responses (output) | ||
| An ordered vector of acknowledges indicating thecaller's acceptance or rejection of results. The vector containsone acknowledgement per result created by the certificate authority. | |
ElapsedTime (output) | ||
| If the confirmation has not been received, thisoutput value is the number of seconds elapsed since the certificateauthority created the results or CSSM_ELAPSED_TIME_UNKNOWN. If theconfirmation has been received, this output value is CSSM_ELAPSED_TIME_COMPLETE. | |
DESCRIPTION A certificate authority uses this function to poll for confirmationfrom a requester who has been served by the authority. A requestersends a confirmation to the authority by successfully invoking thefunction CSSM_TP_ConfirmCredResult() (CSSM API), or TP_ConfirmCredResult() (TP SPI).The ReferenceIdentifier uniquely identifiesthe service request and corresponding results for which confirmationis expected. This reference identifier need not be identical tothe reference identifier used by the requester, but a one-to-onemapping between the two name spaces must be well-defined.
Responses is an ordered vector of acknowledgementsindicating, for each returned result, whether the result was acceptedor rejected by the original requester for whom the service was performed.
If a result is rejected by the receiver, then the authorityprocess must undo the service if a reverse operation is possibleand available.
If a fatal error occurs, this function returns an error code,indicating that the function call can never be completed. If confirmationhas not been received, the function return value is CSSM_OK andthe ElapsedTime is returned to the caller ofthis function. The time represents elapsed seconds since the service resultswere produced by the authority process. Note that there can be adifference between the time the authority process produces the resultsand the time the results are actually received by the requester. Elapsedtime is relative and should increase with consecutive calls usingthe same ReferenceIdentifier. If the TP modulehas no knowledge of the elapsed time, the value CSSM_ELAPSED_TIME_UNKNOWNmust be returned. If the service requester has confirmed receiptof the service results, this function returns CSSM_OK and ElapsedTime isCSSM_ELAPSED_TIME_COMPLETE.
This function can be invoked repeatedly until the confirmationis received or until the caller decides the acknowledgement maybe lost and chooses to undo the results of the original servicerequest.
This function fails if the ReferenceIdentifier isinvalid or does not match any requested service for which confirmationis expected.
RETURN VALUE A CSSM return value combined with elapsed time to indicateone of three results:CompleteFunction | FunctionReturn | RetrieveOutput | EstimatedTime |
|---|---|---|---|
| Result | Value | ||
| Confirmation Received | CSSM_OK | CSSM_ELAPSED_TIME_COMPLETE | |
| Confirmation not received, but expected in thefuture | CSSM_OK | CSSM_ELAPSED_TIME_UNKNOWN or <elapsed seconds> | |
| FatalError, Confirmation is not expected | (!CSSM_OK) | NA | |
For a return value of (!CSSM_OK), the return value is an errorcode.
ERRORS Errors are described in the CDSA Technical Standard. CSSMERR_TP_INVALID_IDENTIFIER_POINTERCSSMERR_TP_INVALID_IDENTIFIER
SEE ALSO BooksIntel CDSA Application Developer's Guide
Functions for the CSSM API:
CSSM_TP_ConfirmCredResult
Functions for the TP SPI:
CSSM_TP_ConfirmCredResult
|
|