Sample code for 30+ languages & platforms
Rust Requires Chilkat v11.0.0+

Signed Zip as Base64 with XAdES-BES

See more XAdES Examples

This example is to help companies implement a solution for sending XAdES-BES to the Polish government for reporting purposes. Specifically:

Przed podpisaniem deklaracja zbiorcza (PIT-11Z, PIT-8CZ, PIT-40Z, PIT-RZ) musi zostać
umieszczona w archiwum ZIP. W tym przypadku, podpisywany jest plik archiwum ZIP,
przyjmujący w podpisie XAdES-BES formę zakodowaną base64.

The example demonstrates the following:

  1. Zip an XML file (PIT-11Z.xml is zipped to PIT-11Z.zip)
  2. Create XML to be signed, where the XML contains the base64 encoded content of the PIT-11Z.zip archive.
  3. XAdES-BES sign the XML containing the base64 zip.

This example will also show the reverse:

  1. Verify the signed XML.
  2. Extract the PIT-11z.zip from the signed XML.
  3. Unzip the PIT-11Z.zip to get the original PIT-11Z.xml

Chilkat Rust Downloads

Download Chilkat for Rust
Rust 

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Zip the PIT-11Z.xml to create PIT-11Z.zip (not as a .zip file, but in-memory).
let sb_xml_to_zip = chilkat::StringBuilder::new();
if sb_xml_to_zip.load_file("qa_data/xml/PIT-11Z.xml", "utf-8").is_err() {
    println!("Failed to load the XML to be zipped.");
    return;
}

let zip = chilkat::Zip::new();

// Initialize the zip object. No file is created in this call.
// It should always return true.
let _ = zip.new_zip("PIT-11Z.zip").is_ok();

// Add the XML to be zipped.
let _ = zip.add_sb("PIT-11Z.xml", &sb_xml_to_zip, "utf-8");

// Write the zip to a BinData object.
let bd_zip = chilkat::BinData::new();
let _ = zip.write_bd(&bd_zip);
// The contents of the bdZip will be retrieved in base64 format when needed below..

let gen_ = chilkat::XmlDSigGen::new();

gen_.set_sig_location("");
gen_.set_sig_location_mod(0);

gen_.set_sig_id("Signature_2a8df7f8-b958-40cc-83f6-edb53b837347_19");
gen_.set_sig_namespace_prefix("ds");
gen_.set_sig_namespace_uri("http://www.w3.org/2000/09/xmldsig#");
gen_.set_sig_value_id("SignatureValue_2a8df7f8-b958-40cc-83f6-edb53b837347_52");
gen_.set_signed_info_id("SignedInfo_2a8df7f8-b958-40cc-83f6-edb53b837347_41");
gen_.set_signed_info_canon_alg("C14N");
gen_.set_signed_info_digest_method("sha1");

// Set the KeyInfoId before adding references..
gen_.set_key_info_id("KeyInfo_2a8df7f8-b958-40cc-83f6-edb53b837347_24");

