使用HSM對文檔進行數字簽名或認證

硬體安全模組(HSM)和電子令牌是專用、加固和防篡改的計算設備,旨在安全地管理、處理和儲存數字密鑰。 這些設備直接連接到電腦或網路伺服器。

Adobe Experience Manager Forms可使用儲存在HSM或etoken上的憑證來eSign,或將伺服器端的數位簽名套用至檔案。 要將HSM或令牌設備與AEM Forms一起使用:

  1. 啟用DocAssurance服務。
  2. 設定Reader擴充功能的憑證。
  3. 在AEM Web Console中為HSM或Etoken裝置建立別名。
  4. 使用DocAssurance Service API使用儲存在設備上的數字密鑰來簽署或認證文檔。

使用AEM Forms配置HSM或Etoken設備之前

  • 安裝AEM Forms附加元件套件。
  • 在與AEM伺服器相同的電腦上安裝和配置HSM或etoken客戶端軟體。 需要客戶端軟體與HSM和令牌設備通信。
  • (僅限Microsoft Windows)設定JAVA_HOME_32環境變數,以指向安裝32位版本Java 8開發套件(JDK 8)的目錄。 目錄的預設路徑為C:\Program Files(x86)\Java\jdk<version>
  • (僅限OSGi上的AEM Forms)將根憑證安裝在信任存放區。 需要驗證已簽名的PDF
注意

在Microsoft Windows上,僅支援32位LunaSA或EToken客戶端。

啟用DocAssurance服務

預設情況下,DocAssurance服務未啟用。 執行下列步驟以啟用服務:

  1. 停止AEM Forms環境的Author例項。

  2. 開啟[AEM_root]\crx-quickstart\conf\sling.properties檔案進行編輯。

    注意

    如果您已使用[AEM_root]\crx-quickstart\bin\start.bat檔案來啟動AEM執行個體,請開啟[AEM_root]\crx-quickstart\sling.properties檔案進行編輯。

  3. 將下列屬性新增或取代至sling.properties檔案:

    sling.bootdelegation.sun=sun.*,com.sun.*,sun.misc.*
    sling.bootdelegation.ibm=com.ibm.xml.*,com.ibm.*
    sling.bootdelegation.class.com.rsa.jsafe.provider.JsafeJCE=com.rsa.*
    sling.bootdelegation.class.org.bouncycastle.jce.provider.BouncyCastleProvider=org.bouncycastle.*
    
  4. 儲存並關閉sling.properties檔案。

  5. 重新啟動AEM執行個體。

設定Reader擴展的證書

執行下列步驟來設定憑證:

  1. 以管理員身分登入AEM Author例項。

  2. 按一下全域導覽列上的​Adobe Experience Manager。 前往​工具 > 安全性 > 使用者

  3. 按一下使用者帳戶的​name​欄位。 將開啟「編輯用戶設定」頁。

  4. 在AEM製作例項上,憑證位於KeyStore中。 如果您之前尚未建立KeyStore,請按一下​建立KeyStore​並為KeyStore設定新密碼。 如果伺服器已包含KeyStore,請跳過此步驟。

  5. 在​編輯用戶設定​頁上,按一下​管理KeyStore

  6. 在「密鑰儲存管理」對話框中,展開「從密鑰儲存檔案​添加私鑰」選項並提供別名。​別名用於執行Reader擴展操作。

  7. 若要上傳憑證檔案,請按一下「選取金鑰存放區檔案​」並上傳.pfx檔案。

  8. 將與證書關聯的​密鑰儲存密碼私鑰密碼​和​私鑰別名​添加到相應欄位。 按一下​Submit

    注意

    要確定證書的P 私鑰別名,可以使用Java keytool命令:keytool -list -v -keystore [keystore-file] -storetype pkcs12

    注意

    在​密鑰儲存密碼​和​私鑰密碼​欄位中,指定證書檔案提供的密碼。

注意

若要在OSGi上使用AEM Forms,請驗證已簽署的PDF(信任存放區中安裝的根憑證)。

注意

轉至生產環境時,請以生產憑證取代評估憑證。 在更新過期或評估憑據之前,請確保刪除舊的Reader擴展憑據。

為設備建立別名

