fiscal 0.6.0

Brazilian fiscal document library (NF-e/NFC-e) — Rust port of sped-nfe
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
// Ported from TypeScript: certificate.test.ts
// Tests for loadCertificate, getCertificateInfo, signXml

/// Generate a self-signed PFX certificate for testing via OpenSSL API.
///
/// No CLI dependency — uses the `openssl` crate directly, making it
/// portable across Linux, macOS, and Windows.
fn generate_test_pfx() -> (Vec<u8>, String) {
    use openssl::asn1::Asn1Time;
    use openssl::bn::BigNum;
    use openssl::hash::MessageDigest;
    use openssl::pkey::PKey;
    use openssl::rsa::Rsa;
    use openssl::x509::{X509, X509NameBuilder};

    let passphrase = "test123".to_string();

    // Generate RSA 2048-bit key pair
    let rsa = Rsa::generate(2048).expect("RSA key generation failed");
    let pkey = PKey::from_rsa(rsa).expect("PKey creation failed");

    // Build self-signed X509 certificate
    let mut name_builder = X509NameBuilder::new().unwrap();
    name_builder
        .append_entry_by_text("CN", "Test NFe Company")
        .unwrap();
    name_builder
        .append_entry_by_text("O", "FinOpenPOS Test")
        .unwrap();
    let name = name_builder.build();

    let mut x509_builder = X509::builder().unwrap();
    x509_builder.set_version(2).unwrap();
    x509_builder.set_subject_name(&name).unwrap();
    x509_builder.set_issuer_name(&name).unwrap();
    x509_builder.set_pubkey(&pkey).unwrap();
    x509_builder
        .set_not_before(&Asn1Time::days_from_now(0).unwrap())
        .unwrap();
    x509_builder
        .set_not_after(&Asn1Time::days_from_now(365).unwrap())
        .unwrap();
    x509_builder
        .set_serial_number(&BigNum::from_u32(1).unwrap().to_asn1_integer().unwrap())
        .unwrap();
    x509_builder.sign(&pkey, MessageDigest::sha256()).unwrap();
    let cert = x509_builder.build();

    // Export to PKCS12/PFX
    let pkcs12 = openssl::pkcs12::Pkcs12::builder()
        .name("test")
        .pkey(&pkey)
        .cert(&cert)
        .build2(&passphrase)
        .expect("PKCS12 build failed");

    let pfx_bytes = pkcs12.to_der().expect("PKCS12 DER serialization failed");
    (pfx_bytes, passphrase)
}

fn sample_xml() -> String {
    [
        r#"<?xml version="1.0" encoding="UTF-8"?>"#,
        r#"<NFe xmlns="http://www.portalfiscal.inf.br/nfe">"#,
        r#"<infNFe xmlns="http://www.portalfiscal.inf.br/nfe" versao="4.00" Id="NFe35260112345678000199650010000000011123456780">"#,
        "<ide><cUF>35</cUF><mod>65</mod></ide>",
        "<emit><CNPJ>12345678000199</CNPJ></emit>",
        r#"<det nItem="1"><prod><cProd>1</cProd><xProd>Test</xProd></prod></det>"#,
        "<total><ICMSTot><vNF>10.00</vNF></ICMSTot></total>",
        "</infNFe>",
        "</NFe>",
    ].join("")
}

// =============================================================================
// loadCertificate()
// =============================================================================

mod load_certificate {
    use super::*;

    #[test]
    fn extracts_private_key_and_certificate_from_pfx() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase)
            .expect("load_certificate failed");

        assert!(cert.private_key.contains("-----BEGIN PRIVATE KEY-----"));
        assert!(cert.certificate.contains("-----BEGIN CERTIFICATE-----"));
        assert_eq!(cert.pfx_buffer, pfx_bytes);
        assert_eq!(cert.passphrase, passphrase);
    }

    #[test]
    fn throws_on_invalid_pfx_buffer() {
        let result = fiscal::certificate::load_certificate(b"not-a-pfx", "pass");
        assert!(result.is_err());
    }

    #[test]
    fn throws_on_wrong_password() {
        let (pfx_bytes, _) = generate_test_pfx();
        let result = fiscal::certificate::load_certificate(&pfx_bytes, "wrong-password");
        assert!(result.is_err());
    }
}

// =============================================================================
// getCertificateInfo()
// =============================================================================

mod get_certificate_info {
    use super::*;

    #[test]
    fn returns_certificate_metadata() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let info = fiscal::certificate::get_certificate_info(&pfx_bytes, &passphrase)
            .expect("get_certificate_info failed");