// Create an Object to be added to the Signature.
let object1 = chilkat::Xml::new();
object1.set_tag("xades:QualifyingProperties");
let _ = object1.add_attribute("xmlns:xades", "http://uri.etsi.org/01903/v1.3.2#");
let _ = object1.add_attribute("Id", "QualifyingProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_43");
let _ = object1.add_attribute("Target", "#Signature_2a8df7f8-b958-40cc-83f6-edb53b837347_19");
let _ = object1.update_attr_at("xades:SignedProperties", true, "Id", "SignedProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_4e");
let _ = object1.update_attr_at("xades:SignedProperties|xades:SignedSignatureProperties", true, "Id", "SignedSignatureProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_0a");
// Chilkat will replace the strings "TO BE GENERATED BY CHILKAT" with actual values when the signature is created.
object1.update_child_content("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
let _ = object1.update_attr_at("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod", true, "Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
object1.update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue", "TO BE GENERATED BY CHILKAT");
object1.update_child_content("xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2", "TO BE GENERATED BY CHILKAT");
let _ = object1.update_attr_at("xades:SignedProperties|xades:SignedDataObjectProperties", true, "Id", "SignedDataObjectProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_4b");
let _ = object1.update_attr_at("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat", true, "ObjectReference", "#Reference1_2a8df7f8-b958-40cc-83f6-edb53b837347_27");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:Description", "MIME-Version: 1.0\r\nContent-Type: application/zip\r\nContent-Transfer-Encoding: binary\r\nContent-Disposition: filename="PIT-11Z.zip"");
let _ = object1.update_attr_at("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier", true, "Qualifier", "OIDAsURI");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Identifier", "http://www.certum.pl/OIDAsURI/signedFile/1.2.616.1.113527.3.1.1.3.1");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:Description", "Opis formatu dokumentu oraz jego pelna nazwa");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:ObjectIdentifier|xades:DocumentationReferences|xades:DocumentationReference", "http://www.certum.pl/OIDAsURI/signedFile.pdf");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:DataObjectFormat|xades:MimeType", "application/zip");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication|xades:CommitmentTypeId|xades:Identifier", "http://uri.etsi.org/01903/v1.2.2#ProofOfApproval");
object1.update_child_content("xades:SignedProperties|xades:SignedDataObjectProperties|xades:CommitmentTypeIndication|xades:AllSignedDataObjects", "");
let _ = object1.update_attr_at("xades:UnsignedProperties", true, "Id", "UnsignedProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_55");

// Emit XML in compact (single-line) format to avoid whitespace problems.
object1.set_emit_compact(true);
let _ = gen_.add_object("", &object1.get_xml().unwrap_or_default(), "", "");

// Create an Object to be added to the Signature.
// This is where we add the base64 representation of the PIT-11Z.zip
let _ = gen_.add_object("Object1_2a8df7f8-b958-40cc-83f6-edb53b837347", &bd_zip.get_encoded("base64").unwrap_or_default(), "", "http://www.w3.org/2000/09/xmldsig#base64");

// -------- Reference 1 --------
let _ = gen_.add_object_ref("Object1_2a8df7f8-b958-40cc-83f6-edb53b837347", "sha1", "C14N_WithComments", "", "");
let _ = gen_.set_ref_id_attr("Object1_2a8df7f8-b958-40cc-83f6-edb53b837347", "Reference1_2a8df7f8-b958-40cc-83f6-edb53b837347_27");

// -------- Reference 2 --------
let _ = gen_.add_object_ref("SignedProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_4e", "sha1", "", "", "http://uri.etsi.org/01903#SignedProperties");
let _ = gen_.set_ref_id_attr("SignedProperties_2a8df7f8-b958-40cc-83f6-edb53b837347_4e", "SignedProperties-Reference_2a8df7f8-b958-40cc-83f6-edb53b837347_28");

// Provide a certificate + private key. (PFX password is test123)
let cert = chilkat::Cert::new();
if cert.load_pfx_file("qa_data/pfx/cert_test123.pfx", "test123").is_err() {
    println!("{}", cert.last_error_text());
    return;
}

let _ = gen_.set_x509_cert(&cert, true);

gen_.set_key_info_type("X509Data");
gen_.set_x509_type("Certificate");

// This will be an enveloping signature where the Signature element
// is the XML document root, the signed data is contained within Object
// tag(s) within the Signature.
// Therefore, pass an empty sbXml to CreateXmlDsigSb.
let sb_xml = chilkat::StringBuilder::new();

// The Polish government's XmlDSig implementation requires that we reproduce an attribute-sorting error.
// (This is an error in the XML canonicalization that is not noticed when both the signature-creation code and signature-verification code use
// the same XML canonicalization implementation w/ the bug.)
gen_.set_behaviors("AttributeSortingBug,CompactSignedXml");

// Sign the XML...
if gen_.create_xml_d_sig_sb(&sb_xml).is_err() {
    println!("{}", gen_.last_error_text());
    return;
}

// -----------------------------------------------

// Save the signed XML to a file.
let _ = sb_xml.write_file("qa_output/signedXml.xml", "utf-8", false).is_ok();

println!("{}", sb_xml.get_as_string().unwrap_or_default());

// ----------------------------------------
// Verify the signature we just produced...
let verifier = chilkat::XmlDSig::new();
if verifier.load_signature_sb(&sb_xml).is_err() {
    println!("{}", verifier.last_error_text());
    return;
}

if verifier.verify_signature(true).is_err() {
    println!("{}", verifier.last_error_text());
    return;
}

println!("This signature was successfully verified.");

// ------------------------------------
// Finally, let's extract the .zip from the signed XML, and then unzip the original PIT-11Z.xml from the in-memory zip.
let xml = chilkat::Xml::new();
let _ = xml.load_sb(&sb_xml, true);

// The base64 image of the PIT-11Z.zip is in the 2nd ds:Object child of the ds:Signature (the ds:Signature is the root element of the signed XML).
// (ds:Object[0] would be the 1st ds:Object child.  Index 1 is the 2nd ds:Object child.)
let str_zip_base64 = xml.get_child_content("ds:Object[1]").unwrap_or_default();

let _ = bd_zip.clear();
let _ = bd_zip.append_encoded(&str_zip_base64, "base64");
if bd_zip.num_bytes() == 0 {
    println!("Something went wrong.. we dont' have any data..");
    return;
}

if zip.open_bd(&bd_zip).is_err() {
    println!("{}", zip.last_error_text());
    return;
}

// Get the 1st file in the zip, which should be the PIT-11Z.xml
let entry = chilkat::ZipEntry::new();
if zip.entry_at(0, &entry).is_err() {
    println!("Zip contains no files...");
    return;
}

// Get the XML:
let orig_xml = entry.unzip_to_string(0, "utf-8").unwrap_or_default();
println!("Original XML extracted from base64 zip:");
println!("{}", orig_xml);