PSPDFSignatureStatus

Objective-C


@interface PSPDFSignatureStatus : NSObject

Swift

class PDFSignatureStatus : NSObject

Represents the status of a digital signature after it has been validated.

  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_EMPTY_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer

    Undocumented

    Declaration

    Objective-C

    PSPDF_EMPTY_INIT_UNAVAILABLE
  • Designated initializer. Initializes a signature status from a given signer name, a signing date, and whether the signature covers the entire document, that is, if there are no further changes possibly added by an incremental save to the document.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSigner:(nullable NSString *)signer
                               signingDate:(nullable NSDate *)date
                      coversEntireDocument:(BOOL)coversEntireDocument;

    Swift

    init(signer: String?, signing date: Date?, coversEntireDocument: Bool)
  • The signer name

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *signer;

    Swift

    var signer: String? { get }
  • Set to the trusted time of the timestamp, if the signature was timestamped. Otherwise this is the creation date of the signature.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSDate *signingDate;

    Swift

    var signingDate: Date? { get }
  • Returns YES if the signature covers the entire document, that is, if there are no further changes possibly added by an incremental save to the document. NO otherwise.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL coversEntireDocument;

    Swift

    var coversEntireDocument: Bool { get }
  • Whether the signature is valid.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isValid;

    Swift

    var isValid: Bool { get }
  • Returns an array of problems as text strings

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull problems;

    Swift

    var problems: [String] { get }
  • The status severity (None, if no problems; warning, or error).

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureStatusSeverity severity;

    Swift

    var severity: PDFSignatureStatus.Severity { get }
  • The integrity status of this signature field, that is, if the document that is protected by this signature has been modified and the modification has broken this digital signature.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureIntegrityStatus signatureIntegrityStatus;

    Swift

    var signatureIntegrityStatus: PDFSignatureStatus.Integrity { get }
  • Returns a status summary with the specified signer name and signing date

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull summary;

    Swift

    var summary: String { get }
  • Returns the signature type, either a basic CMS/PKCS#7, an advanced CAdES signature, or a document timestamp signature.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureType signatureType;

    Swift

    var signatureType: PDFSignatureType { get }
  • The level of PAdES conformance of the digital signature, or PSPDFPadesSignatureLevelNone if the signature is not PAdES.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFPadesSignatureLevel padesSignatureLevel;

    Swift

    var padesSignatureLevel: PDFPadesSignatureLevel { get }
  • The signature timestamp information, or nil if the digital signature is not timestamped.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) PSPDFTimestampInformation *timestampStatus;

    Swift

    var timestampStatus: PSPDFTimestampInformation? { get }
  • Returns the “valid_from” date of the signing certificate of the chain used for creating the signature. Before this date the certificate is not valid.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *validFrom;

    Swift

    var validFrom: Date? { get }
  • Returns the “valid_until” date of this certificate. After this date the certificate is not valid.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSDate *validUntil;

    Swift

    var validUntil: Date? { get }
  • The certificate’s serial number

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSData *serialNumber;

    Swift

    var serialNumber: Data? { get }
  • The subject’s DN (distinguished name).

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *subjectDistinguishedName;

    Swift

    var subjectDistinguishedName: String? { get }
  • The issuer’s CN (common name).

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *issuerCommonName;

    Swift

    var issuerCommonName: String? { get }
  • Certificate’s public key.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) PSPDFRSAKey *publicKey;

    Swift

    var publicKey: RSAKey? { get }
  • The digest (hash) algorithm used when computing the digital signature.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureHashAlgorithm hashAlgorithm;

    Swift

    var hashAlgorithm: PDFSignatureHashAlgorithm { get }
  • The encryption algorithm used by the digital signature (for example, RSA).

    Declaration

    Objective-C

    @property (nonatomic, readonly) PSPDFSignatureEncryptionAlgorithm encryptionAlgorithm;

    Swift

    var encryptionAlgorithm: PDFSignatureEncryptionAlgorithm { get }
  • The certificate is self-signed status and valid. That means if isSelfSigned is true, isValid will also be true.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isSelfSigned;

    Swift

    var isSelfSigned: Bool { get }
  • Whether the digital signature is enabled for long-term validation (LTV) or not.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isLongTermValidationEnabled;

    Swift

    var isLongTermValidationEnabled: Bool { get }