Index

A

B

batch operations
- ending with okvBatchFree 11.2.3
- executing with okvBatchExecute 11.2.2
- getting counts of batch operations with okvGetBatchOperationCount 11.2.4
- getting name of batch job number with okvGetBatchOperationName 11.2.5
- start of with okvBatchCreate 11.2.1

C

certificate
- request object 11.1.23
client SDK KMIP APIs
- about 11.1.1
connections
- creating with OKIConnConnec 8.1
- KMIP response messaging with okvConnSendRecvBytes 8.2
- KMIP response messaging with okvConnSet 8.3
- KMIP response messaging with okvConnUnSet 8.4
- OKI types 5.4
- removing with okvDisconnect 8.5
- SSL connection wallet, password 7.5
contact information
- adding with okvAttrAddContactInfo 12.1.10
- getting with okvAttrGetContactInfo 12.1.45
- length, getting with okvAttrGetContactInfoLen 12.1.46
cryptographic
- algorithm, adding with okvAttrAddCryptoAlgo 12.1.11
- algorithm, getting with okvAttrGetCryptoAlgo 12.1.47
- length, adding with okvAttrAddCryptoLen 12.1.12
- length, getting with okvAttrGetCryptoLen 12.1.48
- parameters, adding with okvAttrAddCryptoParams 12.1.13
- parameters, getting with okvAttrGetCryptoParams 12.1.49
- usage mask, adding with okvAttrAddCryptoUsageMask 12.1.14
- usage mask, getting with okvAttrGetCryptoUsageMask 12.1.50

D

data, opaque
- getting with okvGetOpaqueData 11.1.14
- registering with okvRegOpaqueData 11.1.25
data, secret
- getting with okvGetSecretData 11.1.17
- registering with okvRegSecretData 11.1.28
dates
- activation date, getting with okvAttrGetActivationDate 12.1.39
- adding activation date attribute with okvAttrAddActivationDate 12.1.5
- adding initial with okvCreateKeyPair 11.1.34
- adding initial with okvSign 11.1.32
- adding initial with okvSignatureVerify 11.1.33
- adding initial with OKVSignResponse 6.2.14
- adding initial with OKVSignVerifyResponse 6.2.15
- archive date, getting with okvAttrGetArchiveDate 12.1.40
- compromise date, adding with okvAttrAddCompromiseDate 12.1.8
- compromise date, getting with okvAttrGetCompromiseDate 12.1.43
- compromise occurrence date, adding with okvAttrAddCompromiseOccurrenceDate 12.1.9
- compromise occurrence date, getting with okvAttrGetCompromiseOccurrenceDate 12.1.44
- deactivation date, adding with okvAttrAddDeactivationDate 12.1.15
- deactivation date, getting with okvAttrGetDeactivationDate 12.1.51
- destroy date, adding with okvAttrAddDestroyDate 12.1.16
- destroy date, getting with okvAttrGetDestroyDate 12.1.52
- initial, getting with okvAttrGetInitialDate 12.1.58
- last change, with with okvAttrGetLastChangeDate 12.1.59
- okvCustomAttrAddDateTime 12.2.4
- okvCustomAttrGetDateTime 12.2.17
- process start date, adding with okvAttrAddProcessStartDate 12.1.28
- process start date, getting with okvAttrGetProcessStartDate 12.1.67
- process stop date, getting with okvAttrGetProtectStopDate 12.1.68
- protect stop date, adding with okvAttrAddProtectStopDate 12.1.29
digest
- adding with okvAttrAddDigest 12.1.17
- digest attribute, getting with okvAttrGetDigest 12.1.53
- length, getting with okvAttrGetDigestLen 12.1.54
downloading SDK software 4.2

E

element index
- about 12.1.2
ending Oracle Key Vault Interface environment, okvEnvFree 7.2
endpoints
- SDK program behavior, OKVEnv 6.2.6
- SDK program behavior, okvEnvCreate 7.1
error handling
- capturing errors with OKVErr 6.2.7
- depth of error stack for batch job with okvErrGetDepthForBatch 10.2
- depth of error stack with okvErrGetDepth 10.1
- error at depth with okvErrGetNumAtDepth 10.4
- error number at specified depth of error stack with okvErrGetNumAtDepthForBatch 10.5
- error number for batch with okvErrGetNumForBatch 10.6
- get error number with okvErrGetNum 10.3
- reset error stack with okvErrReset 10.7
- text of error with okvGetTextForErrNum 10.8
extractable
- extractable attribute, getting with okvAttrGetExtractable 12.1.56

F

freeing Oracle Key Vault Interface TTLV descriptor, okvEnvFreeResultObj 7.3
fresh attributes
- adding with okvAttrAddFresh 12.1.20
- getting with okvAttrGetFresh 12.1.57

J

