Uma biblioteca PHP gerenciadora nonce útil para prevenir ataques CSRF e de repetição.
Podemos encontrar vários artigos e vídeos explicando as vulnerabilidades que os nonces tentam prevenir:
Parece, porém, que muitas bibliotecas PHP nonces são muito restritivas, juntamente com algum framework, difíceis de usar ou difíceis de entender como funcionam.
pedroac/nonce
tenta resolver esses problemas.
Permite escolher qualquer implementação do PSR-16 para armazenar temporariamente os nonces, geradores de valores de nonces, intervalos de expiração e até mesmo um provedor DateTime
para sobrescrever o sistema de relógio (este recurso é usado para testes unitários).
Ele também fornece ajudantes para gerenciar entradas, gerar nomes e valores aleatórios de nonces, verificar tokens enviados em relação ao nonce e gerar elementos HTML.
Execute o comando:
composer require pedroac/nonce
Os formulários HTML podem ser testados usando um servidor web integrado em PHP.
Na pasta php/examples
execute o comando:
php -S localhost:8000
Use a URL http://localhost:8000/ em um navegador.
<?php
require __DIR__ . ' /../vendor/autoload.php ' ;
use Symfony Component Cache Simple FilesystemCache ;
use pedroac nonce NoncesManager ;
use pedroac nonce Form HtmlNonceField ;
use pedroac nonce Form NonceForm ;
// this handles automatically the input and nonce management
$ form = new NonceForm (
' token ' , // the HTML input name
new NoncesManager (
new FilesystemCache // a PsrSimpleCacheCacheInterface implementation
)
);
// this will be used to generate a HTML input element
$ htmlField = new HtmlNonceField ( $ form );
if ( $ form -> isSubmittedValid ()) {
/**
* handle the success:
* - if all form input is valid, show success page;
* - otherwise, show an error page and the form again;
*/
}
if ( $ form -> isSubmittedInvalid ()) {
/**
* handle failure:
* - don't show the form again;
* - show an error message;
*/
}
<form method=" POST ">
<?= $ htmlField ?>
<!-- more HTML -->
<input type="submit" name="myform" value="Submit" />
</form>
O nonce expira automaticamente quando o token é verificado com a classe NonceForm
.
<?php
require __DIR__ . ' /../vendor/autoload.php ' ;
use Symfony Component Cache Simple FilesystemCache ;
use pedroac nonce NoncesManager ;
$ manager = new NoncesManager ( new FilesystemCache );
$ isValidToken = false ;
$ isValidForm = false ;
$ wasSubmitted = filter_has_var ( INPUT_POST , ' myform ' );
$ tokenName = filter_input ( INPUT_POST , ' token_name ' );
$ tokenValue = filter_input ( INPUT_POST , ' token_value ' ) ?? '' ;
if ( $ tokenName ) {
$ isValidToken = $ manager -> verifyAndExpire ( $ tokenName , $ tokenValue );
}
if ( $ wasSubmitted && $ isValidToken ) {
// validate input
}
if (! $ wasSubmitted || (! $ isValidForm && $ isValidToken )) {
$ nonce = $ manager -> create ();
}
<?php if ( $ nonce ) : ?>
<input type="hidden"
name="token_name"
value=" <?= htmlspecialchars ( $ nonce -> getName ()) ?> " />
<input type="hidden"
name="token_value"
value=" <?= htmlspecialchars ( $ nonce -> getValue ()) ?> " />
<input type="submit" name="myform" value="Submit" />
<?php endif ; >
Além do armazenamento em cache de nonces, é possível selecionar o gerador de valor aleatório de nonce e o intervalo de expiração:
<?php
require __DIR__ . ' /../vendor/autoload.php ' ;
use Symfony Component Cache Simple ArrayCache ;
use pedroac nonce NoncesManager ;
use pedroac nonce Random HexRandomizer ;
$ manager = new NoncesManager (
new ArrayCache ( 60 ),
new HexRandomizer ( 32 ), // a pedroacnonceRandom implementation
new DateInterval ( ' PT3H ' )
);
Também é possível criar um nonce com um nome especificado:
$ user_id = $ _SESSION [ ' user_id ' ];
$ tokenName = "{ $ user_id } _form " ;
$ nonce = $ manager -> create ( $ tokenName );
A fonte de entrada padrão NonceForm
é $_POST, mas aceita qualquer entrada de array:
$ form = new NonceForm (
' token ' ,
new NoncesManager (
new FilesystemCache
),
filter_input_array ( INPUT_GET ) // use $_GET
);
Execute a partir da pasta raiz da biblioteca:
php/vendor/bin/phpunit php/tests/ -c php/tests/configuration.xml
Se os testes foram bem-sucedidos, php/tests/coverage-html
deverá ter o relatório de cobertura de código.
Execute a partir da pasta raiz da biblioteca:
sh scripts/generate-docs.sh
A documentação gerada deverá estar dentro da pasta docs
.
Deve ser utilizado SemVer para versionamento.
pedroac/nonce é lançado sob a licença pública do MIT.
Consulte a LICENÇA anexa para obter detalhes.
A biblioteca foi desenvolvida como uma resposta de solicitação privada feita por um usuário Stackoverflow.