TP_ConfirmCredResult

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

TP_CertSign

TP_CrlCreateTemplate

TP_ConfirmCredResult

Library
Description
Errors

Parameters
Return Value
See Also

NAME

TP_ConfirmCredResult: CSSM_TP_ConfirmCredResult - Confirm credentials (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_TP_ConfirmCredResult(CSSM_TP_HANDLE TPHandle,const CSSM_DATA *ReferenceIdentifier,const CSSM_TP_CALLERAUTH_CONTEXT *CallerAuthCredentials,const CSSM_TP_CONFIRM_RESPONSE *Responses,const CSSM_TP_AUTHORITY_ID *PreferredAuthority)SPI:CSSM_RETURN CSSMTPI TP_ConfirmCredResult(CSSM_TP_HANDLE TPHandle,const CSSM_DATA *ReferenceIdentifier,const CSSM_TP_CALLERAUTH_CONTEXT *CallerAuthCredentials,const CSSM_TP_CONFIRM_RESPONSE *Responses,const CSSM_TP_AUTHORITY_ID *PreferredAuthority)

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 identifiesexecution of the call sequence `CSSM_TP_SubmitCredRequest()` and `CSSM_TP_RetrieveCredResult()` (or the equivalent TP SPI call pair) to submit a setof requests and to retrieve the results of those requests.
`CallerAuthCredentials` (input/optional)
		This structure contains a set of caller authenticationcredentials. The authentication information can be a passphrase,a PIN, a completed registration form, a certificate, or a templateof user-specific data. The required set of credentials is definedby the service provider module and recorded in a record in the MDSPrimary relation. Multiple credentials can be required. If the localservice provider module does not require credentials from a caller,then the `Credentials` field of this verificationcontext structure can be NULL. The structure optionally containsadditional credentials that can be used to support the authenticationprocess. Authentication credentials required by the authority shouldbe included in the `RequestInput`. The local TPmodule can forward information from the `CallerAuthCredentials` tothe authority, as appropriate, but is not required to do so.
`Responses` (input)
		An ordered vector of acknowledges indicating thecaller's acceptance or rejection of results. The vector containsone acknowledgement per result returned by `CSSM_TP_RetrieveCredResult()` (CSSM API), or `TP_RetrieveCredResult()` (TP SPI).
`PreferredAuthority` (input/optional)
		The identifier which uniquely describes the Authorityto receive the acknowledgements. The structure can include: An identity certificate for the authority The location of the authority

DESCRIPTION

This function submits a vector of acknowledgements to a CertificateAuthority for a set of requests and corresponding results identifiedby ReferenceIdentifier. The caller must executethe call sequence CSSM_TP_SubmitCredRequest() and CSSM_TP_RetrieveCredResult()(or the equivalent TP SPI calls) to submit a set of requestsand to retrieve the results of those requests. Some CertificateAuthority services accessed through the request and retrieve functionsrequire confirmation. The function CSSM_TP_RetrieveCredResult() (CSSM API), or TP_RetrieveCredResult() (TP SPI), returns a value indicating whether the callermust invoke CSSM_TP_ConfirmCredResult(), (CSSM API), or TP_ConfirmCredResult() (TP SPI), to successfully complete the service.

The Responses vector accepts or rejectseach result independently. If the caller rejects a returned result,the action taken by the authority depends on the requested typeof service.

The ReferenceIdentifier also identifiesthe authority process state associated with the function pair CSSM_TP_SubmitCredRequest() and CSSM_TP_RetrieveCredResult() (or the equivalent TP SPI calls). The PreferredAuthority informationcan be used to further identify the authority to receive the acknowledgement.After successful execution of this function, the value of the ReferenceIdentifier is undefinedand should not be used in subsequent operations in the current moduleattach session.

This function fails if ReferenceIdentifier isinvalid or the Authority process can not be located.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_TP_INVALID_IDENTIFIER_POINTERCSSMERR_TP_INVALID_IDENTIFIERCSSMERR_TP_INVALID_CALLERAUTH_CONTEXT_POINTERCSSMERR_TP_INVALID_POLICY_IDENTIFIERSCSSMERR_TP_INVALID_TIMESTRINGCSSMERR_TP_INVALID_STOP_ON_POLICYCSSMERR_TP_INVALID_CALLBACKCSSMERR_TP_INVALID_ANCHOR_CERTCSSMERR_TP_CERTGROUP_INCOMPLETECSSMERR_TP_INVALID_DL_HANDLECSSMERR_TP_INVALID_DB_HANDLECSSMERR_TP_INVALID_DB_LIST_POINTERCSSMERR_TP_INVALID_DB_LISTCSSMERR_TP_AUTHENTICATION_FAILEDCSSMERR_TP_INSUFFICIENT_CREDENTIALSCSSMERR_TP_NOT_TRUSTEDCSSMERR_TP_CERT_REVOKEDCSSMERR_TP_CERT_SUSPENDEDCSSMERR_TP_CERT_EXPIREDCSSMERR_TP_CERT_NOT_VALID_YETCSSMERR_TP_INVALID_CERT_AUTHORITYCSSMERR_TP_INVALID_SIGNATURECSSMERR_TP_INVALID_NAMECSSMERR_TP_INVALID_RESPONSE_VECTORCSSMERR_TP_INVALID_AUTHORITYCSSMERR_TP_NO_DEFAULT_AUTHORITYCSSMERR_TP_UNSUPPORTED_ADDR_TYPECSSMERR_TP_INVALID_NETWORK_ADDR