KMES integration guides overview
14 min
the {{k3}} integration guide provides detailed technical documentation on integrating third party applications with the {{futurex}} {{k3}} these guides result from our rigorous certification process in which our integration engineering team thoroughly tests and validates each integration in a lab environment before certifying it for customer deployment each integration guide is specific to a particular third party application and explains how to integrate those applications with the {{k3}} by using supported protocols such as pkcs #11, microsoft cng, jce, openssl engine, kmip, and more this guide assumes you have a solid technical understanding of the third party applications, cryptographic concepts, and basic networking futurex certification process the {{futurex}} certification process is a rigorous and standardized approach to testing and certifying integrations between third party applications and {{futurex}} hsms and key management servers (such as {{k3}} ) the certification process ensures that we fully test and validate third party application integrations in a lab environment before deploying them in a production environment our integration engineering team implements this process so that you can be confident that third party applications integrate seamlessly with {{futurex}} hsms and {{k3}} devices and that all operations result in the expected behavior the certification process involves several steps, including research, testing, troubleshooting, and certification, and is fully documented in an integration guide for each integration the full process includes the following steps research the third party application to gain a general understanding of the solution and the protocol it uses to integrate with an hsm or kms device (such as pkcs #11, microsoft cng, jce, openssl engine, and kmip) determine the scope of the third party application use of the hsm or kms device, including the specific functionalities it uses (for example, data encryption, key protection, entropy, and so on) install and configure the third party application in a lab environment, where all testing and validation take place establish a connection between the third party application and the {{futurex}} device, which typically involves configuring tls certificates and creating roles and identities that the third party application uses to connect and authenticate to the {{futurex}} device initiate a request from the third party application to the {{futurex}} device, such as generating keys or certificates, encrypting or decrypting data, or performing other cryptographic functions if any errors occur during the testing process, the integration engineering team diagnoses the issues and takes necessary corrective actions if necessary, the team also documents the errors by creating engineering change requests (ecrs) to ensure all issues are addressed and resolved before certification after any necessary engineering changes have been made, the team performs a new end to end test to ensure that all errors are resolved and all operations are successful certify the integration by creating an integration guide that covers all necessary prerequisites, lists configurations required in both the third party application and the {{futurex}} device, and provides instructions to test functionality by following these steps, we ensure that the integration between the third party application and the {{fu}} device is fully tested and validated and that we resolve any errors or issues before we certify the integration as fully supported integration guide organization the typical flow of our integration guides is as follows before you start covers supported hardware models, os versions, third party software, and other prerequisites configure the futurex device provides detailed step by step instructions on setting up the hsm device for the integration this includes network setup, loading major keys, configuring policies and permissions, and setting up authentication by using tls certificates or shared secrets configure the third party application shows how to configure the application to connect to the futurex device and use its cryptographic functionalities test the integration provides test cases and expected results to validate that the integration works end to end for key use cases properly troubleshoot common issues offers tips for diagnosing and resolving common errors or issues seen with the integration integration guides by application a apache http server docid\ qlijqjpxthlovl ewj0lg ansible docid\ seb4shvj71onh5czogsfb aws byok docid\ tufgk3yldqugd5abw4ngl azure byok docid\ ebmvthx1djlrugxq0o2qe b bitwarden docid\ gcsgzqxwqsqv6p6wd6uni c cyberark privileged access docid\ du9jryxyh4ekbcpfywgny d digicert docid\ v7v4o5o3sld2lkcqovc0h e encrypted file transport docid\ xpii11elo5byybrpn1wvw encrypted key loading docid\ kc98dilo6ushjm syhuz9 external key migration docid 5castbzih17jd1w0u8ji8 f file encryption docid\ ilxztkrvd4mji9jap6toh futurex offline root ca docid\ a3lhs5zqk4d3ve7usc04i futurex online issuing ca docid\ kchdetr qpsebrw miytm g generic futurex pkcs #11 docid\ qeux9j7wat0besjno6bz6 generic kmip docid\ xv5oioc3y9t7n5cygd34o generic scep docid\ mq0wwbwlqhehxaeyvwsbz google cloud ekm (external key manager) docid\ wwakhg 1 zht0qh9eghy0 google workspace client side encryption docid\ ifwjonir0sd5v1 cascz9 h automatic unseal, seal wrap, and entropy augmentation docid 8vwiop5pm5bh5ma5wwsck hashicorp vault managed keys docid\ vbxlemthlgydgzakbcaqv pkcs #12 secret export docid\ kuzbyptjouiz03e8pi5 e i ibm db2 docid\ s6ws phaeat urgmtahb2 j java jarsigner docid\ d0tcix9crd6shwkbpyb3k jenkins code signing docid\ plzk0s4 qqzng86el0f0p k key labeling docid 7hup0xnh6oylfq0thholi m microsoft adcs docid\ x6 2xo 2gqxuewhmdz6tx microsoft ad rms docid\ wxszkowq6qnxv3271 cys microsoft intune docid dtip5uwoe0v1umupixbv microsoft signtool docid\ sgcmilfjrk63tvvjyu8oy microsoft sql server docid\ wprzm5llca0h3feccgogu mongodb docid ysvbacr6ulawuwkxud3m mysql enterprise tde docid\ l3hiun m2872ehwud0j6e n nginx docid\ kk akmcy6d0fdjy8wu9ll o oracle database tde docid\ zqotqroxyy9fx39uwd9ec p pure storage flasharray docid\ fhxiek3fzcd5mzangemdd r red hat certificate system (rhcs) docid\ igphi5a8mwzovfgkgqgy3 s ssh key offloading docid\ ztwzyq ccxiafptkbh4bq t truenas docid\ hnyljavpei6uysetzgbyy v venafi adaptable ca docid 4bdrh6t342sqge2skpklm venafi control plane for machine identities docid 7pntmbwnxk aiu9v1o5xr versasec vsec\ cms docid\ qmqhv5olf03ulimmwunt0 vmware vsphere docid\ ex9hs zbhk1ngs93quqtc z zettaset xcrypt full disk docid\ ba9ryp0gfjxwetjtvamuw