Java packages
- enum class, in oracle.okv.kmip 16.2
- exceptions, in oracle.okv.exception 16.1
- OKVBatchOperation class, in oracle.okv.operation 16.3
- OKVService class, in oracle.okv.service 16.5
- response classes, in oracle.okv.response 16.4

K

keys
- creating KMIP key object with okvCreateKey 11.1.4
- getting symmetric keys with okvGetKey 11.1.13
- registering symmetric 11.1.24
- rekeying with okvRekey 11.1.30
KMIP features
- supported managed objects 3.3
- supported operations 3.4
- supported profiles 3.2
- supported version 3.1
- used with Oracle Key Vault client SDK 3
KMIP objects
- activating with okvActivate 11.1.2
- adding attributes with okvAddAttribute 11.1.3
- certificate request operations with okvRegCertificateRequest 11.1.23
- creating key with okvCreateKey 11.1.4
- decrypting with okvDecrypt 11.1.5
- deleting attributes with okvDeleteAttribute 11.1.6
- destroying with okvDestroy 11.1.7
- encrypting with okvEncrypt 11.1.8
- getting attribute list with okvGetAttributeList 11.1.9
- getting attributes with okvGetAttributes 11.1.10
- getting certificate request with okvGetCertificateRequest 11.1.12
- getting certificate with okvGetCertificate 11.1.11
- getting opaque data with okvGetOpaqueData 11.1.14
- getting private key with okvGetPrivateKey 11.1.15
- getting public key with okvGetPublicKey 11.1.16
- getting secret data with okvGetSecretData 11.1.17
- getting symmetric key objects with okvGetKey 11.1.13
- getting template objects with okvGetTemplate 11.1.18
- implementing locate operations with okvLocate 11.1.19
- modifying attributes with okvModifyAttribute 11.1.20
- opaque data object register operations with okvRegOpaqueData 11.1.25
- querying with okvQueryCapability 11.1.21
- register certificate with okvRegCertificate 11.1.22
- register private key with okvRegPrivateKey 11.1.26
- register public key with okvRegPublicKey 11.1.27
- rekey operations with okvRekey 11.1.30
- revoke operations with okvRevoke 11.1.31
- secret data object register operations with okvRegSecretData 11.1.28
- symmetric key object register operations with okvRegKey 11.1.24
- template object register operations with okvRegTemplate 11.1.29

L

length
- certificate length, getting with okvAttrGetCertLen 12.1.41

M

memory management
- memory management context with OKVMemoryCtx 6.2.8
- memory re-allocation with okvRealloc 9.3
- pointer to memory allocation program with okvMalloc 9.2
- pointer to memory freeing program with okvFree 9.1

N

names
- adding with okvAttrAddName 12.1.24
- attribute, name, and index, getting with okvGetAttributeObject 12.1.86
- getting name, index attribute with okvAttrGetName 12.1.61
- getting name, index length attribute with okvAttrGetNameValueLen 12.1.62
never extractable
- adding with okvAttrAddNeverExtractable 12.1.25
- getting never extractable attribute with okvAttrGetNeverExtractable 12.1.63

O

P

passwords
- SSL connection wallet, okvEnvSetConfig 7.5

Q

queries
- okvQueryCapability 11.1.21

R

revokes
- okvRevoke 11.1.31
- reason, getting with okvAttrGetRevocationReason 12.1.69
- reason message length, getting with okvAttrGetRevocationReasonMessageLen 12.1.70
- revocation reason, adding with okvAttrAddRevocationReason 12.1.30

S

sessions
- Oracle Key Vault program 5.5
state
- attribute, getting with okvAttrGetState 12.1.71

T

templates
- getting with okvGetTemplate 11.1.18
- registering with okvRegTemplate 11.1.29
time
- lease time, adding with okvAttrAddLeaseTime 12.1.23
- lease time, getting with okvAttrGetLeaseTime 12.1.60
- okvCustomAttrAddDateTime 12.2.4
- okvCustomAttrGetDateTime 12.2.17
trace files
- location of, using okvEnvSetTrace 7.6
TTLV (tag type length value)
- freeing TTLV descriptor, okvEnvFreeResultObj 7.3
- root of Oracle Key Vault Interface TTLV descriptor, okvEnvGetOpRequestObj 7.4
TTLV objects
- about 14.1
- child TTLV object, creating with okvTTLVAddToObject 14.2
- child TTLV object, creating with okvTTLVAddToObjectByTag 14.3
- child TTLV object, getting with okvTTLVGetChild 14.4
- child TTLV object, getting with tag using OKITTLVGetChild 14.5
- first child TTLV object, getting with okvTTLVGetFirstChildByTag 14.8
- length value of TTLV object, getting with okvTTLVGetLen 14.9
- number of child TTLV objects, getting of parent with okvTTLVGetChildCountByTag 14.7
- number of child TTLV objects, getting with okvTTLVGetChildCount 14.6
- Oracle Key Vault structure, defining with OKVTTLV 6.2.13
- tag value of TTLV object, getting with okvTTLVGetTag 14.12
- TTLV child attributes, converting with OKIAttrExtractTTLV 15.3
- TTLV child attributes, converting with okvAttrExtractTTLV 15.2
- TTLV object pointer, getting with okvTTLVGetValue 14.14
- TTLV object type value, getting with okvTTLVGetType 14.13
- TTLV object value, getting with okvTTLVGetValueCopy 14.15
- TTLV request object, getting with okvTTLVGetRequest 14.10
- TTLV response object, getting with okvTTLVGetResponse 14.11
type
- certificate type, getting with okvAttrGetCertType 12.1.42

