fs_ltvverifier.h

Go to the documentation of this file.

#ifndef FS_LTVVERIFIER_H_
#define FS_LTVVERIFIER_H_

#include "common/fs_common.h"
#include "pdf/fs_pdfdoc.h"

namespace foxit {
namespace pdf {
class Response FS_FINAL : public Object{
 public:
  typedef enum _ResponseType {
    e_TypeNone = 0,
    e_TypeCRL = 1,
    e_TypeOCSP = 2
  } ResponseType;
  

  Response(ResponseType type, const String& response_data) {
    this->type = type;
    this->response_data = response_data;
  }

  Response() : type(Response::e_TypeNone) {}

  ~Response() {}

  Response(const Response& other) {
    type = other.type;
    response_data = other.response_data;
  }

  Response& operator = (const Response& other) {
    type = other.type;
    response_data = other.response_data;
    return *this;
  }

  bool operator == (const Response& other) const {
    return (type == other.type && response_data == other.response_data);
  }

  bool operator != (const Response& other) const {
    return!(*this == other);
  }

  void Set(ResponseType type, const String& response_data) {
    this->type = type;
    this->response_data = response_data;
  }

  ResponseType type;

  String response_data;
};

class TimeRange FS_FINAL : public Object{
 public:
  TimeRange(const DateTime& start_time, const DateTime& end_time) {
    this->start_time = start_time;
    this->end_time = end_time;
  }

  TimeRange() {}

  ~TimeRange() {}

  TimeRange(const TimeRange& other) {
    start_time = other.start_time;
    end_time = other.end_time;
  }

  TimeRange& operator = (const TimeRange& other) {
    start_time = other.start_time;
    end_time = other.end_time;
    return *this;
  }

  bool operator == (const TimeRange& other) const {
    return (start_time == other.start_time && end_time == other.end_time);
  }

  bool operator != (const TimeRange& other) const {
    return!(*this == other);
  }

  void Set(const DateTime& start_time, const DateTime& end_time) {
    this->start_time = start_time;
    this->end_time = end_time;
  }

  DateTime start_time;
  DateTime end_time;
};

class CertVerifyResult FS_FINAL : public Object{
 public:
  typedef enum _CertStatus {
    e_CertStatusValid = 0,
    e_CertStatusRevoked = 1,
    e_CertStatusExpired = 2,
    e_CertStatusUnknown = 3
  } CertStatus;
  
  typedef enum _RevocationReason {
    e_ReasonNoStatus = -1,
    e_ReasonUnspecified = 0,
    e_ReasonKeyCompromise = 1,
    e_ReasonCACompromise = 2,
    e_ReasonAffiliationChanged = 3,
    e_ReasonSuperseded = 4,
    e_ReasonCessationOfOperation = 5,
    e_ReasonCertificateHold = 6,
    e_ReasonRemoveFromCRL = 7,
    e_ReasonPrivilegeWithDrawn = 8,
    e_ReasonAACompromise = 9
  } RevocationReason;
  
  typedef enum _ResponseInfoLocation {
    e_LocationNotSet = 0,
    e_LocationDSS = 1,
    e_LocationSignature = 2,
    e_LocationOnline = 3
  } ResponseInfoLocation;
  

  CertVerifyResult(const String& cert, bool is_ca, bool is_trusted, const Response& response,
                   const TimeRange& response_effect_time_range, const DateTime& revoke_time,
                   CertStatus cert_status, RevocationReason reason,
                   const DateTime& cert_check_time,
                   bool exist_signature_vri_creation_time, const DateTime& signature_vri_creation_time,
                   bool exist_response_signature_vri_creation_time, const DateTime& response_signature_vri_creation_time,
                   ResponseInfoLocation response_info_location) {
    this->cert = cert;
    this->is_ca = is_ca;
    this->is_trusted = is_trusted;
    this->response = response;
    this->response_effect_time_range = response_effect_time_range;
    this->revoke_time = revoke_time;
    this->cert_status = cert_status;
    this->reason = reason;
    this->cert_check_time = cert_check_time;
    this->exist_signature_vri_creation_time = exist_signature_vri_creation_time;
    this->signature_vri_creation_time = signature_vri_creation_time;
    this->exist_response_signature_vri_creation_time = exist_response_signature_vri_creation_time;
    this->response_signature_vri_creation_time = response_signature_vri_creation_time;
    this->response_info_location = response_info_location;
  }

