Foxit PDF SDK

Instance Methods | List of all members
<FSRevocationCallback> Protocol Reference

Inherits <NSObject>.

## Instance Methods
(NSArray< NSData * > *) | - getCertChainFromSignature:
| A callback function used to get the cert chain from the signature content. More...
(FSTimeRange *) | - getCertValidTimeRange:
| A callback function used to get the time range that represents validity period of a certificate. More...
(NSData *) | - getCRLSignature:
| A callback function used to get the signature content from a CRL response. More...
(FSDateTime *) | - getDTSTime:
| A callback function used to get the DTS (document time stamp signature) time from signature content. More...
(FSCertIssuerPair *) | - getOCSPCertAndIssuer:trust_cert_chain:
| A callback function used to get the cert-issuer pair of OCSP response. More...
(FSDateTime *) | - getOCSPProducedAtTime:
| A callback function used to get the produce time of the OCSP response. More...
(NSData *) | - getOCSPSignature:
| A callback function used to get the signature content from a OCSP response. More...
(FSResponse *) | - getResponseOnLineForSingleCert:
| A callback function used to get response online for a certificate. More...
(FSRevocationArrayInfo *) | - getRevocationInfoFromSignatureData:
| A callback function used to get the revocation information (in array type) from a signature. More...
(NSData *) | - getTSTSignature:
| A callback function used to get the time stamp token content from a signature content. More...
(FSDateTime *) | - getTSTTime:
| A callback function used to get the time stamp token time from signature content. More...
(BOOL) | - isCA:
| A callback function used to judge whether a certificate is a CA certificate. More...
(BOOL) | - isIssuerMatchCert:
| A callback function used to check if an issuer matches a certificate. More...
(BOOL) | - isOCSPNeedCheck:
| A callback function used to get flag which decides if need to check OCSP response. More...
(FSCertVerifyResult *) | - verifyCRL:crl_data:
| A callback function used to verify whether the CRL response matches the certificate and get the verify result for the certificate. More...
(FSCertVerifyResult *) | - verifyOCSP:ocsp_data:
| A callback function used to verify whether the OCSP response matches the certificate and get the verify result for the certificate. More...

## Detailed Description

This class represent a revocation callback object which is used for class FSLTVVerifier. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

See also
  FSLTVVerifier

## Method Documentation

## ◆ getCertChainFromSignature:()

- (NSArray<NSData*>*) getCertChainFromSignature: |  | (NSData *) | signature_content |
| required

A callback function used to get the cert chain from the signature content.

Parameters

  [in] | signature_content | Signature content.

Returns
  An array that represents the cert chain.

## ◆ getCertValidTimeRange:()

- (FSTimeRange*) getCertValidTimeRange: |  | (NSData *) | cert |
| required

A callback function used to get the time range that represents validity period of a certificate.

Parameters

  [in] | cert | Certificate content.

Returns
  Time range that represents validity period of the certificate.

## ◆ getCRLSignature:()

- (NSData*) getCRLSignature: |  | (NSData *) | crl_data |
| required

A callback function used to get the signature content from a CRL response.

Parameters

  [in] | crl_data | CRL response content.

Returns
  Signature content.

## ◆ getDTSTime:()

- (FSDateTime*) getDTSTime: |  | (NSData *) | signature_content |
| required

A callback function used to get the DTS (document time stamp signature) time from signature content.

Parameters

  [in] | signature_content | Signature content.

Returns
  DTS time. utc_hour_offset and utc_minite_offset of this time would be ignored.

## ◆ getOCSPCertAndIssuer:trust_cert_chain:()

- (FSCertIssuerPair*) getOCSPCertAndIssuer: |  | (NSData *) | ocsp_data
trust_cert_chain: |  | (NSArray< NSData * > *) | trust_cert_chain
| required

A callback function used to get the cert-issuer pair of OCSP response.

Parameters

  [in] | ocsp_data | OCSP response data.
  [in] | trust_cert_chain | The trust cert chain used to find the issuer of the OCSP cert.

Returns
  A cert-issuer pair that obtained from OCSP.

## ◆ getOCSPProducedAtTime:()

