Una biblioteca PHP de administrador nonce útil para prevenir CSRF y ataques de repetición.
Podemos encontrar varios artículos y vídeos explicando las vulnerabilidades que los nonces intentan prevenir:
Sin embargo, parece que muchas bibliotecas PHP nonces son demasiado restrictivas, junto con algún marco, difíciles de usar o difíciles de entender cómo funcionan.
pedroac/nonce
intenta resolver esos problemas.
Permite elegir cualquier implementación de PSR-16 para almacenar temporalmente los nonces, generadores de valores de nonces, intervalos de vencimiento e incluso un proveedor DateTime
para anular el sistema de reloj (esta característica se usa para pruebas unitarias).
También proporciona ayudas para administrar entradas, generar nombres y valores nonce aleatorios, verificar tokens enviados con respecto al nonce y generar elementos HTML.
Ejecute el comando:
composer require pedroac/nonce
Los formularios HTML se pueden probar utilizando un servidor web PHP integrado.
Desde la carpeta php/examples
ejecuta el comando:
php -S localhost:8000
Utilice la URL http://localhost:8000/ en un 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>
El nonce caduca automáticamente cuando el token se verifica con la clase 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 ; >
Además del almacenamiento en caché de nonces, es posible seleccionar el generador de valores nonce aleatorios y el intervalo de vencimiento:
<?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 ' )
);
También es posible crear un nonce con un nombre específico:
$ user_id = $ _SESSION [ ' user_id ' ];
$ tokenName = "{ $ user_id } _form " ;
$ nonce = $ manager -> create ( $ tokenName );
La fuente de entrada predeterminada NonceForm
es $_POST, pero acepta cualquier entrada de matriz:
$ form = new NonceForm (
' token ' ,
new NoncesManager (
new FilesystemCache
),
filter_input_array ( INPUT_GET ) // use $_GET
);
Ejecute desde la carpeta raíz de la biblioteca:
php/vendor/bin/phpunit php/tests/ -c php/tests/configuration.xml
Si las pruebas fueron exitosas, php/tests/coverage-html
debería tener el informe de cobertura del código.
Ejecute desde la carpeta raíz de la biblioteca:
sh scripts/generate-docs.sh
La documentación generada debe estar dentro de la carpeta docs
.
Se debe utilizar SemVer para el control de versiones.
pedroac/nonce se publica bajo la licencia pública del MIT.
Consulte la LICENCIA adjunta para obtener más detalles.
La biblioteca se desarrolló como una respuesta a una solicitud privada realizada por un usuario de Stackoverflow.