  CertVerifyResult()
      : is_ca(false)
      , is_trusted(false)
      , cert_status(CertVerifyResult::e_CertStatusUnknown)
      , reason(CertVerifyResult::e_ReasonNoStatus)
      , exist_signature_vri_creation_time(false)
      , exist_response_signature_vri_creation_time(false)
      , response_info_location(CertVerifyResult::e_LocationNotSet) {}

  ~CertVerifyResult() {}

  CertVerifyResult(const CertVerifyResult& other) {
    cert = other.cert;
    is_ca = other.is_ca;
    is_trusted = other.is_trusted;
    response = other.response;
    response_effect_time_range = other.response_effect_time_range;
    revoke_time = other.revoke_time;
    cert_status = other.cert_status;
    reason = other.reason;
    cert_check_time = other.cert_check_time;
    exist_signature_vri_creation_time = other.exist_signature_vri_creation_time;
    signature_vri_creation_time = other.signature_vri_creation_time;
    exist_response_signature_vri_creation_time = other.exist_response_signature_vri_creation_time;
    response_signature_vri_creation_time = other.response_signature_vri_creation_time;
    response_info_location = other.response_info_location;
  }

  CertVerifyResult& operator = (const CertVerifyResult& other) {
    cert = other.cert;
    is_ca = other.is_ca;
    is_trusted = other.is_trusted;
    response = other.response;
    response_effect_time_range = other.response_effect_time_range;
    revoke_time = other.revoke_time;
    cert_status = other.cert_status;
    reason = other.reason;
    cert_check_time = other.cert_check_time;
    exist_signature_vri_creation_time = other.exist_signature_vri_creation_time;
    signature_vri_creation_time = other.signature_vri_creation_time;
    exist_response_signature_vri_creation_time = other.exist_response_signature_vri_creation_time;
    response_signature_vri_creation_time = other.response_signature_vri_creation_time;
    response_info_location = other.response_info_location;
    return *this;
  }

  bool operator == (const CertVerifyResult& other) const {
    return (cert == other.cert && is_ca == other.is_ca && is_trusted == other.is_trusted &&
            response == other.response &&
            response_effect_time_range == other.response_effect_time_range &&
            revoke_time == other.revoke_time &&
            cert_status == other.cert_status && reason == other.reason &&
            cert_check_time == other.cert_check_time &&
            exist_signature_vri_creation_time == other.exist_signature_vri_creation_time&&
            signature_vri_creation_time == other.signature_vri_creation_time &&
            exist_response_signature_vri_creation_time == other.exist_response_signature_vri_creation_time &&
            response_signature_vri_creation_time == other.response_signature_vri_creation_time &&
            response_info_location == other.response_info_location);
  }

  bool operator != (const CertVerifyResult& other) const {
    return!(*this == other);
  }

  void Set(const String& cert, bool is_ca, bool is_trusted, const Response& response,
           const TimeRange& response_effect_time_range, const DateTime& revoke_time,
           CertStatus cert_status, RevocationReason reason,
           const DateTime& cert_check_time,
           bool exist_signature_vri_creation_time, const DateTime& signature_vri_creation_time,
           bool exist_response_signature_vri_creation_time, const DateTime& response_signature_vri_creation_time,
           ResponseInfoLocation response_info_location) {
    this->cert = cert;
    this->is_ca = is_ca;
    this->is_trusted = is_trusted;
    this->response = response;
    this->response_effect_time_range = response_effect_time_range;
    this->revoke_time = revoke_time;
    this->cert_status = cert_status;
    this->reason = reason;
    this->cert_check_time = cert_check_time;
    this->exist_signature_vri_creation_time = exist_signature_vri_creation_time;
    this->signature_vri_creation_time = signature_vri_creation_time;
    this->exist_response_signature_vri_creation_time = exist_response_signature_vri_creation_time;
    this->response_signature_vri_creation_time = response_signature_vri_creation_time;
    this->response_info_location = response_info_location;
  }

