Tipagem do AssinaturaA1.assinar() e melhorias para a assinatura (#405)

leandroguimaraes · web-flow · commit e9e287eee013 · 2025-04-22T08:47:26.000-03:00
* Melhorias em tratamento de erros * Tipagem * Testes unitários * Compatibilidade com Python 3.8 e 3.9 * Remoção de TODO * Refatoração * Refatoração * Atualização: actions/runner-images#11101
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,7 @@ name: PyNFe CI
 on: [pull_request, push]
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
diff --git a/pynfe/entidades/certificado.py b/pynfe/entidades/certificado.py
@@ -46,10 +46,13 @@ def separar_arquivo(self, senha, caminho=False):
         try:
             with open(self.caminho_arquivo, "rb") as cert_arquivo:
                 cert_conteudo = cert_arquivo.read()
-        except (PermissionError, FileNotFoundError) as exc:
-            raise Exception(
-                """Falha ao abrir arquivo do certificado digital A1.
-                Verifique local e permissoes do arquivo."""
+        except FileNotFoundError as exc:
+            raise FileNotFoundError(
+                "Falha ao abrir arquivo do certificado digital A1. Verifique o local do arquivo."
+            ) from exc
+        except PermissionError as exc:
+            raise PermissionError(
+                "Falha ao abrir arquivo do certificado digital A1. Verifique as permissoes do arquivo."
             ) from exc
         except Exception as exc:
             raise Exception(
diff --git a/pynfe/processamento/assinatura.py b/pynfe/processamento/assinatura.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import signxml
+from typing import Union
 
 from pynfe.entidades import CertificadoA1
 from pynfe.utils import CustomXMLSigner, etree, remover_acentos
@@ -26,7 +27,7 @@ class AssinaturaA1(Assinatura):
     def __init__(self, certificado, senha):
         self.key, self.cert = CertificadoA1(certificado).separar_arquivo(senha)
 
-    def assinar(self, xml, retorna_string=False):
+    def assinar(self, xml: etree._Element, retorna_string=False) -> Union[str, etree._Element]:
         # busca tag que tem id(reference_uri), logo nao importa se tem namespace
         reference = xml.find(".//*[@Id]").attrib["Id"]
 
diff --git a/tests/test_certificadoA1.py b/tests/test_certificadoA1.py
@@ -25,16 +25,15 @@ def test_assinatura_com_caminho(self):
         self.a1.excluir()
 
     def test_exception_certificado_filenotfounderror(self):
-        with self.assertRaises(Exception) as context:
+        with self.assertRaises(FileNotFoundError) as context:
             self.a1 = CertificadoA1(self.certificado_incorreto)
             self.a1.separar_arquivo(
                 senha=self.senha_incorreto, caminho=self.certificado_incorreto
             )
         self.assertEqual(
             str(context.exception),
             (
-                """Falha ao abrir arquivo do certificado digital A1.
-                Verifique local e permissoes do arquivo."""
+                "Falha ao abrir arquivo do certificado digital A1. Verifique o local do arquivo."
             ),
         )
 
diff --git a/tests/test_nfse_serializacao.py b/tests/test_nfse_serializacao.py
@@ -4,6 +4,7 @@
 from pynfe.entidades.emitente import Emitente
 from pynfe.entidades.notafiscal import NotaFiscalServico
 from pynfe.entidades.servico import Servico
+from pynfe.processamento.assinatura import AssinaturaA1
 from pynfe.processamento.serializacao import SerializacaoNfse
 from pynfe.utils import obter_codigo_por_municipio
 from pynfe.utils.flags import (
@@ -12,6 +13,7 @@
 from decimal import Decimal
 import datetime
 import re
+from lxml import etree
 
 
 class SerializacaoNFSeConfigTest:
@@ -22,14 +24,7 @@ def __init__(self, certificado: str, senha: str, homologacao: bool):
 
 
 class SerializacaoNFSeTest:
-
-    @staticmethod
-    def get_config() -> SerializacaoNFSeConfigTest:
-        return SerializacaoNFSeConfigTest(
-            "./tests/certificado.pfx",
-            bytes("123456", "utf-8"),
-            True
-        )
+    data_hora = "2025-04-10T09:45:29"
 
     @staticmethod
     def get_notafiscal_servico() -> NotaFiscalServico:
@@ -61,7 +56,8 @@ def get_notafiscal_servico() -> NotaFiscalServico:
 
         return NotaFiscalServico(
             identificador='50',
-            data_emissao=datetime.datetime.now(),
+            data_emissao=datetime.datetime.strptime(
+                SerializacaoNFSeTest.data_hora, "%Y-%m-%dT%H:%M:%S"),
             servico=servico,
             emitente=SerializacaoNFSeTest._get_emitente(),
             cliente=SerializacaoNFSeTest._get_destinatario(),
@@ -84,16 +80,19 @@ def serializa_nfse(nfse: NotaFiscalServico, autorizador: str) -> str:
         xml = serializador.gerar(nfse)
         return xml
 
-    # TODO: assinatura digital
-    # @staticmethod
-    # def assina_xml(config: SerializacaoNFSeConfigTest, nfse_xml: str):
-    #     a1 = AssinaturaA1(config.certificado, config.senha)
-    #     xml = a1.assinar(nfse_xml, True)
-    #     return xml
+    @staticmethod
+    def assina_xml(xml: str) -> str:
+        config = SerializacaoNFSeTest._get_config()
+        nfse = etree.fromstring(xml)
+
+        a1 = AssinaturaA1(config.certificado, config.senha)
+        xml_assinado = a1.assinar(nfse, True)
+
+        return xml_assinado
 
     @staticmethod
     def strip_xml(xml: str) -> str:
-        return re.sub(r">\s+<", "><", xml.replace("\n", "").strip())
+        return re.sub(r">\s+<", "><", xml.strip())
 
     @staticmethod
     def limpa_namespace() -> None:
@@ -114,6 +113,14 @@ def limpa_namespace() -> None:
     #         xml_doc=nfse_xml_assinado, xsd_file=xsd_nfse, use_assert=True
     #     )
 
+    @staticmethod
+    def _get_config() -> SerializacaoNFSeConfigTest:
+        return SerializacaoNFSeConfigTest(
+            "./tests/certificado.pfx",
+            bytes("123456", "utf-8"),
+            True
+        )
+
     @staticmethod
     def _get_emitente() -> Emitente:
         return Emitente(
diff --git a/tests/test_nfse_serializacao_betha.py b/tests/test_nfse_serializacao_betha.py
@@ -1,7 +1,6 @@
 import unittest
 
 from pynfe.entidades.notafiscal import NotaFiscalServico
-
 from tests.test_nfse_serializacao import SerializacaoNFSeTest
 
 
@@ -10,15 +9,12 @@ def test_notafiscal_geral(self):
         nfse = self._get_notafiscal_servico()
         nfse_xml = SerializacaoNFSeTest.serializa_nfse(nfse, 'betha')
 
-        # TODO: assinatura digital
-        # config = SerializacaoNFSeTest.get_config()
-        # nfse_xml_assinado = SerializacaoNFSeTest.assina_xml(config, nfse_xml)
-
-        self.maxDiff = None
-        result = self._get_nfse_esperada(nfse)
+        nfse_xml_assinado = SerializacaoNFSeTest.assina_xml(nfse_xml)
+        nfse_esperada = self._get_nfse_esperada()
 
         # Teste do conteúdo das tags do XML
-        self.assertEqual(nfse_xml, result)
+        self.maxDiff = None
+        self.assertEqual(nfse_xml_assinado, nfse_esperada)
 
         # TODO: Testa a validação do XML com os schemas XSD
         # SerializacaoNFSeTest.validacao_com_xsd_do_xml_gerado_sem_processar(
@@ -36,9 +32,8 @@ def _get_notafiscal_servico(self) -> NotaFiscalServico:
 
         return nota_fiscal
 
-    def _get_nfse_esperada(self, nfse: NotaFiscalServico) -> str:
+    def _get_nfse_esperada(self) -> str:
         return SerializacaoNFSeTest.strip_xml(f"""
-            <?xml version="1.0" ?>
             <GerarNfseEnvio xmlns:ns1="http://www.betha.com.br/e-nota-contribuinte-ws">
                 <ns1:Rps>
                     <ns1:InfDeclaracaoPrestacaoServico Id="50">
@@ -48,10 +43,10 @@ def _get_nfse_esperada(self, nfse: NotaFiscalServico) -> str:
                                 <ns1:Serie>A1</ns1:Serie>
                                 <ns1:Tipo>1</ns1:Tipo>
                             </ns1:IdentificacaoRps>
-                            <ns1:DataEmissao>{nfse.data_emissao.strftime("%Y-%m-%d")}</ns1:DataEmissao>
+                            <ns1:DataEmissao>{SerializacaoNFSeTest.data_hora[:10]}</ns1:DataEmissao>
                             <ns1:Status>1</ns1:Status>
                         </ns1:Rps>
-                        <ns1:Competencia>{nfse.data_emissao.strftime("%Y-%m-%d")}</ns1:Competencia>
+                        <ns1:Competencia>{SerializacaoNFSeTest.data_hora[:10]}</ns1:Competencia>
                         <ns1:Servico>
                             <ns1:Valores>
                                 <ns1:ValorServicos>100.0</ns1:ValorServicos>
@@ -85,8 +80,27 @@ def _get_nfse_esperada(self, nfse: NotaFiscalServico) -> str:
                         <ns1:IncentivoFiscal>2</ns1:IncentivoFiscal>
                     </ns1:InfDeclaracaoPrestacaoServico>
                 </ns1:Rps>
-            </GerarNfseEnvio>
-        """)
+                <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
+                    <SignedInfo>
+                        <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+                        <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
+                        <Reference URI="#50">
+                            <Transforms>
+                                <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
+                                <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
+                            </Transforms>
+                            <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
+                            <DigestValue>xzbAflAhVih7JNxmSa2ZJ1rMpzw=</DigestValue>
+                        </Reference>
+                    </SignedInfo>
+                    <SignatureValue>W6Ys1KHIbz9BDtG+ej++ROAkqZTtSgYH2cplorcxxOZ2VJG3KKWnasyLghEIJfcXtss4kjblgdGOf3IJVgaDuub4GyYPkEzCxnGEr1nQXw74rDmGLwZg1vPBUdHsIbcw8wvAoUOW6zfMI5ljr61Rz5CCytBu4IqpUFCQzWguiG8=</SignatureValue>
+                    <KeyInfo>
+                        <X509Data>
+                            <X509Certificate>MIICMTCCAZqgAwIBAgIQfYOsIEVuAJ1FwwcTrY0t1DANBgkqhkiG9w0BAQUFADBX\nMVUwUwYDVQQDHkwAewA1ADkARgAxAEUANAA2ADEALQBEAEQARQA1AC0ANABEADIA\nRgAtAEEAMAAxAEEALQA4ADMAMwAyADIAQQA5AEUAQgA4ADMAOAB9MB4XDTE1MDYx\nNTA1NDc1N1oXDTE2MDYxNDExNDc1N1owVzFVMFMGA1UEAx5MAHsANQA5AEYAMQBF\nADQANgAxAC0ARABEAEUANQAtADQARAAyAEYALQBBADAAMQBBAC0AOAAzADMAMgAy\nAEEAOQBFAEIAOAAzADgAfTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAk41G\nnqXXLaiOC/y0/cA4tbS+NZCqI+x4EsztgDFvPPlHstiVYcLRkni4i93gK9zoC6g0\nmh66HMVzAfE8vRNwW5b7m6nWS1SiHBon7/Mqsw4MIq3SC+J/fTbKpqwyfAuH2YZl\nAiQuQc85fyllAMLh2WrA7JgOLR/5tF3kLtpbHdECAwEAATANBgkqhkiG9w0BAQUF\nAAOBgQArdh+RyT6VxKGsXk1zhHsgwXfToe6GpTF4W8PHI1+T0WIsNForDhvst6nm\nQtgAhuZM9rxpOJuNKc+pM29EixpAiZZiRMCSWEItNyEVdUIi+YnKBcAHd88TwO86\nd126MWQ2O8cu5W1VoDp7hYBYKOnLbYi11/StO+0rzK+oPYAvIw==\n</X509Certificate>
+                        </X509Data>
+                    </KeyInfo>
+                </Signature>
+            </GerarNfseEnvio>""")
 
 
 if __name__ == "__main__":
diff --git a/tests/test_nfse_serializacao_ginfes.py b/tests/test_nfse_serializacao_ginfes.py

Original file line number	Diff line number	Diff line change
`@@ -25,16 +25,15 @@ def test_assinatura_com_caminho(self):`
`25`	`25`	`self.a1.excluir()`
`26`	`26`
`27`	`27`	`def test_exception_certificado_filenotfounderror(self):`
`28`		`- with self.assertRaises(Exception) as context:`
	`28`	`+ with self.assertRaises(FileNotFoundError) as context:`
`29`	`29`	`self.a1 = CertificadoA1(self.certificado_incorreto)`
`30`	`30`	`self.a1.separar_arquivo(`
`31`	`31`	`senha=self.senha_incorreto, caminho=self.certificado_incorreto`
`32`	`32`	`)`
`33`	`33`	`self.assertEqual(`
`34`	`34`	`str(context.exception),`
`35`	`35`	`(`
`36`		`- """Falha ao abrir arquivo do certificado digital A1.`
`37`		`- Verifique local e permissoes do arquivo."""`
	`36`	`+ "Falha ao abrir arquivo do certificado digital A1. Verifique o local do arquivo."`
`38`	`37`	`),`
`39`	`38`	`)`
`40`	`39`