HELPLIB.HLB  —  CDSA  CDSA_API, TP FormSubmit
 NAME
   TP_FormSubmit,
   CSSM_TP_FormSubmit - Submit form to ClearanceAuthority (CDSA)

 SYNOPSIS
   # include <cssm.h>

    API:
        CSSM_RETURN CSSMAPI CSSM_TP_FormSubmit
        (CSSM_TP_HANDLE TPHandle,
        CSSM_TP_FORM_TYPE FormType,
        const CSSM_DATA *Form,
        const CSSM_TP_AUTHORITY_ID *ClearanceAuthority,
        const CSSM_TP_AUTHORITY_ID *RepresentedAuthority,
        CSSM_ACCESS_CREDENTIALS_PTR Credentials)
    SPI:
        CSSM_RETURN CSSMTPI TP_FormSubmit
        (CSSM_TP_HANDLE TPHandle,
        CSSM_TP_FORM_TYPE FormType,
        const CSSM_DATA *Form,
        const CSSM_TP_AUTHORITY_ID *ClearanceAuthority,
        const CSSM_TP_AUTHORITY_ID *RepresentedAuthority,
        CSSM_ACCESS_CREDENTIALS_PTR Credentials)

 LIBRARY
   Common Security Services Manager library (CDSA$INCSSM300_SHR.EXE)

 PARAMETERS
   TPHandle (input)
           A handle for the service provider module that will perform
           the operation.

   FormType (input)
           Indicates the type of form being submitted.

   Form (input)
           A pointer to the CSSM_DATA structure containing the completed
           form to be submitted to the ClearanceAuthority.

   ClearanceAuthority (input/optional)
           A CSSM_TP_AUTHORITY_ID structure containing either a
           certificate that identifies the clearance authority
           process, or a network address directly or indirectly
           identifying the location of the authority. If the input
           is NULL, the service provider module can assume a default
           authority based on the FormType and contents of Form. If
           a default authority can not be assumed, the request can
           not be initiated and the operation fails.

   RepresentedAuthority (input/optional)
           A CSSM_TP_AUTHORITY_ID structure containing either a
           certificate that identifies the authority represented by
           the ClearanceAuthority, or a network address directly or
           indirectly identifying the location of the authority. If
           the input is NULL, the service provider module can assume
           a default authority based on the FormType and contents of
           Form. If a default authority can not be assumed, the
           request can not be initiated and the operation fails.

   Credentials (output/optional)
           A pointer to a structure containing one or more credentials
           issued in response to the contents of the Form. If the
           output is NULL, either no credentials were returned or an
           error occurred.

 DESCRIPTION
   The completed Form is submitted to a ClearanceAuthority, who is acting
   on behalf of a RepresentedAuthority. Typically the submitted form is
   requesting an authorization credential required as input to future
   service requests to the RepresentedAuthority.

   If the form is honored by the ClearanceAuthority, then a set of one
   or more Credentials is returned to the requester. These credential
   can be used as the input credential in future service requests
   submitted to the RepresentedAuthority.

 RETURN VALUE
   A CSSM_RETURN value indicating success or specifying a particular
   error condition. The value CSSM_OK indicates success. All other
   values represent an error condition.

 ERRORS
   Errors are described in the CDSA technical standard.  See CDSA.

        CSSMERR_TP_INVALID_FORM_TYPE
        CSSMERR_TP_INVALID_AUTHORITY
        CSSMERR_TP_NO_DEFAULT_AUTHORITY
        CSSMERR_TP_UNSUPPORTED_ADDR_TYPE
        CSSMERR_TP_INVALID_NETWORK_ADDR
        CSSMERR_TP_AUTHENTICATION_FAILED
        CSSMERR_TP_INSUFFICIENT_CREDENTIALS
        CSSMERR_TP_REJECTED_FORM

 SEE ALSO
   Books

   Intel CDSA Application Developer's Guide (see CDSA)

   Other Help Topics

   Functions for the CSSM API:

       CSSM_TP_FormRequest

   Functions for the TP SPI:

       TP_FormRequest
Close Help