Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Related Documents
  • Conventions
• Part I Introduction to the Oracle Key Vault Client SDK
  • Changes in This Release
    • Changes for Oracle Key Vault Client SDK Release 21.6
      • Support for Sign and Signature Verify Operations
      • Ability to Control the Extraction of Private Keys from Oracle Key Vault
    • Changes for Oracle Key Vault Client SDK Release 21.5
    • Changes for Oracle Key Vault Client SDK Release 21.4
      • C and Java SDK APIs for Cryptographic Operations
      • Client Endpoint File Updated When A KMIP Server Operation Is Executed Using SDK
      • Ability to Control the Extraction of Symmetric Encryption Keys from Oracle Key Vault
    • Changes for Oracle Key Vault Client SDK Release 21.3
    • Changes for Oracle Key Vault Client SDK Release 21.2
      • New C and Java SDK APIs for Certificates, Certificate Requests, Private Keys, and Public Keys
  • Getting Started with the Oracle Key Vault Client SDK
    • About Getting Started with the Oracle Key Vault Client SDK
    • Who Should Use This Guide
    • Platforms Supported
    • Advantages of Using the Oracle Key Vault Client SDK
  • KMIP Features of the Oracle Key Vault Client SDK
    • KMIP Version
    • KMIP Profile Support
    • KMIP Managed Objects
    • KMIP Operations
  • Setting Up the Oracle Key Vault SDK
    • Enrolling an Endpoint
    • Downloading the C or Java SDK Software
    • Contents of the C SDK File
    • Contents of the Java SDK File
  • Oracle Key Vault Client SDK Program Structure
    • About the Oracle Key Vault Client SDK Program Structure
    • Oracle Key Vault Program Flow
      • Basic Program Flow
      • Advanced Program Flow
        • Oracle Key Vault Program with Batching
        • Detailed Oracle Key Vault Program
    • Oracle Key Vault Program Environment
    • Oracle Key Vault Program Connection
    • Oracle Key Vault Program Session
