本文是XML数字签名原理篇的姐妹篇，在“原理篇”中我们从理论上探讨了 XML 数字签名的原理和签名的处理过程，以及验证数字签名的步骤。胡适先生说过科学的精神就是大胆假设，小心求证，所以这篇文章的目标就是从应用层面针对“原理篇”中介绍的内容进行验证，实践是检验真理的唯一标准，尤其是编程这门实践性非常强的学科。
本文分成两部分，第一部分以一个第三方系统生成的一份 XML 签名文档为例，应用 Java 代码进行签名的验证，第二部分则通过对一份简单的原始 XML 文档进行签名来演示生成 XML 数字签名的过程。
说明：完整的代码可以从github下载，代码基于 JDK 8+以上测试。
验证 XML 数字签名
我们以第三方权威系统（Okta）签发的一份 XML 测试文档为例，使用从 Okta 获取的可靠证书，分步骤演示如何验证这份文档的签名是否有效，最后再给出一个综合的例子。读者可以点击链接查看或下载XML签名文档。为了更好的从原理上验证签名的处理过程，除了 DOM 节点的查找和规范化处理使用了 Apache 的Santuario库，其他步骤不借助任何 XML 数字签名的类库。
第一步：验证签名信息
在原理篇我们谈到，XML 的数字签名是针对整个”SignedInfo"子节点规范化的内容进行签名的，为了验证签名，我们需要取得整个“SignedInfo”子节点的规范化内容，签名的方法和签名信息，以及验证的公钥，我们一步一步来分析如何获取这些信息：
Document doc = XMLHelper.loadXML("xml/signed-xml-example.xml");
复制代码
X509Certificate verifyCert = SecurityHelper.loadCert("certs/test-okta-public-key.pem");
复制代码
//获取签名节点Element signatureNode = getSignatureNode(doc.getDocumentElement());
//获取SignedInfo子节点Element signInfoNode = XMLHelper.getNextElement(signatureNode.getFirstChild());
//获取Base64解码后的签名信息byte[] signatureValue = getSignatureValue(signatureNode);
//取得规范化处理的算法String methodUrl = getCanonicalizationMethodURI(signInfoNode);
//获取SignedInfo规范化的内容Canonicalizer canon = Canonicalizer.getInstance(methodUrl);canon.setSecureValidation(true);byte[] canonSignInfo = canon.canonicalizeSubtree(signInfoNode);
//创建RSA-SHA256签名实例Signature sig = Signature.getInstance("SHA256withRSA");
//使用公钥验证签名sig.initVerify(verifyCert.getPublicKey());sig.update(canonSignInfo);
boolean test = sig.verify(signatureValue);System.out.println(String.format("XML data validation result is %s.", test));
复制代码
如果验证通过，则说明整个"SignedInfo"节点没有被篡改过，有兴趣的同学可以试着下载代码，并把原始的签名 XML 文档的“SignedInfo”子节点改变某个属性值，或者增加个属性看看验证的结果有什么不同。
如果对规范化处理感兴趣，也可以把规范化后的“SignedInfo”（new String(canonSignInfo, "UTF-8")）输出来和原始的 SignedInfo 对比下，看看有什么不一样。
点击VerifySignatureValue.java查看或下载完整的源代码.
第二步：验证所有 Reference 的引用节点摘要
在确认“SignedInfo”没有被篡改的情况下，还需要进一步验证 Reference 对应的节点的摘要是否一致，验证过程和签名大体相似，加载 XML 签名文档和公钥的步骤和上面验证签名完全一致，这里就不重复了，这里着重分步解析 Reference 的验证过程。
//获取Signature节点Element signatureNode = getSignatureNode(doc.getDocumentElement());
//从Signature节点取得SignedInfoElement signInfoNode = XMLHelper.getNextElement(signatureNode.getFirstChild());
//列出SignedInfo的所有Reference子节点Element[] references = getReferences(signInfoNode);
//循环验证所有的Reference节点对应的摘要信息for (Element ref: references) { verifyReference(ref, doc);}
复制代码
//通过Reference URI属性查找引用节点Element node = getRefNode(reference);
//计算引用节点的规范化输出XML字节数组byte[] c14nData = getCanonicalizedXML(node, doc);
//创建“SHA-256”摘要算法实例MessageDigest digest = MessageDigest.getInstance("SHA-256");digest.reset();
//计算规范化XML摘要byte[] calcDigest =digest.digest(c14nData);
//读取Reference的“DigestValue”子节点的Base64文本并解码成字节数组byte[] orignalDigest = Base64.getDecoder().decode(getDigestValue(reference));
//比较原始的摘要和重新计算的摘要，两者一致则表明引用的节点内容没有被篡改System.out.println(String.format("Reference %s validation result: %s", reference.getAttribute("URI"), Arrays.equals(calcDigest, orignalDigest)));
复制代码
点击VerifyXMLSignedInfoReference.java查看或下载完整的源代码.
使用 XML 数字签名类库验证签名
上一节分步验证 XML 数字签名主要是为了更方便和直观的理解签名的验证原理，在实际使用中，完全没必要这么做，JDK 本身就提供了“javax.xml.crypto.dsig”库用于支持 XML 数字签名的生成和验证，使用起来略繁琐，也可以使用 Apach 旗下便捷的开源的Santuario库，它们的内部实现和我们前面介绍的两个步骤基本一致，我们用刚才的例子分别用这两个类库来验证签名：
Note：实际项目使用中，除了验证签名有效性外，还需要注意防范常见的 XML 包装攻击，安全性这块本文就不再展开了。
Document doc = XMLHelper.loadXML("xml/signed-xml-example.xml");X509Certificate verifyCert = SecurityHelper.loadCert("certs/test-okta-public-key.pem");
Element signatureNode = getSignatureNode(doc.getDocumentElement());
DOMValidateContext valContext = new DOMValidateContext(certificate.getPublicKey(), signatureNode);XMLSignatureFactory fac = XMLSignatureFactory.getInstance("DOM");javax.xml.crypto.dsig.XMLSignature signature = fac.unmarshalXMLSignature(valContext);
//validate成功，说明XML签名是有效的，反之则被篡改boolean result = signature.validate(valContext);
System.out.println(String.format("Signature validation result is: %s", result));
//当签名验证失败时，可以通过下面的代码进一步判断具体失败的原因是签名问题还是Reference的摘要验证失败boolean sv = signature.getSignatureValue().validate(valContext);System.out.println(String.format("Signature value validation status: %s", sv));
List refs = signature.getSignedInfo().getReferences();for(int i=0; i<refs.size(); i++) { Reference ref = (Reference)refs.get(i); boolean refValid = ref.validate(valContext); System.out.println(String.format("Reference[%s] validity status is %s", i, refValid));}
复制代码
Document doc = XMLHelper.loadXML("xml/signed-xml-example.xml");X509Certificate verifyCert = SecurityHelper.loadCert("certs/test-okta-public-key.pem");
Element signatureNode = getSignatureNode(doc.getDocumentElement());XMLSignature signature = new XMLSignature(signatureNode, "", true);
//valiate成功，说明XML签名是有效的，反之则被篡改boolean result = signature.checkSignatureValue(certificate.getPublicKey());
System.out.println(String.format("Signature validation result is: %s", result));
//当签名验证失败时，可以通过下面的代码进一步判断具体失败的原因是签名问题还是Reference的摘要验证失败for(int i =0; i < signature.getSignedInfo().getLength(); i ++){ boolean isRefValidated = signature.getSignedInfo().getVerificationResult(i); System.out.println(String.format("Reference[%s] validation result is %s", i, isRefValidated));}
复制代码
点击VerifyXMLSignatureFullExample.java查看或下载完整的源代码.
生成 XML 数字签名
为了创建 XML 数字签名，我们需要一份原始的 XML 文档，一个私钥和公钥（可选），公钥和私钥可以通过 openssl 工具生成，在这个例子里我们使用了预先生成好的密钥对(私钥保护密码"ringcentral"，可以通过下面的链接点击下载：
验证公钥
签名私钥
待签名XML文档
使用 JDK1.8 及以下版本的同学，在运行代码时可能会遇到“java.security.InvalidKeyException: Illegal key size”这个异常，这是因为按照美国法律，默认的 JDK 分发包仅允许支持 128 位的密钥长度，解决方法就是到 oracle 网站JCE for Java1.8下载无限制版的 JCE 替换默认分发的 JCE。
下面我们按照上一篇（原理篇）介绍的步骤分步演示怎么来生成签名：
public static void main(String[] args) throws Exception { System.setProperty("org.apache.xml.security.ignoreLineBreaks", "true"); org.apache.xml.security.Init.init();
//加载待签名XML文档 Document doc = XMLHelper.loadXML("xml/source-doc-to-be-signed.xml"); //加载公钥文件,可选 X509Certificate certificate = SecurityHelper.loadCert("certs/test-public-key.pem"); //加载私钥 PrivateKey signKey = SecurityHelper.getPrivateKey("certs/test-sign-key.pem", "ringcentral");
//创建XMLSignature对象，指定签名算法为RSA-SHA256 XMLSignature sig = new XMLSignature(doc, "", XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA256);
//例子中使用的是Enveloped格式，所以需要把把Signature节点作为原始文档根节点的子节点 doc.getDocumentElement().appendChild(sig.getElement());
//指定规范化算法，并指明签名是Enveloped格式 Transforms transforms = new Transforms(doc); transforms.addTransform(Transforms.TRANSFORM_ENVELOPED_SIGNATURE); transforms.addTransform(Transforms.TRANSFORM_C14N_EXCL_OMIT_COMMENTS);
//设置Reference引用节点的ID，本例子ID也可以放空，因为是根节点，并指明摘要算法是SHA256 sig.addDocument(String.format("#%s", doc.getDocumentElement().getAttribute("ID")), transforms, "http://www.w3.org/2001/04/xmlenc#sha256");
//包含公钥到KeyInfo节点，可选 sig.addKeyInfo(certificate); //使用私钥签名 sig.sign(signKey);
//输出生成后的XML节点 XMLHelper.toXML(doc.getDocumentElement(), System.out); }
复制代码
点击签名XML文档例子查看签名后的文档
创建签名的步骤并不复杂，有兴趣的同学可以把签名后的 XML 文档使用例子提供的公钥和本文第一部分介绍的验证签名方法进行验证。
点击CreateXMLSignature.java查看或下载完整的源代码.
参考资料
Programming With the Java XML Digital Signature API
Apache XML Security for Java
评论