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
pki
PackageAttribute
AttributeList
BadRequestException
CertNotFoundException
ConflictingOperationException
FIPS
ForbiddenException
GroupNotFoundException
HTTPGoneException
KeyNotFoundException
PKIException
ProfileNotFoundException
PropertyFile
RequestNotFoundException
ResourceMessage
ResourceNotFoundException
UnauthorizedException
UserNotFoundException
convert_x509_name_to_dn()
generate_password()
get_info()
handle_exceptions()
implementation_version()
specification_version()
account
Modulecert
ModuleCertClient
CertClient.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()
CertData
CertDataInfo
CertDataInfoCollection
CertEnrollmentRequest
CertEnrollmentResult
CertRequestInfo
CertRequestInfoCollection
CertRequestStatus
CertReviewResponse
CertRevokeRequest
CertSearchRequest
main()
client
Modulecrypto
ModuleCryptoProvider
CryptoProvider.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()
CryptographyCryptoProvider
CryptographyCryptoProvider.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()
encoder
Modulekey
ModuleAsymKeyGenerationRequest
AsymKeyGenerationRequest.DECRYPT_USAGE
AsymKeyGenerationRequest.DERIVE_USAGE
AsymKeyGenerationRequest.ENCRYPT_USAGE
AsymKeyGenerationRequest.SIGN_RECOVER_USAGE
AsymKeyGenerationRequest.SIGN_USAGE
AsymKeyGenerationRequest.UNWRAP_USAGE
AsymKeyGenerationRequest.VERIFY_RECOVER_USAGE
AsymKeyGenerationRequest.VERIFY_USAGE
AsymKeyGenerationRequest.WRAP_USAGE
Key
KeyArchivalRequest
KeyClient
KeyClient.AES_ALGORITHM
KeyClient.ASYMMETRIC_KEY_TYPE
KeyClient.DES3_ALGORITHM
KeyClient.DESEDE_ALGORITHM
KeyClient.DES_ALGORITHM
KeyClient.DSA_ALGORITHM
KeyClient.KEY_STATUS_ACTIVE
KeyClient.KEY_STATUS_INACTIVE
KeyClient.PASS_PHRASE_TYPE
KeyClient.RC2_ALGORITHM
KeyClient.RC4_ALGORITHM
KeyClient.RSA_ALGORITHM
KeyClient.SYMMETRIC_KEY_TYPE
KeyClient.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()
KeyData
KeyInfo
KeyInfoCollection
KeyRecoveryRequest
KeyRequestInfo
KeyRequestInfoCollection
KeyRequestResponse
RequestId
SymKeyGenerationRequest
main()
kra
Moduleprofile
Modulesystem
Modulesystemcert
Moduleupgrade
ModulePKIUpgradeScriptlet
PKIUpgradeTracker
PKIUpgrader
PKIUpgrader.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()
util
Module