Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_KeyBase.h File Reference


Detailed Description

MQeKey base functions.

MQeKeys can be attached to and used by an attribute.

The native attribute interface currently consists of two different classes: MQeKey (abstract) and MQeLocalKey. MQeLocalKey is a subclass of MQeKey.

The MQeKey has only one method, mqeKey_free, and it is a polymorphic entry point to actual implementations of subclass free functions. Callers should use this polymorphic entry point to access subclass implemented methods.

The MQeLocalKey is a symmetric key (the same key used for both encoding and decoding) which can not be shared across a network. It must be initialized with an ASCII string seed, using mqeLocalKey_setKeySeed, before it can be used.


Functions

MQERETURN mqeKey_free (MQeKeyHndl hKey, MQeExceptBlock *pErrStruct)
 Frees the MQeKey hKey.

MQERETURN mqeKey_nextEncryptKey (MQeKeyHndl hKey, MQeExceptBlock *pErrStruct, MQEBYTE *pNewKey, MQEINT32 *pNewKeyLen, MQEINT32 encSeqNo)
 Get next encrypt key value from hKey. To be used when implementing a cryptor plugin.

MQERETURN mqeKey_nextDecryptKey (MQeKeyHndl hKey, MQeExceptBlock *pErrStruct, MQEBYTE *pNewKey, MQEINT32 *pNewKeyLen, MQEINT32 decSeqNo)
 Get next decrypt key value from hKey. To be used when implementing a cryptor plugin.


Function Documentation

MQERETURN mqeKey_free MQeKeyHndl    hKey,
MQeExceptBlock   pErrStruct
 

Frees the MQeKey hKey.

Parameters:
hKey  [in] Handle for the MQeKey to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • Completed Successfully
MQERETURN_S_LOCALKEY_FREE_FAIL 
  • MQEREASON_LOCALKEY_FREE_FAIL memory free failure while freeing an MQeLocalKey

MQERETURN mqeKey_nextEncryptKey MQeKeyHndl    hKey,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pNewKey,
MQEINT32 *    pNewKeyLen,
MQEINT32    encSeqNo
 

Get next encrypt key value from hKey. To be used when implementing a cryptor plugin.

Parameters:
hKey  [in] Handle for the MQeKey to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pNewKey  [in/out] Pointer to a byte array for storing encrypt key value
pNewKeyLen  [in/out] Pointer to an integer variable for storing the length of pNewKey
encSeqNo  [in] Parameter passed down from MQeCryptor_EncryptInput.encSeqNo
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • Completed Successfully
MQERETURN_S_LOCALKEY_GETKEY_FAIL 
  • MQEREASON_LOCALKEY_NO_PRESET_KEY key not yet set
MQERETURN_S_LOCALKEY_GETKEY_FAIL 
  • MQEREASON_LOCALKEY_BUFFER_OVERFLOW) key buffer not big enough

MQERETURN mqeKey_nextDecryptKey MQeKeyHndl    hKey,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pNewKey,
MQEINT32 *    pNewKeyLen,
MQEINT32    decSeqNo
 

Get next decrypt key value from hKey. To be used when implementing a cryptor plugin.

Parameters:
hKey  [in] Handle for the MQeKey to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pNewKey  [in/out] Pointer to a byte array for storing decrypt key value
pNewKeyLen  [in/out] Pointer to an integer variable for storing the length of pNewKey
decSeqNo  [in] Parameter passed down from MQeCryptor_DecryptInput.decSeqNo
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • Completed Successfully
MQERETURN_S_LOCALKEY_GETKEY_FAIL 
  • MQEREASON_LOCALKEY_NO_PRESET_KEY key not yet set
MQERETURN_S_LOCALKEY_GETKEY_FAIL 
  • MQEREASON_LOCALKEY_BUFFER_OVERFLOW) key buffer not big enough


Generated Thu Aug 11 23:27:10 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference