VerificationResult.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef PDFTRON_H_CPPPDFVerificationResult
#define PDFTRON_H_CPPPDFVerificationResult
#include <C/PDF/TRN_VerificationResult.h>

#include <Common/BasicTypes.h>
#include <Common/UString.h>
#include <PDF/PDFDoc.h>

#include <Crypto/DigestAlgorithm.h>
#include <PDF/DisallowedChange.h>

#include <vector>

namespace pdftron { namespace PDF { 
    class TrustVerificationResult;

class VerificationResult
{
public:
    typedef pdftron::PDF::DisallowedChange DisallowedChange;
    //enums:
    enum DocumentStatus {
        e_no_error = 0,
        e_corrupt_file = 1,
        e_unsigned = 2,
        e_bad_byteranges = 3,
        e_corrupt_cryptographic_contents = 4
    };
    enum DigestStatus {
        e_digest_invalid = 0,
        e_digest_verified = 1,
        e_digest_verification_disabled = 2,
        e_weak_digest_algorithm_but_digest_verifiable = 3,
        e_no_digest_status = 4,
        e_unsupported_encoding = 5,
        e_unsupported_digest_algorithm = 6
    };
    enum TrustStatus {
        e_trust_verified = 0,
        e_untrusted = 1,
        e_trust_verification_disabled = 2,
        e_no_trust_status = 3,
        e_unsupported_trust_features = 4
    };
    enum ModificationPermissionsStatus {
        e_invalidated_by_disallowed_changes = 0,
        e_has_allowed_changes = 1,
        e_unmodified = 2,
        e_permissions_verification_disabled = 3,
        e_no_permissions_status = 4,
        e_unsupported_permissions_features = 5
    };
    VerificationResult(const VerificationResult& other);
    VerificationResult& operator= (const VerificationResult& other);
    ~VerificationResult();
    
    void Destroy();

    //methods:
    
    bool GetVerificationStatus() const;
    
    DocumentStatus GetDocumentStatus() const;
    
    DigestStatus GetDigestStatus() const;
    
    TrustStatus GetTrustStatus() const;
    
    ModificationPermissionsStatus GetPermissionsStatus() const;

    bool HasTrustVerificationResult() const;
    TrustVerificationResult GetTrustVerificationResult() const;
    
    std::vector<DisallowedChange> GetDisallowedChanges() const;

    Crypto::DigestAlgorithm::Type GetDigestAlgorithm() const;
    
    UString GetDocumentStatusAsString() const;
    
    UString GetDigestStatusAsString() const;
    
    UString GetTrustStatusAsString() const;
    
    UString GetPermissionsStatusAsString() const;

#ifdef SWIG
    // We use an std::vector of UTF-8 std::strings for SWIG, because SWIG has trouble with mapping UString to string when it's in a vector<UString>.
    std::vector<std::string> GetUnsupportedFeatures() const;
#else
    std::vector<UString> GetUnsupportedFeatures() const;
#endif

#ifdef SWIG
    VerificationResult();
#endif

#ifndef SWIGHIDDEN
    VerificationResult(TRN_VerificationResult impl);
    TRN_VerificationResult m_impl;
#endif

private:

#ifndef SWIGHIDDEN
    mutable bool m_owner; 
#endif
};


} //end pdftron
} //end PDF

#include <Impl/TrustVerificationResult.inl>

#endif //PDFTRON_H_CPPPDFVerificationResult