  String cert;

  bool is_ca;
  bool is_trusted;
  Response response;
  TimeRange response_effect_time_range;
  DateTime revoke_time;
  CertStatus cert_status;
  RevocationReason reason;
  DateTime cert_check_time;
  bool exist_signature_vri_creation_time;
  DateTime signature_vri_creation_time;
  bool exist_response_signature_vri_creation_time;
  DateTime response_signature_vri_creation_time;
  ResponseInfoLocation response_info_location;
};

FSDK_DEFINE_ARRAY(CertVerifyResultArray, CertVerifyResult);

class CertIssuerPair FS_FINAL : public Object{
 public:
  CertIssuerPair(const String& cert, const String& issuer) {
    this->cert = cert;
    this->issuer = issuer;
  }

  CertIssuerPair() {}

  ~CertIssuerPair() {}

  CertIssuerPair(const CertIssuerPair& other) {
    cert = other.cert;
    issuer = other.issuer;
  }

  CertIssuerPair& operator = (const CertIssuerPair& other) {
    cert = other.cert;
    issuer = other.issuer;
    return *this;
  }

  bool operator == (const CertIssuerPair& other) const {
    return (cert == other.cert && issuer == other.issuer);
  }

  bool operator != (const CertIssuerPair& other) const {
    return!(*this == other);
  }

  void Set(const String& cert, const String& issuer) {
    this->cert = cert;
    this->issuer = issuer;
  }

  String cert;
  String issuer;
};

class RevocationArrayInfo FS_FINAL : public Object{
 public:
  RevocationArrayInfo(const StringArray& ocsp_array, const StringArray& crl_array) {
    this->ocsp_array = ocsp_array;
    this->crl_array = crl_array;
  }

  RevocationArrayInfo() {}

  ~RevocationArrayInfo() {}

  RevocationArrayInfo(const RevocationArrayInfo& other) {
    ocsp_array = other.ocsp_array;
    crl_array = other.crl_array;
  }

  RevocationArrayInfo& operator = (const RevocationArrayInfo& other) {
    ocsp_array = other.ocsp_array;
    crl_array = other.crl_array;
    return *this;
  }

  bool operator == (const RevocationArrayInfo& other) const {
    size_t ocsp_count = ocsp_array.GetSize();
    size_t crl_count = crl_array.GetSize();
    if (ocsp_count != other.ocsp_array.GetSize() || crl_count != crl_array.GetSize())
      return false;
    for (size_t i = 0; i < ocsp_count; i++) {
      if (ocsp_array.GetAt(i) != other.ocsp_array.GetAt(i))
        return false;
    }
    for (size_t i = 0; i < ocsp_count; i++) {
      if (crl_array.GetAt(i) != other.crl_array.GetAt(i))
        return false;
    }
    return true;
  }

  bool operator != (const RevocationArrayInfo& other) const {
    return!(*this == other);
  }

  void Set(const StringArray& ocsp_array, const StringArray& crl_array) {
    this->ocsp_array = ocsp_array;
    this->crl_array = crl_array;
  }

  StringArray ocsp_array;
  StringArray crl_array;
};

class RevocationCallback {
 public:
  virtual void Release() = 0;
  
  virtual StringArray GetCertChainFromSignature(const String& signature_content) = 0;

  virtual Response GetResponseOnLineForSingleCert(const CertIssuerPair& cert_issuer_pair) = 0;

  virtual CertVerifyResult VerifyOCSP(const CertIssuerPair& cert_issuer_pair, const String& ocsp_data) = 0;

  virtual CertVerifyResult VerifyCRL(const CertIssuerPair& cert_issuer_pair, const String& crl_data) = 0;

  virtual bool IsCA(const String& cert) = 0;

