Page d'accueil>Code source PHP>Autres catégories
Télécharger

Bibliothèque client PHP de tourniquet

Inspiré sur recaptcha

Table des matières

  1. Installation
  2. Commencer
  3. Usage
    • Tourniquet
    • Client
      • Exemples clients http
        • Client de Guzzle HTTP
        • Client Symfony HTTP et NYHOLM PSR-7
        • Client Symfony HTTP et Guzzle PSR-7
        • Client Symfony HTTP et Guzzle PSR-7 et Discovery
        • Curl HTTP Client et NYHOLM PSR-7
        • Discovery HTTP Client
    • clé secrète
    • clé idempotence
    • vérifier
    • réponse
    • codes d'erreur à la description

Installation 

 composer require usarise/turnstile

Commencer

Installation Symfony HTTP Client et NYHOLM PSR7 et Usarise Turnique 

 composer require symfony/http-client nyholm/psr7 usarise/turnstile

TurnstileExample.php 

 <?php

declare (strict_types= 1 );

require_once __DIR__ . ' /vendor/autoload.php ' ;

use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Error  Code ;
use Turnstile  Turnstile ;

// Get real API keys at https://dash.cloudflare.com/?to=/:account/turnstile
$ siteKey = ' 1x00000000000000000000AA ' ; // Always passes (Dummy Testing)
$ secretKey = ' 1x0000000000000000000000000000000AA ' ; // Always passes (Dummy Testing)

if ( $ token = $ _POST [ ' cf-turnstile-response ' ] ?? null ) {
    $ turnstile = new Turnstile (
        client: new Psr18Client (),
        secretKey: $ secretKey ,
    );

    $ response = $ turnstile -> verify (
        $ token , // The response provided by the Turnstile client-side render on your site.
        $ _SERVER [ ' REMOTE_ADDR ' ], // With usage CloudFlare: $_SERVER['HTTP_CF_CONNECTING_IP']
    );

    if ( $ response -> success ) {
        echo ' Success! ' ;
    } else {
        $ errors = $ response -> errorCodes ;
        var_dump ( $ errors );
        var_dump (Code:: toDescription ( $ errors ));
    }

    exit ;
}
?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Turnstile example</title>
  <script src="https://challenges.cloudflare.com/turnstile/v0/api.js" async defer></script>
</head>
<body>
<form action="" method="POST">
  <!-- The following line controls and configures the Turnstile widget. -->
  <div class="cf-turnstile" data-sitekey=" <?php echo $ siteKey ; ?> " data-theme="light"></div>
  <!-- end. -->
  <button type="submit" value="Submit">Verify</button>
</form>
</body>
</html>

Réponse à la chaîne 

 var_dump (( string ) $ response );

Réponse au tableau 

 var_dump ( $ response -> toArray ());

Objet de réponse à la table 

 var_dump ( $ response -> toArray (strict: true ));

Turnstile d'utilisation

Construction 

 use Turnstile  Client  Client ;
use Turnstile  Turnstile ;

$ turnstile = new Turnstile (
    client: new Client (...),
    secretKey: ' secret key ' ,
    idempotencyKey: ' idempotency key ' ,
);

Construction simplifiée

Des clients PSR-18 comme php-http/discovery 

 $ turnstile = new Turnstile (
    client: new Psr18Client (),
    secretKey: ' secret key ' ,
    idempotencyKey: ' idempotency key ' ,
);

Client d'utilisation

Construction 

 use Turnstile  Client  Client ;
use Turnstile  TurnstileInterface ;

$ client = new Client (
    client: ..., // implementation PsrHttpClientClientInterface
    requestFactory: ..., // implementation PsrHttpMessageRequestFactoryInterface (default: requestFactory = client)
    streamFactory: ..., // implementation PsrHttpMessageStreamFactoryInterface (default: streamFactory = requestFactory)
    siteVerifyUrl: TurnstileInterface:: SITE_VERIFY_URL , // https://challenges.cloudflare.com/turnstile/v0/siteverify (default)
);

Exemples clients http

Client de Guzzle HTTP

Installation 
 composer require guzzlehttp/guzzle
Usage 
 use GuzzleHttp  Client as GuzzleHttpClient ;
use GuzzleHttp  Psr7  HttpFactory ;
use Turnstile  Client  Client ;

$ client = new Client (
    new GuzzleHttpClient (),
    new HttpFactory (),
);

Client Symfony HTTP et NYHOLM PSR-7

Installation Symfony HTTP Client et NYHOLM PSR7 
 composer require symfony/http-client nyholm/psr7
Usage 
 use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
Construction simplifiée 
 use Symfony  Component  HttpClient  Psr18Client ;

$ client = new Psr18Client ();

Client Symfony HTTP et Guzzle PSR-7

Installation Symfony HTTP Client et Guzzlehttp PSR7 
 composer require symfony/http-client guzzlehttp/psr7
Usage 
 use GuzzleHttp  Psr7  HttpFactory ;
use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (
        responseFactory: new HttpFactory (),
    ),
);
Construction simplifiée 
 use GuzzleHttp  Psr7  HttpFactory ;
use Symfony  Component  HttpClient  Psr18Client ;

$ client = new Psr18Client (
    responseFactory: new HttpFactory (),
);

Client Symfony HTTP et Guzzle PSR-7 et Discovery

Installation Symfony HTTP Client et Guzzlehttp PSR7 et PHP HTTP Discovery 
 composer require symfony/http-client guzzlehttp/psr7 php-http/discovery
