Java
Chilkat2 Java
UBL XAdES Enveloped Signature
See more XAdES Examples
Demonstrates how to create a UBL XAdES enveloped signature.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.Cert;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.StringBuilder;
import com.chilkatsoft.chilkat2.Xml;
import com.chilkatsoft.chilkat2.XmlDSig;
import com.chilkatsoft.chilkat2.XmlDSigGen;
public class ChilkatExample {
public static void main(String[] args) {
boolean success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
success = true;
// The following code creates the XML document to be signed.
// (It is also possible to simply load the XML into the Chilkat XML object by calling the LoadXml method.)
// A sample (already signed) of this XML is available here: External link: credit-note-en16931-xades-signed.xml
// Also, you may use this online tool to generate code from sample XML:
// Generate Code to Create XML
Xml xmlToSign = new Xml();
xmlToSign.setTag("CreditNote");
xmlToSign.addAttribute("xmlns", "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2");
xmlToSign.addAttribute("xmlns:cac", "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2");
xmlToSign.addAttribute("xmlns:cbc", "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2");
xmlToSign.addAttribute("xmlns:ext", "urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2");
xmlToSign.updateAttrAt("ext:UBLExtensions|ext:UBLExtension", true, "xmlns:sac", "urn:oasis:names:specification:ubl:schema:xsd:SignatureAggregateComponents-2");
xmlToSign.updateAttrAt("ext:UBLExtensions|ext:UBLExtension", true, "xmlns:sig", "urn:oasis:names:specification:ubl:schema:xsd:CommonSignatureComponents-2");
xmlToSign.updateChildContent("ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation", "");
xmlToSign.updateChildContent("cbc:CustomizationID", "urn:cen.eu:en16931:2017");
xmlToSign.updateChildContent("cbc:ProfileID", "P1");
xmlToSign.updateChildContent("cbc:ID", "c2ad1540-cf12-4e83-b47c-906aac70242e");
xmlToSign.updateChildContent("cbc:IssueDate", "2009-12-15");
xmlToSign.updateAttrAt("cbc:Note", true, "languageID", "en");
xmlToSign.updateChildContent("cbc:Note", "Ordered in our booth at the convention.");
xmlToSign.updateAttrAt("cbc:DocumentCurrencyCode", true, "listAgencyID", "6");
xmlToSign.updateAttrAt("cbc:DocumentCurrencyCode", true, "listID", "ISO 4217 Alpha");
xmlToSign.updateChildContent("cbc:DocumentCurrencyCode", "HRK");
xmlToSign.updateChildContent("cbc:AccountingCost", "Project cost code 123");
xmlToSign.updateChildContent("cac:InvoicePeriod|cbc:StartDate", "2009-11-01");
xmlToSign.updateChildContent("cac:InvoicePeriod|cbc:EndDate", "2009-11-30");
xmlToSign.updateChildContent("cac:OrderReference|cbc:ID", "123");
xmlToSign.updateChildContent("cac:ContractDocumentReference|cbc:ID", "Contract321");
xmlToSign.updateChildContent("cac:ContractDocumentReference|cbc:DocumentType", "Framework agreement");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference|cbc:ID", "Doc1");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference|cbc:DocumentType", "Timesheet");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference|cac:Attachment|cac:ExternalReference|cbc:URI", "http://www.suppliersite.eu/sheet001.html");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference[1]|cbc:ID", "Doc2");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference[1]|cbc:DocumentType", "Drawing");
xmlToSign.updateAttrAt("cac:AdditionalDocumentReference[1]|cac:Attachment|cbc:EmbeddedDocumentBinaryObject", true, "mimeCode", "application/pdf");
xmlToSign.updateChildContent("cac:AdditionalDocumentReference[1]|cac:Attachment|cbc:EmbeddedDocumentBinaryObject", "UjBsR09EbGhjZ0dTQUxNQUFBUUNBRU1tQ1p0dU1GUXhEUzhi");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PartyIdentification|cbc:ID", "9934:18683136487::HR99:276");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PostalAddress|cbc:StreetName", "KATANCICEVA");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PostalAddress|cbc:CityName", "ZAGREB");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PostalAddress|cbc:PostalZone", "10000");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PostalAddress|cac:Country|cbc:IdentificationCode", "HR");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PartyTaxScheme|cbc:CompanyID", "HR18683136487");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PartyTaxScheme|cac:TaxScheme|cbc:ID", "FRE");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:PartyLegalEntity|cbc:RegistrationName", "MINISTARSTVO FINANCIJA");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:Contact|cbc:Name", "JURAJ MARKOVIC");
xmlToSign.updateChildContent("cac:AccountingSupplierParty|cac:Party|cac:Contact|cbc:ElectronicMail", "juraj.markovic@fina.hr");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PartyIdentification|cbc:ID", "9934:49811265576::HR99:NOVO1");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PostalAddress|cbc:StreetName", "GETALDICEVA 4");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PostalAddress|cbc:CityName", "ZAGREB");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PostalAddress|cbc:PostalZone", "10000");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PostalAddress|cac:Country|cbc:IdentificationCode", "HR");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PartyTaxScheme|cbc:CompanyID", "HR49811265576");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PartyTaxScheme|cac:TaxScheme|cbc:ID", "VAT");
xmlToSign.updateChildContent("cac:AccountingCustomerParty|cac:Party|cac:PartyLegalEntity|cbc:RegistrationName", "NOVO1");
xmlToSign.updateChildContent("cac:Delivery|cac:DeliveryLocation|cac:Address|cac:Country|cbc:IdentificationCode", "HR");
xmlToSign.updateChildContent("cac:PaymentMeans|cbc:PaymentMeansCode", "30");
xmlToSign.updateChildContent("cac:PaymentMeans|cbc:InstructionNote", "Neki opis placanja");
xmlToSign.updateChildContent("cac:PaymentMeans|cbc:PaymentID", "HR00 12456");
xmlToSign.updateChildContent("cac:PaymentMeans|cac:PayeeFinancialAccount|cbc:ID", "HR1210010051863000160");
xmlToSign.updateChildContent("cac:PaymentTerms|cbc:Note", "Neki uvjeti placanja");
xmlToSign.updateAttrAt("cac:TaxTotal|cbc:TaxAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:TaxTotal|cbc:TaxAmount", "25.00");
xmlToSign.updateAttrAt("cac:TaxTotal|cac:TaxSubtotal|cbc:TaxableAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:TaxTotal|cac:TaxSubtotal|cbc:TaxableAmount", "100.00");
xmlToSign.updateAttrAt("cac:TaxTotal|cac:TaxSubtotal|cbc:TaxAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:TaxTotal|cac:TaxSubtotal|cbc:TaxAmount", "25.00");
xmlToSign.updateChildContent("cac:TaxTotal|cac:TaxSubtotal|cac:TaxCategory|cbc:ID", "S");
xmlToSign.updateChildContent("cac:TaxTotal|cac:TaxSubtotal|cac:TaxCategory|cbc:Percent", "25");
xmlToSign.updateChildContent("cac:TaxTotal|cac:TaxSubtotal|cac:TaxCategory|cac:TaxScheme|cbc:ID", "VAT");
xmlToSign.updateAttrAt("cac:LegalMonetaryTotal|cbc:LineExtensionAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:LegalMonetaryTotal|cbc:LineExtensionAmount", "100.00");
xmlToSign.updateAttrAt("cac:LegalMonetaryTotal|cbc:TaxExclusiveAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:LegalMonetaryTotal|cbc:TaxExclusiveAmount", "100.00");
xmlToSign.updateAttrAt("cac:LegalMonetaryTotal|cbc:TaxInclusiveAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:LegalMonetaryTotal|cbc:TaxInclusiveAmount", "125.00");
xmlToSign.updateAttrAt("cac:LegalMonetaryTotal|cbc:PayableAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:LegalMonetaryTotal|cbc:PayableAmount", "125.00");
xmlToSign.updateChildContent("cac:CreditNoteLine|cbc:ID", "1");
xmlToSign.updateAttrAt("cac:CreditNoteLine|cbc:CreditedQuantity", true, "unitCode", "H87");
xmlToSign.updateChildContent("cac:CreditNoteLine|cbc:CreditedQuantity", "1.000");
xmlToSign.updateAttrAt("cac:CreditNoteLine|cbc:LineExtensionAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:CreditNoteLine|cbc:LineExtensionAmount", "100.00");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cbc:Description", "Neki detaljniji opis proizvoda ide ovdje");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cbc:Name", "Neki proizvod");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:OriginCountry|cbc:IdentificationCode", "HR");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:ClassifiedTaxCategory|cbc:ID", "S");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:ClassifiedTaxCategory|cbc:Percent", "25");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:ClassifiedTaxCategory|cac:TaxScheme|cbc:ID", "VAT");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:AdditionalItemProperty|cbc:Name", "Boja");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:AdditionalItemProperty|cbc:Value", "Plava");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:AdditionalItemProperty[1]|cbc:Name", "Masa");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Item|cac:AdditionalItemProperty[1]|cbc:Value", "1,2 Kg");
xmlToSign.updateAttrAt("cac:CreditNoteLine|cac:Price|cbc:PriceAmount", true, "currencyID", "HRK");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Price|cbc:PriceAmount", "100.000000");
xmlToSign.updateAttrAt("cac:CreditNoteLine|cac:Price|cbc:BaseQuantity", true, "unitCode", "H87");
xmlToSign.updateChildContent("cac:CreditNoteLine|cac:Price|cbc:BaseQuantity", "1.000");
// Use this online tool to generate XAdES code from a sample signed XML:
// Generate Code to Creaet XAdES from Sample XAdES
// The following code was generated by the online tool.
XmlDSigGen gen = new XmlDSigGen();
gen.setSigLocation("CreditNote|ext:UBLExtensions|ext:UBLExtension|ext:ExtensionContent|sig:UBLDocumentSignatures|sac:SignatureInformation");
gen.setSigLocationMod(0);
gen.setSigId("Signature-7f4c4719515a4a0a8ce4d1b983a2ec69");
gen.setSigNamespacePrefix("");
gen.setSigNamespaceUri("http://www.w3.org/2000/09/xmldsig#");
gen.setSignedInfoCanonAlg("C14N");
gen.setSignedInfoDigestMethod("sha256");
// Create an Object to be added to the Signature.
Xml object1 = new Xml();
object1.setTag("xades:QualifyingProperties");
object1.addAttribute("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#");
object1.addAttribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#");
object1.addAttribute("Target", "#Signature-7f4c4719515a4a0a8ce4d1b983a2ec69");
object1.updateAttrAt("xades:SignedProperties", true, "Id", "SignedProperties-6573207f4ad64b49b0310f7a9e2dfadc");
object1.updateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", "TO BE GENERATED BY CHILKAT");
// Note: It may be that http://www.w3.org/2001/04/xmlenc#sha256 is needed in the following line instead of http://www.w3.org/2000/09/xmldsig#sha1
object1.updateAttrAt("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod", true, "Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
object1.updateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue", "TO BE GENERATED BY CHILKAT");
object1.updateChildContent("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2", "TO BE GENERATED BY CHILKAT");
object1.updateAttrAt("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat", true, "ObjectReference", "");
object1.updateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description", "document");
object1.updateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType", "application/xml");
object1.updateChildContent("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Encoding", "UTF-8");
gen.addObject("", object1.getXml(), "", "");
// -------- Reference 1 --------
gen.addSameDocRef("", "sha256", "", "", "");
// -------- Reference 2 --------
gen.addObjectRef("SignedProperties-6573207f4ad64b49b0310f7a9e2dfadc", "sha256", "", "", "http://uri.etsi.org/01903#SignedProperties");
// Provide a certificate + private key. (PFX password is test123)
Cert cert = new Cert();
try {
cert.loadPfxFile("qa_data/pfx/cert_test123.pfx", "test123");
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
gen.setX509Cert(cert, true);
gen.setKeyInfoType("X509Data+KeyValue");
gen.setX509Type("IssuerSerial,SubjectName,SKI,Certificate");
// Load XML to be signed...
StringBuilder sbXml = new StringBuilder();
xmlToSign.getXmlSb(sbXml);
// Adding the "UBLDocumentSignatures" behavior causes the following Transform to be used for the
// first Reference:
// <Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116"><XPath>count(ancestor-or-self::sig:UBLDocumentSignatures | here()/ancestor::sig:UBLDocumentSignatures[1]) > count(ancestor-or-self::sig:UBLDocumentSignatures)</XPath></Transform>
gen.setBehaviors("IndentedSignature,UBLDocumentSignatures");
// Sign the XML...
try {
gen.createXmlDSigSb(sbXml);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
// -----------------------------------------------
// Save the signed XML to a file.
sbXml.writeFile("qa_output/signedXml.xml", "utf-8", false);
System.out.println(sbXml.getAsString());
// ----------------------------------------
// Verify the signature we just produced...
XmlDSig verifier = new XmlDSig();
try {
verifier.loadSignatureSb(sbXml);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
// We should have just one signature..
int numSigs = verifier.getNumSignatures();
int verifyIdx = 0;
while (verifyIdx < numSigs) {
verifier.setSelector(verifyIdx);
try {
verifier.verifySignature(true);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
verifyIdx = verifyIdx + 1;
}
System.out.println("The signature was successfully verified.");
}
}