Index for Section 3

Alphabetical listing for Q

Bottom of page

QueryKeySizeInBits(3)
NAME
  QueryKeySizeInBits, CSSM_QueryKeySizeInBits, CSP_QueryKeySizeInBits - Get
  CSP logical and effective sizes (CDSA)

SYNOPSIS
  # include <cdsa/cssm.h>

       API:
       CSSM_RETURN CSSMAPI CSSM_QueryKeySizeInBits
       (CSSM_CSP_HANDLE CSPHandle,
       CSSM_CC_HANDLE CCHandle,
       const CSSM_KEY *Key,
       CSSM_KEY_SIZE_PTR KeySize)
       SPI:
       CSSM_RETURN CSSMCSPI CSP_QueryKeySizeInBits
       (CSSM_CSP_HANDLE CSPHandle,
       CSSM_CC_HANDLE CCHandle,
       const CSSM_CONTEXT *Context,
       const CSSM_KEY *Key,
       CSSM_KEY_SIZE_PTR KeySize)

LIBRARY
  Common Security Services Manager library (libcssm.so)

API PARAMETERS
  CSPHandle (input/optional)
	  The handle that describes the cryptographic service provider module
	  used to perform this function.

	  For the API, this parameter is ignored if a valid cryptographic
	  context handle is specified.

  CCHandle (input/optional)
	  A handle to a context that describes a cryptographic operation. The
	  cryptographic context should contain a handle to the CSP that is
	  being queried and the key about which key-size information is being
	  requested.

  Key (input/optional)
	  A pointer to a CSSM_KEY structure containing the key about which
	  key-size information is being requested. This parameter is ignored
	  if a valid cryptographic context handle is specified.

  KeySize (output)
	  Pointer to a CSSM_KEY_SIZE data structure. The logical and
	  effective sizes (in bits) for the key are returned in this
	  structure.

	  For the API, if no context handle is provided, only the
	  CSSM_KEY_SIZE LogicalKeySizeInBits field is set.

SPI PARAMETERS
  Context (input)
	  Pointer to CSSM_CONTEXT structure that describes the attributes
	  with this context.

DESCRIPTION
  This function queries a Cryptographic Service Provider (CSP) for the
  logical and effective sizes of a specified key.

  The cryptographic service provider (handle) and the key can be specified
  either in the cryptographic context or as parameters to the function call.
  If a valid cryptographic context handle parameter is specified, the CSP
  handle and key parameters are ignored.

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_intro(3).

       CSSMERR_CSP_QUERY_SIZE_UNKNOWN

SEE ALSO
  Books

  Intel CDSA Application Developer's Guide (see CDSA_intro(3))

  Reference Pages

  Functions for the CSSM API:

  CSSM_GenerateRandom(3), CSSM_GenerateKeyPair(3), CSSM_GenerateKey(3)

  Functions for the CSP SPI:

  CSP_GenerateRandom(3), CSP_GenerateKeyPair(3), CSP_GenerateKey(3)

Index for Section 3

Alphabetical listing for Q

Top of page