別名包含HSM或etoken所需的所有參數。 執行下列指示,為eSign或數字簽名使用的每個HSM或etoken憑據建立別名:

  1. 開啟AEM Console。 AEM主控台的預設URL為https://<host>:<port>/system/console/configMgr

  2. 開啟​HSM憑據配置服務​並指定以下欄位的值:

    • 憑據別名:指定用於標識別名的字串。此值用作某些數字簽名操作的屬性,如簽名簽名欄位操作。
    • DLL路徑:指定伺服器上HSM或Etoken客戶端庫的完全限定路徑。例如, C:\Program Files\LunaSA\cryptoki.dll。 在群集環境中,此路徑對於群集中的所有伺服器必須相同。
    • HSM針:指定訪問設備密鑰所需的密碼。
    • HSM插槽Id:指定整數類型的槽標識符。插槽ID是逐個用戶端設定。 如果將第二台電腦註冊到不同的分區(例如,同一HSM設備上的HSMPART2),則插槽1與客戶機的HSMPART2分區相關聯。

    注意: 在配置Etoken時,請為「HSM插槽ID」欄位指定數值。需要一個數值才能使簽名操作正常工作。

    • 憑證SHA1:為您使用的憑據指定公鑰(.cer)檔案的SHA1值(指紋)。請確定SHA1值中沒有使用空格。 如果您使用實體憑證,則不是必要憑證。
    • HSM設備類型:選擇HSM(Luna或其他)或eToken設備的製造商。

    按一下「儲存」。硬體安全模組已針對AEM Forms進行配置。 現在,您可以使用硬體安全模組搭配AEM Forms來簽署或認證檔案。

使用DocAssurance Service API簽名或認證具有儲存在設備上的數字密鑰的文檔 

以下示例代碼使用HSM或etoken來簽名或證明文檔。

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 * Copyright 2014 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.docassurance.samples;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.jcr.Binary;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.jcr.api.SlingRepository;
import org.apache.sling.jcr.resource.JcrResourceResolverFactory;

import com.adobe.aemfd.docmanager.Document;
import com.adobe.fd.docassurance.client.api.DocAssuranceException;
import com.adobe.fd.docassurance.client.api.DocAssuranceService;
import com.adobe.fd.docassurance.client.api.DocAssuranceServiceOperationTypes;
import com.adobe.fd.docassurance.client.api.SignatureOptions;
import com.adobe.fd.signatures.client.types.exceptions.InvalidArgumentException;
import com.adobe.fd.signatures.pdf.inputs.CredentialContext;
import com.adobe.fd.signatures.pdf.inputs.DSSPreferences;
import com.adobe.fd.signatures.pdf.inputs.DSSPreferencesImpl;
import com.adobe.fd.signatures.pdf.inputs.PDFSignatureAppearenceOptions;
import com.adobe.fd.signatures.pdf.inputs.UnlockOptions;
import com.adobe.fd.signatures.pdf.inputs.PDFSignatureAppearenceOptions.PDFSignatureAppearanceType;
import com.adobe.fd.signatures.pdf.inputs.PDFSignatureAppearenceOptions.TextDirection;
import com.adobe.fd.signatures.pki.client.types.common.HashAlgorithm;
import com.adobe.fd.signatures.pki.client.types.common.RevocationCheckStyle;
import com.adobe.fd.signatures.pki.client.types.prefs.CRLPreferences;
import com.adobe.fd.signatures.pki.client.types.prefs.CRLPreferencesImpl;
import com.adobe.fd.signatures.pki.client.types.prefs.GeneralPreferencesImpl;
import com.adobe.fd.signatures.pki.client.types.prefs.PKIPreferences;
import com.adobe.fd.signatures.pki.client.types.prefs.PKIPreferencesImpl;
import com.adobe.fd.signatures.pki.client.types.prefs.PathValidationPreferences;
import com.adobe.fd.signatures.pki.client.types.prefs.PathValidationPreferencesImpl;

