GenerateMac

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

GenerateKeyPairP

GenerateMacFinal

GenerateMac

Library
Spi Parameters
Notes ON Api
Return Value
See Also

Api Parameters
Description
Notes ON Spi
Errors

NAME

GenerateMac: CSSM_GenerateMac, CSP_GenerateMac - Compute a message authentication code (CDSA)

SYNOPSIS

# include <cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_GenerateMac
(CSSM_CC_HANDLE CCHandle,
const CSSM_DATA *DataBufs,
uint32 DataBufCount,
CSSM_DATA_PTR Mac)
SPI:
CSSM_RETURN CSSMCSPI CSP_GenerateMac
(CSSM_CSP_HANDLE CSPHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_CONTEXT *Context,
const CSSM_DATA *DataBufs,
uint32 DataBufCount,
CSSM_DATA_PTR Mac)

LIBRARY

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

API PARAMETERS

`CCHandle` (input)
		The handle that describes the context of this cryptographic operation used to link to the CSP-managed information.
`DataBufs` (input)
		A pointer to a vector of CSSM_DATA structures that contain the data to be operated on.
`DataBufCount` (input)
		The number of DataBufs.
`Mac` (output)		A pointer to the CSSM_DATA structure for the Message Authentication Code.

SPI PARAMETERS

`CSPHandle` (input)
		The handle that describes the add-in Cryptographic Service Provider module used to perform calls to CSSM for the memory functions managed by CSSM.
`Context` (input)
		Pointer to CSSM_CONTEXT structure that describes the attributes with this context.

DESCRIPTION

This function computes a message authentication code for all data contained in the set of input buffers.

NOTES ON API

The output is returned to the caller either by filling the caller-specified buffer or by using the application's declared memory allocation functions to allocate buffer space. To specify a specific, preallocated output buffer, the caller must provide an array of one or more CSSM_DATA structures, each containing a Length field value greater than zero and a non-NULL data pointer field value. To specify automatic output buffer allocation by the CSP, the caller must provide an array of one or more CSSM_DATA structures, each containing a Length field value equal to zero and a NULL data pointer field value. The application is always responsible for deallocating the memory when it is no longer needed.

NOTES ON SPI

The output is returned to the caller as specified in Buffer Management for Cryptographic Services.

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.

CSSMERR_CSP_OUTPUT_LENGTH_ERROR