  virtual DateTime GetDTSTime(const String& signature_content) = 0;

  virtual String GetTSTSignature(const String& signature_content) = 0;

  virtual DateTime GetTSTTime(const String& signature_content) = 0;

  virtual CertIssuerPair GetOCSPCertAndIssuer(const String& ocsp_data, const StringArray& trust_cert_chain) = 0;

  virtual DateTime GetOCSPProducedAtTime(const String& ocsp_data)  = 0;

  virtual bool IsOCSPNeedCheck(const String& ocsp_data) = 0;

  virtual TimeRange GetCertValidTimeRange(const String& cert) = 0;

  virtual String GetOCSPSignature(const String& ocsp_data) = 0;

  virtual String GetCRLSignature(const String& crl_data) = 0;

  virtual RevocationArrayInfo GetRevocationInfoFromSignatureData(const String& signature_content) = 0;

  virtual bool IsIssuerMatchCert(const CertIssuerPair& cert_issuer_pair) = 0;

 protected:
  ~RevocationCallback() {}
};

class TrustedCertStoreCallback {
 public:
  virtual bool IsCertTrusted(const String& cert) = 0;

  virtual bool IsCertTrustedRoot(const String& cert) = 0;

};

class CertChainResolverCallback {
 public:
  virtual StringArray GetCertificates() = 0;
};

class SignatureVerifyResult;
FSDK_DEFINE_ARRAY(SignatureVerifyResultArray, SignatureVerifyResult)


class LTVVerifier FS_FINAL : public Base{
 public:
  typedef enum _TimeType {
    e_SignatureCreationTime = 0,
    e_SignatureTSTTime = 1,
    e_CurrentTime = 2,
    e_VRICreationTime = 3
  } TimeType;
  
  typedef enum _VerifyMode {
    e_VerifyModeAcrobat = 1
  } VerifyMode;
  

  explicit LTVVerifier(const PDFDoc& document, bool is_verify_signature, bool use_expired_tst,
                       bool ignore_doc_info, TimeType time_type);

  LTVVerifier(const LTVVerifier& other);
  LTVVerifier& operator = (const LTVVerifier& other);

  bool operator == (const LTVVerifier& other) const;
  bool operator != (const LTVVerifier& other) const;

  ~LTVVerifier();

  bool IsEmpty() const;

  void SetRevocationCallback(RevocationCallback* callback);

  void SetVerifyMode(VerifyMode mode);

  void SetTrustedCertStoreCallback(TrustedCertStoreCallback* callback);

  SignatureVerifyResultArray Verify();

  SignatureVerifyResultArray VerifySignature(const Signature& signature);

  void AddDSS(const SignatureVerifyResult& signature_verify_result);

  void SetCertChainResolverCallback(CertChainResolverCallback* callback);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit LTVVerifier(FS_HANDLE handle = NULL);
};

class SignatureVerifyResult FS_FINAL : public Base{
 public:
  typedef enum _LTVState {
    e_LTVStateInactive = 0,
    e_LTVStateEnable = 1,
    e_LTVStateNotEnable = 2
  } LTVState;
  

  SignatureVerifyResult(const SignatureVerifyResult& other);
  SignatureVerifyResult& operator = (const SignatureVerifyResult& other);

  bool operator == (const SignatureVerifyResult& other) const;
  bool operator != (const SignatureVerifyResult& other) const;

  bool IsEmpty() const;

  ~SignatureVerifyResult();

  String GetSignatureName();
  String GetSignatureHashValue();
  uint32 GetSignatureState();
  DateTime GetSignatureCheckTime();
  LTVVerifier::TimeType GetSignatureCheckTimeType();
  LTVState GetLTVState();

  CertVerifyResultArray GetCertificateVerifyResults();

  SignatureVerifyResultArray GetOCSPSigantureVerifyResults();

  SignatureVerifyResult GetTSTSignatureVerifyResult();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit SignatureVerifyResult(FS_HANDLE handle = NULL);

};

}  // namespace pdf
}  // namespace foxit
#endif  // FS_LTVVERIFIER_H_