/**
 * Digital signatures can be applied to PDF documents to provide a level of security. Digital signatures, like handwritten signatures, provide a means by which signers 
 * identify themselves and make statements about a document. The technology used to digitally sign documents helps to ensure that both the signer and recipients are clear 
 * about what was signed and confident that the document was not altered since it was signed.
 * 
 * PDF documents are signed by means of public-key technology. A signer has two keys: a public key and a private key. The private key is stored in a user's credential that 
 * must be available at the time of signing. The public key is stored in the user's certificate that must be available to recipients to validate the signature. Information
 * about revoked certificates is found in certificate revocation lists (CRLs) and Online Certificate Status Protocol (OCSP) responses distributed by Certificate Authorities (CAs). 
 * The time of signing can be obtained from a trusted source known as a Timestamping Authority.
 * 
 * The following Java code example digitally signs a PDF document that is based on a PDF file. 
 * The alias that is specified for the security credential is secure, and revocation checking is performed. 
 * Because no CRL or OCSP server information is specified, the server information is obtained from the certificate used to 
 * digitally sign the PDF document
 * 
 * PreRequisites - Digital certificate for signing the document has to be uploaded on Granite Key Store
 */

@Component
@Service(value=Sign.class)
public class Sign{
 @Reference
 private DocAssuranceService docAssuranceService;
 
 @Reference
    private SlingRepository slingRepository;
 
 @Reference
    private JcrResourceResolverFactory jcrResourceResolverFactory ;

 /**
  * 
  * @param inputFile - path to the pdf document stored at JCR node 
  * @param outputFile - path to the pdf document where the output needs to be stored
  * @throws IOException
  * @throws RepositoryException
  * @throws InvalidArgumentException
  * @throws DocAssuranceException
  */
 public void signExtend(String inputFile, String outputFile, String alias) throws IOException, RepositoryException, InvalidArgumentException, DocAssuranceException{
  
  Document inDoc = new Document(inputFile);
  Document outDoc = null;
  
  Session adminSession = null;
        ResourceResolver resourceResolver = null;
        try {
          
          /** resourceResolver with admin privileges to be passed to SignatureServiceAPI and Reader Extensions
          the resource resolver for signature options has to be corresponding to the user who has the signing certificate in his granite key store
          the resource resolver for signature options has to be corresponding to the user who has the credential for reader extension in his granite key store
          here we are using the same resource resolver
          */
          adminSession = slingRepository.loginAdministrative(null);
             resourceResolver = jcrResourceResolverFactory.getResourceResolver(adminSession);
             
             //retrieve specifications for each of the services, you may pass null if you don't want to use that service
             //as we don't want encryption in this case, passing null for Encryption Options
             //for encrypted document pass Unlock Options - see the method getUnlockOptions() below
    outDoc = docAssuranceService.secureDocument(inDoc, null, getSignatureOptions(alias,resourceResolver),null,null);
        }
  catch(Exception e){
   e.printStackTrace();
  }
        finally{
            /**
             * always close the PDFDocument object after your processing is done.
             */
            if(inDoc != null){
                inDoc.close();
            }
            if(adminSession != null && adminSession.isLive()){
                if(resourceResolver != null){
                    resourceResolver.close();
                }
                adminSession.logout();
            }
        }
        
        //flush the output document contents to JCR Node
  flush(outDoc, outputFile);

 }
 
 /**
  * 
  * @param rr resource resolver corresponding to the user with the access to signing credential for the 
  * given alias "allcertificatesanypolicytest11ee_new" in this case
  * @return SignatureOptions
  */
 private SignatureOptions getSignatureOptions(String alias, ResourceResolver rr){
  
  //create an instance of SignatureOptions
  SignatureOptions signatureOptions = SignatureOptions.getInstance();
  
  //set the operation you want to perform - SIGN/CERTIFY
  signatureOptions.setOperationType(DocAssuranceServiceOperationTypes.SIGN);
  
  //field to sign
  String fieldName = "Signature1" ;

        //Hash Algo to be used to compute digest the PDF document
        HashAlgorithm algo = HashAlgorithm.SHA384;
        
        //Reason for signing/certifying
        String reason = "Test Reason";
        
        //location of the signer
        String location = "Test Location";
        
        //contact info of the signer
        String contactInfo = "Test Contact";
        
        //Create a PDFSignatureAppearanceOptions object 
        //and show date information
        PDFSignatureAppearenceOptions appOptions = new PDFSignatureAppearenceOptions(
                PDFSignatureAppearanceType.NAME, null, 1.0d, null, true, true,
                true, true, true, true, true, TextDirection.AUTO);
        
        signatureOptions.setSignatureFieldName(fieldName);
        signatureOptions.setAlgo(algo);
        signatureOptions.setContactInfo(contactInfo);
        signatureOptions.setLocation(location);
        signatureOptions.setSigAppearence(appOptions);
        signatureOptions.setReason(reason);
        signatureOptions.setDssPref(getDSSPreferences(rr));
        signatureOptions.setCredential(new CredentialContext(alias, rr, true));
  return signatureOptions;
 }
 