        assert_eq!(info.common_name, "Test NFe Company");
        // Self-signed: issuer == subject
        assert_eq!(info.issuer, "Test NFe Company");
        // valid_until should be in the future
        let today = chrono::Local::now().date_naive();
        assert!(info.valid_until > today);
        assert!(!info.serial_number.is_empty());
    }

    #[test]
    fn throws_on_invalid_pfx() {
        let result = fiscal::certificate::get_certificate_info(b"garbage", "pass");
        assert!(result.is_err());
    }
}

// =============================================================================
// signXml()
// =============================================================================

mod sign_xml {
    use super::*;

    #[test]
    fn produces_signed_xml_with_signature_element() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .expect("sign_xml failed");

        assert!(signed.contains("<Signature"));
        assert!(signed.contains("<SignedInfo"));
        assert!(signed.contains("<SignatureValue>"));
        assert!(signed.contains("<X509Certificate>"));
        assert!(signed.contains("<DigestValue>"));
    }

    #[test]
    fn signature_is_inside_nfe_element() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        let nfe_end = signed.find("</NFe>").expect("</NFe> not found");
        let sig_start = signed.find("<Signature").expect("<Signature not found");
        assert!(sig_start > 0);
        assert!(sig_start < nfe_end);
    }

    #[test]
    fn references_the_correct_inf_nfe_id() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        assert!(signed.contains(r##"URI="#NFe35260112345678000199650010000000011123456780""##));
    }

    #[test]
    fn uses_rsa_sha1_signature_algorithm() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        assert!(signed.contains("rsa-sha1"));
    }

    #[test]
    fn uses_c14n_canonicalization() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        assert!(signed.contains("xml-c14n-20010315"));
    }

    #[test]
    fn includes_enveloped_signature_transform() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        assert!(signed.contains("enveloped-signature"));
    }

    #[test]
    fn signed_xml_can_be_verified() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        // Verify complete signature structure
        assert!(signed.contains("<Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\">"));
        assert!(signed.contains("</Signature>"));
        assert!(signed.contains("<X509Certificate>"));
        assert!(signed.contains("<DigestValue>"));
        assert!(signed.contains("<SignatureValue>"));

        // SignedInfo must NOT have its own xmlns (inherits from Signature)
        assert!(
            !signed.contains("<SignedInfo xmlns="),
            "SignedInfo must not have redundant xmlns declaration"
        );
        assert!(signed.contains("<SignedInfo>"));
    }

    #[test]
    fn c14n_sorts_attributes_alphabetically() {
        // The sample XML has: versao="4.00" Id="NFe..."
        // C14N requires: Id="NFe..." versao="4.00" (alphabetical order)
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        // The DigestValue must be computed from the C14N canonical form where
        // attributes are sorted. We verify this by checking the same XML signed
        // twice with different attribute order gives the SAME DigestValue.
        let xml_alt_order = sample_xml().replace(
            r#"versao="4.00" Id="NFe35260112345678000199650010000000011123456780""#,
            r#"Id="NFe35260112345678000199650010000000011123456780" versao="4.00""#,
        );
        let signed_alt =
            fiscal::certificate::sign_xml(&xml_alt_order, &cert.private_key, &cert.certificate)
                .unwrap();

        let extract_digest = |xml: &str| -> String {
            let start = xml.find("<DigestValue>").unwrap() + "<DigestValue>".len();
            let end = xml[start..].find("</DigestValue>").unwrap() + start;
            xml[start..end].to_string()
        };

        assert_eq!(
            extract_digest(&signed),
            extract_digest(&signed_alt),
            "C14N must produce identical DigestValue regardless of attribute order in input"
        );
    }

    #[test]
    fn c14n_preserves_namespace_before_attributes() {
        // In C14N, xmlns declarations come before regular attributes.
        // Verify the signed XML has correct attribute order on infNFe.
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        // The infNFe in the output should still have xmlns before Id/versao
        // (it's the output XML, not the canonical form, but the original input preserves this)
        let inf_start = signed.find("<infNFe").unwrap();
        let inf_tag_end = signed[inf_start..].find('>').unwrap() + inf_start;
        let tag = &signed[inf_start..=inf_tag_end];

        let xmlns_pos = tag.find("xmlns=").expect("xmlns not found on infNFe");
        let id_pos = tag.find("Id=").expect("Id not found on infNFe");
        assert!(
            xmlns_pos < id_pos,
            "xmlns must appear before Id in the output tag"
        );
    }

    #[test]
    fn deterministic_digest_for_known_xml() {
        // Sign the same XML with the same key and verify the DigestValue
        // is deterministic (digest depends only on canonical content).
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();

        let signed1 =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();
        let signed2 =
            fiscal::certificate::sign_xml(&sample_xml(), &cert.private_key, &cert.certificate)
                .unwrap();

        let extract_digest = |xml: &str| -> String {
            let start = xml.find("<DigestValue>").unwrap() + "<DigestValue>".len();
            let end = xml[start..].find("</DigestValue>").unwrap() + start;
            xml[start..end].to_string()
        };

        assert_eq!(
            extract_digest(&signed1),
            extract_digest(&signed2),
            "DigestValue must be deterministic for same input"
        );

        // SignatureValue must also be deterministic (RSA with PKCS#1 v1.5 is deterministic)
        let extract_sigval = |xml: &str| -> String {
            let start = xml.find("<SignatureValue>").unwrap() + "<SignatureValue>".len();
            let end = xml[start..].find("</SignatureValue>").unwrap() + start;
            xml[start..end].to_string()
        };

        assert_eq!(
            extract_sigval(&signed1),
            extract_sigval(&signed2),
            "SignatureValue must be deterministic for same input and key"
        );
    }

    #[test]
    fn self_verifies_signature_with_openssl() {
        // Independently verify the RSA-SHA1 SignatureValue using OpenSSL.
        // This proves the signing round-trip is correct: the SignatureValue
        // can be verified against the canonical SignedInfo using the same key.
        use openssl::base64;
        use openssl::hash::MessageDigest;
        use openssl::pkey::PKey;
        use openssl::sign::Verifier;

        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert_data = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let signed = fiscal::certificate::sign_xml(
            &sample_xml(),
            &cert_data.private_key,
            &cert_data.certificate,
        )
        .unwrap();

        // Extract SignedInfo (without xmlns) and reconstruct canonical form
        // (with xmlns, as SEFAZ does during verification — C14N includes
        // in-scope namespace from parent <Signature xmlns="...">)
        let si_start = signed.find("<SignedInfo>").unwrap();
        let si_end = signed.find("</SignedInfo>").unwrap() + "</SignedInfo>".len();
        let signed_info = &signed[si_start..si_end];
        let canonical_si = signed_info.replacen(
            "<SignedInfo>",
            "<SignedInfo xmlns=\"http://www.w3.org/2000/09/xmldsig#\">",
            1,
        );

        // Extract SignatureValue
        let sigval_start = signed.find("<SignatureValue>").unwrap() + "<SignatureValue>".len();
        let sigval_end = signed[sigval_start..].find("</SignatureValue>").unwrap() + sigval_start;
        let signature_bytes = base64::decode_block(&signed[sigval_start..sigval_end]).unwrap();

        // Verify RSA-SHA1 signature
        let pkey = PKey::private_key_from_pem(cert_data.private_key.as_bytes()).unwrap();
        let mut verifier = Verifier::new(MessageDigest::sha1(), &pkey).unwrap();
        verifier.update(canonical_si.as_bytes()).unwrap();
        assert!(
            verifier.verify(&signature_bytes).unwrap(),
            "RSA-SHA1 signature must verify against canonical SignedInfo"
        );
    }

    #[test]
    fn throws_when_inf_nfe_element_is_missing() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();
        let result = fiscal::certificate::sign_xml(
            "<NFe><data>test</data></NFe>",
            &cert.private_key,
            &cert.certificate,
        );
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("infNFe"), "Error should mention infNFe: {err}");
    }

    #[test]
    fn produces_different_signatures_for_different_xml_content() {
        let (pfx_bytes, passphrase) = generate_test_pfx();
        let cert = fiscal::certificate::load_certificate(&pfx_bytes, &passphrase).unwrap();

        let xml1 = sample_xml();
        let xml2 = xml1.replace("<vNF>10.00</vNF>", "<vNF>99.99</vNF>");

        let signed1 =
            fiscal::certificate::sign_xml(&xml1, &cert.private_key, &cert.certificate).unwrap();
        let signed2 =
            fiscal::certificate::sign_xml(&xml2, &cert.private_key, &cert.certificate).unwrap();

        fn extract_sig_value(xml: &str) -> Option<String> {
            let start = xml.find("<SignatureValue>")? + "<SignatureValue>".len();
            let end = xml[start..].find("</SignatureValue>")? + start;
            Some(xml[start..end].to_string())
        }

        let sig1 = extract_sig_value(&signed1).expect("sig1 not found");
        let sig2 = extract_sig_value(&signed2).expect("sig2 not found");
        assert_ne!(sig1, sig2);
    }
}