Skip to content

Commit

Permalink
Merge pull request #208 from GuilhermeNastrini/patch-2
Browse files Browse the repository at this point in the history
[UPD] Correções textuais em geral
  • Loading branch information
robmachado committed Jul 3, 2019
2 parents 4627e4d + f388e5f commit eeace41
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions docs/Signer.md
Expand Up @@ -2,7 +2,7 @@

Esta classe é responsável por testar, remover e realizar as assinaturas digitais nos documentos XML e pode ser usado para NFe, NFCe, CTe, MDFe, eSocial, eFinanceira e para os vários modelos de NFSe que requeiram esse tipo de assinatura.

Esta assinatura segue os padrões estabelecidos pelas SEFAZ, Recita Federal e Ministério do Trabalho.
Esta assinatura segue os padrões estabelecidos pelas SEFAZ, Receita Federal e Ministério do Trabalho.

# MÉTODOS

Expand All @@ -12,17 +12,17 @@ Este método realiza a assinatura em um XML. O XML assinado é retornado como st

> NOTA: essa assinatura está limitada aos padrões da Receita Federal e Sefaz, e permite o uso dos algoritimos SHA1 e SHA256 apenas.
> NOTA: A assinatura será montada mesmo que o certificado estaja vencido !! e com isso gerand uma assinatura INVALIDA.
> NOTA: A assinatura será montada mesmo que o certificado esteja vencido! E com isso, gerando uma assinatura INVÁLIDA.
| Parametro | Tipo | Descrição |
| Parâmetro | Tipo | Descrição |
| :--- | :---: | :--- |
| $certificate | Certificate::class | objeto (OBRIGATÓRIO) |
| $content | string | conteudo do XML a ser assinado (OBRIGATÓRIO) |
| $content | string | conteúdo do XML a ser assinado (OBRIGATÓRIO) |
| $tagname | string | nome da tag a ser assinada Ex. infNFe (OPCIONAL), em alguns casos |
| $mark | string | atributo de identificação da tag a ser assinada Ex. Id (OPCIONAL), em alguns casos |
| $algorithm | integer | Ex. OPENSSL_ALGO_SHA1 (Opcional), em alguns casos |
| $canonical | array | opções para obter a forma canonica da string a ser assinada Ex. [true,false,null,null] (Opcional), em alguns casos |
| $rootname | string | nome da tag que irá conter a assinatura, Ex. '' (Opcional) |
| $algorithm | integer | Ex. OPENSSL_ALGO_SHA1 (OPCIONAL), em alguns casos |
| $canonical | array | opções para obter a forma canônica da string a ser assinada Ex. [true,false,null,null] (OPCIONAL), em alguns casos |
| $rootname | string | nome da tag que irá conter a assinatura, Ex. '' (OPCIONAL) |

### Exceptions

Expand All @@ -46,16 +46,15 @@ $tagname = 'infNFe'; //tag a ser assinada,
$mark = 'Id'; //indica se a assinatura fará referencia a uma tag
//com atributo de identificação definido,
//se for assinar a raiz do documento este campo deverá
//ser deixado em branco
//ser deixado em branco

$algorithm = OPENSSL_ALGO_SHA1; //algoritimo de encriptação a ser usado
$algorithm = OPENSSL_ALGO_SHA1; //algoritmo de encriptação a ser usado

$canonical = [true,false,null,null]; //veja função C14n do PHP

$rootname = ''; //este campo indica em qual node a assinatura deverá ser inclusa

try {

$pfx = file_get_contents('certificado_teste.pfx');
$certificate = Certificate::readPfx($pfx, 'associacao');

Expand Down Expand Up @@ -85,7 +84,7 @@ try {
Este método irá remover a tag <Signature> do XML, caso exista.
Se não existir será retornado o mesmo XML da entrada.

| Parametro | Tipo | Descrição |
| Parâmetro | Tipo | Descrição |
| :--- | :---: | :--- |
| $content | string | string com o conteúdo de um XML (OBRIGATÓRIA) |

Expand All @@ -102,14 +101,13 @@ use NFePHP\Common\Signer;
$content = "<esta string deve conter o XML assinado>";

try {

$unsigned = Signer::removeSignature($content);

header('Content-type: text/xml; charset=UTF-8');
echo $unsigned;

} catch (\Exception $e) {
//aqui você trata a possivel exception
//aqui você trata a possível exception
echo $e->getMessage();
}

Expand All @@ -120,15 +118,15 @@ try {

Este método verifica a validade de uma assinatura em um XML conforme os padrões da SEFAZ e da Receita Federal.

> NOTA: Existem inumeros possiveis modelos de asssinaturas, mas este método não foi desenhado para avaliar de forma genérica qualquer assinatura. Seu escopo está limitado aos padrões anteriormente indicados.
> NOTA: Existem inúmeros possíveis modelos de asssinaturas, mas este método não foi desenhado para avaliar de forma genérica qualquer assinatura. Seu escopo está limitado aos padrões anteriormente indicados.
| Parâmetro | Tipo | Descrição |
| :--- | :---: | :--- |
| $content | string | string com o conteúdo de um XML (OBRIGATÓRIA) |
| $tagname | string | nome da tag a ser usada na validação (OPCIONAL) |
| $canonical | array | opções para obtenção da forma canonica da string a ser assinada (OPCIONAL) |
| $canonical | array | opções para obtenção da forma canônica da string a ser assinada (OPCIONAL) |

> NOTA: Limitação apenas nos casos de SHA1 e SHA256, outros possiveis modelos de assinatura não podem ser validados com essa classe.
> NOTA: Limitação apenas nos casos de SHA1 e SHA256, outros possíveis modelos de assinatura não podem ser validados com essa classe.
> NOTA: Caso o XML não esteja assinado irá retornar FALSE
Expand All @@ -140,12 +138,12 @@ $content = "<esta string deve conter o XML já assinado>";

try {
if (Signer::isSigned($content)) {
echo "Assinatura Válida";
echo "Assinatura VÁLIDA";
} else {
echo "Assinatura INVÁLIDA";
}
} catch (\Exception $e) {
//aqui você trata a possivel exception
//aqui você trata a possível exception
echo $e->getMessage();
}

Expand Down Expand Up @@ -179,7 +177,7 @@ try {
echo "O XML NÃO contêm assinatura.";
}
} catch (\Exception $e) {
//aqui você trata a possivel exception
//aqui você trata a possível exception
echo $e->getMessage();
}

Expand Down

0 comments on commit eeace41

Please sign in to comment.