pki-python-client(1)
NAME
pki-python-client – 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 Package
This module contains top-level classes and functions used by the Dogtag project.
class pki.Attribute(name, value)- Bases:
object class pki.AttributeList- Bases:
object exception pki.BadRequestException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.CertNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException exception pki.ConflictingOperationException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.ForbiddenException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.GroupNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException exception pki.HTTPGoneException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.KeyNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException class pki.Link- Bases:
object classmethod from_json(attr_list)- Generate Link from JSON
Parametersattr_list(str) — JSON representation of LinkReturns- pki.Link
exception pki.PKIException(message, exception=None, code=None, class_name=None)- Bases:
exceptions.Exception,pki.ResourceMessage classmethod from_json(json_value)- Construct PKIException from JSON. :param json_value: JSON representation of the exception. :type json_value: str :return: pki.PKIException
exception pki.ProfileNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException class pki.PropertyFile(filename, delimiter=’=’)- Bases:
object get(name)- Get the value of the specified property.
Parametersname(str) — name of property to be fetched.Returns- str — value of property
index(name)- Find the index (position) of a property in a property file.
Parametersname(str) — name of propertyReturns- int — index of property.
insert_line(index, line)- Insert property into the list of properties maintained by this object at the specified location (index).
Parameters- •
index(int) — point at which to insert value.- •
line(str) — value to be inserted.Returns- None
read()- Read from property file into the list of properties maintained by this object.
Returns- None
remove(name)- Remove property from list of properties maintained by this object.
Parametersname(str) — name of property to be removed.Returns- None
remove_line(index)- Remove property at specified index from the properties list.
Parametersindex(int) — location of property to be removed.Returns- None
set(name, value, index=None)- Set value of specified property.
Parameters- •
name(str) — name of property to set.- •
value(str) — value to set- •
index(int) — (optional) position of propertyReturns- None
show()- Print the contents of the list of properties maintained by this object to STDOUT.
Returns- None
write()- Write the list of properties maintained by this object to the property file.
Returns- None
exception pki.RequestNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException class pki.ResourceMessage(class_name)- Bases:
object add_attribute(name, value)- Add an attribute to the list.
Parameters- •
name(str) — name of attribute to add- •
value(str) — value to addReturns- None
get_attribute_value(name)- Get the value of a given attribute.
Parametersname(str) — name of attribute to retrieveReturns- str — value of parameter
exception pki.ResourceNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.UnauthorizedException(message, exception=None, code=None, class_name=None)- Bases:
pki.PKIException exception pki.UserNotFoundException(message, exception=None, code=None, class_name=None)- Bases:
pki.ResourceNotFoundException pki.handle_exceptions()- Decorator handling exceptions from REST methods.
pki.implementation_version()- Return implementation version.
Returns- str –implementation version
pki.read_text(message, options=None, default=None, delimiter=’:’, allow_empty=True, case_sensitive=True)- Get an input from the user. This is used, for example, in pkispawn and pkidestroy to obtain user input.
Parameters- •
message(str) — prompt to display to the user- •
options(list) — list of possible inputs by the user.- •
default(str) — default value of parameter being prompted.- •
delimiter(str) — delimiter to be used at the end of the prompt.- •
allow_empty(boolean — True/False) — Allow input to be empty.- •
case_sensitive(boolean — True/False) — Allow input to be case sensitive.Returns- str — value obtained from user input.
Class representing a key/value pair.
This object is the basis of the representation of a ResourceMessage.
Class representing a list of attributes.
This class is needed because of a JavaMapper used in the REST API.
Bad Request Exception: return code = 400
Cert Not Found Exception: return code = 404
Conflicting Operation Exception: return code = 409
Forbidden Exception: return code = 403
Group Not Found Exception: return code = 404
Gone Exception: return code = 410
Key Not Found Exception: return code 404
Stores the information of the resteasy’s Link object sent by the server for a resource.
Base exception class for REST Interface
Profile Not Found Exception: return code = 404
Class to manage property files The contents of the property file are maintained internally as a list of properties.
Properties are strings of the format <name> <delimiter> <value> where ‘=’ is the default delimiter.
Request Not Found Exception: return code = 404
This class is the basis for the various types of key requests. It is essentially a list of attributes.
Not Found Exception: return code = 404
Unauthorized Exception: return code = 401
User Not Found Exception: return code = 404
account Module
class pki.account.AccountClient(connection)- Class used to associate an authentication session variable with a connection.
To use this class:- •
- set the authentication credentials with the connection,
- •
- create an AccountClient and then call login().
- •
- further operations in this session will use the same authentication credentials without re-authentication.
- •
- call logout() to invalidate the session.
login(inst, *args, **kwargs)- Login to account REST interface. If login is successful, an authentication session variable is associated with the connection.
Returns- None
logout(inst, *args, **kwargs)- Logs out of the session. Authentication session variables are invalidated for the connection
Returns- None
cert Module
class pki.cert.CertClient(connection)- Bases:
object approve_request(request_id, cert_review_response=None)- Approves a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
assign_request(request_id, cert_review_response)- Assigns a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
cancel_request(request_id, cert_review_response=None)- Cancels a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
create_enrollment_request(inst, *args, **kwargs)- Fetches the enrollment request object for the given profile and sets values to its attributes using the values provided in the inputs dictionary. Returns the CertEnrollmentRequest object, which can be submitted to enroll a certificate.
enroll_cert(inst, *args, **kwargs)- A convenience method for enrolling a certificate for a given profile id. The inputs parameter should be a dictionary with values for the profile attributes for an enrollment request.
get_cert(inst, *args, **kwargs)- Return a CertData object for a particular certificate.
get_enrollment_template(inst, *args, **kwargs)- Fetch the enrollment template for the given profile id. For the first time, the request is sent to the server. The retrieved CertEnrollmentRequest object is then cached locally for future requests. Returns a CerEnrollmentRequest object.
get_request(inst, *args, **kwargs)- Get information of a certificate request with the given request ID. Returns a CertRequestInfo object.
hold_cert(inst, *args, **kwargs)- Places a certificate on-hold. Calls the revoke_cert method with reason – CertRevokeRequest.REASON_CERTIFICATE_HOLD. Returns a CertRequestInfo object. This method requires an agent’s authentication cert in the connection object.
list_certs(inst, *args, **kwargs)- Return a CertDataInfoCollection object with a information about all the certificates that satisfy the search criteria. If cert_search_request=None, returns all the certificates.
list_enrollment_templates(inst, *args, **kwargs)- Gets the list of profile templates supported by the CA. The values for start and size arguments determine the starting point and the length of the list. Returns a ProfileDataInfoCollection object.
list_requests(inst, *args, **kwargs)- Query for a list of certificates using the arguments passed. Returns a CertRequestInfoCollection object.
reject_request(request_id, cert_review_response=None)- Rejects a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
review_cert(inst, *args, **kwargs)- Reviews a certificate. Returns a CertData object with a nonce. This method requires an agent’s authentication cert in the connection object.
review_request(inst, *args, **kwargs)- Reviews a certificate enrollment request. Returns a CertReviewResponse object which contains the nonce from the server needed to perform an action on the request.
revoke_ca_cert(inst, *args, **kwargs)- Revokes a CA certificate. Returns a CertRequestInfo object with information about the request. This method requires an agent’s authentication cert in the connection object.
revoke_cert(inst, *args, **kwargs)- Revokes a certificate. Returns a CertRequestInfo object with information about the request. This method requires an agent’s authentication cert in the connection object.
submit_enrollment_request(inst, *args, **kwargs)- Submits the CertEnrollmentRequest object to the server. Returns a CertRequestInfoCollection object with information about the certificate requests enrolled at the CA.
unassign_request(request_id, cert_review_response)- Un-assigns a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
unrevoke_cert(inst, *args, **kwargs)- Un-revokes a revoked certificate. Returns a CertRequestInfo object. This method requires an agent’s authentication cert in the connection object.
update_request(request_id, cert_review_response)- Updates a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
validate_request(request_id, cert_review_response)- Validates a certificate enrollment request. If cert_review_response is None, a review request operation is performed to fetch the CertReviewResponse object. Requires as agent level authentication.
class pki.cert.CertData- Bases:
object classmethod from_json(attr_list)- Return CertData object from JSON dict
json_attribute_names = {‘Nonce’: ‘nonce’, ‘SubjectDN’: ‘subject_dn’, ‘NotBefore’: ‘not_before’, ‘IssuerDN’: ‘issuer_dn’, ‘NotAfter’: ‘not_after’, ‘id’: ‘serial_number’, ‘Status’: ‘status’, ‘PKCS7CertChain’: ‘pkcs7_cert_chain’, ‘PrettyPrint’: ‘pretty_repr’, ‘Link’: ‘link’, ‘Encoded’: ‘encoded’}class pki.cert.CertDataInfo- Bases:
object classmethod from_json(attr_list)- Return CertDataInfo object from JSON dict
json_attribute_names = {‘IssuedOn’: ‘issued_on’, ‘SubjectDN’: ‘subject_dn’, ‘NotValidBefore’: ‘not_valid_before’, ‘Version’: ‘version’, ‘Type’: ‘type’, ‘id’: ‘serial_number’, ‘Status’: ‘status’, ‘NotValidAfter’: ‘not_valid_after’, ‘IssuedBy’: ‘issued_by’, ‘KeyLength’: ‘key_length’, ‘Link’: ‘link’, ‘KeyAlgorithmOID’: ‘key_algorithm_oid’}class pki.cert.CertDataInfoCollection- Bases:
object classmethod from_json(json_value)- Populate object from JSON input
class pki.cert.CertEnrollmentRequest(profile_id=None, renewal=False, serial_number=None, remote_host=None, remote_address=None, inputs=None, outputs=None)- Bases:
object This class encapsulates the parameters required for a certificate- enrollment request.
add_input(profile_input)add_output(profile_output)classmethod from_json(attr_list)get_input(profile_input_name)get_output(profile_output_name)json_attribute_names = {‘RemoteAddress’: ‘remote_address’, ‘RemoteHost’: ‘remote_host’, ‘SerialNumber’: ‘serial_number’, ‘Output’: ‘outputs’, ‘Input’: ‘inputs’, ‘Renewal’: ‘renewal’, ‘ProfileID’: ‘profile_id’}remove_input(profile_input_name)remove_output(profile_output_name)class pki.cert.CertEnrollmentResult(request, cert)- Bases:
object class pki.cert.CertRequestInfo- Bases:
object classmethod from_json(attr_list)json_attribute_names = {‘certRequestType’: ‘cert_request_type’, ‘certId’: ‘cert_id’, ‘operationResult’: ‘operation_result’, ‘requestType’: ‘request_type’, ‘requestStatus’: ‘request_status’, ‘errorMessage’: ‘error_message’, ‘requestURL’: ‘request_url’, ‘certURL’: ‘cert_url’}class pki.cert.CertRequestInfoCollection- Bases:
object classmethod from_json(json_value)- Populate object from JSON input
class pki.cert.CertRequestStatus- Bases:
object CANCELED = ‘canceled’COMPLETE = ‘complete’PENDING = ‘pending’REJECTED = ‘rejected’class pki.cert.CertReviewResponse(profile_id=None, renewal=False, serial_number=None, remote_host=None, remote_address=None, inputs=None, outputs=None, nonce=None, request_id=None, request_type=None, request_status=None, request_owner=None, request_creation_time=None, request_modification_time=None, request_notes=None, profile_approval_by=None, profile_set_id=None, profile_is_visible=None, profile_name=None, profile_description=None, profile_remote_host=None, profile_remote_address=None, policy_sets=None)- Bases:
pki.cert.CertEnrollmentRequest classmethod from_json(attr_list)json_attribute_names = {‘ProfilePolicySet’: ‘policy_sets’, ‘profileSetId’: ‘profile_set_id’, ‘RemoteAddress’: ‘remote_address’, ‘requestType’: ‘request_type’, ‘RemoteHost’: ‘remote_host’, ‘SerialNumber’: ‘serial_number’, ‘requestCreationTime’: ‘request_creation_time’, ‘requestOwner’: ‘request_owner’, ‘Input’: ‘inputs’, ‘Output’: ‘outputs’, ‘profileIsVisible’: ‘profile_is_visible’, ‘requestStatus’: ‘request_status’, ‘profileRemoteHost’: ‘profile_remote_host’, ‘profileApprovedBy’: ‘profile_approved_by’, ‘requestNotes’: ‘request_notes’, ‘Renewal’: ‘renewal’, ‘profileDescription’: ‘profile_description’, ‘profileRemoteAddr’: ‘profile_remote_address’, ‘ProfileID’: ‘profile_id’, ‘profileName’: ‘profile_name’, ‘requestModificationTime’: ‘request_modification_time’, ‘requestId’: ‘request_id’}class pki.cert.CertRevokeRequest(nonce, reason=None, invalidity_date=None, comments=None)- Bases:
object Valid values for reasons for revoking a request are:- ‘Unspecified’, ‘Key_Compromise’, ‘CA_Compromise’, ‘Affiliation_Changed’, ‘Superseded’, ‘Cessation_of_Operation’, ‘Certificate_Hold’, ‘Remove_from_CRL’, ‘Privilege_Withdrawn’, ‘AA_Compromise’
reasons = [‘Unspecified’, ‘Key_Compromise’, ‘CA_Compromise’, ‘Affiliation_Changed’, ‘Superseded’, ‘Cessation_of_Operation’, ‘Certificate_Hold’, ‘Remove_from_CRL’, ‘Privilege_Withdrawn’, ‘AA_Compromise’]class pki.cert.CertSearchRequest(**cert_search_params)- Bases:
object search_params = {‘valid_not_before_from’: ‘validNotBeforeFrom’, ‘cert_type_ssl_client’: ‘certTypeSSLClient’, ‘common_name’: ‘commonName’, ‘serial_to’: ‘serialTo’, ‘validity_unit’: ‘validityUnit’, ‘cert_type_sub_ssl_ca’: ‘certTypeSubSSLCA’, ‘user_id’: ‘userID’, ‘locality’: ‘locality’, ‘org_unit’: ‘orgUnit’, ‘issued_by’: ‘issuedBy’, ‘revocation_reason’: ‘revocationReason’, ‘state’: ‘state’, ‘validity_operation’: ‘validityOperation’, ’email’: ‘eMail’, ‘status’: ‘status’, ‘valid_not_after_from’: ‘validNotAfterFrom’, ‘match_exactly’: ‘matchExactly’, ‘valid_not_before_to’: ‘validNotBeforeTo’, ‘revoked_on_from’: ‘revokedOnFrom’, ‘validity_count’: ‘validityCount’, ‘org’: ‘org’, ‘cert_type_ssl_server’: ‘certTypeSSLServer’, ‘issued_on_from’: ‘issuedOnFrom’, ‘cert_type_sub_email_ca’: ‘certTypeSubEmailCA’, ‘serial_from’: ‘serialFrom’, ‘country’: ‘country’, ‘issued_on_to’: ‘issuedOnTo’, ‘revoked_by’: ‘revokedBy’, ‘valid_not_after_to’: ‘validNotAfterTo’, ‘cert_type_secure_email’: ‘certTypeSecureEmail’, ‘revoked_on_to’: ‘revokedOnTo’}pki.cert.main()
Class encapsulating and mirroring the functionality in the CertResource Java interface class defining the REST API for Certificate resources.
Calling this method with valid arguments, creates an enrollment request, submits it to the server, approves the certificate requests generated for the enrollment and returns a list of CertData objects for all the certificates generated as part of this enrollment.
Note: This method supports only certificate enrollment where only one agent approval is sufficient.
Requires an agent level authentication. Returns a list of CertEnrollmentResult objects.
Class containing certificate data as returned from getCert()
Class containing information contained in a CertRecord on the CA. This data is returned when searching/listing certificate records.
Class containing list of CertDataInfo objects and their respective link objects. This data is returned when searching/listing certificate records in the CA.
Class containing results of an enrollment request.
This structure contains information about the cert request generated and any certificates issued.
An object of this class stores represents a certificate request.
Class containing list of CertRequestInfo objects. This data is returned when listing certificate request records in the CA.
Class containing valid cert statuses.
An object of this class represent the response from the server when reviewing a certificate enrollment request. It contains a nonce required to perform action on the request.
An object of this class encapsulates all the parameters required for revoking a certificate.
An object of this class is used to store the search parameters and send them to server.
client Module
class pki.client.PKIConnection(protocol=’http’, hostname=’localhost’, port=’8080′, subsystem=’ca’, accept=’application/json’, trust_env=None)- Class to encapsulate the connection between the client and a Dogtag subsystem.
authenticate(username=None, password=None)- Set the parameters used for authentication if username/password is to be used. Both username and password must not be None. Note that this method only sets the parameters. Actual authentication occurs when the connection is attempted,
Parameters- •
username— username to authenticate connection- •
password— password to authenticate connectionReturns- None
delete(*args, **kwargs)- Uses python-requests to issue a DEL request to the server.
Parameters- •
path(str) — path URI for the DEL request- •
headers(dict) — headers for the DEL requestReturns- request.response — response from the server
Raises- Exception from python-requests in case the DEL was not successful, or returns an error code.
get(*args, **kwargs)- Uses python-requests to issue a GET request to the server.
Parameters- •
path(str) — path URI for the GET request- •
headers(dict) — headers for the GET request- •
params(dict or bytes) — Query parameters for the GET request- •
payload(dict, bytes, file-like object) — data to be sent in the body of the requestReturns- request.response — response from the server
Raises- Exception from python-requests in case the GET was not successful, or returns an error code.
post(*args, **kwargs)- Uses python-requests to issue a POST request to the server.
Parameters- •
path(str) — path URI for the POST request- •
payload(dict, bytes, file-like object) — data to be sent in the body of the request- •
headers(dict) — headers for the POST request- •
params(dict or bytes) — Query parameters for the POST requestReturns- request.response — response from the server
Raises- Exception from python-requests in case the POST was not successful, or returns an error code.
put(*args, **kwargs)- Uses python-requests to issue a PUT request to the server.
Parameters- •
path(str) — path URI for the PUT request- •
payload(dict, bytes, file-like object) — data to be sent in the body of the request- •
headers(dict) — headers for the PUT requestReturns- request.response — response from the server
Raises- Exception from python-requests in case the PUT was not successful, or returns an error code.
set_authentication_cert(pem_cert_path)- Set the path to the PEM file containing the certificate and private key for the client certificate to be used for authentication to the server, when client certificate authentication is required.
Parameterspem_cert_path(str) — path to the PEM fileReturns- None
Raises- Exception if path is empty or None.
pki.client.catch_insecure_warning(func)- Temporary silence InsecureRequestWarning
See- https://fedorahosted.org/pki/ticket/1253
pki.client.main()- Test code for the PKIConnection class. :return: None
PKIConnection is not able to verify HTTPS connections yet. This decorator catches the warning.
crypto Module
Module containing crypto classes.
class pki.crypto.CryptoProvider- Bases:
object asymmetric_wrap(data, wrapping_cert, mechanism=None)- encrypt a symmetric key with the public key of a transport cert.
static generate_nonce_iv(mechanism)- Create a random initialization vector
generate_session_key()- Generate a session key to be used for wrapping data to the DRM This must return a 3DES 168 bit key
generate_symmetric_key(mechanism=None, size=0)- Generate and return a symmetric key
get_cert(cert_nick)- Get the certificate for the specified cert_nick.
initialize()- Initialization code
symmetric_unwrap(data, wrapping_key, mechanism=None, nonce_iv=None)- decrypt data originally encrypted with symmetric key (wrapping key)
symmetric_wrap(data, wrapping_key, mechanism=None, nonce_iv=None)- encrypt data using a symmetric key (wrapping key)
class pki.crypto.NSSCryptoProvider(certdb_dir, certdb_password=None, password_file=None)- Bases:
pki.crypto.CryptoProvider asymmetric_wrap(data, wrapping_cert, mechanism=310)- :param data Data to be wrapped :param wrapping_cert Public key to wrap data :param mechanism algorithm of symmetric key to be wrapped
static generate_nonce_iv(mechanism=310)- Create a random initialization vector
generate_session_key()- Returns a session key to be used when wrapping secrets for the DRM This will return a 168 bit 3DES key.
generate_symmetric_key(mechanism=310, size=0)- Returns a symmetric key.
get_cert(cert_nick)- :param cert_nick Nickname for the certificate to be returned
import_cert(cert_nick, cert, trust=’, ‘)- Import a certificate into the nss database
initialize()- Initialize the nss db. Must be done before any crypto operations
classmethod setup_contexts(mechanism, sym_key, nonce_iv)- Set up contexts to do wrapping/unwrapping by symmetric keys.
static setup_database(db_dir, password=None, over_write=False, password_file=None)- Create an NSS database
symmetric_unwrap(data, wrapping_key, mechanism=310, nonce_iv=None)- :param data Data to be unwrapped :param wrapping_key Symmetric key to unwrap data :param nonce_iv iv data
symmetric_wrap(data, wrapping_key, mechanism=310, nonce_iv=None)- :param data Data to be wrapped :param wrapping_key Symmetric key to wrap data
Abstract class containing methods to do cryptographic operations.
The mechanism is the type of symmetric key, which defaults to a 56 bit DES3 key.
We expect the data and nonce_iv values to be base64 encoded. The mechanism is the type of key used to do the wrapping. It defaults to a 56 bit DES3 key.
Class that defines NSS implementation of CryptoProvider. Requires an NSS database to have been set up and initialized.
Note that all inputs and outputs are unencoded.
Wrap (encrypt) data using the supplied asymmetric key
Note that for fixed length keys, this length should be 0. If no length is provided, then the function will either use 0 (for fixed length keys) or the maximum available length for that algorithm and the token.
Searches NSS database and returns SecItem object for this certificate.
Unwrap (decrypt) data using the supplied symmetric key
Wrap (encrypt) data using the supplied symmetric key
encoder Module
pki.encoder.CustomTypeDecoder(dct)class pki.encoder.CustomTypeEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, encoding=’utf-8′, default=None)- Bases:
json.encoder.JSONEncoder static attr_name_conversion(attr_dict, object_class)default(obj)pki.encoder.decode_cert(data)- base64 decode X.509 certificate
Parametersdata(str, bytes) — data as bytes or ASCII textReturn type- bytes
pki.encoder.encode_cert(data)- base64 encode X.509 certificate
Parametersdata(str, bytes) — data as bytes or ASCII textReturn type- bytes
A custom JSONEncoder class that knows how to encode core custom objects.
Custom objects are encoded as JSON object literals (ie, dicts) with one key, ‘TypeName’ where ‘TypeName’ is the actual name of the type to which the object belongs. That single key maps to another object literal which is just the __dict__ of the object encoded.
Reason for ignoring the error: E0202 – An attribute affected in json.encoder line 157 hide this method reported by pylint:
The error is in json.encoder.JSONEncoder class. There is a default method (which is overridden here) and also a class attribute self.default initialized in the init method of the class. The intention of such usage being that a custom default method object can be passed to init when creating an instance of JSONEncoder, which is then assigned to class’s default method. (which is valid) But pylint raises an issue due to the usage of same name for a method and an attribute in which case the attribute definition hides the method. The reason and example for the issue: (top rated comment) http://stackoverflow.com/questions/12949064/python-what-happens– when-instance-variable-name-is-same-as-method-name
Python 3’s base64.b64encode() doesn’t support ASCII text.
key Module
Module containing the Python client classes for the KeyClient and KeyRequestClient REST API on a DRM
class pki.key.AsymKeyGenerationRequest(client_key_id=None, key_size=None, key_algorithm=None, key_usages=None, trans_wrapped_session_key=None, realm=None)- Bases:
pki.ResourceMessage DECRYPT_USAGE = ‘decrypt’DERIVE_USAGE = ‘derive’ENCRYPT_USAGE = ‘encrypt’SIGN_RECOVER_USAGE = ‘sign_recover’SIGN_USAGE = ‘sign’UNWRAP_USAGE = ‘unwrap’VERIFY_RECOVER_USAGE = ‘verify_recover’VERIFY_USAGE = ‘verify’WRAP_USAGE = ‘wrap’class pki.key.Key(key_data)- Bases:
object class pki.key.KeyArchivalRequest(client_key_id=None, data_type=None, wrapped_private_data=None, trans_wrapped_session_key=None, pki_archive_options=None, algorithm_oid=None, symkey_params=None, key_algorithm=None, key_size=None, realm=None)- Bases:
pki.ResourceMessage class pki.key.KeyClient(connection, crypto, transport_cert_nick=None)- Bases:
object AES_ALGORITHM = ‘AES’ASYMMETRIC_KEY_TYPE = ‘asymmetricKey’DES3_ALGORITHM = ‘DES3’DESEDE_ALGORITHM = ‘DESede’DES_ALGORITHM = ‘DES’DES_EDE3_CBC_OID = ‘{1 2 840 113549 3 7}’DSA_ALGORITHM = ‘DSA’KEY_STATUS_ACTIVE = ‘active’KEY_STATUS_INACTIVE = ‘inactive’PASS_PHRASE_TYPE = ‘passPhrase’RC2_ALGORITHM = ‘RC2’RC4_ALGORITHM = ‘RC4’RSA_ALGORITHM = ‘RSA’SYMMETRIC_KEY_TYPE = ‘symmetricKey’approve_request(inst, *args, **kwargs)- Approve a secret recovery request
archive_encrypted_data(inst, *args, **kwargs)- Archive a secret (symmetric key or passphrase) on the DRM.
The following parameters are also required:- •
- encrypted_data – which is the data encrypted by a session key (168 bit 3DES symmetric key)
- •
- wrapped_session_key – the above session key wrapped by the DRM transport certificate public key.
- •
- the algorithm_oid string for the symmetric key wrap
- •
- the nonce_iv for the symmetric key wrap
archive_key(inst, *args, **kwargs)- Archive a secret (symmetric key or passphrase) on the DRM.
data_type can be one of the following:- KeyClient.SYMMETRIC_KEY_TYPE, KeyClient.ASYMMETRIC_KEY_TYPE, KeyClient.PASS_PHRASE_TYPE
archive_pki_options(inst, *args, **kwargs)- Archive a secret (symmetric key or passphrase) on the DRM.
cancel_request(inst, *args, **kwargs)- Cancel a secret recovery request
generate_asymmetric_key(inst, *args, **kwargs)- Generate and archive asymmetric keys in the DRM. Supports algorithms RSA and DSA. Valid key size for RSA = 256 + (16 * n), where n: 0-496 Valid key size for DSA = 512, 768, 1024. p,q,g params are not supported.
generate_symmetric_key(inst, *args, **kwargs)- Generate and archive a symmetric key on the DRM.
get_active_key_info(inst, *args, **kwargs)- Get the info in the KeyRecord for the active secret in the DRM.
get_key_info(inst, *args, **kwargs)- Get the info in the KeyRecord for a specific secret in the DRM.
get_request_info(inst, *args, **kwargs)- Return a KeyRequestInfo object for a specific request.
list_keys(inst, *args, **kwargs)- List/Search archived secrets in the DRM.
list_requests(inst, *args, **kwargs)- List/Search key requests in the DRM.
modify_key_status(inst, *args, **kwargs)- Modify the status of a key
recover_key(inst, *args, **kwargs)- Create a request to recover a secret.
reject_request(inst, *args, **kwargs)- Reject a secret recovery request.
retrieve_key(inst, *args, **kwargs)- Retrieve a secret (passphrase or symmetric key) from the DRM.
- 1.
- trans_wrapped_session_key is not provided by caller.
- 2.
- The trans_wrapped_session_key is provided by the caller.
retrieve_key_by_passphrase(inst, *args, **kwargs)- Retrieve a secret (passphrase or symmetric key) from the DRM using a passphrase.
- 1.
- A passphrase is provided by the caller.
- •
- the passphrase wrapped by a 168 bit 3DES symmetric key (the session key). This is referred to as the parameter session_wrapped_passphrase.
- •
- the session key wrapped with the public key in the DRM transport certificate. This is referred to as the trans_wrapped_session_key.
- •
- ivps nonce data, referred to as nonce_data
- 2.
- The caller provides the trans_wrapped_session_key, session_wrapped_passphrase and nonce_data.
retrieve_key_by_pkcs12(inst, *args, **kwargs)- Retrieve an asymmetric private key and return it as PKCS12 data.
retrieve_key_data(inst, *args, **kwargs)- Retrieve a secret from the DRM.
set_transport_cert(transport_cert_nick)- Set the transport certificate for crypto operations
submit_request(inst, *args, **kwargs)- Submit an archival, recovery or key generation request to the DRM.
class pki.key.KeyData- Bases:
object classmethod from_json(attr_list)- Return a KeyData object from a JSON dict
json_attribute_names = {‘nonceData’: ‘nonce_data’, ‘wrappedPrivateData’: ‘wrapped_private_data’}class pki.key.KeyInfo- Bases:
object classmethod from_json(attr_list)- Return KeyInfo from JSON dict
get_key_id()- Return the key ID as parsed from key URL
json_attribute_names = {‘publicKey’: ‘public_key’, ‘clientKeyID’: ‘client_key_id’, ‘ownerName’: ‘owner_name’, ‘keyURL’: ‘key_url’}class pki.key.KeyInfoCollection- Bases:
object classmethod from_json(json_value)- Return a KeyInfoCollection object from its JSON representation
class pki.key.KeyRecoveryRequest(key_id=None, request_id=None, trans_wrapped_session_key=None, session_wrapped_passphrase=None, nonce_data=None, certificate=None, passphrase=None)- Bases:
pki.ResourceMessage class pki.key.KeyRequestInfo- Bases:
object classmethod from_json(attr_list)- Return a KeyRequestInfo object from a JSON dict.
get_key_id()- Return the ID of the secret referred to by this request.
get_request_id()- Return the request ID by parsing the request URL.
json_attribute_names = {‘requestType’: ‘request_type’, ‘requestStatus’: ‘request_status’, ‘requestURL’: ‘request_url’, ‘keyURL’: ‘key_url’}class pki.key.KeyRequestInfoCollection- Bases:
object classmethod from_json(json_value)- Return a KeyRequestInfoCollection object from its JSON representation.
class pki.key.KeyRequestResponse- Bases:
object classmethod from_json(json_value)- Return a KeyRequestResponse object from its JSON representation.
get_key_id()- Return the id for the key archived, recovered or generated
get_request_id()- Return the id for the created request
class pki.key.RequestId(req_id)- Bases:
object class pki.key.SymKeyGenerationRequest(client_key_id=None, key_size=None, key_algorithm=None, key_usages=None, trans_wrapped_session_key=None, realm=None)- Bases:
pki.ResourceMessage DECRYPT_USAGE = ‘decrypt’ENCRYPT_USAGE = ‘encrypt’SIGN_USAGE = ‘sign’UNWRAP_USAGE = ‘unwrap’VERIFY_USAGE = ‘verify’WRAP_USAGE = ‘wrap’pki.key.main()- Some unit tests – basically printing different types of requests
Class representing the data sent to the DRM when generating and archiving asymmetric keys in the DRM.
An instance of this class stores the decoded encrypted secret present in the KeyData object passed in the constructor. All the key retrieval requests return this object.
Class representing the object sent to the DRM when archiving a secret.
Class that encapsulates and mirrors the functions in the KeyResource and KeyRequestResource Java classes in the DRM REST API.
Refer to archive_key() comments for a description of client_key_id, data_type, key_algorithm and key_size.
This function is useful if the caller wants to do their own wrapping of the secret, or if the secret was generated on a separate client machine and the wrapping was done there.
The function returns a KeyRequestResponse object containing a KeyRequestInfo object with details about the archival request and key archived.
Requires a user-supplied client ID. There can be only one active key with a specified client ID. If a record for a duplicate active key exists, a BadRequestException is thrown.
key_algorithm and key_size are applicable to symmetric keys only. If a symmetric key is being archived, these parameters are required.
private_data is the raw secret to be archived. It will be wrapped and sent to the DRM.
The function returns a KeyRequestResponse object containing a KeyRequestInfo object with details about the archival request and key archived.
Refer to archive_key() comments for a description of client_key_id, data_type, key_algorithm and key_size.
pki_archive_options is the data to be archived wrapped in a PKIArchiveOptions structure,
The function returns a KeyRequestResponse object containing a KeyRequestInfo object with details about the archival request and key archived.
Return a KeyRequestResponse which contains a KeyRequestInfo object that describes the URL for the request and generated keys.
Return a KeyRequestResponse which contains a KeyRequestInfo object that describes the URL for the request and generated key.
See KRAClient.list_keys for the valid values of status. Returns a KeyInfoCollection object.
See KRAClient.list_requests for the valid values of request_state and request_type. Returns a KeyRequestInfoCollection object.
To retrieve a symmetric key or passphrase, the only parameter that is required is the keyId. It is possible (but not required) to pass in the session keys/passphrase and nonceData for the retrieval at this time. Those parameters are documented in the docstring for retrieve_key below.
To retrieve an asymmetric key, the keyId and the the base-64 encoded certificate is required.
This function generates a key recovery request, approves it, and retrieves the secret referred to by key_id. This assumes that only one approval is required to authorize the recovery.
To ensure data security in transit, the data will be returned encrypted by a session key (168 bit 3DES symmetric key) – which is first wrapped (encrypted) by the public key of the DRM transport certificate before being sent to the DRM. The parameter trans_wrapped_session_key refers to this wrapped session key.
There are two ways of using this function:
In this case, the function will call CryptoProvider methods to generate and wrap the session key. The function will return the KeyData object with a private_data attribute which stores the unwrapped key information.
In this case, the function will simply pass the data to the DRM, and will return the secret wrapped in the session key. The secret will still need to be unwrapped by the caller.
The function will return the KeyData object, where the KeyData structure includes the wrapped secret and some nonce data to be used as a salt when unwrapping.
This function generates a key recovery request, approves it, and retrieves the secret referred to by key_id. This assumes that only one approval is required to authorize the recovery.
The secret is secured in transit by wrapping the secret with a passphrase using PBE encryption.
There are two ways of using this function:
In this case, CryptoProvider methods will be called to create the data to securely send the passphrase to the DRM. Basically, three pieces of data will be sent:
The function will return the tuple (KeyData, unwrapped_secret)
In this case, the data will simply be passed to the DRM. The function will return the secret encrypted by the passphrase using PBE Encryption. The secret will still need to be decrypted by the caller.
The function will return the tuple (KeyData, None)
This function generates a key recovery request, approves it, and retrieves the secret referred to by key_id in a PKCS12 file. This assumes that only one approval is required to authorize the recovery.
This function requires the following parameters: – key_id : the ID of the key – certificate: the certificate associated with the private key – passphrase: A passphrase for the pkcs12 file.
The function returns a KeyData object.
@param: data – a KeyRecoveryRequest containing the keyId of the secret being retrieved, the request_id of the approved recovery request and a wrapping mechanism. More details at KRAClient.retrieve_key.
Returns a KeyData object containing the wrapped secret.
@param request – is either a KeyArchivalRequest, KeyRecoverRequest, SymKeyGenerationRequest or AsymKeyGenerationRequest.
returns a KeyRequestResponse object.
This is the object that contains the encoded wrapped secret when that secret is retrieved. It is used by the DRM to send information of the key in the key retrieval requests.
This is the object that contains information stored in the database record for an archived secret. It does not contain the secret itself.
This class represents data returned when searching the DRM archived secrets. Essentially, its a list of KeyInfo objects.
Class representing the data sent to the DRM when either creating a request for the recovery of a secret, or, once the request is approved, retrieving the secret.
This class represents data about key requests (archival, recovery, key generation etc.) in the DRM.
This class represents the data returned when searching the key requests in the DRM. Essentially, its a list of KeyRequestInfo objects.
This class is returned when an archival, recovery or key generation request is created. It includes a KeyRequestInfo object with information about the created request, and a KeyData structure which contains the wrapped secret (if that operation is supported).
Class representing a Request ID
Class representing the data sent to the DRM when generating and archiving a symmetric key in the DRM.
kra Module
Module containing KRAClient class. This class should be used by Python clients to interact with the DRM to expose the functionality of the KeyClient and KeyRequestResource REST APIs.
class pki.kra.KRAClient(connection, crypto, transport_cert_nick=None)- Bases:
object
Client class that models interactions with a KRA using the Key and KeyRequest REST APIs.
profile Module
class pki.profile.Descriptor(syntax=None, constraint=None, description=None, default_value=None)- Bases:
object classmethod from_json(attr_list)json_attribute_names = {‘DefaultValue’: ‘default_value’, ‘Constraint’: ‘constraint’, ‘Description’: ‘description’, ‘Syntax’: ‘syntax’}class pki.profile.PolicyConstraint(name=None, description=None, class_id=None, policy_constraint_values=None)- Bases:
object add_constraint_value(policy_constraint_value)- Add a PolicyConstraintValue to the policy_constraint_values list.
classmethod from_json(attr_list)get_constraint_value(policy_constraint_value_name)- Returns a PolicyConstraintValue object with the given name. None, if there is no match.
json_attribute_names = {‘classId’: ‘class_id’, ‘id’: ‘name’, ‘constraint’: ‘policy_constraint_values’}remove_constraint_value(policy_constraint_value_name)- Removes a PolicyConstraintValue with the given name form the policy_constraint_values list.
class pki.profile.PolicyConstraintValue(name=None, value=None, descriptor=None)- Bases:
object classmethod from_json(attr_list)nameclass pki.profile.PolicyDefault(name=None, class_id=None, description=None, policy_attributes=None, policy_params=None)- Bases:
object add_attribute(policy_attribute)- Add a policy attribute to the attribute list. @param policy_attribute – A ProfileAttribute object
add_parameter(policy_parameter)- Add a profile parameter to the parameters list. @param policy_parameter – A ProfileParameter object.
classmethod from_json(attr_list)get_attribute(policy_attribute_name)- Fetch the policy attribute with the given name from the attributes list.
get_parameter(profile_parameter_name)- Fetch a profile parameter with the given name from the parameters list.
json_attribute_names = {‘classId’: ‘class_id’, ‘params’: ‘policy_params’, ‘id’: ‘name’, ‘policyAttribute’: ‘policy_attributes’}remove_attribute(policy_attribute_name)- Remove a policy attribute with the given name from the attributes list.
remove_parameter(profile_parameter_name)- Remove a profile parameter with the given name from the parameters list.
class pki.profile.PolicySet(name=None, policy_list=None)- Bases:
object add_policy(profile_policy)- Add a ProfilePolicy object to the policy_list
classmethod from_json(attr_list)get_policy(policy_id)- Returns a ProfilePolicy object with the given profile id.
json_attribute_names = {‘id’: ‘name’, ‘value’: ‘policy_list’}remove_policy(policy_id)- Removes a ProfilePolicy with the given ID from the PolicySet.
class pki.profile.PolicySetList(policy_sets=None)- Bases:
object add_policy_set(policy_set)- Add a PolicySet object to the policy_sets list.
classmethod from_json(attr_list)get_policy_set(policy_set_name)- Fetch the PolicySet object for the given name. Returns None, if not found.
policy_setsremove_policy_set(policy_set_name)- Remove a PolicySet object with the given name from the policy_sets list.
class pki.profile.Profile(profile_id=None, class_id=None, name=None, description=None, enabled=None, visible=None, enabled_by=None, authenticator_id=None, authorization_acl=None, renewal=None, xml_output=None, inputs=None, outputs=None, policy_set_list=None, link=None)- Bases:
object add_input(profile_input)- Add a ProfileInput object to the inputs list of the Profile.
add_output(profile_output)- Add a ProfileOutput object to the outputs list of the Profile.
add_policy_set(policy_set)- Add a PolicySet object to the policy_sets list of the Profile.
classmethod from_json(attr_list)get_input(profile_input_id)- Fetches a ProfileInput with the given ProfileInput id. Returns None, if there is no matching input.
get_output(profile_output_id)- Fetches a ProfileOutput with the given ProfileOutput id. Returns None, if there is no matching output.
get_policy_set(policy_set_name)- Fetches a ProfileInput with the given ProfileInput id. Returns None, if there is no matching input.
static get_profile_data_from_file(path_to_file)- Reads the file for the serialized Profile object. Currently supports only data format in json.
json_attribute_names = {‘classId’: ‘class_id’, ‘authenticatorId’: ‘authenticator_id’, ‘Output’: ‘outputs’, ‘PolicySets’: ‘policy_set_list’, ‘xmlOutput’: ‘xml_output’, ‘authzAcl’: ‘authorization_acl’, ‘enabledBy’: ‘enabled_by’, ‘Input’: ‘inputs’, ‘id’: ‘profile_id’}remove_input(profile_input_id)- Remove a ProfileInput from the inputs list of the Profile.
remove_output(profile_output_id)- Remove a ProfileOutput from the outputs list of the Profile.
remove_policy_set(policy_set_name)- Remove a PolicySet from the policy_sets list of the Profile.
class pki.profile.ProfileAttribute(name=None, value=None, descriptor=None)- Bases:
object classmethod from_json(attr_list)json_attribute_names = {‘Descriptor’: ‘descriptor’, ‘Value’: ‘value’}class pki.profile.ProfileClient(connection)- Bases:
object create_profile(inst, *args, **kwargs)- Create a new profile for the given Profile object.
create_profile_from_file(path_to_file)- Reads the file for the serialized Profile object. Performs the profile create operation. Currently supports only data format in json.
delete_profile(inst, *args, **kwargs)- Delete a profile with the given Profile Id.
disable_profile(inst, *args, **kwargs)- Disables a profile.
enable_profile(inst, *args, **kwargs)- Enables a profile.
get_profile(inst, *args, **kwargs)- Fetches information for the profile for the given profile id. Returns a ProfileData object.
list_profiles(inst, *args, **kwargs)- Fetches the list of profiles. The start and size arguments provide pagination support. Returns a ProfileDataInfoCollection object.
modify_profile(inst, *args, **kwargs)- Modify an existing profile with the given Profile object.
modify_profile_from_file(path_to_file)- Reads the file for the serialized Profile object. Performs the profile modify operation. Currently supports only data format in json.
class pki.profile.ProfileDataInfo- Bases:
object classmethod from_json(attr_list)json_attribute_names = {‘profileDescription’: ‘profile_description’, ‘profileId’: ‘profile_id’, ‘profileURL’: ‘profile_url’, ‘profileName’: ‘profile_name’}class pki.profile.ProfileDataInfoCollection- Bases:
object classmethod from_json(attr_list)class pki.profile.ProfileInput(profile_input_id=None, class_id=None, name=None, text=None, attributes=None, config_attributes=None)- Bases:
object add_attribute(profile_attribute)- Add a ProfileAttribute object to the attributes list.
add_config_attribute(profile_attribute)- Add a ProfileAttribute object to the config_attributes list.
classmethod from_json(attr_list)get_attribute(profile_attribute_name)- Returns a ProfileAttribute object for the given name. None, if no match.
get_config_attribute(config_attribute_name)- Returns a ProfileAttribute object with the given name. None, if there is no match in the config_attributes list.
json_attribute_names = {‘ClassID’: ‘class_id’, ‘Name’: ‘name’, ‘Text’: ‘text’, ‘ConfigAttribute’: ‘config_attributes’, ‘Attribute’: ‘attributes’, ‘id’: ‘profile_input_id’}remove_attribute(profile_attribute_name)- Remove a ProfileAttribute object with the given name from the attributes list.
remove_config_attribute(config_attribute_name)- Remove a ProfileAttribute object with the given name from the config_attributes list.
class pki.profile.ProfileOutput(profile_output_id=None, name=None, text=None, class_id=None, attributes=None)- Bases:
object add_attribute(profile_attribute)- Add a ProfileAttribute object to the attributes list.
classmethod from_json(attr_list)get_attribute(profile_attribute_name)- Returns a ProfileAttribute object for the given name. None, if no match.
json_attribute_names = {‘classId’: ‘class_id’, ‘id’: ‘profile_output_id’}remove_attribute(profile_attribute_name)- Remove a ProfileAttribute object with the given name from the attributes list.
class pki.profile.ProfileParameter(name=None, value=None)- Bases:
object classmethod from_json(attr_list)class pki.profile.ProfilePolicy(policy_id=None, policy_default=None, policy_constraint=None)- Bases:
object classmethod from_json(attr_list)json_attribute_names = {‘id’: ‘policy_id’, ‘def’: ‘policy_default’, ‘constraint’: ‘policy_constraint’}class pki.profile.ProfilePolicySet- Bases:
object classmethod from_json(attr_list)pki.profile.main()
This class represents the description of a ProfileAttribute. It stores information such as the syntax, constraint and default value of a profile attribute.
An object of this class contains the policy constraints applied to a ProfileInput used by a certificate enrollment request.
Represents a PolicyConstraintValue
An object of this class contains information of the default usage of a specific ProfileInput.
An object of this class contains a name value pair of the policy name and the ProfilePolicy object.
An object of this class stores a list of ProfileSet objects.
This class represents an enrollment profile.
Represents a profile attribute of a ProfileInput.
This class consists of methods for accessing the ProfileResource.
Stores information about a profile
Represents a collection of ProfileDataInfo objects. Also encapsulates the links for the list of the objects stored.
This class encapsulates all the attributes of a profile to generate a specific property of a certificate. Ex. Subject name, Requestor Information etc.
This class defines the output of a certificate enrollment request using a profile.
This class represents the policy a profile adheres to. An object of this class stores the default values for profile and the constraints present on the values of the attributes of the profile submitted for an enrollment request.
Stores a list of ProfilePolicy objects.
system Module
class pki.system.ConfigurationRequest- Bases:
object class pki.system.ConfigurationResponse- Bases:
object class pki.system.SecurityDomainClient(connection)- Bases:
object get_old_security_domain_info()- Contact the security domain CA specified in the connection object used to construct this client and get the security domain using the old servlet-based interface. This method is useful when contacting old servers which do not provide the REST API.
Returns- pki.system.SecurityDomainInfo
get_security_domain_info()- Contact the security domain CA specified in the connection object used to construct this client and get the security domain using the REST API.
Returns- pki.system.SecurityDomainInfo
class pki.system.SecurityDomainHost- Bases:
object classmethod from_json(json_value)- Constructs a SecurityDomainHost object from JSON.
Parametersjson_value(str) — JSON string representing a security domain host.Returns- SecurityDomainHost
class pki.system.SecurityDomainInfo- Bases:
object classmethod from_json(json_value)- Create a SecurityDomainInfo object from JSON.
Parametersjson_value(str) — JSON representation of a security domain.Returns- SecurityDomainInfo
class pki.system.SecurityDomainSubsystem- Bases:
object classmethod from_json(json_value)- Constructs a SecurityDomainSubsystem from a JSON representation.
Parametersjson_value(str) — JSON representation of the Security Domain SubsystemReturns- SecurityDomainSubsystem
class pki.system.SystemCertData- Bases:
object class pki.system.SystemConfigClient(connection)- Bases:
object configure(data)- Contacts the server and invokes the Java configuration REST API to configure a Dogtag subsystem.
Parametersdata(ConfigurationRequest) — Configuration request containing all the input needed to configure the subsystemReturns- ConfigurationResponse — response from configuration servlet.
class pki.system.SystemStatusClient(connection)- Bases:
object get_status()- Checks the status of the subsystem by calling the getStatus() servlet. This is used to determine if the server is up and ready to receive and process requests.
Returns- str – getStatus response
Class used to represent a configuration request to be submitted to the Java installation servlet during the execution of pkispawn.
This class is the python equivalent of the Java class: com.netscape.certsrv.system.ConfigurationRequest
Class used to represent the response from the Java configuration servlet during the execution of pkispawn.
This class is the python equivalent of the Java class: com.netscape.certsrv.system.ConfigurationRequest
Client used to get the security domain from a security domain CA. The connection details for the security domain CA are specified in a PKIConnection object used to construct this client.
Class representing a security domain host.
Class representing the entire security domain. This is essentially a list of SecurityDomainSubsystem components.
Class representing a security domain subsystem. This is essentially a list of SecurityDomainHost objects of a particular subsystem type (ca, kra, tps, tks, ocsp).
Class used to represent the data for a system certificate, which is used in the data passed into and returned from the Java installation servlet during the execution of pkispawn.
This class is the python equivalent of the Java class: com.netscape.certsrv.system.SystemCertData
Client used to interact with the Java configuration servlet to configure a Dogtag subsystem during the execution of pkispawn.
The connection details for the system being configured are passed in the PKIConnection object used when constructing this object.
Client used to check the status of a Dogtag subsystem.
systemcert Module
Module containing the Python client classes for the SystemCert REST API
class pki.systemcert.SystemCertClient(connection)- Bases:
object get_transport_cert(inst, *args, **kwargs)- Return transport certificate.
Returns- pki.cert.CertData — transport certificate data
Class encapsulating and mirroring the functionality in the SystemCertResource Java interface class defining the REST API for system certificate resources.
upgrade Module
class pki.upgrade.PKIUpgradeScriptlet- Bases:
object backup(path)can_upgrade()get_backup_dir()init()revert()update_tracker()upgrade()upgrade_system()class pki.upgrade.PKIUpgradeTracker(name, filename, delimiter=’=’, version_key=’PKI_VERSION’, index_key=’PKI_UPGRADE_INDEX’)- Bases:
object get_index()get_version()remove()remove_index()remove_version()set(version)set_index(index)set_version(version)show()class pki.upgrade.PKIUpgrader(upgrade_dir=’/usr/share/pki/upgrade’, version=None, index=None, silent=False)- Bases:
object all_versions()get_current_version()get_target_version()get_tracker()is_complete()remove_tracker()reset_tracker()revert()revert_version(version)scriptlets(version)set_tracker(version)show_tracker()status()upgrade()upgrade_version(version)version_dir(version)versions()class pki.upgrade.Version(obj)- Bases:
object
util Module
Module containing utility functions and classes for the Dogtag python code
pki.util.chown(path, uid, gid)- Change ownership of a folder and its contents.
pki.util.copy(source, dest)- Copy a file or a folder and its contents.
pki.util.copydirs(source, dest)- Copy a folder and its parents while preserving their attributes.
pki.util.copyfile(source, dest, overwrite=True)- Copy a file or link while preserving its attributes.
pki.util.customize_file(input_file, output_file, params)- Customize a file with specified parameters.
- •
- genindex
- •
- modindex
- •
- search
AUTHOR
Dogtag PKI Project Team
COPYRIGHT
2014, Dogtag PKI Team