 private DSSPreferences getDSSPreferences(ResourceResolver rr){
  //sets the DSS Preferences
        DSSPreferencesImpl prefs = DSSPreferencesImpl.getInstance();
        prefs.setPKIPreferences(getPKIPreferences());
        GeneralPreferencesImpl gp = (GeneralPreferencesImpl) prefs.getPKIPreferences().getGeneralPreferences();
        gp.setDisableCache(true);
        return prefs;
    }
    
    private PKIPreferences getPKIPreferences(){
     //sets the PKI Preferences
        PKIPreferences pkiPref = new PKIPreferencesImpl();
        pkiPref.setCRLPreferences(getCRLPreferences());
        pkiPref.setPathPreferences(getPathValidationPreferences());
        return pkiPref;
    }
    
    private CRLPreferences getCRLPreferences(){
        //specifies the CRL Preferences
        CRLPreferencesImpl crlPrefs = new CRLPreferencesImpl();
        crlPrefs.setRevocationCheck(RevocationCheckStyle.CheckIfAvailable);
        crlPrefs.setGoOnline(true);
        return crlPrefs;
    }
    
    private PathValidationPreferences getPathValidationPreferences(){
     //sets the path validation preferences
        PathValidationPreferencesImpl pathPref = new PathValidationPreferencesImpl();
        pathPref.setDoValidation(false);
        return pathPref;
        
    }
    
    /**
     * sets Unlock Options for encrypted PDF
     */
    private UnlockOptions getUnlockOptions(){
        UnlockOptions unlockOptions = new UnlockOptions();
        //sets the Open Password for password encrypted PDF
        unlockOptions.setPassword("OpenPassword");
        
        //for Certificate Encrypted Document, set the alias of the credential uploaded in the user's key store
        //and corresponding resource resolver
        
        return unlockOptions;
        
    }
    /**
     * This method copies the data from {@code Document}, to the specified file at the given resourcePath.
     * @param doc
     * @param resourcePath
     * @throws IOException
     */
    private void flush(Document doc, String resourcePath) throws IOException {
   //extracts the byte data from Document
   byte[] output = doc.getInlineData();
   Binary opBin;
   Session adminSession = null;
      try {
         adminSession = slingRepository.loginAdministrative(null);
         
         //get access to the specific node
         //here we are assuming that node exists
           Node node = adminSession.getNode(resourcePath); 
          
           //convert byte[] to Binary
           opBin = adminSession.getValueFactory().createBinary((InputStream)new ByteArrayInputStream(output));
     
           //set the Binary data value to node's jcr:data
           node.getNode("jcr:content").getProperty("jcr:data").setValue(opBin);
      } catch (RepositoryException e) {

      }
      finally{
       
       if(adminSession != null && adminSession.isLive()){
        try {
      adminSession.save();
      adminSession.logout();
     } catch (RepositoryException e) {
      
     }
              
             }
      }
   
  }
}

如果您已從AEM 6.0表單或AEM 6.1 Forms升級,且您在舊版中使用了DocAssurance服務,則:

  • 要在不使用HSM或令牌設備的情況下使用DocAssurance服務,請繼續使用現有代碼。
  • 要將DocAssurance服務與HSM或令牌設備一起使用,請用下面列出的API替換現有的CredentialContext對象代碼。
/**
  * 
  * @param credentialAlias alias of the PKI Credential stored in CQ Key Store or 
  * the alias of the HSM Credential configured using HSM Credentials Configuration Service.      
  * @param resourceResolver corresponding to the user with the access to the key store and trust store.
  * @param isHSMCredential if the alias is corresponding to HSM Credential. 
  */
 public CredentialContext(String credentialAlias, ResourceResolver resourceResolver, boolean isHSMCredential);

有關API和DocAssurance服務的示例代碼的詳細資訊,請參閱以寫程式方式使用AEM文檔服務

本頁內容