SecPkgContext_KeyInfoA structure (sspi.h)

  • Article

The SecPkgContext_KeyInfo structure contains information about the session keys used in a security context. The QueryContextAttributes (General) function uses this structure.

Applications using the Schannel security support provider (SSP) should not use the SecPkgContext_KeyInfo structure. Instead, use the SecPkgContext_ConnectionInfo structure.

Syntax

typedef struct _SecPkgContext_KeyInfoA {
  SEC_CHAR      *sSignatureAlgorithmName;
  SEC_CHAR      *sEncryptAlgorithmName;
  unsigned long KeySize;
  unsigned long SignatureAlgorithm;
  unsigned long EncryptAlgorithm;
} SecPkgContext_KeyInfoA, *PSecPkgContext_KeyInfoA;

Members

sSignatureAlgorithmName

Pointer to a null-terminated string that contains the name, if available, of the algorithm used for generating signatures, for example "MD5" or "SHA-2".

sEncryptAlgorithmName

Pointer to a null-terminated string that contains the name, if available, of the algorithm used for encrypting messages. Reserved for future use.

KeySize

Specifies the effective key length, in bits, for the session key. This is typically 40, 56, or 128 bits.

SignatureAlgorithm

Specifies the algorithm identifier (ALG_ID) used for generating signatures, if available.

EncryptAlgorithm

Specifies the algorithm identifier (ALG_ID) used for encrypting messages. Reserved for future use.

Remarks

Note

The sspi.h header defines SecPkgContext_KeyInfo as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header sspi.h (include Security.h)

See also

QueryContextAttributes (General)