com.itextpdf.signatures Documentation Differences

iText7 7.1.8 Overview Package Class Text Changes Statistics Help

Generated by
JDiff

PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

com.itextpdf.signatures Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.signatures as colored differences. Deletions are shown ~~like this~~ , and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.

 
  
 Class CertificateInfo.X500Name, ASN1ObjectIdentifier EmailAddress 
  
 
  
 
  
    Email address (RSA PKCS#9 extension) - IA5String. 
    Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here. 
   
  
 Class CertificateInfo.X509NameTokenizer 
  
 
  
 
  
    Class for breaking up an X500 Name into it's component tokens, similar to java.util.StringTokenizer. We need this class as some of the lightweight Java environments don't support classes such as StringTokenizer. 
   
  
 Class PdfPKCS7, boolean verifySignatureIntegrityAndAuthenticity() 
  
 
  
 
  
    Verifies that signature integrity is intact (or in other words that signed data wasn't modified) by checking that embedded data digest corresponds to the calculated one. Also ensures that signature is genuine and is created by the owner of private key that corresponds to the declared public certificate. 
    Even though signature can be authentic and signed data integrity can be intact, one shall also always check that signed data is not only a part of PDF contents but is actually a complete PDF file. In order to check that given signature covers the current com.itextpdf.kernel.pdf.PdfDocument please use SignatureUtil.signatureCoversWholeDocument(String) method. 
      @return true if the signature checks out, false otherwise @throws java.security.GeneralSecurityException if this signature object is not initialized properly, the passed-in signature is improperly encoded or of the wrong type, if this signature algorithm is unable to process the input data provided, if the public key is invalid or if security provider or signature algorithm are not recognized, etc. 
   
  
 Class PdfSigner, void setFieldLockDict(PdfSigFieldLock) 
  
 
  
 
  
    Setter for the field lock dictionary. 
    Be aware: if a signature is created on an existing signature field, then its /Lock dictionary takes the precedence (if it exists). @param fieldLock Field lock dictionary 
   
  
 Class SignatureUtil, PdfPKCS7 readSignatureData(String) 
  
 
  
 
  
    Prepares an PdfPKCS7 instance for the given signature. This method handles signature parsing and might throw an exception if signature is malformed. 
    The returned PdfPKCS7 can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field.  
    In order to validate the signature it is required to check if it covers the entire file, otherwise one cannot be sure that signature in question indeed signs the data that constitutes current PdfDocument with all its contents. In order to check that given signature covers the current PdfDocument please use .signatureCoversWholeDocument(String) method. @param signatureFieldName the signature field name @return a PdfPKCS7 instance which can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field. 
  
 Class SignatureUtil, PdfPKCS7 readSignatureData(String, String) 
  
 
  
 
  
    Prepares an PdfPKCS7 instance for the given signature. This method handles signature parsing and might throw an exception if signature is malformed. 
    The returned PdfPKCS7 can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field.  
    Prepared PdfPKCS7 instance calculates digest based on signature's /ByteRange entry. In order to check that /ByteRange is properly defined and given signature indeed covers the current PDF document revision please use .signatureCoversWholeDocument(String) method. @param signatureFieldName the signature field name @param securityProvider the security provider or null for the default provider @return a PdfPKCS7 instance which can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field. 
  
 Class SignatureUtil, boolean signatureCoversWholeDocument(String) 
  
 
  
 
  
    Checks if the signature covers the entire document (except for signature's Contents) or just a part of it. 
    If this method does not return {@code true} it means that signature in question does not cover the entire contents of current PdfDocument. Such signatures cannot be considered as verifying the PDF document, because content that is not covered by signature might have been modified since the signature creation.  
    @param name the signature field name @return true if the signature covers the entire document, false if it doesn't 
  
 Class SignatureUtil, PdfPKCS7 verifySignature(String) 
  
 
  
 
  
    Prepares an PdfPKCS7 instance for the given signature. This method handles signature parsing and might throw an exception if signature is malformed. 
    The returned PdfPKCS7 can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field.  
    In order to check that given signature covers the current PdfDocument revision please use .signatureCoversWholeDocument(String) method. @param name the signature field name @return a PdfPKCS7 instance which can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field. @deprecated This method is deprecated and will be removed in future versions. Please use .readSignatureData(String) instead. 
  
 Class SignatureUtil, PdfPKCS7 verifySignature(String, String) 
  
 
  
 
  
    Prepares an PdfPKCS7 instance for the given signature. This method handles signature parsing and might throw an exception if signature is malformed. 
    The returned PdfPKCS7 can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field.  
    In order to check that given signature covers the current PdfDocument revision please use .signatureCoversWholeDocument(String) method. @param name the signature field name @param provider the security provider or null for the default provider @return a PdfPKCS7 instance which can be used to fetch additional info about the signature and also to perform integrity check of data signed by the given signature field. @deprecated This method is deprecated and will be removed in future versions. Please use .readSignatureData(String, String) instead. 
   
  
 Class TSAClientBouncyCastle 
  
 
  
 
  
    Time Stamp Authority Client interface implementation using Bouncy Castle org.bouncycastle.tsp package. 
    Created by Aiken Sam, 2006-11-15, refactored by Martin Brunecky, 07/15/2007 for ease of subclassing.