U

unique IDs
- adding with okvAttrAddUniqueID 12.1.32
- attribute, getting with okvAttrGetUniqueID 12.1.72
- length, getting with okvAttrGetUniqueIDLen 12.1.73
usage
- limits, adding with okvAttrAddUsageLimits 12.1.33
- limits, getting with okvAttrGetUsageLimits 12.1.74
utility APIs
- about 15.1
- collection of KMIP attributes with OKVAttr 6.2.1
- creating crypto context, creating with okvGetTextForTag 15.4
- creating decrypt response structure, creating with okvDecryptResponseCreate 15.22
- creating encrypt response structure, creating with okvEncryptResponseCreate 15.24
- freeing crypto context, freeing with okvCryptoContextFree 15.5
- freeing decrypt response structure, freeing with okvDecryptResponseFree 15.23
- freeing memory for encrypt response structure, freeing with okvEncryptResponseFree 15.25
- getting authenticated encryption additional data, getting with okvCryptoContextGetAuthEncryptionAdditionalData 15.6
- getting authenticated encryption tag, getting with okvCryptoContextGetAuthEncryptionTag 15.7
- getting authenticated encryption value, getting with okvCryptoResponseGetAuthEncryptionTag 15.18
- getting block cipher mode, getting with okvCryptoContextGetBlockCipherMode 15.8
- getting decrypted data from response structure, getting with okvCryptoResponseGetDecryptedData 15.19
- getting encrypted data from response structure, getting with okvCryptoResponseGetEncryptedData 15.20
- getting IV parameter, getting with okvCryptoContextGetIV 15.9
- getting IV value from encrypt response structure, getting with okvCryptoResponseGetIV 15.21
- getting padding IV parameter, getting with okvCryptoContextGetRandomIV 15.11
- getting padding parameter, getting with okvCryptoContextGetPadding 15.10
- name of KMIP tag, getting with okvGetTextForTag 15.27
- name of KMIP tag enumerated value, getting with okvGetTextForTagEnum 15.28
- name of KMIP type, okvGetTextForTagType 15.29
- OKIAttr to TTLV structure, converting with okvAttrMakeTTLV 15.3
- setting authenticated encryption additional data, setting with okvCryptoContextSetAuthEncryptionAdditionalData 15.12
- setting authenticated encryption tag, setting with okvCryptoContextSetAuthEncryptionTag 15.13
- setting block cipher mode, setting with okvCryptoContextSetBlockCipherMode 15.14
- setting IV parameter, setting with okvCryptoContextSetIV 15.15
- setting padding parameter, setting with okvCryptoContextSetPadding 15.16
- setting random IV parameter, setting with okvCryptoContextSetRandomIV 15.17
- TTLV child attributes, converting with okvAttrExtractTTLV 15.2

X

X.509 certificate
- add certificate ID, adding with okvAttrAddX509CertId 12.1.34
- add certificate issuer, adding with okvAttrAddX509CertIss 12.1.35
- add certificate issuer alternate name, adding withokvAttrAddX509CertIssAltName 12.1.36
- add certificate subject, adding with okvAttrAddX509CertSubj 12.1.37
- add certificate subject alternate name, adding with okvAttrAddX509CertSubjAltName 12.1.38
- get certificate ID, getting with okvAttrGetX509CertId 12.1.75
- get certificate ID issurer length, getting with okvAttrGetX509CertIdIssuerLen 12.1.76
- get certificate ID serial number length, getting with okvAttrGetX509CertIdSerialNoLen 12.1.77
- get certificate issurer, getting with okvAttrGetX509CertIss 12.1.78
- get certificate issurer alternate name, getting with okvAttrGetX509CertIssAltName 12.1.79
- get certificate issurer alternate name length, getting with okvAttrGetX509CertIssAltNameLen 12.1.80
- get certificate issurer distinguished name length, getting with okvAttrGetX509CertIssDNLen 12.1.81
- get certificate subject, getting with okvAttrGetX509CertSubj 12.1.82
- get certificate subject alternate name, getting with okvAttrGetX509CertSubjAltName 12.1.83
- get certificate subject alternate name length, getting with okvAttrGetX509CertSubjAltNameLen 12.1.84
- get certificate subject distinguished name length, getting with okvAttrGetX509CertSubjDNLen 12.1.85