• Part II Oracle Key Vault Client C SDK API Reference
  • Oracle Key Vault Datatypes and Structures
    • Oracle Key Vault Datatypes
    • Oracle Key Vault Structures and Enumerations
      • OKVAttr
      • OKVAttrNo
      • OKVCryptoContext
      • OKVDecryptResponse
      • OKVEncryptResponse
      • OKVEnv
      • OKVErr
      • OKVMemoryCtx
      • OKVObjNo
      • OKVOps
      • OKVOpsNo
      • OKVServerInformation
      • OKVTTLV
      • OKVSignResponse
      • OKVSignVerifyResponse
  • Oracle Key Vault Client SDK Management APIs
    • okvEnvCreate
    • okvEnvFree
    • okvEnvFreeResultObj
    • okvEnvGetOpRequestObj
    • okvEnvSetConfig
    • okvEnvSetTrace
  • Oracle Key Vault Client SDK Connection Management APIs
    • okvConnect
    • okvConnSendRecvBytes
    • okvConnSet
    • okvConnUnSet
    • okvDisconnect
  • Oracle Key Vault Client SDK Memory Management APIs
    • okvFree
    • okvMalloc
    • okvRealloc
  • Oracle Key Vault Client SDK Error Handling APIs
    • okvErrGetDepth
    • okvErrGetDepthForBatch
    • okvErrGetNum
    • okvErrGetNumAtDepth
    • okvErrGetNumAtDepthForBatch
    • okvErrGetNumForBatch
    • okvErrReset
    • okvGetTextForErrNum
  • Oracle Key Vault Client SDK KMIP and Batch APIs
    • Oracle Key Vault Client SDK KMIP APIs
      • About the Oracle Key Vault Client SDK KMIP APIs
      • okvActivate
      • okvAddAttribute
      • okvCreateKey
      • okvDecrypt
      • okvDeleteAttribute
      • okvDestroy
      • okvEncrypt
      • okvGetAttributeList
      • okvGetAttributes
      • okvGetCertificate
      • okvGetCertificateRequest
      • okvGetKey
      • okvGetOpaqueData
      • okvGetPrivateKey
      • okvGetPublicKey
      • okvGetSecretData
      • okvGetTemplate
      • okvLocate
      • okvModifyAttribute
      • okvQueryCapability
      • okvRegCertificate
      • okvRegCertificateRequest
      • okvRegOpaqueData
      • okvRegKey
      • okvRegPrivateKey
      • okvRegPublicKey
      • okvRegSecretData
      • okvRegTemplate
      • okvRekey
      • okvRevoke
      • okvSign
      • okvSignVerify
      • okvCreateKeyPair
    • Oracle Key Vault Client SDK Batch APIs
      • okvBatchCreate
      • okvBatchExecute
      • okvBatchFree
      • okvGetBatchOperationCount
      • okvGetBatchOperationName
  • Oracle Key Vault Client SDK KMIP Attributes and Custom Attributes APIs
    • Oracle Key Vault Client SDK KMIP Attribute APIs
      • About the Oracle Key Vault KMIP Attribute APIs
      • Attribute Index and Element Index
      • okvAttrAddArchiveDate
      • okvAddAttributeObject
      • okvAttrAddActivationDate
      • okvAttrAddCertLen
      • okvAttrAddCertType
      • okvAttrAddCompromiseDate
      • okvAttrAddCompromiseOccurrenceDate
      • okvAttrAddContactInfo
      • okvAttrAddCryptoAlgo
      • okvAttrAddCryptoLen
      • okvAttrAddCryptoParams
      • okvAttrAddCryptoUsageMask
      • okvAttrAddDeactivationDate
      • okvAttrAddDestroyDate
      • okvAttrAddDigest
      • okvAttrAddDigitalSignAlgo
      • okvAttrAddExtractable
      • okvAttrAddFresh
      • okvAttrAddInitialDate
      • okvAttrAddLastChangeDate
      • okvAttrAddLeaseTime
      • okvAttrAddName
      • okvAttrAddNeverExtractable
      • okvAttrAddObjectGroup
      • okvAttrAddObjectType
      • okvAttrAddProcessStartDate
      • okvAttrAddProtectStopDate
      • okvAttrAddRevocationReason
      • okvAttrAddState
      • okvAttrAddUniqueID
      • okvAttrAddUsageLimits
      • okvAttrAddX509CertId
      • okvAttrAddX509CertIss
      • okvAttrAddX509CertIssAltName
      • okvAttrAddX509CertSubj
      • okvAttrAddX509CertSubjAltName
      • okvAttrGetActivationDate
      • okvAttrGetArchiveDate
      • okvAttrGetCertLen
      • okvAttrGetCertType
      • okvAttrGetCompromiseDate
      • okvAttrGetCompromiseOccurrenceDate
      • okvAttrGetContactInfo
      • okvAttrGetContactInfoLen
      • okvAttrGetCryptoAlgo
      • okvAttrGetCryptoLen
      • okvAttrGetCryptoParams
      • okvAttrGetCryptoUsageMask
      • okvAttrGetDeactivationDate
      • okvAttrGetDestroyDate
      • okvAttrGetDigest
      • okvAttrGetDigestLen
      • okvAttrGetDigitalSignAlgo
      • okvAttrGetExtractable
      • okvAttrGetFresh
      • okvAttrGetInitialDate
      • okvAttrGetLastChangeDate
      • okvAttrGetLeaseTime
      • okvAttrGetName
      • okvAttrGetNameValueLen
      • okvAttrGetNeverExtractable
      • okvAttrGetObjectGroup
      • okvAttrGetObjectGroupLen
      • okvAttrGetObjectType
      • okvAttrGetProcessStartDate
      • okvAttrGetProtectStopDate
      • okvAttrGetRevocationReason
      • okvAttrGetRevocationReasonMessageLen
      • okvAttrGetState
      • okvAttrGetUniqueID
      • okvAttrGetUniqueIDLen
      • okvAttrGetUsageLimits
      • okvAttrGetX509CertId
      • okvAttrGetX509CertIdIssuerLen
      • okvAttrGetX509CertIdSerialNoLen
      • okvAttrGetX509CertIss
      • okvAttrGetX509CertIssAltName
      • okvAttrGetX509CertIssAltNameLen
      • okvAttrGetX509CertIssDNLen
      • okvAttrGetX509CertSubj
      • okvAttrGetX509CertSubjAltName
      • okvAttrGetX509CertSubjAltNameLen
      • okvAttrGetX509CertSubjDNLen
      • okvGetAttributeObject
    • Oracle Key Vault Client SDK KMIP Custom Attribute APIs
      • About the KMIP Custom Attributes API
      • okvCustomAttrAddBigInteger
      • okvCustomAttrAddBoolean
      • okvCustomAttrAddByteString
      • okvCustomAttrAddDateTime
      • okvCustomAttrAddEnum
      • okvCustomAttrAddInteger
      • okvCustomAttrAddInterval
      • okvCustomAttrAddLongInteger
      • okvCustomAttrAddStructure
      • okvCustomAttrAddTextString
      • okvCustomAttrGet
      • okvCustomAttrGetBigInteger
      • okvCustomAttrGetBigIntegerLen
      • okvCustomAttrGetBoolean
      • okvCustomAttrGetByName
      • okvCustomAttrGetByteString
      • okvCustomAttrGetByteStringLen
      • okvCustomAttrGetByType
      • okvCustomAttrGetDateTime
      • okvCustomAttrGetEnum
      • okvCustomAttrGetInteger
      • okvCustomAttrGetInterval
      • okvCustomAttrGetLongInteger
      • okvCustomAttrGetStructure
      • okvCustomAttrGetTextString
      • okvCustomAttrGetTextStringLen
  • Oracle Key Vault Client SDK Extension Operation Management APIs
    • About the Oracle Key Vault Client SDK Extension Operation Management APIs
    • okvOpsCreate
    • okvOpsExecuteOp
    • okvOpsFree
  • Oracle Key Vault Client SDK TTLV Object APIs
    • About the Oracle Key Vault Client SDK TTLV Object APIs
    • okvTTLVAddToObject
    • okvTTLVAddToObjectByTag
    • okvTTLVGetChild
    • okvTTLVGetChildByTag
    • okvTTLVGetChildCount
    • okvTTLVGetChildCountByTag
    • okvTTLVGetFirstChildByTag
    • okvTTLVGetLen
    • okvTTLVGetRequest
    • okvTTLVGetResponse
    • okvTTLVGetTag
    • okvTTLVGetType
    • okvTTLVGetValue
    • okvTTLVGetValueCopy
  • Oracle Key Vault Client SDK Utility APIs
    • About the Oracle Key Vault Client SDK Utility APIs
    • okvAttrExtractTTLV
    • okvAttrMakeTTLV
    • okvCryptoContextCreate
    • okvCryptoContextFree
    • okvCryptoContextGetAuthEncryptionAdditionalData
    • okvCryptoContextGetAuthEncryptionTag
    • okvCryptoContextGetBlockCipherMode
    • okvCryptoContextGetIV
    • okvCryptoContextGetPadding
    • okvCryptoContextGetRandomIV
    • okvCryptoContextSetAuthEncryptionAdditionalData
    • okvCryptoContextSetAuthEncryptionTag
    • okvCryptoContextSetBlockCipherMode
    • okvCryptoContextSetIV
    • okvCryptoContextSetPadding
    • okvCryptoContextSetRandomIV
    • okvCryptoResponseGetAuthEncryptionTag
    • okvCryptoResponseGetDecryptedData
    • okvCryptoResponseGetEncryptedData
    • okvCryptoResponseGetIV
    • okvDecryptResponseCreate
    • okvDecryptResponseFree
    • okvEncryptResponseCreate
    • okvEncryptResponseFree
    • okvGetTextForAttributeNum
    • okvGetTextForTag
    • okvGetTextForTagEnum
    • okvGetTextForTagType
    • okvGetTextLenForAttributeNum
    • okvObjGetAttrNo
    • okvCryptoContextSetCryptoAlgo
    • okvCryptoContextSetHashingAlgo
    • okvCryptoContextSetDigitalSignAlgo
    • okvCryptoContextGetCryptoAlgo
    • okvCryptoContextGetHashingAlgo
    • okvCryptoContextGetDigitalSignAlgo
    • okvCryptoResponseGetSignatureData
    • okvCryptoResponseGetRecoveredData
    • okvCryptoResponseGetValidity
    • okvSignResponseCreate
    • okvSignResponseFree
    • okvSignVerifyResponseCreate
    • okvSignVerifyResponseFree
• Part III Oracle Key Vault Client Java SDK API Reference
  • Oracle Key Vault Java SDK Packages
    • oracle.okv.exception Java Package
    • oracle.okv.kmip Java Package
    • oracle.okv.operation Java Package
    • oracle.okv.response Java Package
    • oracle.okv.service Java Package
  • Oracle Key Vault Java SDK APIs
    • Java SDK Management APIs
    • Java SDK Connection Management APIs
    • Java SDK KMIP APIs
    • Java SDK KMIP Batch APIs
    • Java SDK KMIP Attribute APIs
    • Java SDK KMIP Custom Attribute APIs
    • Java SDK Extension Operation Management APIs
    • Java SDK TTLV Object APIs
    • Java SDK Utility APIs
• Part IV Oracle Key Vault Client SDK Troubleshooting
  • Troubleshooting