Foxit PDF SDK  9.1
<FSRevocationCallback> Protocol Reference
Inheritance diagram for <FSRevocationCallback>:

Instance Methods

(NSArray< NSData * > *) - getCertChainFromSignature:
 A callback function used to get the cert chain for the signature content. More...
 
(FSTimeRange *) - getCertValidTimeRange:
 A callback function used to get the valid time range of the certificate.. More...
 
(NSData *) - getCRLSignature:
 A callback function used to get the signature from a CRL response. More...
 
(FSDateTime *) - getDTSTime:
 A callback function used to get the document time stamp time from signature content. More...
 
(FSCertIssuerPair *) - getOCSPCertAndIssuer:trust_cert_chain:
 A callback function used to get the cert and issuer 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 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 from a signature. More...
 
(NSData *) - getTSTSignature:
 A callback function used to get the time stamp token signature content form 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. More...
 
(FSCertVerifyResult *) - verifyOCSP:ocsp_data:
 A callback function used to verify whether the OCSP response matches the certificate. More...
 

Detailed Description

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

Method Documentation

◆ getCertChainFromSignature:

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

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

Parameters
[in]signature_contentSignature content.
Returns
A string array that represents the cert chain.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getCertValidTimeRange:

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

A callback function used to get the valid time range of the certificate..

Parameters
[in]certA certificate.
Returns
Valid time range of the certificate.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getCRLSignature:

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

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

Parameters
[in]crl_dataCRL response content.
Returns
Signature content .
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getDTSTime:

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

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

Parameters
[in]signature_contentSignature content.
Returns
Time of document time stamp. utc_hour_offset and utc_minite_offset are ignored.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ 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 and issuer of OCSP response.

Parameters
[in]ocsp_dataOCSP response data.
[in]trust_cert_chainThe trust cert chain to find the issuer of the OCSP cert.
Returns
Cert-issuer pair.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getOCSPProducedAtTime:

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

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

Parameters
[in]ocsp_dataOCSP response content.
Returns
Produce time of the OCSP response. utc_hour_offset and utc_minite_offset are ignored.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getOCSPSignature:

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

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

Parameters
[in]ocsp_dataOCSP response content.
Returns
Signature content .
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getResponseOnLineForSingleCert:

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

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

Parameters
[in]cert_issuer_pairCertificate and issuer pair.
Returns
Response for the certificate.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getRevocationInfoFromSignatureData:

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

A callback function used to get the revocation information from a signature.

Parameters
[in]signature_contentSignature content.
[out]OCSPVectorThe OCSP response got from the signature.
[out]CRLVectorThe CRL response got from the signature.
Returns
Revocation array information object.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getTSTSignature:

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

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

Parameters
[in]signature_contentSignature content.
Returns
Signature content of the time stamp token signature.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ getTSTTime:

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

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

Parameters
[in]signature_contentSignature content.
Returns
Time of time stamp token of a signature. utc_hour_offset and utc_minite_offset are ignored.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ isCA:

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

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

Parameters
[in]certA certificate.
Returns
true means the certificate is a CA certificate, while false 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_pairCertificate and issuer pair.
Returns
true means issuer matches the certificate, while false 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_dataOCSP response content.
Returns
true</> means need to check OCSP response, while false 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.

Parameters
[in]cert_issuer_pairCertificate and issuer pair.
[in]crl_dataCRL content.
Returns
Certificate verify result.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .

◆ 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.

Parameters
[in]cert_issuer_pairCertificate and issuer pair.
[in]ocsp_dataOCSP content.
Returns
Certificate verify result.
Note
User can throw exception for errors. Please refere to class and values starting from foxit::e_ErrFile .