help_pages.commands =================== .. py:module:: help_pages.commands .. autoapi-nested-parse:: This module contains cli commands which are displayed in the help pages. Module Contents --------------- .. py:class:: KeyGenCommandBuilder Gets key-generation commands. .. py:method:: get_key_gen_command(public_key_info, cred_number, key_name = '') :staticmethod: Gets the key generation command corresponding to the provided type. :param public_key_info: Key type information. :param cred_number: The credential number to use. :param key_name: Custom key file name, will default to key-{ cred_number }.pem otherwise. :raises ValueError: If the public key information is inconsistent or key type is not supported. :returns: The key generation command as string. .. py:class:: CmpSharedSecretCommandBuilder Builds CMP shared-secret commands for different certificate profiles. .. py:method:: get_dynamic_cert_profile_command(host, pk, shared_secret, cred_number, sample_request) :staticmethod: Gets the dynamic certificate profile command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :param pk: The primary key of the device in question used as Key Identifier (KID). :param shared_secret: The shared secret. :param cred_number: The credential number - counter of issued credentials. :param sample_request: The sample certificate request in JSON format. :returns: The constructed command. .. py:method:: get_domain_credential_profile_command(host, pk, shared_secret) :staticmethod: Get the domain credential profile command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :param pk: The primary key of the device in question used as Key Identifier (KID). :param shared_secret: The shared secret. :param domain_name: The name of the domain will be used in the file names to mitigate overriding other files. :returns: The constructed command. .. py:class:: EstUsernamePasswordCommandBuilder Builds EST username-password commands for different certificate profiles. .. py:method:: get_dynamic_cert_profile_command(cred_number, sample_request) :staticmethod: Gets the dynamic certificate profile command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :param pk: The primary key of the device in question used as Key Identifier (KID). :param shared_secret: The shared secret. :param cred_number: The credential number - counter of issued credentials. :param sample_request: The sample certificate request in JSON format. :returns: The constructed command. .. py:method:: get_curl_enroll_command(est_username, est_password, host, cred_number) :staticmethod: Get the curl enroll command. :param est_username: The EST username to use. :param est_password: The EST password to use. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :param cred_number: The credential number - counter of issued credentials. :returns: The constructed command. .. py:method:: get_conversion_p7_pem_command(cred_number) :staticmethod: Get the conversion PKCS#7 (base64/PEM) to PEM command. :param cred_number: The credential number - counter of issued credentials. :returns: The constructed command. .. py:method:: get_domain_credential_profile_command() :staticmethod: Get the domain credential profile command. :returns: The constructed command. .. py:method:: get_curl_enroll_domain_credential_command(est_username, est_password, host) :staticmethod: Get the curl domain credential command. :param est_username: The EST username to use. :param est_password: The EST password to use. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :returns: The constructed command. .. py:method:: get_domain_credential_conversion_p7_pem_command() :staticmethod: Get the domain credential conversion base64 PKCS#7 to PEM command. :returns: The constructed command. .. py:class:: CmpClientCertificateCommandBuilder Builds CMP client-certificate (domain credential auth) commands for different certificate profiles. .. py:method:: get_dynamic_cert_profile_command(host, cred_number, sample_request) :staticmethod: Gets the dynamic certificate profile command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :param pk: The primary key of the device in question used as Key Identifier (KID). :param shared_secret: The shared secret. :param cred_number: The credential number - counter of issued credentials. :param sample_request: The sample certificate request in JSON format. :returns: The constructed command. .. py:method:: get_idevid_domain_credential_command(host) :staticmethod: Gets the idevid domain credential command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./cmp/p/... :returns: The constructed command. .. py:class:: EstClientCertificateCommandBuilder Builds EST username-password commands for different certificate profiles. .. py:method:: get_domain_credential_profile_command() :staticmethod: Get the domain credential profile command. :returns: The constructed command. .. py:method:: get_curl_enroll_application_credential(cred_number, host) :staticmethod: Get the curl enroll application credential command. :param cred_number: The credential number - counter of issued credentials. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./est/... :returns: The constructed command. .. py:method:: get_idevid_gen_csr_command() :staticmethod: Gets the IDevID gen CSR command. :returns: The constructed command. .. py:method:: get_idevid_enroll_domain_credential_command(host) :staticmethod: Gets the IDevID enroll domain credential command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./est/... :returns: The constructed command. .. py:method:: get_idevid_der_pem_conversion_command() :staticmethod: Gets the IDevID DER to PEM conversion command. :returns: The constructed command. .. py:method:: get_idevid_ca_certs_command(host) :staticmethod: Gets the IDevID ca certs command. :param host: The full host name and url path, e.g. https://127.0.0.1/.well-known./est/... :returns: The constructed command. .. py:method:: get_idevid_pkcs7_pem_conversion_command() :staticmethod: Gets the IDevID PKCS#7 to PEM conversion command. :returns: The constructed command.