Skip to content

get_revocation_status

get_revocation_status(
    signature_timestamp: Timestamp,
    platform_id: PlatformId,
    profile_version_arn: Arn,
    job_arn: Arn,
    certificate_hashes: CertificateHashes,
    *,
    config_overrides: Optional[signerClientConfig] = None,
) -> GetRevocationStatusResponse

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

Parameters:

  • signature_timestamp (Timestamp) –

    The timestamp of the signature that validates the profile or job.

  • platform_id (PlatformId) –

    The ID of a signing platform.

  • profile_version_arn (Arn) –

    The version of a signing profile.

  • job_arn (Arn) –

    The ARN of a signing job.

  • certificate_hashes (CertificateHashes) –

    A list of composite signed hashes that identify certificates.

    A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.

    The following example shows how to calculate a hash for this parameter using OpenSSL commands:

    openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs

    openssl sha384 < childCert.tbs -binary > childCertTbsHash

    openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs

    openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex

    cat certificateHash.hex | tr -d '\n'

Raises:

Source code in docs_src/capo_signer/_services/signer.py
def get_revocation_status(
    self,
    signature_timestamp: "capo_signer.types.timestamp.Timestamp",
    platform_id: "capo_signer.types.platform_id.PlatformId",
    profile_version_arn: "capo_signer.types.arn.Arn",
    job_arn: "capo_signer.types.arn.Arn",
    certificate_hashes: "capo_signer.types.certificate_hashes.CertificateHashes",
    *,
    config_overrides: Optional[signerClientConfig] = None,
) -> "capo_signer.types.get_revocation_status_response.GetRevocationStatusResponse":
    r"""<p>Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.</p>

    Args:
        signature_timestamp: <p>The timestamp of the signature that validates the profile or job.</p>
        platform_id: <p>The ID of a signing platform. </p>
        profile_version_arn: <p>The version of a signing profile.</p>
        job_arn: <p>The ARN of a signing job.</p>
        certificate_hashes: <p>A list of composite signed hashes that identify certificates.</p> <p>A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.</p> <p>The following example shows how to calculate a hash for this parameter using OpenSSL commands: </p> <p> <code>openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs</code> </p> <p> <code>openssl sha384 < childCert.tbs -binary > childCertTbsHash</code> </p> <p> <code>openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs</code> </p> <p> <code>openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex</code> </p> <p> <code>cat certificateHash.hex | tr -d '\n'</code> </p>

    Raises:
        capo_signer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_signer.errors.internal_service_error_exception.InternalServiceErrorException: <p>An internal error occurred.</p>
        capo_signer.errors.too_many_requests_exception.TooManyRequestsException: <p>The allowed number of job-signing requests has been exceeded.</p> <p>This error supersedes the error <code>ThrottlingException</code>.</p>
        capo_signer.errors.validation_exception.ValidationException: <p>You signing certificate could not be validated.</p>
        capo_signer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_signer.types.get_revocation_status_request.GetRevocationStatusRequest]",
    ) -> OperationResponse[
        "capo_signer.types.get_revocation_status_response.GetRevocationStatusResponse"
    ]:
        import capo_signer._operations.wallaby_service.get_revocation_status

        output, http_response = (
            capo_signer._operations.wallaby_service.get_revocation_status.get_revocation_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRevocationStatus")
    )
    input_: capo_signer.types.get_revocation_status_request.GetRevocationStatusRequest = {
        "signature_timestamp": signature_timestamp,
        "platform_id": platform_id,
        "profile_version_arn": profile_version_arn,
        "job_arn": job_arn,
        "certificate_hashes": certificate_hashes,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output