Search key names by multiple attributes
To search key names by multiple attributes
The API I_C_GetKeyNames is introduced to accept multiple search criteria. This API can accept multiple custom attribute to search.
Example
I_C_GetKeyNames (I_O_Session handle, I_T_KeyNameAttributes* keyAttr, I_O_StringList*pKeyNamesList)
The following search options are available. All the search criteria are optional.
| Search options | Description |
|---|---|
| Custom Attributelist | Consists of name, value, and type. Multiple custom attributes are supported. For multiple attributes, conjunctive operator is checked for key search. Custom attributes name, value, and type are mandatory. The I_C_CreateCustomAttributeList and I_C_AddToAttributeList APIs can be used to create custom attribute list and to add multiple attributes in the list.Note: Use of "type" custom attribute is supported from CipherTrust Application Data Protection CAPI version 8.12.2 onward. |
| Conjunctive Operator | This operator is applied on custom attributes given in search criteria. Valid values:— AND: key should have all the attributes listed —OR: key should have any of the attributes listed |
| KeyOffset | This is an index of a key array received. From this index onward, the keys will be sent in response. For example: If there are total 10 keys and the offset is 2 then in response, keys will be listed starting from index 2 rather than 0. |
| Max Keys | Total keys received by the user in response starting from offset mentioned. |
| FingerPrint | Search on the basis of a fingerprint. |
In response, this API returns:
| Returned value | Description |
|---|---|
| Key names | Received in response in pKeyNamesList. |
| TotalKeyCount | Added in I_T_KeyNameAttributes structure. Total number of keys having attributes mentioned in the request. |
| KeyCount | Added in I_T_KeyNameAttributes structure. Number of keys received by you in response to total keys. |