- (FSDateTime*) getOCSPProducedAtTime: |  | (NSData *) | ocsp_data |
| required

A callback function used to get the produce time of the OCSP response.

Parameters

  [in] | ocsp_data | OCSP response content.

Returns
  Produce time of the OCSP response. utc_hour_offset and utc_minite_offset of this time would be ignored.

## ◆ getOCSPSignature:()

- (NSData*) getOCSPSignature: |  | (NSData *) | ocsp_data |
| required

A callback function used to get the signature content from a OCSP response.

Parameters

  [in] | ocsp_data | OCSP response content.

Returns
  Signature content .

## ◆ getResponseOnLineForSingleCert:()

- (FSResponse*) getResponseOnLineForSingleCert: |  | (FSCertIssuerPair *) | cert_issuer_pair |
| required

A callback function used to get response online for a certificate.

Parameters

  [in] | cert_issuer_pair | A cert-issuer pair which represents a certificate and an issuer for the certificate.

Returns
  Response for the certificate.

## ◆ getRevocationInfoFromSignatureData:()

- (FSRevocationArrayInfo*) getRevocationInfoFromSignatureData: |  | (NSData *) | signature_content |
| required

A callback function used to get the revocation information (in array type) from a signature.

Parameters

  [in] | signature_content | Signature content.

Returns
  Information in array type of revocation information.

## ◆ getTSTSignature:()

- (NSData*) getTSTSignature: |  | (NSData *) | signature_content |
| required

A callback function used to get the time stamp token content from a signature content.

Parameters

  [in] | signature_content | Signature content.

Returns
  Time stamp token content.

## ◆ getTSTTime:()

- (FSDateTime*) getTSTTime: |  | (NSData *) | signature_content |
| required

A callback function used to get the time stamp token time from signature content.

Parameters

  [in] | signature_content | Signature content.

Returns
  Time of time stamp token of a signature. utc_hour_offset and utc_minite_offset of this time would be ignored.

## ◆ isCA:()

- (BOOL) isCA: |  | (NSData *) | cert |
| required

A callback function used to judge whether a certificate is a CA certificate.

Parameters

  [in] | cert | Certificate content.

Returns
  YES means the certificate is a CA certificate, while NO means not.

## ◆ isIssuerMatchCert:()

- (BOOL) isIssuerMatchCert: |  | (FSCertIssuerPair *) | cert_issuer_pair |
| required

A callback function used to check if an issuer matches a certificate.

Parameters

  [in] | cert_issuer_pair | A cert-issuer pair. Issuer in this pair is to be checked if it matches the ceritificate in this pair.

Returns
  YES means issuer matches the certificate, while NO means not.

## ◆ isOCSPNeedCheck:()

- (BOOL) isOCSPNeedCheck: |  | (NSData *) | ocsp_data |
| required

A callback function used to get flag which decides if need to check OCSP response.

Parameters

  [in] | ocsp_data | OCSP response content.

Returns
  YES means need to check OCSP response, while NO means no need.

## ◆ verifyCRL:crl_data:()

- (FSCertVerifyResult*) verifyCRL: |  | (FSCertIssuerPair *) | cert_issuer_pair
crl_data: |  | (NSData *) | crl_data
| required

A callback function used to verify whether the CRL response matches the certificate and get the verify result for the certificate.

Parameters

  [in] | cert_issuer_pair | A cert-issuer pair which represents a certificate and an issuer for the certificate.
  [in] | crl_data | CRL content.

Returns
  Certificate verify result that obtained from CRL.

## ◆ verifyOCSP:ocsp_data:()

- (FSCertVerifyResult*) verifyOCSP: |  | (FSCertIssuerPair *) | cert_issuer_pair
ocsp_data: |  | (NSData *) | ocsp_data
| required

A callback function used to verify whether the OCSP response matches the certificate and get the verify result for the certificate.

Parameters

  [in] | cert_issuer_pair | A cert-issuer pair which represents a certificate and an issuer for the certificate.
  [in] | ocsp_data | OCSP content.

Returns
  Certificate verify result that obtained from CRL.