CryptoServer Class

Properties Methods Events Config Settings Errors

The CryptoServer class offers capabilities in processing PKI Proxy REST protocol messages.

Syntax

CryptoServer

Remarks

TBD

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


KeyCount	The number of records in the Key arrays.
KeyBits	The length of the key in bits.
KeyCanDecrypt	Returns True if the key can be used for decryption.
KeyCanDerive	Returns True if the key can be used for key derivation.
KeyCanEncrypt	Returns True if the key can be used for encryption.
KeyCanHash	Returns True if the key can be used for hashing/MACing.
KeyCanSign	Returns True if the key can be used for signing.
KeyCanSignRecover	Returns True if the key can be used for enveloping signing.
KeyCanUnwrap	Returns True if the key can be used for key unwrapping.
KeyCanVerify	Returns True if the key can be used for verifying signatures.
KeyCanVerifyRecover	Returns True if the key can be used for verifying enveloping signatures.
KeyCanWrap	Returns True if the key can be used for key wrapping.
KeyCapabilities	A collection of information about the key capabilities TBD: discuss type and options.
KeyDescription	The description, or label, of the object.
KeyEnabled	Enables or disables this key for use in encryption or signing operation.
KeyExportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
KeyFingerprint	Contains the fingerprint (a hash imprint) of this key.
KeyFriendlyName	Contains an associated alias (friendly name) of the key.
KeyGroup	The name of the group associated with this object.
KeyID	Provides access to a storage-specific key identifier.
KeyIV	The initialization vector (IV) of a symmetric key.
KeyKeyType	The type of the key contained in the object.
KeyMechanism	The algorithm of the cryptographic key.
KeyMechanismParams	The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.
KeyNonce	A nonce value associated with a key.
KeyNonPublic	Returns True if the object is private, and False otherwise.
KeyOrigin	Returns the origin (the Storage ID) of this key.
KeyPersistent	Returns True if the object is persistent in the store.
KeyProperties	Returns a collection of object properties as a comma separated name=value list.
KeyReadOnly	Returns True if the object is readonly.
KeySensitive	Returns True if the object is sensitive, and False otherwise.
KeySize	The size of the object in bytes.
KeySubject	Returns the key subject.
KeyUserId	TBD.
KeyUserKeySecret	TBD.
KeyValid	Returns True if this key is valid.
KeyValidFrom	The time point at which the key becomes valid, in UTC.
KeyValidTo	The time point at which the key expires, in UTC.
KeyValue	The byte array representation of the key.
MechCount	The number of records in the Mech arrays.
MechAliases	A comma-separated list of aliases of the mechanism.
MechCanDecrypt	Returns True if the key can be used for decryption.
MechCanDerive	Returns True if the key can be used for key derivation.
MechCanEncrypt	Returns True if the key can be used for encryption.
MechCanGenerate	Returns True if the keystore can generate keys using the mechanism.
MechCanHash	Returns True if the key can be used for hashing/MACing.
MechCanPRNG	Returns True if the mechanism can be used for generating pseudorandom numbers.
MechCanSign	Returns True if the key can be used for signing.
MechCanSignRecover	Returns True if the key can be used for enveloping signing.
MechCanUnwrap	Returns True if the key can be used for key unwrapping.
MechCanVerify	Returns True if the key can be used for verifying signatures.
MechCanVerifyRecover	Returns True if the key can be used for verifying enveloping signatures.
MechCanWrap	Returns True if the key can be used for key wrapping.
MechMaxBits	The maximal supported length of the key in bits.
MechMechanismName	The official name of the mechanism, such as sha256WithRSAEncryption.
MechMinBits	The minimal supported length of the key in bits.
MechProperties	A collection of custom mechanism properties as a collection of comma-separated name=value pairs.
ObjectCount	The number of records in the Object arrays.
ObjectDescription	The description, or label, of the object.
ObjectEnabled	Enables or disables this key for use in encryption or signing operation.
ObjectExportable	Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.
ObjectFingerprint	Contains the fingerprint (a hash imprint) of this object.
ObjectFriendlyName	Contains an associated alias (friendly name) of the object.
ObjectGroup	The name of the group associated with this object.
ObjectID	Provides access to a storage-specific object identifier.
ObjectIssuer	Returns the object issuer.
ObjectKeyUsage	Indicates the purposes of the object.
ObjectNonPublic	Returns True if the object is private, and False otherwise.
ObjectObjType	The type of the key contained in the object.
ObjectOrigin	Returns the origin (the Storage ID) of this object.
ObjectPersistent	Returns True if the object is persistent in the store.
ObjectProperties	Returns a collection of object properties as a comma separated name=value list.
ObjectReadOnly	Returns True if the object is readonly.
ObjectSensitive	Returns True if the object is sensitive, and False otherwise.
ObjectSerialNumber	Returns the certificate's serial number.
ObjectSize	The size of the object in bytes.
ObjectSubject	Returns the object subject.
ObjectUserId	TBD.
ObjectUserKeySecret	TBD.
ObjectValidFrom	The time point at which the object becomes valid, in UTC.
ObjectValidTo	The time point at which the object expires, in UTC.
ObjectValue	The byte array representation of the object.
PinnedKeyBits	The length of the key in bits.
PinnedKeyCanDecrypt	Returns True if the key can be used for decryption.
PinnedKeyCanDerive	Returns True if the key can be used for key derivation.
PinnedKeyCanEncrypt	Returns True if the key can be used for encryption.
PinnedKeyCanHash	Returns True if the key can be used for hashing/MACing.
PinnedKeyCanSign	Returns True if the key can be used for signing.
PinnedKeyCanSignRecover	Returns True if the key can be used for enveloping signing.
PinnedKeyCanUnwrap	Returns True if the key can be used for key unwrapping.
PinnedKeyCanVerify	Returns True if the key can be used for verifying signatures.
PinnedKeyCanVerifyRecover	Returns True if the key can be used for verifying enveloping signatures.
PinnedKeyCanWrap	Returns True if the key can be used for key wrapping.
PinnedKeyCapabilities	A collection of information about the key capabilities TBD: discuss type and options.
PinnedKeyDescription	The description, or label, of the object.
PinnedKeyEnabled	Enables or disables this key for use in encryption or signing operation.
PinnedKeyExportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
PinnedKeyFingerprint	Contains the fingerprint (a hash imprint) of this key.
PinnedKeyFriendlyName	Contains an associated alias (friendly name) of the key.
PinnedKeyGroup	The name of the group associated with this object.
PinnedKeyID	Provides access to a storage-specific key identifier.
PinnedKeyIV	The initialization vector (IV) of a symmetric key.
PinnedKeyKeyType	The type of the key contained in the object.
PinnedKeyMechanism	The algorithm of the cryptographic key.
PinnedKeyMechanismParams	The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.
PinnedKeyNonce	A nonce value associated with a key.
PinnedKeyNonPublic	Returns True if the object is private, and False otherwise.
PinnedKeyOrigin	Returns the origin (the Storage ID) of this key.
PinnedKeyPersistent	Returns True if the object is persistent in the store.
PinnedKeyProperties	Returns a collection of object properties as a comma separated name=value list.
PinnedKeyReadOnly	Returns True if the object is readonly.
PinnedKeySensitive	Returns True if the object is sensitive, and False otherwise.
PinnedKeySize	The size of the object in bytes.
PinnedKeySubject	Returns the key subject.
PinnedKeyUserId	TBD.
PinnedKeyUserKeySecret	TBD.
PinnedKeyValid	Returns True if this key is valid.
PinnedKeyValidFrom	The time point at which the key becomes valid, in UTC.
PinnedKeyValidTo	The time point at which the key expires, in UTC.
PinnedKeyValue	The byte array representation of the key.
PinnedMechAliases	A comma-separated list of aliases of the mechanism.
PinnedMechCanDecrypt	Returns True if the key can be used for decryption.
PinnedMechCanDerive	Returns True if the key can be used for key derivation.
PinnedMechCanEncrypt	Returns True if the key can be used for encryption.
PinnedMechCanGenerate	Returns True if the keystore can generate keys using the mechanism.
PinnedMechCanHash	Returns True if the key can be used for hashing/MACing.
PinnedMechCanPRNG	Returns True if the mechanism can be used for generating pseudorandom numbers.
PinnedMechCanSign	Returns True if the key can be used for signing.
PinnedMechCanSignRecover	Returns True if the key can be used for enveloping signing.
PinnedMechCanUnwrap	Returns True if the key can be used for key unwrapping.
PinnedMechCanVerify	Returns True if the key can be used for verifying signatures.
PinnedMechCanVerifyRecover	Returns True if the key can be used for verifying enveloping signatures.
PinnedMechCanWrap	Returns True if the key can be used for key wrapping.
PinnedMechMaxBits	The maximal supported length of the key in bits.
PinnedMechMechanismName	The official name of the mechanism, such as sha256WithRSAEncryption.
PinnedMechMinBits	The minimal supported length of the key in bits.
PinnedMechProperties	A collection of custom mechanism properties as a collection of comma-separated name=value pairs.
PinnedObjectDescription	The description, or label, of the object.
PinnedObjectEnabled	Enables or disables this key for use in encryption or signing operation.
PinnedObjectExportable	Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.
PinnedObjectFingerprint	Contains the fingerprint (a hash imprint) of this object.
PinnedObjectFriendlyName	Contains an associated alias (friendly name) of the object.
PinnedObjectGroup	The name of the group associated with this object.
PinnedObjectID	Provides access to a storage-specific object identifier.
PinnedObjectIssuer	Returns the object issuer.
PinnedObjectKeyUsage	Indicates the purposes of the object.
PinnedObjectNonPublic	Returns True if the object is private, and False otherwise.
PinnedObjectObjType	The type of the key contained in the object.
PinnedObjectOrigin	Returns the origin (the Storage ID) of this object.
PinnedObjectPersistent	Returns True if the object is persistent in the store.
PinnedObjectProperties	Returns a collection of object properties as a comma separated name=value list.
PinnedObjectReadOnly	Returns True if the object is readonly.
PinnedObjectSensitive	Returns True if the object is sensitive, and False otherwise.
PinnedObjectSerialNumber	Returns the certificate's serial number.
PinnedObjectSize	The size of the object in bytes.
PinnedObjectSubject	Returns the object subject.
PinnedObjectUserId	TBD.
PinnedObjectUserKeySecret	TBD.
PinnedObjectValidFrom	The time point at which the object becomes valid, in UTC.
PinnedObjectValidTo	The time point at which the object expires, in UTC.
PinnedObjectValue	The byte array representation of the object.
RequestAuthToken	Contains the authentication token supplied with the request.
RequestBody	The request body, as provided.
RequestBodyBytes	The generated request body as a byte array.
RequestDataBytes	Contains additional data assumed by the operation, for example the plaintext accompanying the detached signature (which in this case is provided in InputBytes ).
RequestDefRandomLength	The length of pseudorandom data block to return.
RequestFilter	List filter string.
RequestFormat	The request format (json, plain, or other).
RequestHeaders	The HTTP headers supplied with the request.
RequestInputBytes	The data to be processed by the operation, such as plaintext to be encrypted or ciphertext to be decrypted.
RequestKeyId	The ID of the key object to be used for the operation.
RequestMaxCount	The maximum number of elements (objects) to return with the response, or the maximum length of the data requested (e.
RequestMechanism	The name of the mechanism to use for the operation.
RequestMechanismParams	The list of mechanism parameters in comma-separated name=value form.
RequestObjectId	The ID of the object involved in the operation (e.
RequestOperation	The PKI Proxy protocol operation.
RequestOperationParams	The list of operation parameters in comma-separated name=value form.
RequestReqSig	Contains the raw signature over the request.
RequestReqSigned	Indicates whether the request is signed.
RequestReqSigValid	Indicates whether the request signature is valid.
RequestRespFormat	The requested response format (json, plain, or other).
RequestSourceObjectId	The ID of the source object that is to be copied or used for other purpose.
RequestUrl	The request URL.
RequestVerb	The HTTP verb.
ReqKeyBits	The length of the key in bits.
ReqKeyCanDecrypt	Returns True if the key can be used for decryption.
ReqKeyCanDerive	Returns True if the key can be used for key derivation.
ReqKeyCanEncrypt	Returns True if the key can be used for encryption.
ReqKeyCanHash	Returns True if the key can be used for hashing/MACing.
ReqKeyCanSign	Returns True if the key can be used for signing.
ReqKeyCanSignRecover	Returns True if the key can be used for enveloping signing.
ReqKeyCanUnwrap	Returns True if the key can be used for key unwrapping.
ReqKeyCanVerify	Returns True if the key can be used for verifying signatures.
ReqKeyCanVerifyRecover	Returns True if the key can be used for verifying enveloping signatures.
ReqKeyCanWrap	Returns True if the key can be used for key wrapping.
ReqKeyCapabilities	A collection of information about the key capabilities TBD: discuss type and options.
ReqKeyDescription	The description, or label, of the object.
ReqKeyEnabled	Enables or disables this key for use in encryption or signing operation.
ReqKeyExportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
ReqKeyFingerprint	Contains the fingerprint (a hash imprint) of this key.
ReqKeyFriendlyName	Contains an associated alias (friendly name) of the key.
ReqKeyGroup	The name of the group associated with this object.
ReqKeyID	Provides access to a storage-specific key identifier.
ReqKeyIV	The initialization vector (IV) of a symmetric key.
ReqKeyKeyType	The type of the key contained in the object.
ReqKeyMechanism	The algorithm of the cryptographic key.
ReqKeyMechanismParams	The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.
ReqKeyNonce	A nonce value associated with a key.
ReqKeyNonPublic	Returns True if the object is private, and False otherwise.
ReqKeyOrigin	Returns the origin (the Storage ID) of this key.
ReqKeyPersistent	Returns True if the object is persistent in the store.
ReqKeyProperties	Returns a collection of object properties as a comma separated name=value list.
ReqKeyReadOnly	Returns True if the object is readonly.
ReqKeySensitive	Returns True if the object is sensitive, and False otherwise.
ReqKeySize	The size of the object in bytes.
ReqKeySubject	Returns the key subject.
ReqKeyUserId	TBD.
ReqKeyUserKeySecret	TBD.
ReqKeyValid	Returns True if this key is valid.
ReqKeyValidFrom	The time point at which the key becomes valid, in UTC.
ReqKeyValidTo	The time point at which the key expires, in UTC.
ReqKeyValue	The byte array representation of the key.
ReqObjDescription	The description, or label, of the object.
ReqObjEnabled	Enables or disables this key for use in encryption or signing operation.
ReqObjExportable	Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.
ReqObjFingerprint	Contains the fingerprint (a hash imprint) of this object.
ReqObjFriendlyName	Contains an associated alias (friendly name) of the object.
ReqObjGroup	The name of the group associated with this object.
ReqObjID	Provides access to a storage-specific object identifier.
ReqObjIssuer	Returns the object issuer.
ReqObjKeyUsage	Indicates the purposes of the object.
ReqObjNonPublic	Returns True if the object is private, and False otherwise.
ReqObjObjType	The type of the key contained in the object.
ReqObjOrigin	Returns the origin (the Storage ID) of this object.
ReqObjPersistent	Returns True if the object is persistent in the store.
ReqObjProperties	Returns a collection of object properties as a comma separated name=value list.
ReqObjReadOnly	Returns True if the object is readonly.
ReqObjSensitive	Returns True if the object is sensitive, and False otherwise.
ReqObjSerialNumber	Returns the certificate's serial number.
ReqObjSize	The size of the object in bytes.
ReqObjSubject	Returns the object subject.
ReqObjUserId	TBD.
ReqObjUserKeySecret	TBD.
ReqObjValidFrom	The time point at which the object becomes valid, in UTC.
ReqObjValidTo	The time point at which the object expires, in UTC.
ReqObjValue	The byte array representation of the object.
ResponseBody	The generated response body.
ResponseBodyBytes	The generated response body as a byte array.
ResponseCustomHeaders	The custom HTTP headers to be added to the response.
ResponseHeaders	The generated HTTP headers to be supplied with the response.
ResponseHttpReasonPhrase	The HTTP reason phrase to return.
ResponseHttpStatusCode	The HTTP status code to return.
ResponseOperation	The PKI Proxy protocol operation.
ResponseOperationResult	The logical result of an operation that is capable of returning it, such as signature verification.
ResponseOperationResultComment	The service-local operation result comment.
ResponseOutputBytes	The data representing the operation result, such as ciphertext, decrypted plaintext, or signature.
ResponseRawContent	Use this property to provide the response content in non-interpreted form.
ResponseRawContentType	Use this property to provide the raw response content type.
ResponseRequestId	The unique ID assigned to the processed request.
ResponseRespSig	Contains the raw signature over the response.
ResponseRespSigned	Indicates whether the response is signed.
ResponseRespSigValid	Indicates whether the response signature is valid.
ResponseServiceActive	Indicates whether the response is signed.
ResponseServiceDescription	The description of the service.
ResponseServiceId	The identifier of the service.
ResponseServiceProperties	A collection of secondary or custom properties as a comma separated name=value list.
ResponseServiceServices	The services of the service.
ResponseServiceVendor	The name of the service vendor.
ResponseServiceVersion	The version identifier of the service.
ResponseStatusCode	The service status code to return.
ResponseStatusMessage	The service-local operation status message.
ResponseToken	The listing continuation token to be returned.
ResponseTrace	The trace (processing log or debug info) to include with the response.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AddKey	Registers object information in the response.
AddMechanism	Registers mechanism information in the response.
AddObject	Registers object information in the response.
Config	Sets or retrieves a configuration setting.
CreateWebRequest	Creates a new REST request.
CreateWebResponse	Creates a new REST response.
GetRequestParam	Looks up for a parameter in various request locations.
GetResponseParam	Looks up for a parameter in various response locations.
OpenWebRequest	Opens a REST request and populates it in the Request property.
OpenWebResponse	Opens a REST response and populates it in the Response property.
Reset	Clear all list.
SetRequestParam	Sets up a request parameter in the designated location.
SetResponseParam	Sets up a response parameter in the designated location.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


ResponseFormat	The format of response.
TempPath	Path for storing temporary files.

KeyCount Property (CryptoServer Class)

The number of records in the Key arrays.

Syntax

ANSI (Cross Platform)
int GetKeyCount();

Unicode (Windows)
INT GetKeyCount();

int pkiproxy_cryptoserver_getkeycount(void* lpObj);

int GetKeyCount();

Default Value

Remarks

This property controls the size of the following arrays:

KeyBits
KeyCanDecrypt
KeyCanDerive
KeyCanEncrypt
KeyCanHash
KeyCanSign
KeyCanSignRecover
KeyCanUnwrap
KeyCanVerify
KeyCanVerifyRecover
KeyCanWrap
KeyCapabilities
KeyDescription
KeyEnabled
KeyExportable
KeyFingerprint
KeyFriendlyName
KeyGroup
KeyID
KeyIV
KeyKeyType
KeyMechanism
KeyMechanismParams
KeyNonce
KeyNonPublic
KeyOrigin
KeyPersistent
KeyProperties
KeyReadOnly
KeySensitive
KeySize
KeySubject
KeyUserId
KeyUserKeySecret
KeyValid
KeyValidFrom
KeyValidTo
KeyValue

The array indices start at 0 and end at KeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

KeyBits Property (CryptoServer Class)

The length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetKeyBits(int iKeyIndex);

Unicode (Windows)
INT GetKeyBits(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeybits(void* lpObj, int keyindex);

int GetKeyBits(int iKeyIndex);

Default Value

Remarks

The length of the key in bits.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

KeyCanDecrypt Property (CryptoServer Class)

Returns True if the key can be used for decryption.

Syntax

ANSI (Cross Platform)
int GetKeyCanDecrypt(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanDecrypt(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycandecrypt(void* lpObj, int keyindex);

bool GetKeyCanDecrypt(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for decryption.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanDerive Property (CryptoServer Class)

Returns True if the key can be used for key derivation.

Syntax

ANSI (Cross Platform)
int GetKeyCanDerive(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanDerive(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanderive(void* lpObj, int keyindex);

bool GetKeyCanDerive(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key derivation.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanEncrypt Property (CryptoServer Class)

Returns True if the key can be used for encryption.

Syntax

ANSI (Cross Platform)
int GetKeyCanEncrypt(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanEncrypt(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanencrypt(void* lpObj, int keyindex);

bool GetKeyCanEncrypt(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for encryption.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanHash Property (CryptoServer Class)

Returns True if the key can be used for hashing/MACing.

Syntax

ANSI (Cross Platform)
int GetKeyCanHash(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanHash(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanhash(void* lpObj, int keyindex);

bool GetKeyCanHash(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for hashing/MACing.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanSign Property (CryptoServer Class)

Returns True if the key can be used for signing.

Syntax

ANSI (Cross Platform)
int GetKeyCanSign(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanSign(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycansign(void* lpObj, int keyindex);

bool GetKeyCanSign(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for signing.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanSignRecover Property (CryptoServer Class)

Returns True if the key can be used for enveloping signing.

Syntax

ANSI (Cross Platform)
int GetKeyCanSignRecover(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanSignRecover(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycansignrecover(void* lpObj, int keyindex);

bool GetKeyCanSignRecover(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for enveloping signing.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanUnwrap Property (CryptoServer Class)

Returns True if the key can be used for key unwrapping.

Syntax

ANSI (Cross Platform)
int GetKeyCanUnwrap(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanUnwrap(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanunwrap(void* lpObj, int keyindex);

bool GetKeyCanUnwrap(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key unwrapping.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanVerify Property (CryptoServer Class)

Returns True if the key can be used for verifying signatures.

Syntax

ANSI (Cross Platform)
int GetKeyCanVerify(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanVerify(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanverify(void* lpObj, int keyindex);

bool GetKeyCanVerify(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying signatures.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanVerifyRecover Property (CryptoServer Class)

Returns True if the key can be used for verifying enveloping signatures.

Syntax

ANSI (Cross Platform)
int GetKeyCanVerifyRecover(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanVerifyRecover(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanverifyrecover(void* lpObj, int keyindex);

bool GetKeyCanVerifyRecover(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying enveloping signatures.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCanWrap Property (CryptoServer Class)

Returns True if the key can be used for key wrapping.

Syntax

ANSI (Cross Platform)
int GetKeyCanWrap(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyCanWrap(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeycanwrap(void* lpObj, int keyindex);

bool GetKeyCanWrap(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key wrapping.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCapabilities Property (CryptoServer Class)

A collection of information about the key capabilities TBD: discuss type and options.

Syntax

ANSI (Cross Platform)
char* GetKeyCapabilities(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyCapabilities(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeycapabilities(void* lpObj, int keyindex);

QString GetKeyCapabilities(int iKeyIndex);

Default Value

Remarks

A collection of information about the key capabilities TBD: discuss type and options. The following capabilities are offered by PKCS#11: "local", "trusted", "sensitive", "always sensitive", "never extractable", "always authenticate", "modifiable", plus we need to support custom parameters (e.g. Key Checksum)

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetKeyDescription(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyDescription(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeydescription(void* lpObj, int keyindex);

QString GetKeyDescription(int iKeyIndex);

Default Value

Remarks

The description, or label, of the object.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetKeyEnabled(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyEnabled(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeyenabled(void* lpObj, int keyindex);

bool GetKeyEnabled(int iKeyIndex);

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyExportable Property (CryptoServer Class)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetKeyExportable(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyExportable(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeyexportable(void* lpObj, int keyindex);

bool GetKeyExportable(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this key.

Syntax

ANSI (Cross Platform)
int GetKeyFingerprint(int iKeyIndex, char* &lpKeyFingerprint, int &lenKeyFingerprint);

Unicode (Windows)
INT GetKeyFingerprint(INT iKeyIndex, LPSTR &lpKeyFingerprint, INT &lenKeyFingerprint);

int pkiproxy_cryptoserver_getkeyfingerprint(void* lpObj, int keyindex, char** lpKeyFingerprint, int* lenKeyFingerprint);

QByteArray GetKeyFingerprint(int iKeyIndex);

Remarks

Contains the fingerprint (a hash imprint) of this key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KeyFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the key.

Syntax

ANSI (Cross Platform)
char* GetKeyFriendlyName(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyFriendlyName(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyfriendlyname(void* lpObj, int keyindex);

QString GetKeyFriendlyName(int iKeyIndex);

Default Value

Remarks

Contains an associated alias (friendly name) of the key. PKCS#11 equivalent: Label.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetKeyGroup(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyGroup(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeygroup(void* lpObj, int keyindex);

QString GetKeyGroup(int iKeyIndex);

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyID Property (CryptoServer Class)

Provides access to a storage-specific key identifier.

Syntax

ANSI (Cross Platform)
char* GetKeyID(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyID(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyid(void* lpObj, int keyindex);

QString GetKeyID(int iKeyIndex);

Default Value

Remarks

Provides access to a storage-specific key identifier. Key identifiers are used by cryptographicproviders to refer to a particular key and/or distinguish between different keys. They aretypically unique within a storage, but there is no guarantee that a particular cryptoproviderwill conform to that (or will assign any key IDs at all).

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyIV Property (CryptoServer Class)

The initialization vector (IV) of a symmetric key.

Syntax

ANSI (Cross Platform)
int GetKeyIV(int iKeyIndex, char* &lpKeyIV, int &lenKeyIV);

Unicode (Windows)
INT GetKeyIV(INT iKeyIndex, LPSTR &lpKeyIV, INT &lenKeyIV);

int pkiproxy_cryptoserver_getkeyiv(void* lpObj, int keyindex, char** lpKeyIV, int* lenKeyIV);

QByteArray GetKeyIV(int iKeyIndex);

Remarks

The initialization vector (IV) of a symmetric key. This is normally a public part of a symmetric key, the idea of which is to introduce randomness to the encrypted dataand/or serve as a first block in chaining ciphers.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KeyKeyType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetKeyKeyType(int iKeyIndex);

Unicode (Windows)
INT GetKeyKeyType(INT iKeyIndex);

Possible Values

CKT_UNKNOWN(0), 
CKT_PUBLIC(1), 
CKT_PRIVATE(2), 
CKT_SYMMETRIC(3), 
CKT_DOMAIN_PARAMS(4), 
CKT_GENERIC(5)

int pkiproxy_cryptoserver_getkeykeytype(void* lpObj, int keyindex);

int GetKeyKeyType(int iKeyIndex);

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the key type.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

KeyMechanism Property (CryptoServer Class)

The algorithm of the cryptographic key.

Syntax

ANSI (Cross Platform)
char* GetKeyMechanism(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyMechanism(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeymechanism(void* lpObj, int keyindex);

QString GetKeyMechanism(int iKeyIndex);

Default Value

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key.Public key algorithms: RSA, ECDSA, Elgamal, DH.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyMechanismParams Property (CryptoServer Class)

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

Syntax

ANSI (Cross Platform)
char* GetKeyMechanismParams(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyMechanismParams(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeymechanismparams(void* lpObj, int keyindex);

QString GetKeyMechanismParams(int iKeyIndex);

Default Value

Remarks

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyNonce Property (CryptoServer Class)

A nonce value associated with a key.

Syntax

ANSI (Cross Platform)
int GetKeyNonce(int iKeyIndex, char* &lpKeyNonce, int &lenKeyNonce);

Unicode (Windows)
INT GetKeyNonce(INT iKeyIndex, LPSTR &lpKeyNonce, INT &lenKeyNonce);

int pkiproxy_cryptoserver_getkeynonce(void* lpObj, int keyindex, char** lpKeyNonce, int* lenKeyNonce);

QByteArray GetKeyNonce(int iKeyIndex);

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

KeyNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetKeyNonPublic(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyNonPublic(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeynonpublic(void* lpObj, int keyindex);

bool GetKeyNonPublic(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this key.

Syntax

ANSI (Cross Platform)
char* GetKeyOrigin(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyOrigin(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyorigin(void* lpObj, int keyindex);

QString GetKeyOrigin(int iKeyIndex);

Default Value

Remarks

Returns the origin (the Storage ID) of this key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetKeyPersistent(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyPersistent(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeypersistent(void* lpObj, int keyindex);

bool GetKeyPersistent(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetKeyProperties(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyProperties(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyproperties(void* lpObj, int keyindex);

QString GetKeyProperties(int iKeyIndex);

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetKeyReadOnly(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyReadOnly(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeyreadonly(void* lpObj, int keyindex);

bool GetKeyReadOnly(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the object is readonly.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeySensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetKeySensitive(int iKeyIndex);

Unicode (Windows)
BOOL GetKeySensitive(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeysensitive(void* lpObj, int keyindex);

bool GetKeySensitive(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeySize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetKeySize(int iKeyIndex);

Unicode (Windows)
INT GetKeySize(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeysize(void* lpObj, int keyindex);

int GetKeySize(int iKeyIndex);

Default Value

Remarks

The size of the object in bytes

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

KeySubject Property (CryptoServer Class)

Returns the key subject.

Syntax

ANSI (Cross Platform)
char* GetKeySubject(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeySubject(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeysubject(void* lpObj, int keyindex);

QString GetKeySubject(int iKeyIndex);

Default Value

Remarks

Returns the key subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetKeyUserId(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyUserId(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyuserid(void* lpObj, int keyindex);

QString GetKeyUserId(int iKeyIndex);

Default Value

Remarks

TBD

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetKeyUserKeySecret(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyUserKeySecret(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyuserkeysecret(void* lpObj, int keyindex);

QString GetKeyUserKeySecret(int iKeyIndex);

Default Value

Remarks

TBD

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyValid Property (CryptoServer Class)

Returns True if this key is valid.

Syntax

ANSI (Cross Platform)
int GetKeyValid(int iKeyIndex);

Unicode (Windows)
BOOL GetKeyValid(INT iKeyIndex);

int pkiproxy_cryptoserver_getkeyvalid(void* lpObj, int keyindex);

bool GetKeyValid(int iKeyIndex);

Default Value

FALSE

Remarks

Returns True if this key is valid. The term Valid highly depends onthe kind of the key being stored. A symmetric key is considered validif its length fits the algorithm being set. The validity of anRSA key also ensures that the RSA key elements (primes, exponents,and modulus) are consistent.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyValidFrom Property (CryptoServer Class)

The time point at which the key becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetKeyValidFrom(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyValidFrom(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyvalidfrom(void* lpObj, int keyindex);

QString GetKeyValidFrom(int iKeyIndex);

Default Value

Remarks

The time point at which the key becomes valid, in UTC.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyValidTo Property (CryptoServer Class)

The time point at which the key expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetKeyValidTo(int iKeyIndex);

Unicode (Windows)
LPWSTR GetKeyValidTo(INT iKeyIndex);

char* pkiproxy_cryptoserver_getkeyvalidto(void* lpObj, int keyindex);

QString GetKeyValidTo(int iKeyIndex);

Default Value

Remarks

The time point at which the key expires, in UTC.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyValue Property (CryptoServer Class)

The byte array representation of the key.

Syntax

ANSI (Cross Platform)
int GetKeyValue(int iKeyIndex, char* &lpKeyValue, int &lenKeyValue);

Unicode (Windows)
INT GetKeyValue(INT iKeyIndex, LPSTR &lpKeyValue, INT &lenKeyValue);

int pkiproxy_cryptoserver_getkeyvalue(void* lpObj, int keyindex, char** lpKeyValue, int* lenKeyValue);

QByteArray GetKeyValue(int iKeyIndex);

Remarks

The byte array representation of the key. This may not be available for non-KeyExportable keys.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

MechCount Property (CryptoServer Class)

The number of records in the Mech arrays.

Syntax

ANSI (Cross Platform)
int GetMechCount();

Unicode (Windows)
INT GetMechCount();

int pkiproxy_cryptoserver_getmechcount(void* lpObj);

int GetMechCount();

Default Value

Remarks

This property controls the size of the following arrays:

MechAliases
MechCanDecrypt
MechCanDerive
MechCanEncrypt
MechCanGenerate
MechCanHash
MechCanPRNG
MechCanSign
MechCanSignRecover
MechCanUnwrap
MechCanVerify
MechCanVerifyRecover
MechCanWrap
MechMaxBits
MechMechanismName
MechMinBits
MechProperties

The array indices start at 0 and end at MechCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MechAliases Property (CryptoServer Class)

A comma-separated list of aliases of the mechanism.

Syntax

ANSI (Cross Platform)
char* GetMechAliases(int iMechIndex);

Unicode (Windows)
LPWSTR GetMechAliases(INT iMechIndex);

char* pkiproxy_cryptoserver_getmechaliases(void* lpObj, int mechindex);

QString GetMechAliases(int iMechIndex);

Default Value

Remarks

A comma-separated list of aliases of the mechanism. These may be environment-specific or reflect the naming of the mechanism in otherstandards, such as OIDs (1.2.840.113549.1.1.11) or third-party numeric constants.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

String

MechCanDecrypt Property (CryptoServer Class)

Returns True if the key can be used for decryption.

Syntax

ANSI (Cross Platform)
int GetMechCanDecrypt(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanDecrypt(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcandecrypt(void* lpObj, int mechindex);

bool GetMechCanDecrypt(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for decryption.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanDerive Property (CryptoServer Class)

Returns True if the key can be used for key derivation.

Syntax

ANSI (Cross Platform)
int GetMechCanDerive(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanDerive(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanderive(void* lpObj, int mechindex);

bool GetMechCanDerive(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key derivation.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanEncrypt Property (CryptoServer Class)

Returns True if the key can be used for encryption.

Syntax

ANSI (Cross Platform)
int GetMechCanEncrypt(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanEncrypt(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanencrypt(void* lpObj, int mechindex);

bool GetMechCanEncrypt(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for encryption.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanGenerate Property (CryptoServer Class)

Returns True if the keystore can generate keys using the mechanism.

Syntax

ANSI (Cross Platform)
int GetMechCanGenerate(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanGenerate(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcangenerate(void* lpObj, int mechindex);

bool GetMechCanGenerate(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the keystore can generate keys using the mechanism.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanHash Property (CryptoServer Class)

Returns True if the key can be used for hashing/MACing.

Syntax

ANSI (Cross Platform)
int GetMechCanHash(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanHash(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanhash(void* lpObj, int mechindex);

bool GetMechCanHash(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for hashing/MACing.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanPRNG Property (CryptoServer Class)

Returns True if the mechanism can be used for generating pseudorandom numbers.

Syntax

ANSI (Cross Platform)
int GetMechCanPRNG(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanPRNG(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanprng(void* lpObj, int mechindex);

bool GetMechCanPRNG(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the mechanism can be used for generating pseudorandom numbers.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanSign Property (CryptoServer Class)

Returns True if the key can be used for signing.

Syntax

ANSI (Cross Platform)
int GetMechCanSign(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanSign(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcansign(void* lpObj, int mechindex);

bool GetMechCanSign(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for signing.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanSignRecover Property (CryptoServer Class)

Returns True if the key can be used for enveloping signing.

Syntax

ANSI (Cross Platform)
int GetMechCanSignRecover(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanSignRecover(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcansignrecover(void* lpObj, int mechindex);

bool GetMechCanSignRecover(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for enveloping signing.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanUnwrap Property (CryptoServer Class)

Returns True if the key can be used for key unwrapping.

Syntax

ANSI (Cross Platform)
int GetMechCanUnwrap(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanUnwrap(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanunwrap(void* lpObj, int mechindex);

bool GetMechCanUnwrap(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key unwrapping.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanVerify Property (CryptoServer Class)

Returns True if the key can be used for verifying signatures.

Syntax

ANSI (Cross Platform)
int GetMechCanVerify(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanVerify(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanverify(void* lpObj, int mechindex);

bool GetMechCanVerify(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying signatures.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanVerifyRecover Property (CryptoServer Class)

Returns True if the key can be used for verifying enveloping signatures.

Syntax

ANSI (Cross Platform)
int GetMechCanVerifyRecover(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanVerifyRecover(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanverifyrecover(void* lpObj, int mechindex);

bool GetMechCanVerifyRecover(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying enveloping signatures.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechCanWrap Property (CryptoServer Class)

Returns True if the key can be used for key wrapping.

Syntax

ANSI (Cross Platform)
int GetMechCanWrap(int iMechIndex);

Unicode (Windows)
BOOL GetMechCanWrap(INT iMechIndex);

int pkiproxy_cryptoserver_getmechcanwrap(void* lpObj, int mechindex);

bool GetMechCanWrap(int iMechIndex);

Default Value

FALSE

Remarks

Returns True if the key can be used for key wrapping.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MechMaxBits Property (CryptoServer Class)

The maximal supported length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetMechMaxBits(int iMechIndex);

Unicode (Windows)
INT GetMechMaxBits(INT iMechIndex);

int pkiproxy_cryptoserver_getmechmaxbits(void* lpObj, int mechindex);

int GetMechMaxBits(int iMechIndex);

Default Value

Remarks

The maximal supported length of the key in bits.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Integer

MechMechanismName Property (CryptoServer Class)

The official name of the mechanism, such as sha256WithRSAEncryption.

Syntax

ANSI (Cross Platform)
char* GetMechMechanismName(int iMechIndex);

Unicode (Windows)
LPWSTR GetMechMechanismName(INT iMechIndex);

char* pkiproxy_cryptoserver_getmechmechanismname(void* lpObj, int mechindex);

QString GetMechMechanismName(int iMechIndex);

Default Value

Remarks

The official name of the mechanism, such as sha256WithRSAEncryption.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

String

MechMinBits Property (CryptoServer Class)

The minimal supported length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetMechMinBits(int iMechIndex);

Unicode (Windows)
INT GetMechMinBits(INT iMechIndex);

int pkiproxy_cryptoserver_getmechminbits(void* lpObj, int mechindex);

int GetMechMinBits(int iMechIndex);

Default Value

Remarks

The minimal supported length of the key in bits.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

Integer

MechProperties Property (CryptoServer Class)

A collection of custom mechanism properties as a collection of comma-separated name=value pairs.

Syntax

ANSI (Cross Platform)
char* GetMechProperties(int iMechIndex);

Unicode (Windows)
LPWSTR GetMechProperties(INT iMechIndex);

char* pkiproxy_cryptoserver_getmechproperties(void* lpObj, int mechindex);

QString GetMechProperties(int iMechIndex);

Default Value

Remarks

A collection of custom mechanism properties as a collection of comma-separated name=value pairs.

The MechIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MechCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectCount Property (CryptoServer Class)

The number of records in the Object arrays.

Syntax

ANSI (Cross Platform)
int GetObjectCount();

Unicode (Windows)
INT GetObjectCount();

int pkiproxy_cryptoserver_getobjectcount(void* lpObj);

int GetObjectCount();

Default Value

Remarks

This property controls the size of the following arrays:

ObjectDescription
ObjectEnabled
ObjectExportable
ObjectFingerprint
ObjectFriendlyName
ObjectGroup
ObjectID
ObjectIssuer
ObjectKeyUsage
ObjectNonPublic
ObjectObjType
ObjectOrigin
ObjectPersistent
ObjectProperties
ObjectReadOnly
ObjectSensitive
ObjectSerialNumber
ObjectSize
ObjectSubject
ObjectUserId
ObjectUserKeySecret
ObjectValidFrom
ObjectValidTo
ObjectValue

The array indices start at 0 and end at ObjectCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ObjectDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetObjectDescription(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectDescription(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectdescription(void* lpObj, int objectindex);

QString GetObjectDescription(int iObjectIndex);

Default Value

Remarks

The description, or label, of the object.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetObjectEnabled(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectEnabled(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectenabled(void* lpObj, int objectindex);

bool GetObjectEnabled(int iObjectIndex);

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectExportable Property (CryptoServer Class)

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetObjectExportable(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectExportable(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectexportable(void* lpObj, int objectindex);

bool GetObjectExportable(int iObjectIndex);

Default Value

FALSE

Remarks

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this object.

Syntax

ANSI (Cross Platform)
int GetObjectFingerprint(int iObjectIndex, char* &lpObjectFingerprint, int &lenObjectFingerprint);

Unicode (Windows)
INT GetObjectFingerprint(INT iObjectIndex, LPSTR &lpObjectFingerprint, INT &lenObjectFingerprint);

int pkiproxy_cryptoserver_getobjectfingerprint(void* lpObj, int objectindex, char** lpObjectFingerprint, int* lenObjectFingerprint);

QByteArray GetObjectFingerprint(int iObjectIndex);

Remarks

Contains the fingerprint (a hash imprint) of this object.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ObjectFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the object.

Syntax

ANSI (Cross Platform)
char* GetObjectFriendlyName(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectFriendlyName(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectfriendlyname(void* lpObj, int objectindex);

QString GetObjectFriendlyName(int iObjectIndex);

Default Value

Remarks

Contains an associated alias (friendly name) of the object. PKCS#11 equivalent: Label.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetObjectGroup(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectGroup(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectgroup(void* lpObj, int objectindex);

QString GetObjectGroup(int iObjectIndex);

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectID Property (CryptoServer Class)

Provides access to a storage-specific object identifier.

Syntax

ANSI (Cross Platform)
char* GetObjectID(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectID(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectid(void* lpObj, int objectindex);

QString GetObjectID(int iObjectIndex);

Default Value

Remarks

Provides access to a storage-specific object identifier.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectIssuer Property (CryptoServer Class)

Returns the object issuer.

Syntax

ANSI (Cross Platform)
char* GetObjectIssuer(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectIssuer(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectissuer(void* lpObj, int objectindex);

QString GetObjectIssuer(int iObjectIndex);

Default Value

Remarks

Returns the object issuer. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectKeyUsage Property (CryptoServer Class)

Indicates the purposes of the object.

Syntax

ANSI (Cross Platform)
char* GetObjectKeyUsage(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectKeyUsage(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectkeyusage(void* lpObj, int objectindex);

QString GetObjectKeyUsage(int iObjectIndex);

Default Value

Remarks

Indicates the purposes of the object. For certificate object, this corresponds to the elements contained in the Key Usage and Extended Key Usage extensions.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetObjectNonPublic(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectNonPublic(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectnonpublic(void* lpObj, int objectindex);

bool GetObjectNonPublic(int iObjectIndex);

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectObjType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetObjectObjType(int iObjectIndex);

Unicode (Windows)
INT GetObjectObjType(INT iObjectIndex);

Possible Values

COT_UNKNOWN(0), 
COT_CERTIFICATE(1), 
COT_DATA(2), 
COT_GENERIC(3)

int pkiproxy_cryptoserver_getobjectobjtype(void* lpObj, int objectindex);

int GetObjectObjType(int iObjectIndex);

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the object type.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Integer

ObjectOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this object.

Syntax

ANSI (Cross Platform)
char* GetObjectOrigin(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectOrigin(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectorigin(void* lpObj, int objectindex);

QString GetObjectOrigin(int iObjectIndex);

Default Value

Remarks

Returns the origin (the Storage ID) of this object.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetObjectPersistent(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectPersistent(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectpersistent(void* lpObj, int objectindex);

bool GetObjectPersistent(int iObjectIndex);

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetObjectProperties(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectProperties(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectproperties(void* lpObj, int objectindex);

QString GetObjectProperties(int iObjectIndex);

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetObjectReadOnly(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectReadOnly(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectreadonly(void* lpObj, int objectindex);

bool GetObjectReadOnly(int iObjectIndex);

Default Value

FALSE

Remarks

Returns True if the object is readonly.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectSensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetObjectSensitive(int iObjectIndex);

Unicode (Windows)
BOOL GetObjectSensitive(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectsensitive(void* lpObj, int objectindex);

bool GetObjectSensitive(int iObjectIndex);

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectSerialNumber Property (CryptoServer Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
char* GetObjectSerialNumber(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectSerialNumber(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectserialnumber(void* lpObj, int objectindex);

QString GetObjectSerialNumber(int iObjectIndex);

Default Value

Remarks

Returns the certificate's serial number.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectSize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetObjectSize(int iObjectIndex);

Unicode (Windows)
INT GetObjectSize(INT iObjectIndex);

int pkiproxy_cryptoserver_getobjectsize(void* lpObj, int objectindex);

int GetObjectSize(int iObjectIndex);

Default Value

Remarks

The size of the object in bytes

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Integer

ObjectSubject Property (CryptoServer Class)

Returns the object subject.

Syntax

ANSI (Cross Platform)
char* GetObjectSubject(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectSubject(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectsubject(void* lpObj, int objectindex);

QString GetObjectSubject(int iObjectIndex);

Default Value

Remarks

Returns the object subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetObjectUserId(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectUserId(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectuserid(void* lpObj, int objectindex);

QString GetObjectUserId(int iObjectIndex);

Default Value

Remarks

TBD

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetObjectUserKeySecret(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectUserKeySecret(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectuserkeysecret(void* lpObj, int objectindex);

QString GetObjectUserKeySecret(int iObjectIndex);

Default Value

Remarks

TBD

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectValidFrom Property (CryptoServer Class)

The time point at which the object becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetObjectValidFrom(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectValidFrom(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectvalidfrom(void* lpObj, int objectindex);

QString GetObjectValidFrom(int iObjectIndex);

Default Value

Remarks

The time point at which the object becomes valid, in UTC.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectValidTo Property (CryptoServer Class)

The time point at which the object expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetObjectValidTo(int iObjectIndex);

Unicode (Windows)
LPWSTR GetObjectValidTo(INT iObjectIndex);

char* pkiproxy_cryptoserver_getobjectvalidto(void* lpObj, int objectindex);

QString GetObjectValidTo(int iObjectIndex);

Default Value

Remarks

The time point at which the object expires, in UTC.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectValue Property (CryptoServer Class)

The byte array representation of the object.

Syntax

ANSI (Cross Platform)
int GetObjectValue(int iObjectIndex, char* &lpObjectValue, int &lenObjectValue);

Unicode (Windows)
INT GetObjectValue(INT iObjectIndex, LPSTR &lpObjectValue, INT &lenObjectValue);

int pkiproxy_cryptoserver_getobjectvalue(void* lpObj, int objectindex, char** lpObjectValue, int* lenObjectValue);

QByteArray GetObjectValue(int iObjectIndex);

Remarks

The byte array representation of the object. This may not be available for non-ObjectExportable objects.

The ObjectIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

PinnedKeyBits Property (CryptoServer Class)

The length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyBits();
int SetPinnedKeyBits(int iPinnedKeyBits);

Unicode (Windows)
INT GetPinnedKeyBits();
INT SetPinnedKeyBits(INT iPinnedKeyBits);

int pkiproxy_cryptoserver_getpinnedkeybits(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeybits(void* lpObj, int iPinnedKeyBits);

int GetPinnedKeyBits();
int SetPinnedKeyBits(int iPinnedKeyBits);

Default Value

Remarks

The length of the key in bits.

This property is not available at design time.

Data Type

Integer

PinnedKeyCanDecrypt Property (CryptoServer Class)

Returns True if the key can be used for decryption.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanDecrypt();
int SetPinnedKeyCanDecrypt(int bPinnedKeyCanDecrypt);

Unicode (Windows)
BOOL GetPinnedKeyCanDecrypt();
INT SetPinnedKeyCanDecrypt(BOOL bPinnedKeyCanDecrypt);

int pkiproxy_cryptoserver_getpinnedkeycandecrypt(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycandecrypt(void* lpObj, int bPinnedKeyCanDecrypt);

bool GetPinnedKeyCanDecrypt();
int SetPinnedKeyCanDecrypt(bool bPinnedKeyCanDecrypt);

Default Value

FALSE

Remarks

Returns True if the key can be used for decryption.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanDerive Property (CryptoServer Class)

Returns True if the key can be used for key derivation.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanDerive();
int SetPinnedKeyCanDerive(int bPinnedKeyCanDerive);

Unicode (Windows)
BOOL GetPinnedKeyCanDerive();
INT SetPinnedKeyCanDerive(BOOL bPinnedKeyCanDerive);

int pkiproxy_cryptoserver_getpinnedkeycanderive(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanderive(void* lpObj, int bPinnedKeyCanDerive);

bool GetPinnedKeyCanDerive();
int SetPinnedKeyCanDerive(bool bPinnedKeyCanDerive);

Default Value

FALSE

Remarks

Returns True if the key can be used for key derivation.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanEncrypt Property (CryptoServer Class)

Returns True if the key can be used for encryption.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanEncrypt();
int SetPinnedKeyCanEncrypt(int bPinnedKeyCanEncrypt);

Unicode (Windows)
BOOL GetPinnedKeyCanEncrypt();
INT SetPinnedKeyCanEncrypt(BOOL bPinnedKeyCanEncrypt);

int pkiproxy_cryptoserver_getpinnedkeycanencrypt(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanencrypt(void* lpObj, int bPinnedKeyCanEncrypt);

bool GetPinnedKeyCanEncrypt();
int SetPinnedKeyCanEncrypt(bool bPinnedKeyCanEncrypt);

Default Value

FALSE

Remarks

Returns True if the key can be used for encryption.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanHash Property (CryptoServer Class)

Returns True if the key can be used for hashing/MACing.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanHash();
int SetPinnedKeyCanHash(int bPinnedKeyCanHash);

Unicode (Windows)
BOOL GetPinnedKeyCanHash();
INT SetPinnedKeyCanHash(BOOL bPinnedKeyCanHash);

int pkiproxy_cryptoserver_getpinnedkeycanhash(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanhash(void* lpObj, int bPinnedKeyCanHash);

bool GetPinnedKeyCanHash();
int SetPinnedKeyCanHash(bool bPinnedKeyCanHash);

Default Value

FALSE

Remarks

Returns True if the key can be used for hashing/MACing.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanSign Property (CryptoServer Class)

Returns True if the key can be used for signing.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanSign();
int SetPinnedKeyCanSign(int bPinnedKeyCanSign);

Unicode (Windows)
BOOL GetPinnedKeyCanSign();
INT SetPinnedKeyCanSign(BOOL bPinnedKeyCanSign);

int pkiproxy_cryptoserver_getpinnedkeycansign(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycansign(void* lpObj, int bPinnedKeyCanSign);

bool GetPinnedKeyCanSign();
int SetPinnedKeyCanSign(bool bPinnedKeyCanSign);

Default Value

FALSE

Remarks

Returns True if the key can be used for signing.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanSignRecover Property (CryptoServer Class)

Returns True if the key can be used for enveloping signing.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanSignRecover();
int SetPinnedKeyCanSignRecover(int bPinnedKeyCanSignRecover);

Unicode (Windows)
BOOL GetPinnedKeyCanSignRecover();
INT SetPinnedKeyCanSignRecover(BOOL bPinnedKeyCanSignRecover);

int pkiproxy_cryptoserver_getpinnedkeycansignrecover(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycansignrecover(void* lpObj, int bPinnedKeyCanSignRecover);

bool GetPinnedKeyCanSignRecover();
int SetPinnedKeyCanSignRecover(bool bPinnedKeyCanSignRecover);

Default Value

FALSE

Remarks

Returns True if the key can be used for enveloping signing.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanUnwrap Property (CryptoServer Class)

Returns True if the key can be used for key unwrapping.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanUnwrap();
int SetPinnedKeyCanUnwrap(int bPinnedKeyCanUnwrap);

Unicode (Windows)
BOOL GetPinnedKeyCanUnwrap();
INT SetPinnedKeyCanUnwrap(BOOL bPinnedKeyCanUnwrap);

int pkiproxy_cryptoserver_getpinnedkeycanunwrap(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanunwrap(void* lpObj, int bPinnedKeyCanUnwrap);

bool GetPinnedKeyCanUnwrap();
int SetPinnedKeyCanUnwrap(bool bPinnedKeyCanUnwrap);

Default Value

FALSE

Remarks

Returns True if the key can be used for key unwrapping.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanVerify Property (CryptoServer Class)

Returns True if the key can be used for verifying signatures.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanVerify();
int SetPinnedKeyCanVerify(int bPinnedKeyCanVerify);

Unicode (Windows)
BOOL GetPinnedKeyCanVerify();
INT SetPinnedKeyCanVerify(BOOL bPinnedKeyCanVerify);

int pkiproxy_cryptoserver_getpinnedkeycanverify(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanverify(void* lpObj, int bPinnedKeyCanVerify);

bool GetPinnedKeyCanVerify();
int SetPinnedKeyCanVerify(bool bPinnedKeyCanVerify);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying signatures.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanVerifyRecover Property (CryptoServer Class)

Returns True if the key can be used for verifying enveloping signatures.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanVerifyRecover();
int SetPinnedKeyCanVerifyRecover(int bPinnedKeyCanVerifyRecover);

Unicode (Windows)
BOOL GetPinnedKeyCanVerifyRecover();
INT SetPinnedKeyCanVerifyRecover(BOOL bPinnedKeyCanVerifyRecover);

int pkiproxy_cryptoserver_getpinnedkeycanverifyrecover(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanverifyrecover(void* lpObj, int bPinnedKeyCanVerifyRecover);

bool GetPinnedKeyCanVerifyRecover();
int SetPinnedKeyCanVerifyRecover(bool bPinnedKeyCanVerifyRecover);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying enveloping signatures.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCanWrap Property (CryptoServer Class)

Returns True if the key can be used for key wrapping.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyCanWrap();
int SetPinnedKeyCanWrap(int bPinnedKeyCanWrap);

Unicode (Windows)
BOOL GetPinnedKeyCanWrap();
INT SetPinnedKeyCanWrap(BOOL bPinnedKeyCanWrap);

int pkiproxy_cryptoserver_getpinnedkeycanwrap(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycanwrap(void* lpObj, int bPinnedKeyCanWrap);

bool GetPinnedKeyCanWrap();
int SetPinnedKeyCanWrap(bool bPinnedKeyCanWrap);

Default Value

FALSE

Remarks

Returns True if the key can be used for key wrapping.

This property is not available at design time.

Data Type

Boolean

PinnedKeyCapabilities Property (CryptoServer Class)

A collection of information about the key capabilities TBD: discuss type and options.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyCapabilities();
int SetPinnedKeyCapabilities(const char* lpszPinnedKeyCapabilities);

Unicode (Windows)
LPWSTR GetPinnedKeyCapabilities();
INT SetPinnedKeyCapabilities(LPCWSTR lpszPinnedKeyCapabilities);

char* pkiproxy_cryptoserver_getpinnedkeycapabilities(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeycapabilities(void* lpObj, const char* lpszPinnedKeyCapabilities);

QString GetPinnedKeyCapabilities();
int SetPinnedKeyCapabilities(QString qsPinnedKeyCapabilities);

Default Value

Remarks

This property is not available at design time.

Data Type

String

PinnedKeyDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyDescription();
int SetPinnedKeyDescription(const char* lpszPinnedKeyDescription);

Unicode (Windows)
LPWSTR GetPinnedKeyDescription();
INT SetPinnedKeyDescription(LPCWSTR lpszPinnedKeyDescription);

char* pkiproxy_cryptoserver_getpinnedkeydescription(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeydescription(void* lpObj, const char* lpszPinnedKeyDescription);

QString GetPinnedKeyDescription();
int SetPinnedKeyDescription(QString qsPinnedKeyDescription);

Default Value

Remarks

The description, or label, of the object.

This property is not available at design time.

Data Type

String

PinnedKeyEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyEnabled();
int SetPinnedKeyEnabled(int bPinnedKeyEnabled);

Unicode (Windows)
BOOL GetPinnedKeyEnabled();
INT SetPinnedKeyEnabled(BOOL bPinnedKeyEnabled);

int pkiproxy_cryptoserver_getpinnedkeyenabled(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyenabled(void* lpObj, int bPinnedKeyEnabled);

bool GetPinnedKeyEnabled();
int SetPinnedKeyEnabled(bool bPinnedKeyEnabled);

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

This property is not available at design time.

Data Type

Boolean

PinnedKeyExportable Property (CryptoServer Class)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyExportable();
int SetPinnedKeyExportable(int bPinnedKeyExportable);

Unicode (Windows)
BOOL GetPinnedKeyExportable();
INT SetPinnedKeyExportable(BOOL bPinnedKeyExportable);

int pkiproxy_cryptoserver_getpinnedkeyexportable(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyexportable(void* lpObj, int bPinnedKeyExportable);

bool GetPinnedKeyExportable();
int SetPinnedKeyExportable(bool bPinnedKeyExportable);

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedKeyFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this key.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyFingerprint(char* &lpPinnedKeyFingerprint, int &lenPinnedKeyFingerprint);
int SetPinnedKeyFingerprint(const char* lpPinnedKeyFingerprint, int lenPinnedKeyFingerprint);

Unicode (Windows)
INT GetPinnedKeyFingerprint(LPSTR &lpPinnedKeyFingerprint, INT &lenPinnedKeyFingerprint);
INT SetPinnedKeyFingerprint(LPCSTR lpPinnedKeyFingerprint, INT lenPinnedKeyFingerprint);

int pkiproxy_cryptoserver_getpinnedkeyfingerprint(void* lpObj, char** lpPinnedKeyFingerprint, int* lenPinnedKeyFingerprint);
int pkiproxy_cryptoserver_setpinnedkeyfingerprint(void* lpObj, const char* lpPinnedKeyFingerprint, int lenPinnedKeyFingerprint);

QByteArray GetPinnedKeyFingerprint();
int SetPinnedKeyFingerprint(QByteArray qbaPinnedKeyFingerprint);

Remarks

Contains the fingerprint (a hash imprint) of this key.

This property is not available at design time.

Data Type

Byte Array

PinnedKeyFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the key.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyFriendlyName();
int SetPinnedKeyFriendlyName(const char* lpszPinnedKeyFriendlyName);

Unicode (Windows)
LPWSTR GetPinnedKeyFriendlyName();
INT SetPinnedKeyFriendlyName(LPCWSTR lpszPinnedKeyFriendlyName);

char* pkiproxy_cryptoserver_getpinnedkeyfriendlyname(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyfriendlyname(void* lpObj, const char* lpszPinnedKeyFriendlyName);

QString GetPinnedKeyFriendlyName();
int SetPinnedKeyFriendlyName(QString qsPinnedKeyFriendlyName);

Default Value

Remarks

Contains an associated alias (friendly name) of the key. PKCS#11 equivalent: Label.

This property is not available at design time.

Data Type

String

PinnedKeyGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyGroup();
int SetPinnedKeyGroup(const char* lpszPinnedKeyGroup);

Unicode (Windows)
LPWSTR GetPinnedKeyGroup();
INT SetPinnedKeyGroup(LPCWSTR lpszPinnedKeyGroup);

char* pkiproxy_cryptoserver_getpinnedkeygroup(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeygroup(void* lpObj, const char* lpszPinnedKeyGroup);

QString GetPinnedKeyGroup();
int SetPinnedKeyGroup(QString qsPinnedKeyGroup);

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

This property is not available at design time.

Data Type

String

PinnedKeyID Property (CryptoServer Class)

Provides access to a storage-specific key identifier.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyID();
int SetPinnedKeyID(const char* lpszPinnedKeyID);

Unicode (Windows)
LPWSTR GetPinnedKeyID();
INT SetPinnedKeyID(LPCWSTR lpszPinnedKeyID);

char* pkiproxy_cryptoserver_getpinnedkeyid(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyid(void* lpObj, const char* lpszPinnedKeyID);

QString GetPinnedKeyID();
int SetPinnedKeyID(QString qsPinnedKeyID);

Default Value

Remarks

This property is not available at design time.

Data Type

String

PinnedKeyIV Property (CryptoServer Class)

The initialization vector (IV) of a symmetric key.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyIV(char* &lpPinnedKeyIV, int &lenPinnedKeyIV);
int SetPinnedKeyIV(const char* lpPinnedKeyIV, int lenPinnedKeyIV);

Unicode (Windows)
INT GetPinnedKeyIV(LPSTR &lpPinnedKeyIV, INT &lenPinnedKeyIV);
INT SetPinnedKeyIV(LPCSTR lpPinnedKeyIV, INT lenPinnedKeyIV);

int pkiproxy_cryptoserver_getpinnedkeyiv(void* lpObj, char** lpPinnedKeyIV, int* lenPinnedKeyIV);
int pkiproxy_cryptoserver_setpinnedkeyiv(void* lpObj, const char* lpPinnedKeyIV, int lenPinnedKeyIV);

QByteArray GetPinnedKeyIV();
int SetPinnedKeyIV(QByteArray qbaPinnedKeyIV);

Remarks

This property is not available at design time.

Data Type

Byte Array

PinnedKeyKeyType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyKeyType();
int SetPinnedKeyKeyType(int iPinnedKeyKeyType);

Unicode (Windows)
INT GetPinnedKeyKeyType();
INT SetPinnedKeyKeyType(INT iPinnedKeyKeyType);

Possible Values

CKT_UNKNOWN(0), 
CKT_PUBLIC(1), 
CKT_PRIVATE(2), 
CKT_SYMMETRIC(3), 
CKT_DOMAIN_PARAMS(4), 
CKT_GENERIC(5)

int pkiproxy_cryptoserver_getpinnedkeykeytype(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeykeytype(void* lpObj, int iPinnedKeyKeyType);

int GetPinnedKeyKeyType();
int SetPinnedKeyKeyType(int iPinnedKeyKeyType);

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the key type.

This property is not available at design time.

Data Type

Integer

PinnedKeyMechanism Property (CryptoServer Class)

The algorithm of the cryptographic key.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyMechanism();
int SetPinnedKeyMechanism(const char* lpszPinnedKeyMechanism);

Unicode (Windows)
LPWSTR GetPinnedKeyMechanism();
INT SetPinnedKeyMechanism(LPCWSTR lpszPinnedKeyMechanism);

char* pkiproxy_cryptoserver_getpinnedkeymechanism(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeymechanism(void* lpObj, const char* lpszPinnedKeyMechanism);

QString GetPinnedKeyMechanism();
int SetPinnedKeyMechanism(QString qsPinnedKeyMechanism);

Default Value

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key.Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is not available at design time.

Data Type

String

PinnedKeyMechanismParams Property (CryptoServer Class)

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyMechanismParams();
int SetPinnedKeyMechanismParams(const char* lpszPinnedKeyMechanismParams);

Unicode (Windows)
LPWSTR GetPinnedKeyMechanismParams();
INT SetPinnedKeyMechanismParams(LPCWSTR lpszPinnedKeyMechanismParams);

char* pkiproxy_cryptoserver_getpinnedkeymechanismparams(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeymechanismparams(void* lpObj, const char* lpszPinnedKeyMechanismParams);

QString GetPinnedKeyMechanismParams();
int SetPinnedKeyMechanismParams(QString qsPinnedKeyMechanismParams);

Default Value

Remarks

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

This property is not available at design time.

Data Type

String

PinnedKeyNonce Property (CryptoServer Class)

A nonce value associated with a key.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyNonce(char* &lpPinnedKeyNonce, int &lenPinnedKeyNonce);
int SetPinnedKeyNonce(const char* lpPinnedKeyNonce, int lenPinnedKeyNonce);

Unicode (Windows)
INT GetPinnedKeyNonce(LPSTR &lpPinnedKeyNonce, INT &lenPinnedKeyNonce);
INT SetPinnedKeyNonce(LPCSTR lpPinnedKeyNonce, INT lenPinnedKeyNonce);

int pkiproxy_cryptoserver_getpinnedkeynonce(void* lpObj, char** lpPinnedKeyNonce, int* lenPinnedKeyNonce);
int pkiproxy_cryptoserver_setpinnedkeynonce(void* lpObj, const char* lpPinnedKeyNonce, int lenPinnedKeyNonce);

QByteArray GetPinnedKeyNonce();
int SetPinnedKeyNonce(QByteArray qbaPinnedKeyNonce);

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is not available at design time.

Data Type

Byte Array

PinnedKeyNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyNonPublic();
int SetPinnedKeyNonPublic(int bPinnedKeyNonPublic);

Unicode (Windows)
BOOL GetPinnedKeyNonPublic();
INT SetPinnedKeyNonPublic(BOOL bPinnedKeyNonPublic);

int pkiproxy_cryptoserver_getpinnedkeynonpublic(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeynonpublic(void* lpObj, int bPinnedKeyNonPublic);

bool GetPinnedKeyNonPublic();
int SetPinnedKeyNonPublic(bool bPinnedKeyNonPublic);

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedKeyOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this key.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyOrigin();
int SetPinnedKeyOrigin(const char* lpszPinnedKeyOrigin);

Unicode (Windows)
LPWSTR GetPinnedKeyOrigin();
INT SetPinnedKeyOrigin(LPCWSTR lpszPinnedKeyOrigin);

char* pkiproxy_cryptoserver_getpinnedkeyorigin(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyorigin(void* lpObj, const char* lpszPinnedKeyOrigin);

QString GetPinnedKeyOrigin();
int SetPinnedKeyOrigin(QString qsPinnedKeyOrigin);

Default Value

Remarks

Returns the origin (the Storage ID) of this key.

This property is not available at design time.

Data Type

String

PinnedKeyPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyPersistent();
int SetPinnedKeyPersistent(int bPinnedKeyPersistent);

Unicode (Windows)
BOOL GetPinnedKeyPersistent();
INT SetPinnedKeyPersistent(BOOL bPinnedKeyPersistent);

int pkiproxy_cryptoserver_getpinnedkeypersistent(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeypersistent(void* lpObj, int bPinnedKeyPersistent);

bool GetPinnedKeyPersistent();
int SetPinnedKeyPersistent(bool bPinnedKeyPersistent);

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

This property is not available at design time.

Data Type

Boolean

PinnedKeyProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyProperties();
int SetPinnedKeyProperties(const char* lpszPinnedKeyProperties);

Unicode (Windows)
LPWSTR GetPinnedKeyProperties();
INT SetPinnedKeyProperties(LPCWSTR lpszPinnedKeyProperties);

char* pkiproxy_cryptoserver_getpinnedkeyproperties(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyproperties(void* lpObj, const char* lpszPinnedKeyProperties);

QString GetPinnedKeyProperties();
int SetPinnedKeyProperties(QString qsPinnedKeyProperties);

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

This property is not available at design time.

Data Type

String

PinnedKeyReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyReadOnly();
int SetPinnedKeyReadOnly(int bPinnedKeyReadOnly);

Unicode (Windows)
BOOL GetPinnedKeyReadOnly();
INT SetPinnedKeyReadOnly(BOOL bPinnedKeyReadOnly);

int pkiproxy_cryptoserver_getpinnedkeyreadonly(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyreadonly(void* lpObj, int bPinnedKeyReadOnly);

bool GetPinnedKeyReadOnly();
int SetPinnedKeyReadOnly(bool bPinnedKeyReadOnly);

Default Value

FALSE

Remarks

Returns True if the object is readonly.

This property is not available at design time.

Data Type

Boolean

PinnedKeySensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedKeySensitive();
int SetPinnedKeySensitive(int bPinnedKeySensitive);

Unicode (Windows)
BOOL GetPinnedKeySensitive();
INT SetPinnedKeySensitive(BOOL bPinnedKeySensitive);

int pkiproxy_cryptoserver_getpinnedkeysensitive(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeysensitive(void* lpObj, int bPinnedKeySensitive);

bool GetPinnedKeySensitive();
int SetPinnedKeySensitive(bool bPinnedKeySensitive);

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedKeySize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetPinnedKeySize();
int SetPinnedKeySize(int iPinnedKeySize);

Unicode (Windows)
INT GetPinnedKeySize();
INT SetPinnedKeySize(INT iPinnedKeySize);

int pkiproxy_cryptoserver_getpinnedkeysize(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeysize(void* lpObj, int iPinnedKeySize);

int GetPinnedKeySize();
int SetPinnedKeySize(int iPinnedKeySize);

Default Value

Remarks

The size of the object in bytes

This property is not available at design time.

Data Type

Integer

PinnedKeySubject Property (CryptoServer Class)

Returns the key subject.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeySubject();
int SetPinnedKeySubject(const char* lpszPinnedKeySubject);

Unicode (Windows)
LPWSTR GetPinnedKeySubject();
INT SetPinnedKeySubject(LPCWSTR lpszPinnedKeySubject);

char* pkiproxy_cryptoserver_getpinnedkeysubject(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeysubject(void* lpObj, const char* lpszPinnedKeySubject);

QString GetPinnedKeySubject();
int SetPinnedKeySubject(QString qsPinnedKeySubject);

Default Value

Remarks

Returns the key subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is not available at design time.

Data Type

String

PinnedKeyUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyUserId();
int SetPinnedKeyUserId(const char* lpszPinnedKeyUserId);

Unicode (Windows)
LPWSTR GetPinnedKeyUserId();
INT SetPinnedKeyUserId(LPCWSTR lpszPinnedKeyUserId);

char* pkiproxy_cryptoserver_getpinnedkeyuserid(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyuserid(void* lpObj, const char* lpszPinnedKeyUserId);

QString GetPinnedKeyUserId();
int SetPinnedKeyUserId(QString qsPinnedKeyUserId);

Default Value

Remarks

TBD

This property is not available at design time.

Data Type

String

PinnedKeyUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyUserKeySecret();
int SetPinnedKeyUserKeySecret(const char* lpszPinnedKeyUserKeySecret);

Unicode (Windows)
LPWSTR GetPinnedKeyUserKeySecret();
INT SetPinnedKeyUserKeySecret(LPCWSTR lpszPinnedKeyUserKeySecret);

char* pkiproxy_cryptoserver_getpinnedkeyuserkeysecret(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyuserkeysecret(void* lpObj, const char* lpszPinnedKeyUserKeySecret);

QString GetPinnedKeyUserKeySecret();
int SetPinnedKeyUserKeySecret(QString qsPinnedKeyUserKeySecret);

Default Value

Remarks

TBD

This property is not available at design time.

Data Type

String

PinnedKeyValid Property (CryptoServer Class)

Returns True if this key is valid.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyValid();
int SetPinnedKeyValid(int bPinnedKeyValid);

Unicode (Windows)
BOOL GetPinnedKeyValid();
INT SetPinnedKeyValid(BOOL bPinnedKeyValid);

int pkiproxy_cryptoserver_getpinnedkeyvalid(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyvalid(void* lpObj, int bPinnedKeyValid);

bool GetPinnedKeyValid();
int SetPinnedKeyValid(bool bPinnedKeyValid);

Default Value

FALSE

Remarks

This property is not available at design time.

Data Type

Boolean

PinnedKeyValidFrom Property (CryptoServer Class)

The time point at which the key becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyValidFrom();
int SetPinnedKeyValidFrom(const char* lpszPinnedKeyValidFrom);

Unicode (Windows)
LPWSTR GetPinnedKeyValidFrom();
INT SetPinnedKeyValidFrom(LPCWSTR lpszPinnedKeyValidFrom);

char* pkiproxy_cryptoserver_getpinnedkeyvalidfrom(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyvalidfrom(void* lpObj, const char* lpszPinnedKeyValidFrom);

QString GetPinnedKeyValidFrom();
int SetPinnedKeyValidFrom(QString qsPinnedKeyValidFrom);

Default Value

Remarks

The time point at which the key becomes valid, in UTC.

This property is not available at design time.

Data Type

String

PinnedKeyValidTo Property (CryptoServer Class)

The time point at which the key expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetPinnedKeyValidTo();
int SetPinnedKeyValidTo(const char* lpszPinnedKeyValidTo);

Unicode (Windows)
LPWSTR GetPinnedKeyValidTo();
INT SetPinnedKeyValidTo(LPCWSTR lpszPinnedKeyValidTo);

char* pkiproxy_cryptoserver_getpinnedkeyvalidto(void* lpObj);
int pkiproxy_cryptoserver_setpinnedkeyvalidto(void* lpObj, const char* lpszPinnedKeyValidTo);

QString GetPinnedKeyValidTo();
int SetPinnedKeyValidTo(QString qsPinnedKeyValidTo);

Default Value

Remarks

The time point at which the key expires, in UTC.

This property is not available at design time.

Data Type

String

PinnedKeyValue Property (CryptoServer Class)

The byte array representation of the key.

Syntax

ANSI (Cross Platform)
int GetPinnedKeyValue(char* &lpPinnedKeyValue, int &lenPinnedKeyValue);
int SetPinnedKeyValue(const char* lpPinnedKeyValue, int lenPinnedKeyValue);

Unicode (Windows)
INT GetPinnedKeyValue(LPSTR &lpPinnedKeyValue, INT &lenPinnedKeyValue);
INT SetPinnedKeyValue(LPCSTR lpPinnedKeyValue, INT lenPinnedKeyValue);

int pkiproxy_cryptoserver_getpinnedkeyvalue(void* lpObj, char** lpPinnedKeyValue, int* lenPinnedKeyValue);
int pkiproxy_cryptoserver_setpinnedkeyvalue(void* lpObj, const char* lpPinnedKeyValue, int lenPinnedKeyValue);

QByteArray GetPinnedKeyValue();
int SetPinnedKeyValue(QByteArray qbaPinnedKeyValue);

Remarks

The byte array representation of the key. This may not be available for non-PinnedKeyExportable keys.

This property is not available at design time.

Data Type

Byte Array

PinnedMechAliases Property (CryptoServer Class)

A comma-separated list of aliases of the mechanism.

Syntax

ANSI (Cross Platform)
char* GetPinnedMechAliases();
int SetPinnedMechAliases(const char* lpszPinnedMechAliases);

Unicode (Windows)
LPWSTR GetPinnedMechAliases();
INT SetPinnedMechAliases(LPCWSTR lpszPinnedMechAliases);

char* pkiproxy_cryptoserver_getpinnedmechaliases(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechaliases(void* lpObj, const char* lpszPinnedMechAliases);

QString GetPinnedMechAliases();
int SetPinnedMechAliases(QString qsPinnedMechAliases);

Default Value

Remarks

This property is not available at design time.

Data Type

String

PinnedMechCanDecrypt Property (CryptoServer Class)

Returns True if the key can be used for decryption.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanDecrypt();
int SetPinnedMechCanDecrypt(int bPinnedMechCanDecrypt);

Unicode (Windows)
BOOL GetPinnedMechCanDecrypt();
INT SetPinnedMechCanDecrypt(BOOL bPinnedMechCanDecrypt);

int pkiproxy_cryptoserver_getpinnedmechcandecrypt(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcandecrypt(void* lpObj, int bPinnedMechCanDecrypt);

bool GetPinnedMechCanDecrypt();
int SetPinnedMechCanDecrypt(bool bPinnedMechCanDecrypt);

Default Value

FALSE

Remarks

Returns True if the key can be used for decryption.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanDerive Property (CryptoServer Class)

Returns True if the key can be used for key derivation.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanDerive();
int SetPinnedMechCanDerive(int bPinnedMechCanDerive);

Unicode (Windows)
BOOL GetPinnedMechCanDerive();
INT SetPinnedMechCanDerive(BOOL bPinnedMechCanDerive);

int pkiproxy_cryptoserver_getpinnedmechcanderive(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanderive(void* lpObj, int bPinnedMechCanDerive);

bool GetPinnedMechCanDerive();
int SetPinnedMechCanDerive(bool bPinnedMechCanDerive);

Default Value

FALSE

Remarks

Returns True if the key can be used for key derivation.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanEncrypt Property (CryptoServer Class)

Returns True if the key can be used for encryption.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanEncrypt();
int SetPinnedMechCanEncrypt(int bPinnedMechCanEncrypt);

Unicode (Windows)
BOOL GetPinnedMechCanEncrypt();
INT SetPinnedMechCanEncrypt(BOOL bPinnedMechCanEncrypt);

int pkiproxy_cryptoserver_getpinnedmechcanencrypt(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanencrypt(void* lpObj, int bPinnedMechCanEncrypt);

bool GetPinnedMechCanEncrypt();
int SetPinnedMechCanEncrypt(bool bPinnedMechCanEncrypt);

Default Value

FALSE

Remarks

Returns True if the key can be used for encryption.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanGenerate Property (CryptoServer Class)

Returns True if the keystore can generate keys using the mechanism.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanGenerate();
int SetPinnedMechCanGenerate(int bPinnedMechCanGenerate);

Unicode (Windows)
BOOL GetPinnedMechCanGenerate();
INT SetPinnedMechCanGenerate(BOOL bPinnedMechCanGenerate);

int pkiproxy_cryptoserver_getpinnedmechcangenerate(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcangenerate(void* lpObj, int bPinnedMechCanGenerate);

bool GetPinnedMechCanGenerate();
int SetPinnedMechCanGenerate(bool bPinnedMechCanGenerate);

Default Value

FALSE

Remarks

Returns True if the keystore can generate keys using the mechanism.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanHash Property (CryptoServer Class)

Returns True if the key can be used for hashing/MACing.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanHash();
int SetPinnedMechCanHash(int bPinnedMechCanHash);

Unicode (Windows)
BOOL GetPinnedMechCanHash();
INT SetPinnedMechCanHash(BOOL bPinnedMechCanHash);

int pkiproxy_cryptoserver_getpinnedmechcanhash(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanhash(void* lpObj, int bPinnedMechCanHash);

bool GetPinnedMechCanHash();
int SetPinnedMechCanHash(bool bPinnedMechCanHash);

Default Value

FALSE

Remarks

Returns True if the key can be used for hashing/MACing.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanPRNG Property (CryptoServer Class)

Returns True if the mechanism can be used for generating pseudorandom numbers.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanPRNG();
int SetPinnedMechCanPRNG(int bPinnedMechCanPRNG);

Unicode (Windows)
BOOL GetPinnedMechCanPRNG();
INT SetPinnedMechCanPRNG(BOOL bPinnedMechCanPRNG);

int pkiproxy_cryptoserver_getpinnedmechcanprng(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanprng(void* lpObj, int bPinnedMechCanPRNG);

bool GetPinnedMechCanPRNG();
int SetPinnedMechCanPRNG(bool bPinnedMechCanPRNG);

Default Value

FALSE

Remarks

Returns True if the mechanism can be used for generating pseudorandom numbers.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanSign Property (CryptoServer Class)

Returns True if the key can be used for signing.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanSign();
int SetPinnedMechCanSign(int bPinnedMechCanSign);

Unicode (Windows)
BOOL GetPinnedMechCanSign();
INT SetPinnedMechCanSign(BOOL bPinnedMechCanSign);

int pkiproxy_cryptoserver_getpinnedmechcansign(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcansign(void* lpObj, int bPinnedMechCanSign);

bool GetPinnedMechCanSign();
int SetPinnedMechCanSign(bool bPinnedMechCanSign);

Default Value

FALSE

Remarks

Returns True if the key can be used for signing.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanSignRecover Property (CryptoServer Class)

Returns True if the key can be used for enveloping signing.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanSignRecover();
int SetPinnedMechCanSignRecover(int bPinnedMechCanSignRecover);

Unicode (Windows)
BOOL GetPinnedMechCanSignRecover();
INT SetPinnedMechCanSignRecover(BOOL bPinnedMechCanSignRecover);

int pkiproxy_cryptoserver_getpinnedmechcansignrecover(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcansignrecover(void* lpObj, int bPinnedMechCanSignRecover);

bool GetPinnedMechCanSignRecover();
int SetPinnedMechCanSignRecover(bool bPinnedMechCanSignRecover);

Default Value

FALSE

Remarks

Returns True if the key can be used for enveloping signing.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanUnwrap Property (CryptoServer Class)

Returns True if the key can be used for key unwrapping.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanUnwrap();
int SetPinnedMechCanUnwrap(int bPinnedMechCanUnwrap);

Unicode (Windows)
BOOL GetPinnedMechCanUnwrap();
INT SetPinnedMechCanUnwrap(BOOL bPinnedMechCanUnwrap);

int pkiproxy_cryptoserver_getpinnedmechcanunwrap(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanunwrap(void* lpObj, int bPinnedMechCanUnwrap);

bool GetPinnedMechCanUnwrap();
int SetPinnedMechCanUnwrap(bool bPinnedMechCanUnwrap);

Default Value

FALSE

Remarks

Returns True if the key can be used for key unwrapping.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanVerify Property (CryptoServer Class)

Returns True if the key can be used for verifying signatures.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanVerify();
int SetPinnedMechCanVerify(int bPinnedMechCanVerify);

Unicode (Windows)
BOOL GetPinnedMechCanVerify();
INT SetPinnedMechCanVerify(BOOL bPinnedMechCanVerify);

int pkiproxy_cryptoserver_getpinnedmechcanverify(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanverify(void* lpObj, int bPinnedMechCanVerify);

bool GetPinnedMechCanVerify();
int SetPinnedMechCanVerify(bool bPinnedMechCanVerify);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying signatures.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanVerifyRecover Property (CryptoServer Class)

Returns True if the key can be used for verifying enveloping signatures.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanVerifyRecover();
int SetPinnedMechCanVerifyRecover(int bPinnedMechCanVerifyRecover);

Unicode (Windows)
BOOL GetPinnedMechCanVerifyRecover();
INT SetPinnedMechCanVerifyRecover(BOOL bPinnedMechCanVerifyRecover);

int pkiproxy_cryptoserver_getpinnedmechcanverifyrecover(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanverifyrecover(void* lpObj, int bPinnedMechCanVerifyRecover);

bool GetPinnedMechCanVerifyRecover();
int SetPinnedMechCanVerifyRecover(bool bPinnedMechCanVerifyRecover);

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying enveloping signatures.

This property is not available at design time.

Data Type

Boolean

PinnedMechCanWrap Property (CryptoServer Class)

Returns True if the key can be used for key wrapping.

Syntax

ANSI (Cross Platform)
int GetPinnedMechCanWrap();
int SetPinnedMechCanWrap(int bPinnedMechCanWrap);

Unicode (Windows)
BOOL GetPinnedMechCanWrap();
INT SetPinnedMechCanWrap(BOOL bPinnedMechCanWrap);

int pkiproxy_cryptoserver_getpinnedmechcanwrap(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechcanwrap(void* lpObj, int bPinnedMechCanWrap);

bool GetPinnedMechCanWrap();
int SetPinnedMechCanWrap(bool bPinnedMechCanWrap);

Default Value

FALSE

Remarks

Returns True if the key can be used for key wrapping.

This property is not available at design time.

Data Type

Boolean

PinnedMechMaxBits Property (CryptoServer Class)

The maximal supported length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetPinnedMechMaxBits();
int SetPinnedMechMaxBits(int iPinnedMechMaxBits);

Unicode (Windows)
INT GetPinnedMechMaxBits();
INT SetPinnedMechMaxBits(INT iPinnedMechMaxBits);

int pkiproxy_cryptoserver_getpinnedmechmaxbits(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechmaxbits(void* lpObj, int iPinnedMechMaxBits);

int GetPinnedMechMaxBits();
int SetPinnedMechMaxBits(int iPinnedMechMaxBits);

Default Value

Remarks

The maximal supported length of the key in bits.

This property is not available at design time.

Data Type

Integer

PinnedMechMechanismName Property (CryptoServer Class)

The official name of the mechanism, such as sha256WithRSAEncryption.

Syntax

ANSI (Cross Platform)
char* GetPinnedMechMechanismName();
int SetPinnedMechMechanismName(const char* lpszPinnedMechMechanismName);

Unicode (Windows)
LPWSTR GetPinnedMechMechanismName();
INT SetPinnedMechMechanismName(LPCWSTR lpszPinnedMechMechanismName);

char* pkiproxy_cryptoserver_getpinnedmechmechanismname(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechmechanismname(void* lpObj, const char* lpszPinnedMechMechanismName);

QString GetPinnedMechMechanismName();
int SetPinnedMechMechanismName(QString qsPinnedMechMechanismName);

Default Value

Remarks

The official name of the mechanism, such as sha256WithRSAEncryption.

This property is not available at design time.

Data Type

String

PinnedMechMinBits Property (CryptoServer Class)

The minimal supported length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetPinnedMechMinBits();
int SetPinnedMechMinBits(int iPinnedMechMinBits);

Unicode (Windows)
INT GetPinnedMechMinBits();
INT SetPinnedMechMinBits(INT iPinnedMechMinBits);

int pkiproxy_cryptoserver_getpinnedmechminbits(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechminbits(void* lpObj, int iPinnedMechMinBits);

int GetPinnedMechMinBits();
int SetPinnedMechMinBits(int iPinnedMechMinBits);

Default Value

Remarks

The minimal supported length of the key in bits.

This property is not available at design time.

Data Type

Integer

PinnedMechProperties Property (CryptoServer Class)

A collection of custom mechanism properties as a collection of comma-separated name=value pairs.

Syntax

ANSI (Cross Platform)
char* GetPinnedMechProperties();
int SetPinnedMechProperties(const char* lpszPinnedMechProperties);

Unicode (Windows)
LPWSTR GetPinnedMechProperties();
INT SetPinnedMechProperties(LPCWSTR lpszPinnedMechProperties);

char* pkiproxy_cryptoserver_getpinnedmechproperties(void* lpObj);
int pkiproxy_cryptoserver_setpinnedmechproperties(void* lpObj, const char* lpszPinnedMechProperties);

QString GetPinnedMechProperties();
int SetPinnedMechProperties(QString qsPinnedMechProperties);

Default Value

Remarks

A collection of custom mechanism properties as a collection of comma-separated name=value pairs.

This property is not available at design time.

Data Type

String

PinnedObjectDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectDescription();
int SetPinnedObjectDescription(const char* lpszPinnedObjectDescription);

Unicode (Windows)
LPWSTR GetPinnedObjectDescription();
INT SetPinnedObjectDescription(LPCWSTR lpszPinnedObjectDescription);

char* pkiproxy_cryptoserver_getpinnedobjectdescription(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectdescription(void* lpObj, const char* lpszPinnedObjectDescription);

QString GetPinnedObjectDescription();
int SetPinnedObjectDescription(QString qsPinnedObjectDescription);

Default Value

Remarks

The description, or label, of the object.

This property is not available at design time.

Data Type

String

PinnedObjectEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectEnabled();
int SetPinnedObjectEnabled(int bPinnedObjectEnabled);

Unicode (Windows)
BOOL GetPinnedObjectEnabled();
INT SetPinnedObjectEnabled(BOOL bPinnedObjectEnabled);

int pkiproxy_cryptoserver_getpinnedobjectenabled(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectenabled(void* lpObj, int bPinnedObjectEnabled);

bool GetPinnedObjectEnabled();
int SetPinnedObjectEnabled(bool bPinnedObjectEnabled);

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

This property is not available at design time.

Data Type

Boolean

PinnedObjectExportable Property (CryptoServer Class)

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectExportable();
int SetPinnedObjectExportable(int bPinnedObjectExportable);

Unicode (Windows)
BOOL GetPinnedObjectExportable();
INT SetPinnedObjectExportable(BOOL bPinnedObjectExportable);

int pkiproxy_cryptoserver_getpinnedobjectexportable(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectexportable(void* lpObj, int bPinnedObjectExportable);

bool GetPinnedObjectExportable();
int SetPinnedObjectExportable(bool bPinnedObjectExportable);

Default Value

FALSE

Remarks

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedObjectFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this object.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectFingerprint(char* &lpPinnedObjectFingerprint, int &lenPinnedObjectFingerprint);
int SetPinnedObjectFingerprint(const char* lpPinnedObjectFingerprint, int lenPinnedObjectFingerprint);

Unicode (Windows)
INT GetPinnedObjectFingerprint(LPSTR &lpPinnedObjectFingerprint, INT &lenPinnedObjectFingerprint);
INT SetPinnedObjectFingerprint(LPCSTR lpPinnedObjectFingerprint, INT lenPinnedObjectFingerprint);

int pkiproxy_cryptoserver_getpinnedobjectfingerprint(void* lpObj, char** lpPinnedObjectFingerprint, int* lenPinnedObjectFingerprint);
int pkiproxy_cryptoserver_setpinnedobjectfingerprint(void* lpObj, const char* lpPinnedObjectFingerprint, int lenPinnedObjectFingerprint);

QByteArray GetPinnedObjectFingerprint();
int SetPinnedObjectFingerprint(QByteArray qbaPinnedObjectFingerprint);

Remarks

Contains the fingerprint (a hash imprint) of this object.

This property is not available at design time.

Data Type

Byte Array

PinnedObjectFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the object.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectFriendlyName();
int SetPinnedObjectFriendlyName(const char* lpszPinnedObjectFriendlyName);

Unicode (Windows)
LPWSTR GetPinnedObjectFriendlyName();
INT SetPinnedObjectFriendlyName(LPCWSTR lpszPinnedObjectFriendlyName);

char* pkiproxy_cryptoserver_getpinnedobjectfriendlyname(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectfriendlyname(void* lpObj, const char* lpszPinnedObjectFriendlyName);

QString GetPinnedObjectFriendlyName();
int SetPinnedObjectFriendlyName(QString qsPinnedObjectFriendlyName);

Default Value

Remarks

Contains an associated alias (friendly name) of the object. PKCS#11 equivalent: Label.

This property is not available at design time.

Data Type

String

PinnedObjectGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectGroup();
int SetPinnedObjectGroup(const char* lpszPinnedObjectGroup);

Unicode (Windows)
LPWSTR GetPinnedObjectGroup();
INT SetPinnedObjectGroup(LPCWSTR lpszPinnedObjectGroup);

char* pkiproxy_cryptoserver_getpinnedobjectgroup(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectgroup(void* lpObj, const char* lpszPinnedObjectGroup);

QString GetPinnedObjectGroup();
int SetPinnedObjectGroup(QString qsPinnedObjectGroup);

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

This property is not available at design time.

Data Type

String

PinnedObjectID Property (CryptoServer Class)

Provides access to a storage-specific object identifier.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectID();
int SetPinnedObjectID(const char* lpszPinnedObjectID);

Unicode (Windows)
LPWSTR GetPinnedObjectID();
INT SetPinnedObjectID(LPCWSTR lpszPinnedObjectID);

char* pkiproxy_cryptoserver_getpinnedobjectid(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectid(void* lpObj, const char* lpszPinnedObjectID);

QString GetPinnedObjectID();
int SetPinnedObjectID(QString qsPinnedObjectID);

Default Value

Remarks

Provides access to a storage-specific object identifier.

This property is not available at design time.

Data Type

String

PinnedObjectIssuer Property (CryptoServer Class)

Returns the object issuer.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectIssuer();
int SetPinnedObjectIssuer(const char* lpszPinnedObjectIssuer);

Unicode (Windows)
LPWSTR GetPinnedObjectIssuer();
INT SetPinnedObjectIssuer(LPCWSTR lpszPinnedObjectIssuer);

char* pkiproxy_cryptoserver_getpinnedobjectissuer(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectissuer(void* lpObj, const char* lpszPinnedObjectIssuer);

QString GetPinnedObjectIssuer();
int SetPinnedObjectIssuer(QString qsPinnedObjectIssuer);

Default Value

Remarks

Returns the object issuer. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is not available at design time.

Data Type

String

PinnedObjectKeyUsage Property (CryptoServer Class)

Indicates the purposes of the object.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectKeyUsage();
int SetPinnedObjectKeyUsage(const char* lpszPinnedObjectKeyUsage);

Unicode (Windows)
LPWSTR GetPinnedObjectKeyUsage();
INT SetPinnedObjectKeyUsage(LPCWSTR lpszPinnedObjectKeyUsage);

char* pkiproxy_cryptoserver_getpinnedobjectkeyusage(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectkeyusage(void* lpObj, const char* lpszPinnedObjectKeyUsage);

QString GetPinnedObjectKeyUsage();
int SetPinnedObjectKeyUsage(QString qsPinnedObjectKeyUsage);

Default Value

Remarks

Indicates the purposes of the object. For certificate object, this corresponds to the elements contained in the Key Usage and Extended Key Usage extensions.

This property is not available at design time.

Data Type

String

PinnedObjectNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectNonPublic();
int SetPinnedObjectNonPublic(int bPinnedObjectNonPublic);

Unicode (Windows)
BOOL GetPinnedObjectNonPublic();
INT SetPinnedObjectNonPublic(BOOL bPinnedObjectNonPublic);

int pkiproxy_cryptoserver_getpinnedobjectnonpublic(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectnonpublic(void* lpObj, int bPinnedObjectNonPublic);

bool GetPinnedObjectNonPublic();
int SetPinnedObjectNonPublic(bool bPinnedObjectNonPublic);

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedObjectObjType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectObjType();
int SetPinnedObjectObjType(int iPinnedObjectObjType);

Unicode (Windows)
INT GetPinnedObjectObjType();
INT SetPinnedObjectObjType(INT iPinnedObjectObjType);

Possible Values

COT_UNKNOWN(0), 
COT_CERTIFICATE(1), 
COT_DATA(2), 
COT_GENERIC(3)

int pkiproxy_cryptoserver_getpinnedobjectobjtype(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectobjtype(void* lpObj, int iPinnedObjectObjType);

int GetPinnedObjectObjType();
int SetPinnedObjectObjType(int iPinnedObjectObjType);

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the object type.

This property is not available at design time.

Data Type

Integer

PinnedObjectOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this object.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectOrigin();
int SetPinnedObjectOrigin(const char* lpszPinnedObjectOrigin);

Unicode (Windows)
LPWSTR GetPinnedObjectOrigin();
INT SetPinnedObjectOrigin(LPCWSTR lpszPinnedObjectOrigin);

char* pkiproxy_cryptoserver_getpinnedobjectorigin(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectorigin(void* lpObj, const char* lpszPinnedObjectOrigin);

QString GetPinnedObjectOrigin();
int SetPinnedObjectOrigin(QString qsPinnedObjectOrigin);

Default Value

Remarks

Returns the origin (the Storage ID) of this object.

This property is not available at design time.

Data Type

String

PinnedObjectPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectPersistent();
int SetPinnedObjectPersistent(int bPinnedObjectPersistent);

Unicode (Windows)
BOOL GetPinnedObjectPersistent();
INT SetPinnedObjectPersistent(BOOL bPinnedObjectPersistent);

int pkiproxy_cryptoserver_getpinnedobjectpersistent(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectpersistent(void* lpObj, int bPinnedObjectPersistent);

bool GetPinnedObjectPersistent();
int SetPinnedObjectPersistent(bool bPinnedObjectPersistent);

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

This property is not available at design time.

Data Type

Boolean

PinnedObjectProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectProperties();
int SetPinnedObjectProperties(const char* lpszPinnedObjectProperties);

Unicode (Windows)
LPWSTR GetPinnedObjectProperties();
INT SetPinnedObjectProperties(LPCWSTR lpszPinnedObjectProperties);

char* pkiproxy_cryptoserver_getpinnedobjectproperties(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectproperties(void* lpObj, const char* lpszPinnedObjectProperties);

QString GetPinnedObjectProperties();
int SetPinnedObjectProperties(QString qsPinnedObjectProperties);

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

This property is not available at design time.

Data Type

String

PinnedObjectReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectReadOnly();
int SetPinnedObjectReadOnly(int bPinnedObjectReadOnly);

Unicode (Windows)
BOOL GetPinnedObjectReadOnly();
INT SetPinnedObjectReadOnly(BOOL bPinnedObjectReadOnly);

int pkiproxy_cryptoserver_getpinnedobjectreadonly(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectreadonly(void* lpObj, int bPinnedObjectReadOnly);

bool GetPinnedObjectReadOnly();
int SetPinnedObjectReadOnly(bool bPinnedObjectReadOnly);

Default Value

FALSE

Remarks

Returns True if the object is readonly.

This property is not available at design time.

Data Type

Boolean

PinnedObjectSensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectSensitive();
int SetPinnedObjectSensitive(int bPinnedObjectSensitive);

Unicode (Windows)
BOOL GetPinnedObjectSensitive();
INT SetPinnedObjectSensitive(BOOL bPinnedObjectSensitive);

int pkiproxy_cryptoserver_getpinnedobjectsensitive(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectsensitive(void* lpObj, int bPinnedObjectSensitive);

bool GetPinnedObjectSensitive();
int SetPinnedObjectSensitive(bool bPinnedObjectSensitive);

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

This property is not available at design time.

Data Type

Boolean

PinnedObjectSerialNumber Property (CryptoServer Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectSerialNumber();
int SetPinnedObjectSerialNumber(const char* lpszPinnedObjectSerialNumber);

Unicode (Windows)
LPWSTR GetPinnedObjectSerialNumber();
INT SetPinnedObjectSerialNumber(LPCWSTR lpszPinnedObjectSerialNumber);

char* pkiproxy_cryptoserver_getpinnedobjectserialnumber(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectserialnumber(void* lpObj, const char* lpszPinnedObjectSerialNumber);

QString GetPinnedObjectSerialNumber();
int SetPinnedObjectSerialNumber(QString qsPinnedObjectSerialNumber);

Default Value

Remarks

Returns the certificate's serial number.

This property is not available at design time.

Data Type

String

PinnedObjectSize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectSize();
int SetPinnedObjectSize(int iPinnedObjectSize);

Unicode (Windows)
INT GetPinnedObjectSize();
INT SetPinnedObjectSize(INT iPinnedObjectSize);

int pkiproxy_cryptoserver_getpinnedobjectsize(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectsize(void* lpObj, int iPinnedObjectSize);

int GetPinnedObjectSize();
int SetPinnedObjectSize(int iPinnedObjectSize);

Default Value

Remarks

The size of the object in bytes

This property is not available at design time.

Data Type

Integer

PinnedObjectSubject Property (CryptoServer Class)

Returns the object subject.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectSubject();
int SetPinnedObjectSubject(const char* lpszPinnedObjectSubject);

Unicode (Windows)
LPWSTR GetPinnedObjectSubject();
INT SetPinnedObjectSubject(LPCWSTR lpszPinnedObjectSubject);

char* pkiproxy_cryptoserver_getpinnedobjectsubject(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectsubject(void* lpObj, const char* lpszPinnedObjectSubject);

QString GetPinnedObjectSubject();
int SetPinnedObjectSubject(QString qsPinnedObjectSubject);

Default Value

Remarks

Returns the object subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is not available at design time.

Data Type

String

PinnedObjectUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectUserId();
int SetPinnedObjectUserId(const char* lpszPinnedObjectUserId);

Unicode (Windows)
LPWSTR GetPinnedObjectUserId();
INT SetPinnedObjectUserId(LPCWSTR lpszPinnedObjectUserId);

char* pkiproxy_cryptoserver_getpinnedobjectuserid(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectuserid(void* lpObj, const char* lpszPinnedObjectUserId);

QString GetPinnedObjectUserId();
int SetPinnedObjectUserId(QString qsPinnedObjectUserId);

Default Value

Remarks

TBD

This property is not available at design time.

Data Type

String

PinnedObjectUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectUserKeySecret();
int SetPinnedObjectUserKeySecret(const char* lpszPinnedObjectUserKeySecret);

Unicode (Windows)
LPWSTR GetPinnedObjectUserKeySecret();
INT SetPinnedObjectUserKeySecret(LPCWSTR lpszPinnedObjectUserKeySecret);

char* pkiproxy_cryptoserver_getpinnedobjectuserkeysecret(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectuserkeysecret(void* lpObj, const char* lpszPinnedObjectUserKeySecret);

QString GetPinnedObjectUserKeySecret();
int SetPinnedObjectUserKeySecret(QString qsPinnedObjectUserKeySecret);

Default Value

Remarks

TBD

This property is not available at design time.

Data Type

String

PinnedObjectValidFrom Property (CryptoServer Class)

The time point at which the object becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectValidFrom();
int SetPinnedObjectValidFrom(const char* lpszPinnedObjectValidFrom);

Unicode (Windows)
LPWSTR GetPinnedObjectValidFrom();
INT SetPinnedObjectValidFrom(LPCWSTR lpszPinnedObjectValidFrom);

char* pkiproxy_cryptoserver_getpinnedobjectvalidfrom(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectvalidfrom(void* lpObj, const char* lpszPinnedObjectValidFrom);

QString GetPinnedObjectValidFrom();
int SetPinnedObjectValidFrom(QString qsPinnedObjectValidFrom);

Default Value

Remarks

The time point at which the object becomes valid, in UTC.

This property is not available at design time.

Data Type

String

PinnedObjectValidTo Property (CryptoServer Class)

The time point at which the object expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetPinnedObjectValidTo();
int SetPinnedObjectValidTo(const char* lpszPinnedObjectValidTo);

Unicode (Windows)
LPWSTR GetPinnedObjectValidTo();
INT SetPinnedObjectValidTo(LPCWSTR lpszPinnedObjectValidTo);

char* pkiproxy_cryptoserver_getpinnedobjectvalidto(void* lpObj);
int pkiproxy_cryptoserver_setpinnedobjectvalidto(void* lpObj, const char* lpszPinnedObjectValidTo);

QString GetPinnedObjectValidTo();
int SetPinnedObjectValidTo(QString qsPinnedObjectValidTo);

Default Value

Remarks

The time point at which the object expires, in UTC.

This property is not available at design time.

Data Type

String

PinnedObjectValue Property (CryptoServer Class)

The byte array representation of the object.

Syntax

ANSI (Cross Platform)
int GetPinnedObjectValue(char* &lpPinnedObjectValue, int &lenPinnedObjectValue);
int SetPinnedObjectValue(const char* lpPinnedObjectValue, int lenPinnedObjectValue);

Unicode (Windows)
INT GetPinnedObjectValue(LPSTR &lpPinnedObjectValue, INT &lenPinnedObjectValue);
INT SetPinnedObjectValue(LPCSTR lpPinnedObjectValue, INT lenPinnedObjectValue);

int pkiproxy_cryptoserver_getpinnedobjectvalue(void* lpObj, char** lpPinnedObjectValue, int* lenPinnedObjectValue);
int pkiproxy_cryptoserver_setpinnedobjectvalue(void* lpObj, const char* lpPinnedObjectValue, int lenPinnedObjectValue);

QByteArray GetPinnedObjectValue();
int SetPinnedObjectValue(QByteArray qbaPinnedObjectValue);

Remarks

The byte array representation of the object. This may not be available for non-PinnedObjectExportable objects.

This property is not available at design time.

Data Type

Byte Array

RequestAuthToken Property (CryptoServer Class)

Contains the authentication token supplied with the request.

Syntax

ANSI (Cross Platform)
char* GetRequestAuthToken();
int SetRequestAuthToken(const char* lpszRequestAuthToken);

Unicode (Windows)
LPWSTR GetRequestAuthToken();
INT SetRequestAuthToken(LPCWSTR lpszRequestAuthToken);

char* pkiproxy_cryptoserver_getrequestauthtoken(void* lpObj);
int pkiproxy_cryptoserver_setrequestauthtoken(void* lpObj, const char* lpszRequestAuthToken);

QString GetRequestAuthToken();
int SetRequestAuthToken(QString qsRequestAuthToken);

Default Value

Remarks

Contains the authentication token supplied with the request. The contents of the authentication tokenis opaque to the server SDK components and are processed externally. For that reason the authenticationscheme should incorporate all the details necessary to validate the tokens into them.

Data Type

String

RequestBody Property (CryptoServer Class)

The request body, as provided.

Syntax

ANSI (Cross Platform)
char* GetRequestBody();
int SetRequestBody(const char* lpszRequestBody);

Unicode (Windows)
LPWSTR GetRequestBody();
INT SetRequestBody(LPCWSTR lpszRequestBody);

char* pkiproxy_cryptoserver_getrequestbody(void* lpObj);
int pkiproxy_cryptoserver_setrequestbody(void* lpObj, const char* lpszRequestBody);

QString GetRequestBody();
int SetRequestBody(QString qsRequestBody);

Default Value

Remarks

The request body, as provided..

Data Type

String

RequestBodyBytes Property (CryptoServer Class)

The generated request body as a byte array.

Syntax

ANSI (Cross Platform)
int GetRequestBodyBytes(char* &lpRequestBodyBytes, int &lenRequestBodyBytes);
int SetRequestBodyBytes(const char* lpRequestBodyBytes, int lenRequestBodyBytes);

Unicode (Windows)
INT GetRequestBodyBytes(LPSTR &lpRequestBodyBytes, INT &lenRequestBodyBytes);
INT SetRequestBodyBytes(LPCSTR lpRequestBodyBytes, INT lenRequestBodyBytes);

int pkiproxy_cryptoserver_getrequestbodybytes(void* lpObj, char** lpRequestBodyBytes, int* lenRequestBodyBytes);
int pkiproxy_cryptoserver_setrequestbodybytes(void* lpObj, const char* lpRequestBodyBytes, int lenRequestBodyBytes);

QByteArray GetRequestBodyBytes();
int SetRequestBodyBytes(QByteArray qbaRequestBodyBytes);

Remarks

The generated request body as a byte array.

This property is not available at design time.

Data Type

Byte Array

RequestDataBytes Property (CryptoServer Class)

Contains additional data assumed by the operation, for example the plaintext accompanying the detached signature (which in this case is provided in InputBytes ).

Syntax

ANSI (Cross Platform)
int GetRequestDataBytes(char* &lpRequestDataBytes, int &lenRequestDataBytes);
int SetRequestDataBytes(const char* lpRequestDataBytes, int lenRequestDataBytes);

Unicode (Windows)
INT GetRequestDataBytes(LPSTR &lpRequestDataBytes, INT &lenRequestDataBytes);
INT SetRequestDataBytes(LPCSTR lpRequestDataBytes, INT lenRequestDataBytes);

int pkiproxy_cryptoserver_getrequestdatabytes(void* lpObj, char** lpRequestDataBytes, int* lenRequestDataBytes);
int pkiproxy_cryptoserver_setrequestdatabytes(void* lpObj, const char* lpRequestDataBytes, int lenRequestDataBytes);

QByteArray GetRequestDataBytes();
int SetRequestDataBytes(QByteArray qbaRequestDataBytes);

Remarks

Contains additional data assumed by the operation, for example the plaintext accompanying the detached signature (which in this case is provided in RequestInputBytes).

This property is not available at design time.

Data Type

Byte Array

RequestDefRandomLength Property (CryptoServer Class)

The length of pseudorandom data block to return.

Syntax

ANSI (Cross Platform)
int GetRequestDefRandomLength();
int SetRequestDefRandomLength(int iRequestDefRandomLength);

Unicode (Windows)
INT GetRequestDefRandomLength();
INT SetRequestDefRandomLength(INT iRequestDefRandomLength);

int pkiproxy_cryptoserver_getrequestdefrandomlength(void* lpObj);
int pkiproxy_cryptoserver_setrequestdefrandomlength(void* lpObj, int iRequestDefRandomLength);

int GetRequestDefRandomLength();
int SetRequestDefRandomLength(int iRequestDefRandomLength);

Default Value

Remarks

The length of pseudorandom data block to return. The service may impose length restrictions.

Data Type

Integer

RequestFilter Property (CryptoServer Class)

List filter string.

Syntax

ANSI (Cross Platform)
char* GetRequestFilter();
int SetRequestFilter(const char* lpszRequestFilter);

Unicode (Windows)
LPWSTR GetRequestFilter();
INT SetRequestFilter(LPCWSTR lpszRequestFilter);

char* pkiproxy_cryptoserver_getrequestfilter(void* lpObj);
int pkiproxy_cryptoserver_setrequestfilter(void* lpObj, const char* lpszRequestFilter);

QString GetRequestFilter();
int SetRequestFilter(QString qsRequestFilter);

Default Value

Remarks

List filter string. This is applicable to List Objects requests.

Data Type

String

RequestFormat Property (CryptoServer Class)

The request format (json, plain, or other).

Syntax

ANSI (Cross Platform)
char* GetRequestFormat();
int SetRequestFormat(const char* lpszRequestFormat);

Unicode (Windows)
LPWSTR GetRequestFormat();
INT SetRequestFormat(LPCWSTR lpszRequestFormat);

char* pkiproxy_cryptoserver_getrequestformat(void* lpObj);
int pkiproxy_cryptoserver_setrequestformat(void* lpObj, const char* lpszRequestFormat);

QString GetRequestFormat();
int SetRequestFormat(QString qsRequestFormat);

Default Value

Remarks

The request format (json, plain, or other)

Data Type

String

RequestHeaders Property (CryptoServer Class)

The HTTP headers supplied with the request.

Syntax

ANSI (Cross Platform)
char* GetRequestHeaders();
int SetRequestHeaders(const char* lpszRequestHeaders);

Unicode (Windows)
LPWSTR GetRequestHeaders();
INT SetRequestHeaders(LPCWSTR lpszRequestHeaders);

char* pkiproxy_cryptoserver_getrequestheaders(void* lpObj);
int pkiproxy_cryptoserver_setrequestheaders(void* lpObj, const char* lpszRequestHeaders);

QString GetRequestHeaders();
int SetRequestHeaders(QString qsRequestHeaders);

Default Value

Remarks

The HTTP headers supplied with the request..

Data Type

String

RequestInputBytes Property (CryptoServer Class)

The data to be processed by the operation, such as plaintext to be encrypted or ciphertext to be decrypted.

Syntax

ANSI (Cross Platform)
int GetRequestInputBytes(char* &lpRequestInputBytes, int &lenRequestInputBytes);
int SetRequestInputBytes(const char* lpRequestInputBytes, int lenRequestInputBytes);

Unicode (Windows)
INT GetRequestInputBytes(LPSTR &lpRequestInputBytes, INT &lenRequestInputBytes);
INT SetRequestInputBytes(LPCSTR lpRequestInputBytes, INT lenRequestInputBytes);

int pkiproxy_cryptoserver_getrequestinputbytes(void* lpObj, char** lpRequestInputBytes, int* lenRequestInputBytes);
int pkiproxy_cryptoserver_setrequestinputbytes(void* lpObj, const char* lpRequestInputBytes, int lenRequestInputBytes);

QByteArray GetRequestInputBytes();
int SetRequestInputBytes(QByteArray qbaRequestInputBytes);

Remarks

The data to be processed by the operation, such as plaintext to be encrypted or ciphertext to be decrypted.

This property is not available at design time.

Data Type

Byte Array

RequestKeyId Property (CryptoServer Class)

The ID of the key object to be used for the operation.

Syntax

ANSI (Cross Platform)
char* GetRequestKeyId();
int SetRequestKeyId(const char* lpszRequestKeyId);

Unicode (Windows)
LPWSTR GetRequestKeyId();
INT SetRequestKeyId(LPCWSTR lpszRequestKeyId);

char* pkiproxy_cryptoserver_getrequestkeyid(void* lpObj);
int pkiproxy_cryptoserver_setrequestkeyid(void* lpObj, const char* lpszRequestKeyId);

QString GetRequestKeyId();
int SetRequestKeyId(QString qsRequestKeyId);

Default Value

Remarks

The ID of the key object to be used for the operation.

Data Type

String

RequestMaxCount Property (CryptoServer Class)

The maximum number of elements (objects) to return with the response, or the maximum length of the data requested (e.

Syntax

ANSI (Cross Platform)
int GetRequestMaxCount();
int SetRequestMaxCount(int iRequestMaxCount);

Unicode (Windows)
INT GetRequestMaxCount();
INT SetRequestMaxCount(INT iRequestMaxCount);

int pkiproxy_cryptoserver_getrequestmaxcount(void* lpObj);
int pkiproxy_cryptoserver_setrequestmaxcount(void* lpObj, int iRequestMaxCount);

int GetRequestMaxCount();
int SetRequestMaxCount(int iRequestMaxCount);

Default Value

Remarks

The maximum number of elements (objects) to return with the response, or the maximum length of the data requested (e.g. from a random generator).

Data Type

Integer

RequestMechanism Property (CryptoServer Class)

The name of the mechanism to use for the operation.

Syntax

ANSI (Cross Platform)
char* GetRequestMechanism();
int SetRequestMechanism(const char* lpszRequestMechanism);

Unicode (Windows)
LPWSTR GetRequestMechanism();
INT SetRequestMechanism(LPCWSTR lpszRequestMechanism);

char* pkiproxy_cryptoserver_getrequestmechanism(void* lpObj);
int pkiproxy_cryptoserver_setrequestmechanism(void* lpObj, const char* lpszRequestMechanism);

QString GetRequestMechanism();
int SetRequestMechanism(QString qsRequestMechanism);

Default Value

Remarks

The name of the mechanism to use for the operation.

Data Type

String

RequestMechanismParams Property (CryptoServer Class)

The list of mechanism parameters in comma-separated name=value form.

Syntax

ANSI (Cross Platform)
char* GetRequestMechanismParams();
int SetRequestMechanismParams(const char* lpszRequestMechanismParams);

Unicode (Windows)
LPWSTR GetRequestMechanismParams();
INT SetRequestMechanismParams(LPCWSTR lpszRequestMechanismParams);

char* pkiproxy_cryptoserver_getrequestmechanismparams(void* lpObj);
int pkiproxy_cryptoserver_setrequestmechanismparams(void* lpObj, const char* lpszRequestMechanismParams);

QString GetRequestMechanismParams();
int SetRequestMechanismParams(QString qsRequestMechanismParams);

Default Value

Remarks

The list of mechanism parameters in comma-separated name=value form.

Data Type

String

RequestObjectId Property (CryptoServer Class)

The ID of the object involved in the operation (e.

Syntax

ANSI (Cross Platform)
char* GetRequestObjectId();
int SetRequestObjectId(const char* lpszRequestObjectId);

Unicode (Windows)
LPWSTR GetRequestObjectId();
INT SetRequestObjectId(LPCWSTR lpszRequestObjectId);

char* pkiproxy_cryptoserver_getrequestobjectid(void* lpObj);
int pkiproxy_cryptoserver_setrequestobjectid(void* lpObj, const char* lpszRequestObjectId);

QString GetRequestObjectId();
int SetRequestObjectId(QString qsRequestObjectId);

Default Value

Remarks

The ID of the object involved in the operation (e.g. updated or retrieved)

Data Type

String

RequestOperation Property (CryptoServer Class)

The PKI Proxy protocol operation.

Syntax

ANSI (Cross Platform)
int GetRequestOperation();
int SetRequestOperation(int iRequestOperation);

Unicode (Windows)
INT GetRequestOperation();
INT SetRequestOperation(INT iRequestOperation);

Possible Values

OP_UNKNOWN(0), 
OP_GET_SERVICE_INFO(1), 
OP_LIST_KEYSTORES(2), 
OP_GET_KEYSTORE_INFO(3), 
OP_LIST_OBJECTS(4), 
OP_CREATE_OBJECT(5), 
OP_COPY_OBJECT(6), 
OP_GENERATE_KEY(7), 
OP_IMPORT_KEY(8), 
OP_DERIVE_KEY(9), 
OP_GET_OBJECT_INFO(10), 
OP_GET_OBJECT_PARAM(11), 
OP_EXPORT_OBJECT(12), 
OP_IMPORT_OBJECT(13), 
OP_DESTROY_OBJECT(14), 
OP_SET_OBJECT_PARAM(15), 
OP_GET_KEYSTORE_CAPABILITIES(16), 
OP_ENCRYPT(17), 
OP_ENCRYPT_MULTIPART(18), 
OP_DECRYPT(19), 
OP_DECRYPT_MULTIPART(20), 
OP_SIGN(21), 
OP_SIGN_MULTIPART(22), 
OP_VERIFY(23), 
OP_VERIFY_MULTIPART(24), 
OP_RANDOM_SEED(25), 
OP_RANDOM_GENERATE(26)

int pkiproxy_cryptoserver_getrequestoperation(void* lpObj);
int pkiproxy_cryptoserver_setrequestoperation(void* lpObj, int iRequestOperation);

int GetRequestOperation();
int SetRequestOperation(int iRequestOperation);

Default Value

Remarks

The PKI Proxy protocol operation.

Use this property to check or adjust the keystore request operation.

Data Type

Integer

RequestOperationParams Property (CryptoServer Class)

The list of operation parameters in comma-separated name=value form.

Syntax

ANSI (Cross Platform)
char* GetRequestOperationParams();
int SetRequestOperationParams(const char* lpszRequestOperationParams);

Unicode (Windows)
LPWSTR GetRequestOperationParams();
INT SetRequestOperationParams(LPCWSTR lpszRequestOperationParams);

char* pkiproxy_cryptoserver_getrequestoperationparams(void* lpObj);
int pkiproxy_cryptoserver_setrequestoperationparams(void* lpObj, const char* lpszRequestOperationParams);

QString GetRequestOperationParams();
int SetRequestOperationParams(QString qsRequestOperationParams);

Default Value

Remarks

The list of operation parameters in comma-separated name=value form. One example of such parameter is the signature type (detached, enveloping, or enveloped)

Data Type

String

RequestReqSig Property (CryptoServer Class)

Contains the raw signature over the request.

Syntax

ANSI (Cross Platform)
char* GetRequestReqSig();
int SetRequestReqSig(const char* lpszRequestReqSig);

Unicode (Windows)
LPWSTR GetRequestReqSig();
INT SetRequestReqSig(LPCWSTR lpszRequestReqSig);

char* pkiproxy_cryptoserver_getrequestreqsig(void* lpObj);
int pkiproxy_cryptoserver_setrequestreqsig(void* lpObj, const char* lpszRequestReqSig);

QString GetRequestReqSig();
int SetRequestReqSig(QString qsRequestReqSig);

Default Value

Remarks

Contains the raw signature over the request.

Data Type

String

RequestReqSigned Property (CryptoServer Class)

Indicates whether the request is signed.

Syntax

ANSI (Cross Platform)
int GetRequestReqSigned();
int SetRequestReqSigned(int bRequestReqSigned);

Unicode (Windows)
BOOL GetRequestReqSigned();
INT SetRequestReqSigned(BOOL bRequestReqSigned);

int pkiproxy_cryptoserver_getrequestreqsigned(void* lpObj);
int pkiproxy_cryptoserver_setrequestreqsigned(void* lpObj, int bRequestReqSigned);

bool GetRequestReqSigned();
int SetRequestReqSigned(bool bRequestReqSigned);

Default Value

FALSE

Remarks

Indicates whether the request is signed.

Data Type

Boolean

RequestReqSigValid Property (CryptoServer Class)

Indicates whether the request signature is valid.

Syntax

ANSI (Cross Platform)
int GetRequestReqSigValid();
int SetRequestReqSigValid(int bRequestReqSigValid);

Unicode (Windows)
BOOL GetRequestReqSigValid();
INT SetRequestReqSigValid(BOOL bRequestReqSigValid);

int pkiproxy_cryptoserver_getrequestreqsigvalid(void* lpObj);
int pkiproxy_cryptoserver_setrequestreqsigvalid(void* lpObj, int bRequestReqSigValid);

bool GetRequestReqSigValid();
int SetRequestReqSigValid(bool bRequestReqSigValid);

Default Value

FALSE

Remarks

Indicates whether the request signature is valid.

Data Type

Boolean

RequestRespFormat Property (CryptoServer Class)

The requested response format (json, plain, or other).

Syntax

ANSI (Cross Platform)
char* GetRequestRespFormat();
int SetRequestRespFormat(const char* lpszRequestRespFormat);

Unicode (Windows)
LPWSTR GetRequestRespFormat();
INT SetRequestRespFormat(LPCWSTR lpszRequestRespFormat);

char* pkiproxy_cryptoserver_getrequestrespformat(void* lpObj);
int pkiproxy_cryptoserver_setrequestrespformat(void* lpObj, const char* lpszRequestRespFormat);

QString GetRequestRespFormat();
int SetRequestRespFormat(QString qsRequestRespFormat);

Default Value

Remarks

The requested response format (json, plain, or other)

Data Type

String

RequestSourceObjectId Property (CryptoServer Class)

The ID of the source object that is to be copied or used for other purpose.

Syntax

ANSI (Cross Platform)
char* GetRequestSourceObjectId();
int SetRequestSourceObjectId(const char* lpszRequestSourceObjectId);

Unicode (Windows)
LPWSTR GetRequestSourceObjectId();
INT SetRequestSourceObjectId(LPCWSTR lpszRequestSourceObjectId);

char* pkiproxy_cryptoserver_getrequestsourceobjectid(void* lpObj);
int pkiproxy_cryptoserver_setrequestsourceobjectid(void* lpObj, const char* lpszRequestSourceObjectId);

QString GetRequestSourceObjectId();
int SetRequestSourceObjectId(QString qsRequestSourceObjectId);

Default Value

Remarks

The ID of the source object that is to be copied or used for other purpose.

Data Type

String

RequestUrl Property (CryptoServer Class)

The request URL.

Syntax

ANSI (Cross Platform)
char* GetRequestUrl();
int SetRequestUrl(const char* lpszRequestUrl);

Unicode (Windows)
LPWSTR GetRequestUrl();
INT SetRequestUrl(LPCWSTR lpszRequestUrl);

char* pkiproxy_cryptoserver_getrequesturl(void* lpObj);
int pkiproxy_cryptoserver_setrequesturl(void* lpObj, const char* lpszRequestUrl);

QString GetRequestUrl();
int SetRequestUrl(QString qsRequestUrl);

Default Value

Remarks

The request URL.

Data Type

String

RequestVerb Property (CryptoServer Class)

The HTTP verb.

Syntax

ANSI (Cross Platform)
char* GetRequestVerb();
int SetRequestVerb(const char* lpszRequestVerb);

Unicode (Windows)
LPWSTR GetRequestVerb();
INT SetRequestVerb(LPCWSTR lpszRequestVerb);

char* pkiproxy_cryptoserver_getrequestverb(void* lpObj);
int pkiproxy_cryptoserver_setrequestverb(void* lpObj, const char* lpszRequestVerb);

QString GetRequestVerb();
int SetRequestVerb(QString qsRequestVerb);

Default Value

Remarks

The HTTP verb.

Data Type

String

ReqKeyBits Property (CryptoServer Class)

The length of the key in bits.

Syntax

ANSI (Cross Platform)
int GetReqKeyBits();

Unicode (Windows)
INT GetReqKeyBits();

int pkiproxy_cryptoserver_getreqkeybits(void* lpObj);

int GetReqKeyBits();

Default Value

Remarks

The length of the key in bits.

This property is read-only and not available at design time.

Data Type

Integer

ReqKeyCanDecrypt Property (CryptoServer Class)

Returns True if the key can be used for decryption.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanDecrypt();

Unicode (Windows)
BOOL GetReqKeyCanDecrypt();

int pkiproxy_cryptoserver_getreqkeycandecrypt(void* lpObj);

bool GetReqKeyCanDecrypt();

Default Value

FALSE

Remarks

Returns True if the key can be used for decryption.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanDerive Property (CryptoServer Class)

Returns True if the key can be used for key derivation.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanDerive();

Unicode (Windows)
BOOL GetReqKeyCanDerive();

int pkiproxy_cryptoserver_getreqkeycanderive(void* lpObj);

bool GetReqKeyCanDerive();

Default Value

FALSE

Remarks

Returns True if the key can be used for key derivation.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanEncrypt Property (CryptoServer Class)

Returns True if the key can be used for encryption.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanEncrypt();

Unicode (Windows)
BOOL GetReqKeyCanEncrypt();

int pkiproxy_cryptoserver_getreqkeycanencrypt(void* lpObj);

bool GetReqKeyCanEncrypt();

Default Value

FALSE

Remarks

Returns True if the key can be used for encryption.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanHash Property (CryptoServer Class)

Returns True if the key can be used for hashing/MACing.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanHash();

Unicode (Windows)
BOOL GetReqKeyCanHash();

int pkiproxy_cryptoserver_getreqkeycanhash(void* lpObj);

bool GetReqKeyCanHash();

Default Value

FALSE

Remarks

Returns True if the key can be used for hashing/MACing.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanSign Property (CryptoServer Class)

Returns True if the key can be used for signing.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanSign();

Unicode (Windows)
BOOL GetReqKeyCanSign();

int pkiproxy_cryptoserver_getreqkeycansign(void* lpObj);

bool GetReqKeyCanSign();

Default Value

FALSE

Remarks

Returns True if the key can be used for signing.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanSignRecover Property (CryptoServer Class)

Returns True if the key can be used for enveloping signing.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanSignRecover();

Unicode (Windows)
BOOL GetReqKeyCanSignRecover();

int pkiproxy_cryptoserver_getreqkeycansignrecover(void* lpObj);

bool GetReqKeyCanSignRecover();

Default Value

FALSE

Remarks

Returns True if the key can be used for enveloping signing.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanUnwrap Property (CryptoServer Class)

Returns True if the key can be used for key unwrapping.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanUnwrap();

Unicode (Windows)
BOOL GetReqKeyCanUnwrap();

int pkiproxy_cryptoserver_getreqkeycanunwrap(void* lpObj);

bool GetReqKeyCanUnwrap();

Default Value

FALSE

Remarks

Returns True if the key can be used for key unwrapping.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanVerify Property (CryptoServer Class)

Returns True if the key can be used for verifying signatures.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanVerify();

Unicode (Windows)
BOOL GetReqKeyCanVerify();

int pkiproxy_cryptoserver_getreqkeycanverify(void* lpObj);

bool GetReqKeyCanVerify();

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying signatures.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanVerifyRecover Property (CryptoServer Class)

Returns True if the key can be used for verifying enveloping signatures.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanVerifyRecover();

Unicode (Windows)
BOOL GetReqKeyCanVerifyRecover();

int pkiproxy_cryptoserver_getreqkeycanverifyrecover(void* lpObj);

bool GetReqKeyCanVerifyRecover();

Default Value

FALSE

Remarks

Returns True if the key can be used for verifying enveloping signatures.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCanWrap Property (CryptoServer Class)

Returns True if the key can be used for key wrapping.

Syntax

ANSI (Cross Platform)
int GetReqKeyCanWrap();

Unicode (Windows)
BOOL GetReqKeyCanWrap();

int pkiproxy_cryptoserver_getreqkeycanwrap(void* lpObj);

bool GetReqKeyCanWrap();

Default Value

FALSE

Remarks

Returns True if the key can be used for key wrapping.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyCapabilities Property (CryptoServer Class)

A collection of information about the key capabilities TBD: discuss type and options.

Syntax

ANSI (Cross Platform)
char* GetReqKeyCapabilities();

Unicode (Windows)
LPWSTR GetReqKeyCapabilities();

char* pkiproxy_cryptoserver_getreqkeycapabilities(void* lpObj);

QString GetReqKeyCapabilities();

Default Value

Remarks

This property is read-only and not available at design time.

Data Type

String

ReqKeyDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetReqKeyDescription();

Unicode (Windows)
LPWSTR GetReqKeyDescription();

char* pkiproxy_cryptoserver_getreqkeydescription(void* lpObj);

QString GetReqKeyDescription();

Default Value

Remarks

The description, or label, of the object.

This property is read-only and not available at design time.

Data Type

String

ReqKeyEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetReqKeyEnabled();

Unicode (Windows)
BOOL GetReqKeyEnabled();

int pkiproxy_cryptoserver_getreqkeyenabled(void* lpObj);

bool GetReqKeyEnabled();

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyExportable Property (CryptoServer Class)

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqKeyExportable();

Unicode (Windows)
BOOL GetReqKeyExportable();

int pkiproxy_cryptoserver_getreqkeyexportable(void* lpObj);

bool GetReqKeyExportable();

Default Value

FALSE

Remarks

Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this key.

Syntax

ANSI (Cross Platform)
int GetReqKeyFingerprint(char* &lpReqKeyFingerprint, int &lenReqKeyFingerprint);

Unicode (Windows)
INT GetReqKeyFingerprint(LPSTR &lpReqKeyFingerprint, INT &lenReqKeyFingerprint);

int pkiproxy_cryptoserver_getreqkeyfingerprint(void* lpObj, char** lpReqKeyFingerprint, int* lenReqKeyFingerprint);

QByteArray GetReqKeyFingerprint();

Remarks

Contains the fingerprint (a hash imprint) of this key.

This property is read-only and not available at design time.

Data Type

Byte Array

ReqKeyFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the key.

Syntax

ANSI (Cross Platform)
char* GetReqKeyFriendlyName();

Unicode (Windows)
LPWSTR GetReqKeyFriendlyName();

char* pkiproxy_cryptoserver_getreqkeyfriendlyname(void* lpObj);

QString GetReqKeyFriendlyName();

Default Value

Remarks

Contains an associated alias (friendly name) of the key. PKCS#11 equivalent: Label.

This property is read-only and not available at design time.

Data Type

String

ReqKeyGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetReqKeyGroup();

Unicode (Windows)
LPWSTR GetReqKeyGroup();

char* pkiproxy_cryptoserver_getreqkeygroup(void* lpObj);

QString GetReqKeyGroup();

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

This property is read-only and not available at design time.

Data Type

String

ReqKeyID Property (CryptoServer Class)

Provides access to a storage-specific key identifier.

Syntax

ANSI (Cross Platform)
char* GetReqKeyID();

Unicode (Windows)
LPWSTR GetReqKeyID();

char* pkiproxy_cryptoserver_getreqkeyid(void* lpObj);

QString GetReqKeyID();

Default Value

Remarks

This property is read-only and not available at design time.

Data Type

String

ReqKeyIV Property (CryptoServer Class)

The initialization vector (IV) of a symmetric key.

Syntax

ANSI (Cross Platform)
int GetReqKeyIV(char* &lpReqKeyIV, int &lenReqKeyIV);

Unicode (Windows)
INT GetReqKeyIV(LPSTR &lpReqKeyIV, INT &lenReqKeyIV);

int pkiproxy_cryptoserver_getreqkeyiv(void* lpObj, char** lpReqKeyIV, int* lenReqKeyIV);

QByteArray GetReqKeyIV();

Remarks

This property is read-only and not available at design time.

Data Type

Byte Array

ReqKeyKeyType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetReqKeyKeyType();

Unicode (Windows)
INT GetReqKeyKeyType();

Possible Values

CKT_UNKNOWN(0), 
CKT_PUBLIC(1), 
CKT_PRIVATE(2), 
CKT_SYMMETRIC(3), 
CKT_DOMAIN_PARAMS(4), 
CKT_GENERIC(5)

int pkiproxy_cryptoserver_getreqkeykeytype(void* lpObj);

int GetReqKeyKeyType();

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the key type.

This property is read-only and not available at design time.

Data Type

Integer

ReqKeyMechanism Property (CryptoServer Class)

The algorithm of the cryptographic key.

Syntax

ANSI (Cross Platform)
char* GetReqKeyMechanism();

Unicode (Windows)
LPWSTR GetReqKeyMechanism();

char* pkiproxy_cryptoserver_getreqkeymechanism(void* lpObj);

QString GetReqKeyMechanism();

Default Value

Remarks

The algorithm of the cryptographic key. A cryptokey object may hold either symmetric, MAC, or public key.Public key algorithms: RSA, ECDSA, Elgamal, DH.

This property is read-only and not available at design time.

Data Type

String

ReqKeyMechanismParams Property (CryptoServer Class)

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

Syntax

ANSI (Cross Platform)
char* GetReqKeyMechanismParams();

Unicode (Windows)
LPWSTR GetReqKeyMechanismParams();

char* pkiproxy_cryptoserver_getreqkeymechanismparams(void* lpObj);

QString GetReqKeyMechanismParams();

Default Value

Remarks

The parameters of the key algorithm, such as Curve for ECDSA keys or domain parameters for DH keys.

This property is read-only and not available at design time.

Data Type

String

ReqKeyNonce Property (CryptoServer Class)

A nonce value associated with a key.

Syntax

ANSI (Cross Platform)
int GetReqKeyNonce(char* &lpReqKeyNonce, int &lenReqKeyNonce);

Unicode (Windows)
INT GetReqKeyNonce(LPSTR &lpReqKeyNonce, INT &lenReqKeyNonce);

int pkiproxy_cryptoserver_getreqkeynonce(void* lpObj, char** lpReqKeyNonce, int* lenReqKeyNonce);

QByteArray GetReqKeyNonce();

Remarks

A nonce value associated with a key. It is similar to IV, but its only purpose is to introduce randomness.

This property is read-only and not available at design time.

Data Type

Byte Array

ReqKeyNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqKeyNonPublic();

Unicode (Windows)
BOOL GetReqKeyNonPublic();

int pkiproxy_cryptoserver_getreqkeynonpublic(void* lpObj);

bool GetReqKeyNonPublic();

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this key.

Syntax

ANSI (Cross Platform)
char* GetReqKeyOrigin();

Unicode (Windows)
LPWSTR GetReqKeyOrigin();

char* pkiproxy_cryptoserver_getreqkeyorigin(void* lpObj);

QString GetReqKeyOrigin();

Default Value

Remarks

Returns the origin (the Storage ID) of this key.

This property is read-only and not available at design time.

Data Type

String

ReqKeyPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetReqKeyPersistent();

Unicode (Windows)
BOOL GetReqKeyPersistent();

int pkiproxy_cryptoserver_getreqkeypersistent(void* lpObj);

bool GetReqKeyPersistent();

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetReqKeyProperties();

Unicode (Windows)
LPWSTR GetReqKeyProperties();

char* pkiproxy_cryptoserver_getreqkeyproperties(void* lpObj);

QString GetReqKeyProperties();

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

This property is read-only and not available at design time.

Data Type

String

ReqKeyReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetReqKeyReadOnly();

Unicode (Windows)
BOOL GetReqKeyReadOnly();

int pkiproxy_cryptoserver_getreqkeyreadonly(void* lpObj);

bool GetReqKeyReadOnly();

Default Value

FALSE

Remarks

Returns True if the object is readonly.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeySensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqKeySensitive();

Unicode (Windows)
BOOL GetReqKeySensitive();

int pkiproxy_cryptoserver_getreqkeysensitive(void* lpObj);

bool GetReqKeySensitive();

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeySize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetReqKeySize();

Unicode (Windows)
INT GetReqKeySize();

int pkiproxy_cryptoserver_getreqkeysize(void* lpObj);

int GetReqKeySize();

Default Value

Remarks

The size of the object in bytes

This property is read-only and not available at design time.

Data Type

Integer

ReqKeySubject Property (CryptoServer Class)

Returns the key subject.

Syntax

ANSI (Cross Platform)
char* GetReqKeySubject();

Unicode (Windows)
LPWSTR GetReqKeySubject();

char* pkiproxy_cryptoserver_getreqkeysubject(void* lpObj);

QString GetReqKeySubject();

Default Value

Remarks

Returns the key subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is read-only and not available at design time.

Data Type

String

ReqKeyUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetReqKeyUserId();

Unicode (Windows)
LPWSTR GetReqKeyUserId();

char* pkiproxy_cryptoserver_getreqkeyuserid(void* lpObj);

QString GetReqKeyUserId();

Default Value

Remarks

TBD

This property is read-only and not available at design time.

Data Type

String

ReqKeyUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetReqKeyUserKeySecret();

Unicode (Windows)
LPWSTR GetReqKeyUserKeySecret();

char* pkiproxy_cryptoserver_getreqkeyuserkeysecret(void* lpObj);

QString GetReqKeyUserKeySecret();

Default Value

Remarks

TBD

This property is read-only and not available at design time.

Data Type

String

ReqKeyValid Property (CryptoServer Class)

Returns True if this key is valid.

Syntax

ANSI (Cross Platform)
int GetReqKeyValid();

Unicode (Windows)
BOOL GetReqKeyValid();

int pkiproxy_cryptoserver_getreqkeyvalid(void* lpObj);

bool GetReqKeyValid();

Default Value

FALSE

Remarks

This property is read-only and not available at design time.

Data Type

Boolean

ReqKeyValidFrom Property (CryptoServer Class)

The time point at which the key becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetReqKeyValidFrom();

Unicode (Windows)
LPWSTR GetReqKeyValidFrom();

char* pkiproxy_cryptoserver_getreqkeyvalidfrom(void* lpObj);

QString GetReqKeyValidFrom();

Default Value

Remarks

The time point at which the key becomes valid, in UTC.

This property is read-only and not available at design time.

Data Type

String

ReqKeyValidTo Property (CryptoServer Class)

The time point at which the key expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetReqKeyValidTo();

Unicode (Windows)
LPWSTR GetReqKeyValidTo();

char* pkiproxy_cryptoserver_getreqkeyvalidto(void* lpObj);

QString GetReqKeyValidTo();

Default Value

Remarks

The time point at which the key expires, in UTC.

This property is read-only and not available at design time.

Data Type

String

ReqKeyValue Property (CryptoServer Class)

The byte array representation of the key.

Syntax

ANSI (Cross Platform)
int GetReqKeyValue(char* &lpReqKeyValue, int &lenReqKeyValue);

Unicode (Windows)
INT GetReqKeyValue(LPSTR &lpReqKeyValue, INT &lenReqKeyValue);

int pkiproxy_cryptoserver_getreqkeyvalue(void* lpObj, char** lpReqKeyValue, int* lenReqKeyValue);

QByteArray GetReqKeyValue();

Remarks

The byte array representation of the key. This may not be available for non-ReqKeyExportable keys.

This property is read-only and not available at design time.

Data Type

Byte Array

ReqObjDescription Property (CryptoServer Class)

The description, or label, of the object.

Syntax

ANSI (Cross Platform)
char* GetReqObjDescription();

Unicode (Windows)
LPWSTR GetReqObjDescription();

char* pkiproxy_cryptoserver_getreqobjdescription(void* lpObj);

QString GetReqObjDescription();

Default Value

Remarks

The description, or label, of the object.

This property is read-only and not available at design time.

Data Type

String

ReqObjEnabled Property (CryptoServer Class)

Enables or disables this key for use in encryption or signing operation.

Syntax

ANSI (Cross Platform)
int GetReqObjEnabled();

Unicode (Windows)
BOOL GetReqObjEnabled();

int pkiproxy_cryptoserver_getreqobjenabled(void* lpObj);

bool GetReqObjEnabled();

Default Value

FALSE

Remarks

Enables or disables this key for use in encryption or signing operation.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjExportable Property (CryptoServer Class)

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqObjExportable();

Unicode (Windows)
BOOL GetReqObjExportable();

int pkiproxy_cryptoserver_getreqobjexportable(void* lpObj);

bool GetReqObjExportable();

Default Value

FALSE

Remarks

Returns True if the object is exportable (can be serialized into an array of bytes), and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjFingerprint Property (CryptoServer Class)

Contains the fingerprint (a hash imprint) of this object.

Syntax

ANSI (Cross Platform)
int GetReqObjFingerprint(char* &lpReqObjFingerprint, int &lenReqObjFingerprint);

Unicode (Windows)
INT GetReqObjFingerprint(LPSTR &lpReqObjFingerprint, INT &lenReqObjFingerprint);

int pkiproxy_cryptoserver_getreqobjfingerprint(void* lpObj, char** lpReqObjFingerprint, int* lenReqObjFingerprint);

QByteArray GetReqObjFingerprint();

Remarks

Contains the fingerprint (a hash imprint) of this object.

This property is read-only and not available at design time.

Data Type

Byte Array

ReqObjFriendlyName Property (CryptoServer Class)

Contains an associated alias (friendly name) of the object.

Syntax

ANSI (Cross Platform)
char* GetReqObjFriendlyName();

Unicode (Windows)
LPWSTR GetReqObjFriendlyName();

char* pkiproxy_cryptoserver_getreqobjfriendlyname(void* lpObj);

QString GetReqObjFriendlyName();

Default Value

Remarks

Contains an associated alias (friendly name) of the object. PKCS#11 equivalent: Label.

This property is read-only and not available at design time.

Data Type

String

ReqObjGroup Property (CryptoServer Class)

The name of the group associated with this object.

Syntax

ANSI (Cross Platform)
char* GetReqObjGroup();

Unicode (Windows)
LPWSTR GetReqObjGroup();

char* pkiproxy_cryptoserver_getreqobjgroup(void* lpObj);

QString GetReqObjGroup();

Default Value

Remarks

The name of the group associated with this object. Groups allow to bind together multiple objects logically connected with each other, such as certificates and their keys.

This property is read-only and not available at design time.

Data Type

String

ReqObjID Property (CryptoServer Class)

Provides access to a storage-specific object identifier.

Syntax

ANSI (Cross Platform)
char* GetReqObjID();

Unicode (Windows)
LPWSTR GetReqObjID();

char* pkiproxy_cryptoserver_getreqobjid(void* lpObj);

QString GetReqObjID();

Default Value

Remarks

Provides access to a storage-specific object identifier.

This property is read-only and not available at design time.

Data Type

String

ReqObjIssuer Property (CryptoServer Class)

Returns the object issuer.

Syntax

ANSI (Cross Platform)
char* GetReqObjIssuer();

Unicode (Windows)
LPWSTR GetReqObjIssuer();

char* pkiproxy_cryptoserver_getreqobjissuer(void* lpObj);

QString GetReqObjIssuer();

Default Value

Remarks

Returns the object issuer. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is read-only and not available at design time.

Data Type

String

ReqObjKeyUsage Property (CryptoServer Class)

Indicates the purposes of the object.

Syntax

ANSI (Cross Platform)
char* GetReqObjKeyUsage();

Unicode (Windows)
LPWSTR GetReqObjKeyUsage();

char* pkiproxy_cryptoserver_getreqobjkeyusage(void* lpObj);

QString GetReqObjKeyUsage();

Default Value

Remarks

Indicates the purposes of the object. For certificate object, this corresponds to the elements contained in the Key Usage and Extended Key Usage extensions.

This property is read-only and not available at design time.

Data Type

String

ReqObjNonPublic Property (CryptoServer Class)

Returns True if the object is private, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqObjNonPublic();

Unicode (Windows)
BOOL GetReqObjNonPublic();

int pkiproxy_cryptoserver_getreqobjnonpublic(void* lpObj);

bool GetReqObjNonPublic();

Default Value

FALSE

Remarks

Returns True if the object is private, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjObjType Property (CryptoServer Class)

The type of the key contained in the object.

Syntax

ANSI (Cross Platform)
int GetReqObjObjType();

Unicode (Windows)
INT GetReqObjObjType();

Possible Values

COT_UNKNOWN(0), 
COT_CERTIFICATE(1), 
COT_DATA(2), 
COT_GENERIC(3)

int pkiproxy_cryptoserver_getreqobjobjtype(void* lpObj);

int GetReqObjObjType();

Default Value

Remarks

The type of the key contained in the object.

Use this property to establish the object type.

This property is read-only and not available at design time.

Data Type

Integer

ReqObjOrigin Property (CryptoServer Class)

Returns the origin (the Storage ID) of this object.

Syntax

ANSI (Cross Platform)
char* GetReqObjOrigin();

Unicode (Windows)
LPWSTR GetReqObjOrigin();

char* pkiproxy_cryptoserver_getreqobjorigin(void* lpObj);

QString GetReqObjOrigin();

Default Value

Remarks

Returns the origin (the Storage ID) of this object.

This property is read-only and not available at design time.

Data Type

String

ReqObjPersistent Property (CryptoServer Class)

Returns True if the object is persistent in the store.

Syntax

ANSI (Cross Platform)
int GetReqObjPersistent();

Unicode (Windows)
BOOL GetReqObjPersistent();

int pkiproxy_cryptoserver_getreqobjpersistent(void* lpObj);

bool GetReqObjPersistent();

Default Value

FALSE

Remarks

Returns True if the object is persistent in the store.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjProperties Property (CryptoServer Class)

Returns a collection of object properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetReqObjProperties();

Unicode (Windows)
LPWSTR GetReqObjProperties();

char* pkiproxy_cryptoserver_getreqobjproperties(void* lpObj);

QString GetReqObjProperties();

Default Value

Remarks

Returns a collection of object properties as a comma separated name=value list.

This property is read-only and not available at design time.

Data Type

String

ReqObjReadOnly Property (CryptoServer Class)

Returns True if the object is readonly.

Syntax

ANSI (Cross Platform)
int GetReqObjReadOnly();

Unicode (Windows)
BOOL GetReqObjReadOnly();

int pkiproxy_cryptoserver_getreqobjreadonly(void* lpObj);

bool GetReqObjReadOnly();

Default Value

FALSE

Remarks

Returns True if the object is readonly.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjSensitive Property (CryptoServer Class)

Returns True if the object is sensitive, and False otherwise.

Syntax

ANSI (Cross Platform)
int GetReqObjSensitive();

Unicode (Windows)
BOOL GetReqObjSensitive();

int pkiproxy_cryptoserver_getreqobjsensitive(void* lpObj);

bool GetReqObjSensitive();

Default Value

FALSE

Remarks

Returns True if the object is sensitive, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

ReqObjSerialNumber Property (CryptoServer Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
char* GetReqObjSerialNumber();

Unicode (Windows)
LPWSTR GetReqObjSerialNumber();

char* pkiproxy_cryptoserver_getreqobjserialnumber(void* lpObj);

QString GetReqObjSerialNumber();

Default Value

Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

String

ReqObjSize Property (CryptoServer Class)

The size of the object in bytes.

Syntax

ANSI (Cross Platform)
int GetReqObjSize();

Unicode (Windows)
INT GetReqObjSize();

int pkiproxy_cryptoserver_getreqobjsize(void* lpObj);

int GetReqObjSize();

Default Value

Remarks

The size of the object in bytes

This property is read-only and not available at design time.

Data Type

Integer

ReqObjSubject Property (CryptoServer Class)

Returns the object subject.

Syntax

ANSI (Cross Platform)
char* GetReqObjSubject();

Unicode (Windows)
LPWSTR GetReqObjSubject();

char* pkiproxy_cryptoserver_getreqobjsubject(void* lpObj);

QString GetReqObjSubject();

Default Value

Remarks

Returns the object subject. This is a cryptoprovider-dependent value,which normally aims to provide some user-friendly insight into thekey owner.

This property is read-only and not available at design time.

Data Type

String

ReqObjUserId Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetReqObjUserId();

Unicode (Windows)
LPWSTR GetReqObjUserId();

char* pkiproxy_cryptoserver_getreqobjuserid(void* lpObj);

QString GetReqObjUserId();

Default Value

Remarks

TBD

This property is read-only and not available at design time.

Data Type

String

ReqObjUserKeySecret Property (CryptoServer Class)

TBD.

Syntax

ANSI (Cross Platform)
char* GetReqObjUserKeySecret();

Unicode (Windows)
LPWSTR GetReqObjUserKeySecret();

char* pkiproxy_cryptoserver_getreqobjuserkeysecret(void* lpObj);

QString GetReqObjUserKeySecret();

Default Value

Remarks

TBD

This property is read-only and not available at design time.

Data Type

String

ReqObjValidFrom Property (CryptoServer Class)

The time point at which the object becomes valid, in UTC.

Syntax

ANSI (Cross Platform)
char* GetReqObjValidFrom();

Unicode (Windows)
LPWSTR GetReqObjValidFrom();

char* pkiproxy_cryptoserver_getreqobjvalidfrom(void* lpObj);

QString GetReqObjValidFrom();

Default Value

Remarks

The time point at which the object becomes valid, in UTC.

This property is read-only and not available at design time.

Data Type

String

ReqObjValidTo Property (CryptoServer Class)

The time point at which the object expires, in UTC.

Syntax

ANSI (Cross Platform)
char* GetReqObjValidTo();

Unicode (Windows)
LPWSTR GetReqObjValidTo();

char* pkiproxy_cryptoserver_getreqobjvalidto(void* lpObj);

QString GetReqObjValidTo();

Default Value

Remarks

The time point at which the object expires, in UTC.

This property is read-only and not available at design time.

Data Type

String

ReqObjValue Property (CryptoServer Class)

The byte array representation of the object.

Syntax

ANSI (Cross Platform)
int GetReqObjValue(char* &lpReqObjValue, int &lenReqObjValue);

Unicode (Windows)
INT GetReqObjValue(LPSTR &lpReqObjValue, INT &lenReqObjValue);

int pkiproxy_cryptoserver_getreqobjvalue(void* lpObj, char** lpReqObjValue, int* lenReqObjValue);

QByteArray GetReqObjValue();

Remarks

The byte array representation of the object. This may not be available for non-ReqObjExportable objects.

This property is read-only and not available at design time.

Data Type

Byte Array

ResponseBody Property (CryptoServer Class)

The generated response body.

Syntax

ANSI (Cross Platform)
char* GetResponseBody();

Unicode (Windows)
LPWSTR GetResponseBody();

char* pkiproxy_cryptoserver_getresponsebody(void* lpObj);

QString GetResponseBody();

Default Value

Remarks

The generated response body.

This property is read-only.

Data Type

String

ResponseBodyBytes Property (CryptoServer Class)

The generated response body as a byte array.

Syntax

ANSI (Cross Platform)
int GetResponseBodyBytes(char* &lpResponseBodyBytes, int &lenResponseBodyBytes);

Unicode (Windows)
INT GetResponseBodyBytes(LPSTR &lpResponseBodyBytes, INT &lenResponseBodyBytes);

int pkiproxy_cryptoserver_getresponsebodybytes(void* lpObj, char** lpResponseBodyBytes, int* lenResponseBodyBytes);

QByteArray GetResponseBodyBytes();

Remarks

The generated response body as a byte array.

This property is read-only and not available at design time.

Data Type

Byte Array

ResponseCustomHeaders Property (CryptoServer Class)

The custom HTTP headers to be added to the response.

Syntax

ANSI (Cross Platform)
char* GetResponseCustomHeaders();
int SetResponseCustomHeaders(const char* lpszResponseCustomHeaders);

Unicode (Windows)
LPWSTR GetResponseCustomHeaders();
INT SetResponseCustomHeaders(LPCWSTR lpszResponseCustomHeaders);

char* pkiproxy_cryptoserver_getresponsecustomheaders(void* lpObj);
int pkiproxy_cryptoserver_setresponsecustomheaders(void* lpObj, const char* lpszResponseCustomHeaders);

QString GetResponseCustomHeaders();
int SetResponseCustomHeaders(QString qsResponseCustomHeaders);

Default Value

Remarks

The custom HTTP headers to be added to the response.

Data Type

String

ResponseHeaders Property (CryptoServer Class)

The generated HTTP headers to be supplied with the response.

Syntax

ANSI (Cross Platform)
char* GetResponseHeaders();

Unicode (Windows)
LPWSTR GetResponseHeaders();

char* pkiproxy_cryptoserver_getresponseheaders(void* lpObj);

QString GetResponseHeaders();

Default Value

Remarks

The generated HTTP headers to be supplied with the response.

This property is read-only.

Data Type

String

ResponseHttpReasonPhrase Property (CryptoServer Class)

The HTTP reason phrase to return.

Syntax

ANSI (Cross Platform)
char* GetResponseHttpReasonPhrase();

Unicode (Windows)
LPWSTR GetResponseHttpReasonPhrase();

char* pkiproxy_cryptoserver_getresponsehttpreasonphrase(void* lpObj);

QString GetResponseHttpReasonPhrase();

Default Value

"OK"

Remarks

The HTTP reason phrase to return.

This property is read-only.

Data Type

String

ResponseHttpStatusCode Property (CryptoServer Class)

The HTTP status code to return.

Syntax

ANSI (Cross Platform)
int GetResponseHttpStatusCode();

Unicode (Windows)
INT GetResponseHttpStatusCode();

int pkiproxy_cryptoserver_getresponsehttpstatuscode(void* lpObj);

int GetResponseHttpStatusCode();

Default Value

Remarks

The HTTP status code to return.

This property is read-only.

Data Type

Integer

ResponseOperation Property (CryptoServer Class)

The PKI Proxy protocol operation.

Syntax

ANSI (Cross Platform)
int GetResponseOperation();
int SetResponseOperation(int iResponseOperation);

Unicode (Windows)
INT GetResponseOperation();
INT SetResponseOperation(INT iResponseOperation);

Possible Values

OP_UNKNOWN(0), 
OP_GET_SERVICE_INFO(1), 
OP_LIST_KEYSTORES(2), 
OP_GET_KEYSTORE_INFO(3), 
OP_LIST_OBJECTS(4), 
OP_CREATE_OBJECT(5), 
OP_COPY_OBJECT(6), 
OP_GENERATE_KEY(7), 
OP_IMPORT_KEY(8), 
OP_DERIVE_KEY(9), 
OP_GET_OBJECT_INFO(10), 
OP_GET_OBJECT_PARAM(11), 
OP_EXPORT_OBJECT(12), 
OP_IMPORT_OBJECT(13), 
OP_DESTROY_OBJECT(14), 
OP_SET_OBJECT_PARAM(15), 
OP_GET_KEYSTORE_CAPABILITIES(16), 
OP_ENCRYPT(17), 
OP_ENCRYPT_MULTIPART(18), 
OP_DECRYPT(19), 
OP_DECRYPT_MULTIPART(20), 
OP_SIGN(21), 
OP_SIGN_MULTIPART(22), 
OP_VERIFY(23), 
OP_VERIFY_MULTIPART(24), 
OP_RANDOM_SEED(25), 
OP_RANDOM_GENERATE(26)

int pkiproxy_cryptoserver_getresponseoperation(void* lpObj);
int pkiproxy_cryptoserver_setresponseoperation(void* lpObj, int iResponseOperation);

int GetResponseOperation();
int SetResponseOperation(int iResponseOperation);

Default Value

Remarks

The PKI Proxy protocol operation.

Use this property to check or adjust the keystore request operation.

Data Type

Integer

ResponseOperationResult Property (CryptoServer Class)

The logical result of an operation that is capable of returning it, such as signature verification.

Syntax

ANSI (Cross Platform)
int GetResponseOperationResult();
int SetResponseOperationResult(int iResponseOperationResult);

Unicode (Windows)
INT GetResponseOperationResult();
INT SetResponseOperationResult(INT iResponseOperationResult);

int pkiproxy_cryptoserver_getresponseoperationresult(void* lpObj);
int pkiproxy_cryptoserver_setresponseoperationresult(void* lpObj, int iResponseOperationResult);

int GetResponseOperationResult();
int SetResponseOperationResult(int iResponseOperationResult);

Default Value

Remarks

The logical result of an operation that is capable of returning it, such as signature verification. Note that this is different to HttpStatusCode (which conducts the REST command status and is normally generated automatically) and StatusCode (which indicates the overall outcome of the command andis typically used to convey exceptional situations or errors happening outside of the operation flow). OperationResult contains the logical result of an operation that, due to its nature, must return a value.One example of such operation is Verify. This operation must return the verification status. Note that even a bad verification status (invalid signature) does not imply failure of the operation itself,so StatusCode can still be set to 0 and HttpStatusCode to 200.Supported values:0 - SUCCESS1 - FAILURE

Data Type

Integer

ResponseOperationResultComment Property (CryptoServer Class)

The service-local operation result comment.

Syntax

ANSI (Cross Platform)
char* GetResponseOperationResultComment();
int SetResponseOperationResultComment(const char* lpszResponseOperationResultComment);

Unicode (Windows)
LPWSTR GetResponseOperationResultComment();
INT SetResponseOperationResultComment(LPCWSTR lpszResponseOperationResultComment);

char* pkiproxy_cryptoserver_getresponseoperationresultcomment(void* lpObj);
int pkiproxy_cryptoserver_setresponseoperationresultcomment(void* lpObj, const char* lpszResponseOperationResultComment);

QString GetResponseOperationResultComment();
int SetResponseOperationResultComment(QString qsResponseOperationResultComment);

Default Value

Remarks

The service-local operation result comment.

Data Type

String

ResponseOutputBytes Property (CryptoServer Class)

The data representing the operation result, such as ciphertext, decrypted plaintext, or signature.

Syntax

ANSI (Cross Platform)
int GetResponseOutputBytes(char* &lpResponseOutputBytes, int &lenResponseOutputBytes);
int SetResponseOutputBytes(const char* lpResponseOutputBytes, int lenResponseOutputBytes);

Unicode (Windows)
INT GetResponseOutputBytes(LPSTR &lpResponseOutputBytes, INT &lenResponseOutputBytes);
INT SetResponseOutputBytes(LPCSTR lpResponseOutputBytes, INT lenResponseOutputBytes);

int pkiproxy_cryptoserver_getresponseoutputbytes(void* lpObj, char** lpResponseOutputBytes, int* lenResponseOutputBytes);
int pkiproxy_cryptoserver_setresponseoutputbytes(void* lpObj, const char* lpResponseOutputBytes, int lenResponseOutputBytes);

QByteArray GetResponseOutputBytes();
int SetResponseOutputBytes(QByteArray qbaResponseOutputBytes);

Remarks

The data representing the operation result, such as ciphertext, decrypted plaintext, or signature.

This property is not available at design time.

Data Type

Byte Array

ResponseRawContent Property (CryptoServer Class)

Use this property to provide the response content in non-interpreted form.

Syntax

ANSI (Cross Platform)
int GetResponseRawContent(char* &lpResponseRawContent, int &lenResponseRawContent);
int SetResponseRawContent(const char* lpResponseRawContent, int lenResponseRawContent);

Unicode (Windows)
INT GetResponseRawContent(LPSTR &lpResponseRawContent, INT &lenResponseRawContent);
INT SetResponseRawContent(LPCSTR lpResponseRawContent, INT lenResponseRawContent);

int pkiproxy_cryptoserver_getresponserawcontent(void* lpObj, char** lpResponseRawContent, int* lenResponseRawContent);
int pkiproxy_cryptoserver_setresponserawcontent(void* lpObj, const char* lpResponseRawContent, int lenResponseRawContent);

QByteArray GetResponseRawContent();
int SetResponseRawContent(QByteArray qbaResponseRawContent);

Remarks

Use this property to provide the response content in non-interpreted form. Use ResponseRawContentType to supply the content type.

This property is not available at design time.

Data Type

Byte Array

ResponseRawContentType Property (CryptoServer Class)

Use this property to provide the raw response content type.

Syntax

ANSI (Cross Platform)
char* GetResponseRawContentType();
int SetResponseRawContentType(const char* lpszResponseRawContentType);

Unicode (Windows)
LPWSTR GetResponseRawContentType();
INT SetResponseRawContentType(LPCWSTR lpszResponseRawContentType);

char* pkiproxy_cryptoserver_getresponserawcontenttype(void* lpObj);
int pkiproxy_cryptoserver_setresponserawcontenttype(void* lpObj, const char* lpszResponseRawContentType);

QString GetResponseRawContentType();
int SetResponseRawContentType(QString qsResponseRawContentType);

Default Value

Remarks

Use this property to provide the raw response content type. If this property is set, the ResponseRawContent is used as the response content (be it set or not). If this property is not set but ResponseRawContent is, the content type is generated automatically basing on the processed operation expectations. If neither this property nor ResponseRawContent are set - which will be the case for the majority of uses - the response body is generated automaticallybasing on the data provided to the Response object properties.

Data Type

String

ResponseRequestId Property (CryptoServer Class)

The unique ID assigned to the processed request.

Syntax

ANSI (Cross Platform)
char* GetResponseRequestId();
int SetResponseRequestId(const char* lpszResponseRequestId);

Unicode (Windows)
LPWSTR GetResponseRequestId();
INT SetResponseRequestId(LPCWSTR lpszResponseRequestId);

char* pkiproxy_cryptoserver_getresponserequestid(void* lpObj);
int pkiproxy_cryptoserver_setresponserequestid(void* lpObj, const char* lpszResponseRequestId);

QString GetResponseRequestId();
int SetResponseRequestId(QString qsResponseRequestId);

Default Value

Remarks

The unique ID assigned to the processed request.

Data Type

String

ResponseRespSig Property (CryptoServer Class)

Contains the raw signature over the response.

Syntax

ANSI (Cross Platform)
char* GetResponseRespSig();
int SetResponseRespSig(const char* lpszResponseRespSig);

Unicode (Windows)
LPWSTR GetResponseRespSig();
INT SetResponseRespSig(LPCWSTR lpszResponseRespSig);

char* pkiproxy_cryptoserver_getresponserespsig(void* lpObj);
int pkiproxy_cryptoserver_setresponserespsig(void* lpObj, const char* lpszResponseRespSig);

QString GetResponseRespSig();
int SetResponseRespSig(QString qsResponseRespSig);

Default Value

Remarks

Contains the raw signature over the response.

Data Type

String

ResponseRespSigned Property (CryptoServer Class)

Indicates whether the response is signed.

Syntax

ANSI (Cross Platform)
int GetResponseRespSigned();
int SetResponseRespSigned(int bResponseRespSigned);

Unicode (Windows)
BOOL GetResponseRespSigned();
INT SetResponseRespSigned(BOOL bResponseRespSigned);

int pkiproxy_cryptoserver_getresponserespsigned(void* lpObj);
int pkiproxy_cryptoserver_setresponserespsigned(void* lpObj, int bResponseRespSigned);

bool GetResponseRespSigned();
int SetResponseRespSigned(bool bResponseRespSigned);

Default Value

FALSE

Remarks

Indicates whether the response is signed.

Data Type

Boolean

ResponseRespSigValid Property (CryptoServer Class)

Indicates whether the response signature is valid.

Syntax

ANSI (Cross Platform)
int GetResponseRespSigValid();
int SetResponseRespSigValid(int bResponseRespSigValid);

Unicode (Windows)
BOOL GetResponseRespSigValid();
INT SetResponseRespSigValid(BOOL bResponseRespSigValid);

int pkiproxy_cryptoserver_getresponserespsigvalid(void* lpObj);
int pkiproxy_cryptoserver_setresponserespsigvalid(void* lpObj, int bResponseRespSigValid);

bool GetResponseRespSigValid();
int SetResponseRespSigValid(bool bResponseRespSigValid);

Default Value

FALSE

Remarks

Indicates whether the response signature is valid.

Data Type

Boolean

ResponseServiceActive Property (CryptoServer Class)

Indicates whether the response is signed.

Syntax

ANSI (Cross Platform)
int GetResponseServiceActive();
int SetResponseServiceActive(int bResponseServiceActive);

Unicode (Windows)
BOOL GetResponseServiceActive();
INT SetResponseServiceActive(BOOL bResponseServiceActive);

int pkiproxy_cryptoserver_getresponseserviceactive(void* lpObj);
int pkiproxy_cryptoserver_setresponseserviceactive(void* lpObj, int bResponseServiceActive);

bool GetResponseServiceActive();
int SetResponseServiceActive(bool bResponseServiceActive);

Default Value

FALSE

Remarks

Indicates whether the response is signed.

Data Type

Boolean

ResponseServiceDescription Property (CryptoServer Class)

The description of the service.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceDescription();
int SetResponseServiceDescription(const char* lpszResponseServiceDescription);

Unicode (Windows)
LPWSTR GetResponseServiceDescription();
INT SetResponseServiceDescription(LPCWSTR lpszResponseServiceDescription);

char* pkiproxy_cryptoserver_getresponseservicedescription(void* lpObj);
int pkiproxy_cryptoserver_setresponseservicedescription(void* lpObj, const char* lpszResponseServiceDescription);

QString GetResponseServiceDescription();
int SetResponseServiceDescription(QString qsResponseServiceDescription);

Default Value

Remarks

The description of the service.

Data Type

String

ResponseServiceId Property (CryptoServer Class)

The identifier of the service.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceId();
int SetResponseServiceId(const char* lpszResponseServiceId);

Unicode (Windows)
LPWSTR GetResponseServiceId();
INT SetResponseServiceId(LPCWSTR lpszResponseServiceId);

char* pkiproxy_cryptoserver_getresponseserviceid(void* lpObj);
int pkiproxy_cryptoserver_setresponseserviceid(void* lpObj, const char* lpszResponseServiceId);

QString GetResponseServiceId();
int SetResponseServiceId(QString qsResponseServiceId);

Default Value

Remarks

The identifier of the service.

Data Type

String

ResponseServiceProperties Property (CryptoServer Class)

A collection of secondary or custom properties as a comma separated name=value list.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceProperties();
int SetResponseServiceProperties(const char* lpszResponseServiceProperties);

Unicode (Windows)
LPWSTR GetResponseServiceProperties();
INT SetResponseServiceProperties(LPCWSTR lpszResponseServiceProperties);

char* pkiproxy_cryptoserver_getresponseserviceproperties(void* lpObj);
int pkiproxy_cryptoserver_setresponseserviceproperties(void* lpObj, const char* lpszResponseServiceProperties);

QString GetResponseServiceProperties();
int SetResponseServiceProperties(QString qsResponseServiceProperties);

Default Value

Remarks

A collection of secondary or custom properties as a comma separated name=value list.

Data Type

String

ResponseServiceServices Property (CryptoServer Class)

The services of the service.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceServices();
int SetResponseServiceServices(const char* lpszResponseServiceServices);

Unicode (Windows)
LPWSTR GetResponseServiceServices();
INT SetResponseServiceServices(LPCWSTR lpszResponseServiceServices);

char* pkiproxy_cryptoserver_getresponseserviceservices(void* lpObj);
int pkiproxy_cryptoserver_setresponseserviceservices(void* lpObj, const char* lpszResponseServiceServices);

QString GetResponseServiceServices();
int SetResponseServiceServices(QString qsResponseServiceServices);

Default Value

Remarks

The services of the service.

Data Type

String

ResponseServiceVendor Property (CryptoServer Class)

The name of the service vendor.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceVendor();
int SetResponseServiceVendor(const char* lpszResponseServiceVendor);

Unicode (Windows)
LPWSTR GetResponseServiceVendor();
INT SetResponseServiceVendor(LPCWSTR lpszResponseServiceVendor);

char* pkiproxy_cryptoserver_getresponseservicevendor(void* lpObj);
int pkiproxy_cryptoserver_setresponseservicevendor(void* lpObj, const char* lpszResponseServiceVendor);

QString GetResponseServiceVendor();
int SetResponseServiceVendor(QString qsResponseServiceVendor);

Default Value

Remarks

The name of the service vendor.

Data Type

String

ResponseServiceVersion Property (CryptoServer Class)

The version identifier of the service.

Syntax

ANSI (Cross Platform)
char* GetResponseServiceVersion();
int SetResponseServiceVersion(const char* lpszResponseServiceVersion);

Unicode (Windows)
LPWSTR GetResponseServiceVersion();
INT SetResponseServiceVersion(LPCWSTR lpszResponseServiceVersion);

char* pkiproxy_cryptoserver_getresponseserviceversion(void* lpObj);
int pkiproxy_cryptoserver_setresponseserviceversion(void* lpObj, const char* lpszResponseServiceVersion);

QString GetResponseServiceVersion();
int SetResponseServiceVersion(QString qsResponseServiceVersion);

Default Value

Remarks

The version identifier of the service. No specific format assumed.

Data Type

String

ResponseStatusCode Property (CryptoServer Class)

The service status code to return.

Syntax

ANSI (Cross Platform)
int GetResponseStatusCode();
int SetResponseStatusCode(int iResponseStatusCode);

Unicode (Windows)
INT GetResponseStatusCode();
INT SetResponseStatusCode(INT iResponseStatusCode);

int pkiproxy_cryptoserver_getresponsestatuscode(void* lpObj);
int pkiproxy_cryptoserver_setresponsestatuscode(void* lpObj, int iResponseStatusCode);

int GetResponseStatusCode();
int SetResponseStatusCode(int iResponseStatusCode);

Default Value

Remarks

The service status code to return. This is different to ResponseHttpStatusCode and contains service-local operation result code. The code of 0 indicates successful processing.

Data Type

Integer

ResponseStatusMessage Property (CryptoServer Class)

The service-local operation status message.

Syntax

ANSI (Cross Platform)
char* GetResponseStatusMessage();
int SetResponseStatusMessage(const char* lpszResponseStatusMessage);

Unicode (Windows)
LPWSTR GetResponseStatusMessage();
INT SetResponseStatusMessage(LPCWSTR lpszResponseStatusMessage);

char* pkiproxy_cryptoserver_getresponsestatusmessage(void* lpObj);
int pkiproxy_cryptoserver_setresponsestatusmessage(void* lpObj, const char* lpszResponseStatusMessage);

QString GetResponseStatusMessage();
int SetResponseStatusMessage(QString qsResponseStatusMessage);

Default Value

"OK"

Remarks

The service-local operation status message.

Data Type

String

ResponseToken Property (CryptoServer Class)

The listing continuation token to be returned.

Syntax

ANSI (Cross Platform)
char* GetResponseToken();
int SetResponseToken(const char* lpszResponseToken);

Unicode (Windows)
LPWSTR GetResponseToken();
INT SetResponseToken(LPCWSTR lpszResponseToken);

char* pkiproxy_cryptoserver_getresponsetoken(void* lpObj);
int pkiproxy_cryptoserver_setresponsetoken(void* lpObj, const char* lpszResponseToken);

QString GetResponseToken();
int SetResponseToken(QString qsResponseToken);

Default Value

Remarks

The listing continuation token to be returned. Set it if the returned object list is incomplete..

Data Type

String

ResponseTrace Property (CryptoServer Class)

The trace (processing log or debug info) to include with the response.

Syntax

ANSI (Cross Platform)
char* GetResponseTrace();
int SetResponseTrace(const char* lpszResponseTrace);

Unicode (Windows)
LPWSTR GetResponseTrace();
INT SetResponseTrace(LPCWSTR lpszResponseTrace);

char* pkiproxy_cryptoserver_getresponsetrace(void* lpObj);
int pkiproxy_cryptoserver_setresponsetrace(void* lpObj, const char* lpszResponseTrace);

QString GetResponseTrace();
int SetResponseTrace(QString qsResponseTrace);

Default Value

Remarks

The trace (processing log or debug info) to include with the response.

Data Type

String

AddKey Method (CryptoServer Class)

Registers object information in the response.

Syntax

ANSI (Cross Platform)
int AddKey();

Unicode (Windows)
INT AddKey();

int pkiproxy_cryptoserver_addkey(void* lpObj);

int AddKey();

Remarks

Use this method to register a single key details, provided via the PinnedKey property, in the response for GetObjectInfo or ListObjects requests.

If the ListObjects request you are handling results in truncated content, remember to set the Token property of the response to provide continuity.In the same manner, the Token property of the request lets you continue previously started listing requests.The key is added to the Keys list.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddMechanism Method (CryptoServer Class)

Registers mechanism information in the response.

Syntax

ANSI (Cross Platform)
int AddMechanism();

Unicode (Windows)
INT AddMechanism();

int pkiproxy_cryptoserver_addmechanism(void* lpObj);

int AddMechanism();

Remarks

Use this method to register a single mechanism details, provided via the PinnedMechanism property, in the response for GetMechanismInfo or ListMechanism requests.

The mechanism info is added to the Mechanisms list.

Error Handling (C++)

AddObject Method (CryptoServer Class)

Registers object information in the response.

Syntax

ANSI (Cross Platform)
int AddObject();

Unicode (Windows)
INT AddObject();

int pkiproxy_cryptoserver_addobject(void* lpObj);

int AddObject();

Remarks

Use this method to register a single object details, provided via the PinnedObject property, in the response for GetObjectInfo or ListObjects requests.

Error Handling (C++)

Config Method (CryptoServer Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* pkiproxy_cryptoserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateWebRequest Method (CryptoServer Class)

Creates a new REST request.

Syntax

ANSI (Cross Platform)
int CreateWebRequest();

Unicode (Windows)
INT CreateWebRequest();

int pkiproxy_cryptoserver_createwebrequest(void* lpObj);

int CreateWebRequest();

Remarks

Use this method to create a new web request. Call this method after filling in the properties of the Request object.

Once this method completes, the Verb, Url, Headers, and Body fields of the Request object are updated to match the new request parameters.

Error Handling (C++)

CreateWebResponse Method (CryptoServer Class)

Creates a new REST response.

Syntax

ANSI (Cross Platform)
int CreateWebResponse();

Unicode (Windows)
INT CreateWebResponse();

int pkiproxy_cryptoserver_createwebresponse(void* lpObj);

int CreateWebResponse();

Remarks

Use this method to create a new web request. Call this method after filling in the properties of the Response object.

Once this method completes, the Status, Headers, and Body fields of the Response object are updated to match the new response parameters.

Error Handling (C++)

GetRequestParam Method (CryptoServer Class)

Looks up for a parameter in various request locations.

Syntax

ANSI (Cross Platform)
char* GetRequestParam(const char* lpszParamName, int iLookIn, const char* lpszDef);

Unicode (Windows)
LPWSTR GetRequestParam(LPCWSTR lpszParamName, INT iLookIn, LPCWSTR lpszDef);

char* pkiproxy_cryptoserver_getrequestparam(void* lpObj, const char* lpszParamName, int iLookIn, const char* lpszDef);

QString GetRequestParam(const QString& qsParamName, int iLookIn, const QString& qsDef);

Remarks

Use this method to retrieve secondary or custom request parameters not available via the Request object properties.

LookIn is a bit mask that specifies where to look: 1 in query, 2 in headers, 4 in the request body. Combine them as required. If no parameter with the requested name is found, the value of Def is returned.

Error Handling (C++)

GetResponseParam Method (CryptoServer Class)

Looks up for a parameter in various response locations.

Syntax

ANSI (Cross Platform)
char* GetResponseParam(const char* lpszParamName, int iLookIn, const char* lpszDef);

Unicode (Windows)
LPWSTR GetResponseParam(LPCWSTR lpszParamName, INT iLookIn, LPCWSTR lpszDef);

char* pkiproxy_cryptoserver_getresponseparam(void* lpObj, const char* lpszParamName, int iLookIn, const char* lpszDef);

QString GetResponseParam(const QString& qsParamName, int iLookIn, const QString& qsDef);

Remarks

Use this method to retrieve secondary or custom request parameters not available via the Response object properties.

LookIn is a bit mask that specifies where to look: 1 in query, 2 in headers, 4 in the response body. Combine them as required. If no parameter with the requested name is found, the value of Def is returned.

Error Handling (C++)

OpenWebRequest Method (CryptoServer Class)

Opens a REST request and populates it in the Request property.

Syntax

ANSI (Cross Platform)
int OpenWebRequest(const char* lpszVerb, const char* lpszUrl, const char* lpszHeaders, const char* lpszBody, int iBodyLen);

Unicode (Windows)
INT OpenWebRequest(LPCWSTR lpszVerb, LPCWSTR lpszUrl, LPCWSTR lpszHeaders, LPCWSTR lpszBody, INT iBodyLen);

int pkiproxy_cryptoserver_openwebrequest(void* lpObj, const char* lpszVerb, const char* lpszUrl, const char* lpszHeaders, const char* lpszBody, int iBodyLen);

int OpenWebRequest(const QString& qsVerb, const QString& qsUrl, const QString& qsHeaders, const QString& qsBody, int iBodyLen);

Remarks

Use this method to process a REST request and populate its parameters in the Request property.

Error Handling (C++)

OpenWebResponse Method (CryptoServer Class)

Opens a REST response and populates it in the Response property.

Syntax

ANSI (Cross Platform)
int OpenWebResponse(int iStatusCode, const char* lpszReasonPhrase, const char* lpszHeaders, const char* lpszBody, int iBodyLen, int iOperation);

Unicode (Windows)
INT OpenWebResponse(INT iStatusCode, LPCWSTR lpszReasonPhrase, LPCWSTR lpszHeaders, LPCWSTR lpszBody, INT iBodyLen, INT iOperation);

int pkiproxy_cryptoserver_openwebresponse(void* lpObj, int iStatusCode, const char* lpszReasonPhrase, const char* lpszHeaders, const char* lpszBody, int iBodyLen, int iOperation);

int OpenWebResponse(int iStatusCode, const QString& qsReasonPhrase, const QString& qsHeaders, const QString& qsBody, int iBodyLen, int iOperation);

Remarks

Use this method to process a REST response and populate its parameters in the Response property.

Error Handling (C++)

Reset Method (CryptoServer Class)

Clear all list.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int pkiproxy_cryptoserver_reset(void* lpObj);

int Reset();

Remarks

Use this method to clear all list (objects, keys, mechanisms).

Error Handling (C++)

SetRequestParam Method (CryptoServer Class)

Sets up a request parameter in the designated location.

Syntax

ANSI (Cross Platform)
int SetRequestParam(const char* lpszParamName, const char* lpszParamValue, int iLocation);

Unicode (Windows)
INT SetRequestParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue, INT iLocation);

int pkiproxy_cryptoserver_setrequestparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue, int iLocation);

int SetRequestParam(const QString& qsParamName, const QString& qsParamValue, int iLocation);

Remarks

Use this method to set a secondary or custom request parameter not available via the Request object properties.

Location specifies what part of the request to use for the parameter: 1 in query, 2 in headers, 4 in the request body.

Error Handling (C++)

SetResponseParam Method (CryptoServer Class)

Sets up a response parameter in the designated location.

Syntax

ANSI (Cross Platform)
int SetResponseParam(const char* lpszParamName, const char* lpszParamValue, int iLocation);

Unicode (Windows)
INT SetResponseParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue, INT iLocation);

int pkiproxy_cryptoserver_setresponseparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue, int iLocation);

int SetResponseParam(const QString& qsParamName, const QString& qsParamValue, int iLocation);

Remarks

Use this method to set a secondary or custom response parameter not available via the Response object properties.

Location specifies what part of the request to use for the parameter: 1 in query, 2 in headers, 4 in the response body.

Error Handling (C++)

Error Event (CryptoServer Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(CryptoServerErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CryptoServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(CryptoServerErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CryptoServerErrorEventParams;

#define EID_CRYPTOSERVER_ERROR 1

virtual INT PKIPROXY_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CryptoServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CryptoServerErrorEventParams *e);

// Or, subclass CryptoServer and override this emitter function.
virtual int FireError(CryptoServerErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (CryptoServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

CryptoServer Config Settings

ResponseFormat: The format of response.

The format of response

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Trappable Errors (CryptoServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.