Dogtag Python Client API¶
Dogtag is an enterprise software system designed to manage enterprise Public Key Infrastructure (PKI) deployments. These pages document the Python client API that can be used to interact with Dogtag’s REST API to request and issue certificates, store secrets in the KRA etc.
- pki Package
pkiPackageAttributeAttributeListBadRequestExceptionCertNotFoundExceptionConflictingOperationExceptionFIPSForbiddenExceptionGroupNotFoundExceptionHTTPGoneExceptionKeyNotFoundExceptionPKIExceptionProfileNotFoundExceptionPropertyFileRequestNotFoundExceptionResourceMessageResourceNotFoundExceptionUnauthorizedExceptionUserNotFoundExceptionconvert_x509_name_to_dn()generate_password()get_info()handle_exceptions()implementation_version()specification_version()
accountModulecertModuleCertClientCertClient.approve_request()CertClient.assign_request()CertClient.cancel_request()CertClient.create_enrollment_request()CertClient.enroll_cert()CertClient.get_cert()CertClient.get_enrollment_template()CertClient.get_request()CertClient.hold_cert()CertClient.list_certs()CertClient.list_enrollment_templates()CertClient.list_requests()CertClient.reject_request()CertClient.review_cert()CertClient.review_request()CertClient.revoke_ca_cert()CertClient.revoke_cert()CertClient.submit_enrollment_request()CertClient.unassign_request()CertClient.unrevoke_cert()CertClient.update_request()CertClient.validate_request()
CertDataCertDataInfoCertDataInfoCollectionCertEnrollmentRequestCertEnrollmentResultCertRequestInfoCertRequestInfoCollectionCertRequestStatusCertReviewResponseCertRevokeRequestCertSearchRequestmain()
clientModulecryptoModuleCryptoProviderCryptoProvider.asymmetric_wrap()CryptoProvider.generate_nonce_iv()CryptoProvider.generate_session_key()CryptoProvider.generate_symmetric_key()CryptoProvider.get_cert()CryptoProvider.get_supported_algorithm_keyset()CryptoProvider.initialize()CryptoProvider.key_unwrap()CryptoProvider.set_algorithm_keyset()CryptoProvider.symmetric_unwrap()CryptoProvider.symmetric_wrap()
CryptographyCryptoProviderCryptographyCryptoProvider.asymmetric_wrap()CryptographyCryptoProvider.generate_nonce_iv()CryptographyCryptoProvider.generate_session_key()CryptographyCryptoProvider.generate_symmetric_key()CryptographyCryptoProvider.get_cert()CryptographyCryptoProvider.get_supported_algorithm_keyset()CryptographyCryptoProvider.initialize()CryptographyCryptoProvider.key_unwrap()CryptographyCryptoProvider.set_algorithm_keyset()CryptographyCryptoProvider.symmetric_unwrap()CryptographyCryptoProvider.symmetric_wrap()
encoderModulekeyModuleAsymKeyGenerationRequestAsymKeyGenerationRequest.DECRYPT_USAGEAsymKeyGenerationRequest.DERIVE_USAGEAsymKeyGenerationRequest.ENCRYPT_USAGEAsymKeyGenerationRequest.SIGN_RECOVER_USAGEAsymKeyGenerationRequest.SIGN_USAGEAsymKeyGenerationRequest.UNWRAP_USAGEAsymKeyGenerationRequest.VERIFY_RECOVER_USAGEAsymKeyGenerationRequest.VERIFY_USAGEAsymKeyGenerationRequest.WRAP_USAGE
KeyKeyArchivalRequestKeyClientKeyClient.AES_ALGORITHMKeyClient.ASYMMETRIC_KEY_TYPEKeyClient.DES3_ALGORITHMKeyClient.DESEDE_ALGORITHMKeyClient.DES_ALGORITHMKeyClient.DSA_ALGORITHMKeyClient.KEY_STATUS_ACTIVEKeyClient.KEY_STATUS_INACTIVEKeyClient.PASS_PHRASE_TYPEKeyClient.RC2_ALGORITHMKeyClient.RC4_ALGORITHMKeyClient.RSA_ALGORITHMKeyClient.SYMMETRIC_KEY_TYPEKeyClient.approve_request()KeyClient.archive_encrypted_data()KeyClient.archive_key()KeyClient.archive_pki_options()KeyClient.cancel_request()KeyClient.generate_asymmetric_key()KeyClient.generate_symmetric_key()KeyClient.get_active_key_info()KeyClient.get_client_keyset()KeyClient.get_key_info()KeyClient.get_request_info()KeyClient.get_server_keyset()KeyClient.get_transport_cert()KeyClient.list_keys()KeyClient.list_requests()KeyClient.modify_key_status()KeyClient.process_returned_key()KeyClient.recover_key()KeyClient.reject_request()KeyClient.retrieve_key()KeyClient.retrieve_key_by_passphrase()KeyClient.retrieve_key_by_pkcs12()KeyClient.retrieve_key_data()KeyClient.set_crypto_algorithms()KeyClient.set_transport_cert()KeyClient.submit_request()
KeyDataKeyInfoKeyInfoCollectionKeyRecoveryRequestKeyRequestInfoKeyRequestInfoCollectionKeyRequestResponseRequestIdSymKeyGenerationRequestmain()
kraModuleprofileModulesystemModulesystemcertModuleupgradeModulePKIUpgradeScriptletPKIUpgradeTrackerPKIUpgraderPKIUpgrader.all_versions()PKIUpgrader.backup()PKIUpgrader.copydirs()PKIUpgrader.copyfile()PKIUpgrader.get_current_version()PKIUpgrader.get_target_version()PKIUpgrader.get_tracker()PKIUpgrader.init_scriptlet()PKIUpgrader.is_complete()PKIUpgrader.makedirs()PKIUpgrader.record()PKIUpgrader.remove_tracker()PKIUpgrader.reset_tracker()PKIUpgrader.revert()PKIUpgrader.revert_scriptlet()PKIUpgrader.revert_version()PKIUpgrader.run_scriptlet()PKIUpgrader.scriptlets()PKIUpgrader.set_tracker()PKIUpgrader.show_tracker()PKIUpgrader.status()PKIUpgrader.touch()PKIUpgrader.update_tracker()PKIUpgrader.upgrade()PKIUpgrader.upgrade_version()PKIUpgrader.validate()PKIUpgrader.version_dir()PKIUpgrader.versions()
utilModule