CL_CertGroupToSignedBundle

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

CL_CertGroupFromVerifiedBundle

CL_CertSign

CL_CertGroupToSignedBundle

Library
Description
Errors

Parameters
Return Value
See Also

NAME

CL_CertGroupToSignedBundle: CSSM_CL_CertGroupToSignedBundle - Convert a certificate group to a certificate bundle(CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_CL_CertGroupToSignedBundle(CSSM_CL_HANDLE CLHandle,CSSM_CC_HANDLE CCHandle,const CSSM_CERTGROUP *CertGroupToBundle,const CSSM_CERT_BUNDLE_HEADER *BundleInfo,CSSM_DATA_PTR SignedBundle)SPI:CSSM_RETURN CSSMCLI CL_CertGroupToSignedBundle(CSSM_CL_HANDLE CLHandle,CSSM_CC_HANDLE CCHandle,const CSSM_CERTGROUP *CertGroupToBundle,const CSSM_CERT_BUNDLE_HEADER *BundleInfo,CSSM_DATA_PTR SignedBundle)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`CLHandle` (input)
		The handle that describes the add-in certificatelibrary module used to perform this function.
`CCHandle` (input/optional)
		The handle of the cryptographic context to controlthe signing operation. The operation will fail if a signature isrequired for this type of bundle and the cryptographic context isnot valid.
`CertGroupToBundle` (input)
		An array of individual, encoded certificates. Allcertificates in this list will be included in the resulting certificatebundle.
`BundleInfo` (input/optional)
		A structure containing the type and encoding ofthe bundle to be created. If the type and the encoding are not specified,then the module will use a default bundle type and bundle encoding.
`SignedBundle` (output)
		The function returns a pointer to a signed certificatebundle containing all certificates in the certificate group. Thebundle is of the type and encoding requested by the caller or isthe default type defined by the library module if the `BundleInfo` wasnot specified by the caller. The `SignedBundle->Data` isallocated by the service provider and must be deallocated by theapplication.

DESCRIPTION

This function accepts as input a certificate group (as anarray of individual certificates) and returns a certificate bundle(a codified and signed aggregation of the certificates in the group).The certificate group will first be encoded according to the BundleInfo inputby the user. If BundleInfo is NULL, the librarywill perform a default encoding for its default bundle type. Ifpossible, the certificate group ordering will be maintained in thiscertificate aggregate encoding. After encoding, the certificateaggregate will be signed using the input context. The CL moduleembeds knowledge of the signing scope for the bundle types it supports.The signature is then associated with the certificate aggregateaccording to the bundle type and encoding rules and is returnedas a bundle to the calling application.

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_CL_INVALID_CONTEXT_HANDLECSSMERR_CL_INVALID_CERTGROUP_POINTERCSSMERR_CL_INVALID_CERT_POINTERCSSMERR_CL_UNKNOWN_FORMATCSSMERR_CL_INVALID_BUNDLE_POINTERCSSMERR_CL_INVALID_BUNDLE_INFO