Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
P6R::p6IKMIPClient Interface Referenceabstract

#include <p6kmipclient.h>

Inherits P6R::p6ICom.

Public Member Functions

virtual P6R::P6ERR activateObject (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR addAttributeObject (P6KMIP_ATTRIBPARAMS attribute, P6KMIP_ATTRIBRESULT *pAddResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR addAttributes (P6UINT32 attribCount, P6KMIP_ATTRIBPARAMS *pAttributes, p6IKMIPResult **pResult)=0
 
virtual P6INT32 addref (void)=0
 
virtual P6R::P6ERR archiveObject (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR cancel (P6BCSTR asynchCorrelation, P6KMIP_MSGEXTENSION *pExtension, P6KMIP_RESULT *pResult, P6UINT32 *pCancelResult)=0
 
virtual P6R::P6ERR certifyObject (P6KMIP_CERTIFYPARAMS certifyParams, P6KMIP_NEWOBJECT *pCertify, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR checkAndGet (P6KMIP_CHECKPARAMS check, P6KMIP_GETPARAMS get, P6KMIP_MANAGED *pObject, P6KMIP_CHECKRESULT *pCheck, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR checkAndGetUsageAllocation (P6KMIP_CHECKPARAMS check, P6NCSTR uniqueId, P6UINT64 usageLimitsCount, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_CHECKRESULT *pCheck, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR close (void)=0
 
virtual P6R::P6ERR createKeyObject (P6KMIP_KEYPARAMS keyParams, P6KMIP_NEWOBJECT *pCreate, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR createKeyPairObjects (P6KMIP_PAIRPARAMS pairParams, P6KMIP_NEWOBJECT *pPrivate, P6KMIP_NEWOBJECT *pPublic, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR createSplitKey (P6KMIP_SPLITPARAMS keyParams, P6KMIP_NEWOBJECT *pCreate, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR decrypt (P6KMIP_ENCRYPTPARAMS decryptParams, P6KMIP_CRYPTOOUT *pClearText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR deleteAttributeObject (P6NCSTR uniqueId, P6NCSTR attributeName, P6INT32 *pIndex, P6KMIP_MSGEXTENSION *pExtension, P6KMIP_ATTRIBRESULT *pDelResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR deriveKeyObject (P6KMIP_DERIVEPARAMS keyParams, P6KMIP_NEWOBJECT *pDerived, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR destroyObject (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR discoverVersions (P6BOOL bClientVersions, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPVersions **ppVersions, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR encrypt (P6KMIP_ENCRYPTPARAMS encryptParams, P6KMIP_CRYPTOOUT *pCipherText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR extractExtension (P6UINT16 batchIndex, P6KMIP_RESPEXTENSION *pExtension)=0
 
virtual P6R::P6ERR getAttributeList (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, P6KMIP_ATTRIBUTENAMES *pName, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR getAttributes (P6KMIP_GETATTRIBPARAMS attrib, P6KMIP_ATTRIBRESULT *pGetResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR getAttributesAndGet (P6KMIP_GETATTRIBPARAMS attrib, P6KMIP_GETPARAMS get, p6IKMIPResult **pResult)=0
 
virtual P6R::P6ERR getObject (P6KMIP_GETPARAMS get, P6KMIP_MANAGED *pObject, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR getResponseDOM (p6IDOMXML **pResponse)=0
 
virtual P6R::P6ERR getUsageAllocation (P6NCSTR uniqueId, P6UINT64 usageLimitsCount, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR hash (P6KMIP_CRYPTOPARAMS cParams, P6BCSTR data, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPBinary **pHash, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR initialize (P6KMIPFLAGS flags, p6IKeystore *pCerts, P6KMIP_PREF preferences)=0
 
virtual P6R::P6ERR joinSplitKey (P6KMIP_JOINPARAMS keyParams, P6KMIP_NEWOBJECT *pCreate, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR locateAndCheckObject (P6KMIP_LOCATEPARAMS locate, P6KMIP_CHECKPARAMS check, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult, P6KMIP_CHECKRESULT *pCheck)=0
 
virtual P6R::P6ERR locateAndGetAttributes (P6KMIP_LOCATEPARAMS locate, P6KMIP_GETATTRIBPARAMS attrib, p6IKMIPResult **pResult)=0
 
virtual P6R::P6ERR locateAndGetObject (P6KMIP_LOCATEPARAMS locate, P6KMIP_GETPARAMS get, P6KMIP_MANAGED *pObject, P6KMIP_RESULT *pLocateResult, P6KMIP_RESULT *pGetResult)=0
 
virtual P6R::P6ERR locateObject (P6KMIP_LOCATEPARAMS locate, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR MAC (P6KMIP_SIGNPARAMS macParams, P6KMIP_SIGNOUT *pCipherText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR MACVerify (P6KMIP_SIGNPARAMS macParams, P6KMIP_SIGNOUT *pClearText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR modifyAttributeObject (P6KMIP_ATTRIBPARAMS attribute, P6KMIP_ATTRIBRESULT *pModResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR modifyAttributes (P6UINT32 attribCount, P6KMIP_ATTRIBPARAMS *pAttributes, p6IKMIPResult **pResult)=0
 
virtual P6R::P6ERR obtainLease (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, P6KMIP_LEASE *pLease, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR open (const P6WCHAR *pHost, P6UINT32 port, P6KMIP_CREDENTIAL *pCredential)=0
 
virtual P6R::P6ERR poll (P6BCSTR asynchCorrelation, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPResult **pResult)=0
 
virtual P6R::P6ERR queryInterface (const P6R::P6IID &iid, P6VOID **ppIface)=0
 
virtual P6R::P6ERR queryServer (P6UINT32 queryCount, P6UINT32 *pQueryFunctions, P6KMIP_MSGEXTENSION *pExtension, P6KMIP_SERVERINFO *pCapabilities, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR reCertifyObject (P6KMIP_CERTIFYPARAMS certifyParams, P6KMIP_NEWOBJECT *pCertify, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR recoverObject (P6NCSTR uniqueId, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerCertificateObject (P6KMIP_CERTPARAMS certificate, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerKeyObject (P6KMIP_REGKEYPARAMS key, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerMDOObject (P6KMIP_REGMDOPARAMS key, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerOpaqueObject (P6KMIP_OPAQUEPARAMS objParams, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerSecretDataObject (P6KMIP_SECRETPARAMS secret, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR registerTemplateObject (P6KMIP_TEMPLATEPARAMS tparams, P6KMIP_NEWOBJECT *pRegResult, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR reKeyObject (P6KMIP_KEYPARAMS keyParams, P6KMIP_NEWOBJECT *pReKey, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR reKeyPairObjects (P6KMIP_PAIRPARAMS pairParams, P6KMIP_NEWOBJECT *pPrivate, P6KMIP_NEWOBJECT *pPublic, P6KMIP_RESULT *pResult)=0
 
virtual P6INT32 release (void)=0
 
virtual P6R::P6ERR revokeAndDestroyObject (P6NCSTR uniqueId, P6KMIP_REVOCATION reason, P6TIME *pOccurenceDate, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR revokeObject (P6NCSTR uniqueId, P6KMIP_REVOCATION reason, P6TIME *pOccurenceDate, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPStr **ppUniqueId, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR RNGRetrieve (P6INT32 dataLength, P6KMIP_MSGEXTENSION *pExtension, p6IKMIPBinary **pData, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR RNGSeed (P6BCSTR data, P6KMIP_MSGEXTENSION *pExtension, P6INT32 *pDataLength, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR serverSupportsObject (P6UINT32 objectType)=0
 
virtual P6R::P6ERR serverSupportsOperation (P6UINT32 opCode)=0
 
virtual P6R::P6ERR setAsynchronousIndicator (P6BOOL bAsynch)=0
 
virtual P6R::P6ERR setSSLOptions (const P6WCHAR *pCiphers, P6SECURESOCKETFLAGS fSecureFlags)=0
 
virtual P6R::P6ERR sign (P6KMIP_SIGNPARAMS signParams, P6KMIP_SIGNOUT *pCipherText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR signatureVerify (P6KMIP_SIGNPARAMS signParams, P6KMIP_SIGNOUT *pClearText, P6KMIP_RESULT *pResult)=0
 
virtual P6R::P6ERR validate (P6KMIP_VALIDATEPARAMS chain, P6UINT32 *pValidity, P6KMIP_RESULT *pResult)=0
 

Detailed Description

Note that the server can return a KMIP_RESULT_PENDING status in the pResult parameter.

This means that the server has not completed the operation and that the client code must periodically poll the server until it is complete. In this case, the caller has to extract the P6KMIP_RESULT.pAsynchCorrelation value and then perform a poll() call (see below) with the asynchrounous correlation value. Once the create key operation is complete the poll() call will return the result just as this call would have if the call was not asynchronous. Specifying the P6KMIPFLG_SYNCHRONOUS_ONLY flag in the initialize() call prevents the server from returning asynchronous response, however, the server can just fail the request if it does not support synchronous operations.

Definition at line 2138 of file p6kmipclient.h.


The documentation for this interface was generated from the following file: