JavaSE6基于JSR105的XML签名之实践篇

 　　一、 密码学密钥和证书

　　现在，我们已经准备好我们的XML签名示例应用程序。

　　让我们首先分析下列XML文档-./etc/invoice.xml：

 

＜?XML version="1.0" encoding="UTF-8" standalone="no"?＞ ＜items＞ ＜desc＞Applied Cryptography＜/desc＞ ＜unitprice＞44.50＜/unitprice＞ ＜/item＞ ＜creditcard＞ ＜expiry＞10/20/2009＜/expiry＞ ＜firstname＞Smith＜/firstname＞ ＜/invoice＞

　　我们计划使用一个XML签名对它进行签名并且希望使用一个基于一个公共密钥的签名方法。

　　让我们先生成密码学密钥。为此，我们可以使用JDK中提供的keytool工具-把该程序移动到./etc文件夹下，并且执行下列命令：

 

keytool -genkey -keysize 512 -sigalg DSA -dname "cn=Young Yang， ou=Architecture， o=Company， L=New York， ST=NY， c=US" -alias biz -keypass kp1234 -keystore bizkeystore -storepass sp1234 -validity 180

　　这个命令能够创建密钥并预以存储-名字为bizkeystore，存储在工作目录./etc下，并且指定它的口令为sp1234。它还生成一个针对实体（它包含有一个卓著的名字-Young Yang）的公有/私有密钥对。【注意】，这里使用DSA密钥生成算法来创建公有/私有密钥-都为512位长。
上面的命令进一步创建了一个自签名的证书，这是使用SHA1的DSA算法(JSR-105注释中的DSA_SHA1，其中包括了公共密钥和前面那个卓著名字信息)实现的。这个证书将保持180天的有效期并且关联与一个密钥存储文件（此处引用的别名为"biz"）中的私有密钥。该私有密钥被赋予口令kp1234。

　　我们的示例中包括一个简单的Java类-KeyStoreInfo，用于把存储于前面的密钥存储文件中的密钥和证书信息输出到System.out；这个类也用于应用程序从中取得密钥对-这里的私有和公共密钥匹配作为输入参数指定的条件。为了试验它能够输出包含在前面存储文件bizkeystore中的信息，读者可以运行Ant目标ksInfo。

　　下列代码片断显示KeyStoreInfo中的用来检索一个KeyPair的方法：

 

public static KeyPair getKeyPair(String store，String sPass，String kPass，String alias) IOException， KeyStoreException， KeyStore ks = loadKeyStore(store，sPass); Key key = null; PrivateKey privateKey = null; key = ks.getKey(alias，kPass.toCharArray()); Certificate cert = ks.getCertificate(alias); privateKey = (PrivateKey)key; }else{ } return null; }

　　借助于一个KeyPair，我们可以容易地得到PrivateKey和PublicKey-通过调用相应的操作getPrivate()和getPublic()实现。

　　为了从KeyStore中得到一个PublicKey，我们并不真正需要在上面的方法中所要求的密钥口令，而这正是下列方法所实现的：

 

public static PublicKey getPublicKey(String store， throws KeyStoreException， CertificateException， KeyStore ks = loadKeyStore(store， sPass); return cert.getPublicKey();

　　在上面两部分代码片断中，方法KeyStore loadKeyStore(String store，String sPass)是一个工具函数，用于实例化一个KeyStore对象，并且从文件系统加载入口。我们以如下方式实现它：

 

private static KeyStore loadKeyStore(String store， String sPass) NoSuchAlgorithmException， IOException{ FileInputStream fis = new FileInputStream(store); fis.close(); }

　　伴随JDK提供的keytool还可以把存储在一个密钥储存文件内的证书输出到系统文件中。例如，为了创建一个包含X509证书（关联于别名为biz的密钥入口）的biz.cer文件，我们可以从文件夹./etcdirectory下运行下列命令：

keytool -export -alias biz -file biz.cer -keystore bizkeystore -storepass sp1234

　　这个证书实现认证我们讨论上面的公共密钥。

　　我们还在示例中包括了一个Java类-CertificateInfo，用于把一个证书中的一些有趣的信息输出到System.out。为了试验这一点，读者可以运行Ant目标certInfo。然而，要理解该代码及其输出，必须具有DSA和RSA算法的基本知识。当然，读者可以安全地绕过这个程序而继续阅读后面的内容。||| 

　　这一节讨论借助于JSR-105 API及其缺省实现来实现对invoice.xml文件的签名。

　　我们的示例中创建了一个enveloping签名。注意，当你想使用在一种detached或enveloped签名情形下时，也仅需对本例作一些细微修改。

　　下面，让我们分析程序Sign.java，它能够生成invoice.xml文件的XML签名。

 

public class Sign { String input = "./etc/invoice.xml "; if (args.length ＞ 2) { output = args[1]; //准备 dbf.setNamespaceAware(true); String providerName = System.getProperty("jsr105Provider"，"org.jcp.XML.dsig.internal.dom.XMLDSigRI"); //步骤2 //步骤3 Node invoice = XML.getDocumentElement(); XMLObject obj = fac.newXMLObject(Collections.singletonList(content)，"invoice"， null， null); SignedInfo si = fac.newSignedInfo(fac.newCanonicalizationMethod(CanonicalizationMethod.INCLUSIVE_WITH_COMMENTS， fac.newSignatureMethod(SignatureMethod.DSA_SHA1， null)， //步骤5，分为情形5.0或5.1 //情形5.0 //情形5.1，分为情形5.1.1或5.1.2 　　//情形5.1.1 //kpg.initialize(512); 　　//情形5.1.2 // "kp1234"，"biz"); 　　//如果针对情形5.1，请去掉下面一行中的注释 　　//步骤6，分为情形6.0，6.1或6.2 　　//情形6.0，如果针对情形6.1或6.2也使用下面这一行 　　//如果针对情形6.1或6.2请去掉下面一行中的注释 　　//情形6.1 // ki = kif.newKeyInfo(Collections.singletonList(kv)); 　　//情形6.2 // FileInputStream fis = new FileInputStream("./etc/biz.cer"); // fis.close(); // ki = kif.newKeyInfo(Collections.singletonList(x509d)); 　　//步骤7 　　//步骤8 DOMSignContext dsc = new DOMSignContext(privateKey， doc); 　　//步骤9 //转换成一个xml文档 Transformer trans = tf.newTransformer(); }

　　为了试验这个程序，读者可以运行Ant目标签名-它将创建一个XML文档./etc/signature.xml。这就是所谓的XML签名。为了保持我们的代码更为整洁和集中，我们省略了分析XML和转换DOM树中所有相关的格式设置。结果是，signature.xml文件成为一个有些凌乱的文件。

　　现在，让我们详细分析一下这个程序来说明如何在JSR-105中对一个XML签名进行签名。

　　签名invoice.xm的过程可以分解为如下九个步骤。

　　【步骤1】加载一个XMLSignatureFactory实例。这个工厂类将负责构建几乎所有主要的对象-我们在JSR-105中API中处理XML签名时需要使用这些对象，除了那些与KeyInfo相关的对象之外。

　　【步骤2】选择一个digest方法并创建相应的Reference对象。我们使用在〖步骤1〗中创建的XMLSignatureFactory实例来创建DigestMethod和Reference对象。

　　在XMLSignatureFactory中的针对DigestMethod对象的工厂操作如下所示：

 

public abstract DigestMethod newDigestMethod(String algorithm， InvalidAlgorithmParameterException

　　【注意】这个params参数用来指定digest算法可能需要的参数；在SHA-1，SHA-256或SHA-512的情况下，我们可以使用null。

　　为了创建一个Reference对象，XMLSignatureFactory提供了四种操作：

 

public abstract Reference newReference(String uri， DigestMethod dm); List transforms， String type， String id); List transforms， String type， String id， byte digestValue);

　　为了全面地理解在那些操作中的输入参数的意思，我们需要分析一下在W3C建议中的Reference元素的XML模式定义：

 

＜element name="Reference" type="ds:ReferenceType"/＞ ＜sequence＞ ＜element ref="ds:DigestMethod"/＞ ＜/sequence＞ ＜attribute name="URI" type="anyURI" use="optional"/＞ ＜/complexType＞

　　其中，URI属性参考Reference相应的数据对象。

　　对于我们的示例来说，我们使用SHA-1作为digest方法，并且使用#invoice来在相同的XML签名文档（它包含这个Reference对象的XML描述）中引用一个元素。由#invoice所引用的元素正是我们要在下一步所要讨论的内容。
【步骤3】加载invoice.xml并且用一个XMLObject对象把它包装起来。注意，并非所有的签名生成过程都要求这个步骤。XMLObject在JSR-105中对于我们以前简短地讨论过的可选的Object元素进行建模。该Object元素具有下列模式定义：

 

＜element name="Object" type="ds:ObjectType"/＞ ＜sequence minOccurs="0" maxOccurs="unbounded"＞ ＜/sequence＞ ＜attribute name="MimeType" type="string" use="optional"/＞ ＜/complexType＞

　　XMLSignatureFactory提供下列方法来创建一个XMLObject实例：

public abstract XMLObject newXMLObject(List content， String id，String mimeType，String encoding)

　　我们使用一个DOMStructure对象来包装invoice.xml的根结点。在JSR-105中定义的DOMStructure可以帮助从原始待签名的XML文档中把结点导入到JSR-105运行时刻。

　　我们指定#invoice作为结果对象元素的id。JSR-105实现知道在步骤2中创建的引用对象参考invoice.xml文档，因为这个id把它们链接在一起(在Reference一边，URI属性指向这个id)。

　　【步骤4】创建SignedInfo对象。在W3C建议中，SignedInfo元素具有下列模式定义：

 

＜element name="SignedInfo" type="ds:SignedInfoType"/＞ ＜sequence＞ ＜element ref="ds:SignatureMethod"/＞ ＜/sequence＞ ＜/complexType＞

　　为了创建一个SignedInfo对象，我们需要在〖步骤2〗中创建的Reference；我们还需要两个实例-一个是CanonicalizationMethod的实例，另一个是SignatureMethod的实例。我们建议感兴趣的读者参考一下规范说明书从而对这四种XML规范算法有一个更为精确的了解；在此，我们只是简单地指出，在我们决定选择一个特定的算法-alg后，后面对XMLSignatureFactory的一个实例（即fac）的调用将会创建CanonicalizationMethod的实例：

 

fac.newCanonicalizationMethod(alg，null)

　　我们可以创建一个SignatureMethod实例-通过调用下列在XMLSigantureFactory中定义的操作：

 

public abstract SignatureMethod newSignatureMethod(String algorithm， InvalidAlgorithmParameterException

　　在我们的示例中，我们拥有一个DSA类型密钥对；因此，我们需要选择一个基于DSA的算法-例如DSA_SHA1。对于DSA-SHA1，我们可以把params参数设置为null。

　　为了创建一个SignedInfo实例，XMLSignatureFactory定义了如下两个工厂方法：

 

public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm， public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm，

　　在第二个工厂方法中的第二个参数-id响应于XML签名文档中的SignedInfo元素的Id属性。
||| 
　　【步骤5】-获得签名私有密钥。

　　在我们的示例中，我们展示了三种不同的方法来得到该私有密钥。在第一种方法中，我们调用我们的KeyStoreInfo类的getPrivateKey()方法来检索我们使用keytool创建的DSA类型私有密钥，并且把它储存在密钥存储文件-bizkeystore(前面的5.0情形)中。为了获得该私有密钥，我们还可以从bizkeystore中检索该KeyPair-通过调用KeyStoreInfo的getKeyPair()方法，然后调用KeyPair实例(5.1.2情形)的getPrivate()。另一方面，JCA提供了一个名字为KeyPairGenerator的类用于根据需要随时动态地创建一个KeyPair，这正是Sign.java中的情形5.1.1提到的情况。

　　读者还应该注意，JSR-105允许通过一个KeySelector对象获得私有密钥。我们在下节讨论KeySelector时还要详细分析。

　　【步骤6】创建一个KeyInfo对象。这一步是可选的，就象KeyInfo作为签名元素中的一个元素是可选的一样。在我们的示例的情形6.0下，我们使KeyInfo成为null；这样以来，可以完全从结果XML签名中忽略它。

　　W3C建议和JSR-105定义RSA的KeyValues以及DSA类型for wrapping，respectively，RSA和DSA公共密钥，并允许它们成为KeyInfo的内容。我们的示例中的情形6.1从我们以前使用JDK keytool生成的公共密钥中创建一个KeyValue对象，并且把它放到一个KeyInfo对象。后面，当讨论我们的核心校验程序时，我们将看到它如何使用这样的一个KeyInfo对象来检索公共密钥以用于签名校验。

　　在JSR-105中，我们通过调用一个KeyInfoFactory实例中的操作创建了KeyValue和KeyInfo对象。其中，KeyInfoFactory负责创建所有主要的与KeyInfo相关的对象-例如KeyName，KeyValue，X509Data等。我们可以以与我们在〖步骤1〗得到XMLSignatureFactory实例相同的方式得到一个KeyInfoFactory实例。我们的示例调用XMLSignatureFactory对象的getKeyInfoFactory()方法取得KeyInfoFactory实例。

　　我们的示例的情形6.2将创建一个X509Data对象-使用我们以前借助于工具keytool从bizkeystore中导出的证书biz.cer，然后把这个对象作为内容放入一个KeyInfo对象中。再次，后面我们将讨论的核心校验程序将证明我们如何从这样的一个KeyInfo对象中取得用于签名校验的公共密钥。

　　【步骤7】创建一个XMLSignature对象。在JSR-105中，XMLSignature接口为W3C中建议的签名元素实现了建模。我们已经在前面看到该签名元素的结构。为了创建一个XMLSiganture实例，我们可以在XMLSignatureFactory中调用下列两个方法之一：

 

public abstract XMLSignature newXMLSignature(SignedInfo si， KeyInfo ki); List objects， String id， String signatureValueId).

　　第二个方法中的id和signatureValueId参数将成为结果XML签名文档中的XML元素ID。在我们的示例中，该XML签名将拥有一个Object元素；因此，我们需要使用第二个工厂方法。

　　【步骤8】实例化一个DOMSignContext对象，并且使用它注册私有密钥。XMLSignContext接口(DOMSignContext实现它)包含用于生成XML的上下文信息签名。

　　DOMSignContext提供了几种形式的构造器-签名应用程序用来注册要使用的私有密钥，并且这也是我们的示例中所采用的方法。

　　在继续讨论签名过程的最后步骤之前，我们需要指出XMLSignContext和DOMSignContext实例都可能包含特定于它们所使用的XML签名结构的信息和状态。该JSR-105规范中声明：如果一个XMLSignContext(或DOMSignContext)与不同的签名结构一起使用，那么，结果将是无法预料的。例如，我们不应该使用相同的XMLSignContext(或DOMSignContext)实例来签名两个不同的XMLSignature对象。

　　【步骤9】签名。XMLSignature接口中的sign()操作实现签名XMLSignature。其实，该方法还实现若干操作，包括基于相应的digest方法计算所有引用的digest值，并且基于该签名方法和私有密钥计算签名值。该签名值被XMLSignature实例中的嵌入式SignatureValue类所捕获，而对XMLSignature实例的getSignatureValue()方法的调用将返回使用结果值填充的SignatureValue对象。

　　在我们的签名程序的最后，我们把XMLSignature编排成一个XML文档-signature.xml。