Usage 
 use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
Construction simplifiée 
 use Symfony  Component  HttpClient  Psr18Client ;

$ client = new Psr18Client ();

Curl HTTP Client et NYHOLM PSR-7

Installation NYHOLM PSR7 et PHP HTTP Curl Client 
 composer require nyholm/psr7 php-http/curl-client
Usage 
 use Http  Client  Curl  Client as CurlClient ;
use Nyholm  Psr7  Factory  Psr17Factory ;
use Turnstile  Client  Client ;

$ psr17Factory = new Psr17Factory ();

$ client = new Client (
    client: new CurlClient (
        responseFactory: $ psr17Factory ,
        streamFactory: $ psr17Factory ,
    ),
    requestFactory: $ psr17Factory ,
);

Discovery HTTP Client

Installation PHP HTTP Discovery 
 composer require php-http/discovery
Usage 
 use Http  Discovery  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
Construction simplifiée 
 use Http  Discovery  Psr18Client ;

$ client = new Psr18Client ();

Clé secrète d'utilisation

La clé secrète du widget. La touche secrète se trouve dans les paramètres du widget dans le tableau de bord CloudFlare sous Turnique.

De vraies clés

Keys API à https://dash.cloudflare.com/?to=/:Account/turnstile

Clés de test

1x0000000000000000000000000000000AA PASSES TOUJOURS

2x0000000000000000000000000000000AA échoue toujours

3x0000000000000000000000000000000AA donne une erreur «Token déjà dépensée»

Exemple 

 use Turnstile  Client  Client ;
use Turnstile  Turnstile ;

// Real API keys at https://dash.cloudflare.com/?to=/:account/turnstile
$ secretKey = ' 1x0000000000000000000000000000000AA ' ;

$ turnstile = new Turnstile (
    client: $ client ,
    secretKey: $ secretKey ,
);

Clé d'identification d'utilisation

Si une application nécessite de réessayer les demandes échouées, elle doit utiliser la fonctionnalité d'idémpotence.

Vous pouvez le faire en fournissant un UUID comme paramètre idempotencyKey , puis en utilisant $turnstile->verify(...) avec le même jeton le nombre de fois requis.

Exemple avec Ramsey Uuid

Installation 
 composer require ramsey/uuid
Usage 
 use Ramsey  Uuid  Uuid ;
use Turnstile  Client  Client ;
use Turnstile  Turnstile ;

$ turnstile = new Turnstile (
    client: $ client ,
    secretKey: $ secretKey , // The site’s secret key.
    idempotencyKey: ( string ) Uuid:: uuid4 (), // The UUID to be associated with the response.
);

$ response = $ turnstile -> verify (
    $ token , // The response that will be associated with the UUID (idempotencyKey)
);

if ( $ response -> success ) {
    // ...
}

$ response = $ turnstile -> verify (
    $ token , // The response associated with UUID (idempotencyKey)
);

if ( $ response -> success ) {
    // ...
}

Utilisation Vérifier

Échantillon 

 $ response = $ turnstile -> verify (
    token: $ _POST [ ' cf-turnstile-response ' ], // The response provided by the Turnstile client-side render on your site.
);

IP distant

Le paramètre remoteIp aide à prévenir les abus en veillant à ce que le visiteur actuel soit celui qui a reçu le jeton.

Ce n'est actuellement pas strictement validé.

Utilisation de base 
 $ response = $ turnstile -> verify (
    token: $ _POST [ ' cf-turnstile-response ' ], // The response provided by the Turnstile client-side render on your site.
    remoteIp: $ _SERVER [ ' REMOTE_ADDR ' ], // The visitor’s IP address.
);
Avec l'utilisation de cloudflare 
 $ response = $ turnstile -> verify (
    token: $ _POST [ ' cf-turnstile-response ' ], // The response provided by the Turnstile client-side render on your site.
    remoteIp: $ _SERVER [ ' HTTP_CF_CONNECTING_IP ' ], // The visitor’s IP address.
);

Étendu 

 $ response = $ turnstile -> verify (
    ...
    challengeTimeout: 300 , // Number of allowed seconds after the challenge was solved.
    expectedHostname: $ _SERVER [ ' SERVER_NAME ' ], // Expected hostname for which the challenge was served.
    expectedAction: ' login ' , // Expected customer widget identifier passed to the widget on the client side.
    expectedCdata: ' sessionid-123456789 ' , // Expected customer data passed to the widget on the client side.
);

Réponse d'utilisation

Statut de réussite 

 $ response -> success

Codes d'erreur 

 $ response -> errorCodes

Défi l'horodatage 

 $ response -> challengeTs

Nom d'hôte 

 $ response -> hostname

Action 

 $ response -> action

Données clients 

 $ response -> cdata

À la chaîne

Chaîne avec des données JSON brutes 

( string ) $ response

À la table

Données JSON décodées 

 $ response -> toArray ()

Objection à la table

Tableau de données JSON traitées basées sur les propriétés de la classe Response : success , errorCodes , challengeTs , hostname , action , cdata 

 $ response -> toArray (strict: true )

Codes d'erreur d'utilisation à la description

Convertir les codes d'erreur en une description dans une langue appropriée (anglais par défaut) 

 use Turnstile  Error { Code , Description };

var_dump (
    Code:: toDescription (
        codes: $ response -> errorCodes ,
        descriptions: Description:: TEXTS , // Default
    ),
);
Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout