ホーム>PHPソースコード>その他のカテゴリー
ダウンロード

ターンスタイルPHPクライアントライブラリ

Recaptchaに触発されました

目次

  1. インストール
  2. はじめる
  3. 使用法
    • ターンスタイル
    • クライアント
      • 例HTTPクライアント
        • Guzzle HTTPクライアント
        • Symfony HTTPクライアントとNyholm PSR-7
        • Symfony HTTPクライアントとGuzzle PSR-7
        • Symfony HTTPクライアントとGuzzle PSR-7およびDiscovery
        • Curl HTTPクライアントとNyholm PSR-7
        • ディスカバリーHTTPクライアント
    • 秘密の鍵
    • iDempotencyキー
    • 確認する
    • 応答
    • 説明へのエラーコード

インストール

 composer require usarise/turnstile

はじめる

インストールSymfony HTTPクライアントとNyholm PSR7およびUSARISE TURNSTILE 

 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>

文字列への応答

 var_dump (( string ) $ response );

配列への応答

 var_dump ( $ response -> toArray ());

配列への応答オブジェクト

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

使用Turnstile

構成

 use Turnstile  Client  Client ;
use Turnstile  Turnstile ;

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

簡略化された構成

php-http/discoveryなどのPSR-18クライアント

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

使用Client

構成

 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)
);

例HTTPクライアント

Guzzle HTTPクライアント

インストール
 composer require guzzlehttp/guzzle
使用法
 use GuzzleHttp  Client as GuzzleHttpClient ;
use GuzzleHttp  Psr7  HttpFactory ;
use Turnstile  Client  Client ;

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

Symfony HTTPクライアントとNyholm PSR-7

インストールSymfony HTTPクライアントとNyholm PSR7 
 composer require symfony/http-client nyholm/psr7
使用法
 use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
簡略化された構成
 use Symfony  Component  HttpClient  Psr18Client ;

$ client = new Psr18Client ();

Symfony HTTPクライアントとGuzzle PSR-7

インストールSymfony HTTPクライアントとguzzleHTTP PSR7 
 composer require symfony/http-client guzzlehttp/psr7
使用法
 use GuzzleHttp  Psr7  HttpFactory ;
use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (
        responseFactory: new HttpFactory (),
    ),
);
簡略化された構成
 use GuzzleHttp  Psr7  HttpFactory ;
use Symfony  Component  HttpClient  Psr18Client ;

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

Symfony HTTPクライアントとGuzzle PSR-7およびDiscovery

インストールsymfony HTTPクライアントとguzzlehttp psr7およびphp httpディスカバリー
 composer require symfony/http-client guzzlehttp/psr7 php-http/discovery
使用法
 use Symfony  Component  HttpClient  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
簡略化された構成
 use Symfony  Component  HttpClient  Psr18Client ;

$ client = new Psr18Client ();

Curl HTTPクライアントとNyholm PSR-7

インストールNYHOLM PSR7およびPHP HTTP Curlクライアント
 composer require nyholm/psr7 php-http/curl-client
使用法
 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 ,
);

ディスカバリーHTTPクライアント

インストールPHP HTTPディスカバリー
 composer require php-http/discovery
使用法
 use Http  Discovery  Psr18Client ;
use Turnstile  Client  Client ;

$ client = new Client (
    new Psr18Client (),
);
簡略化された構成
 use Http  Discovery  Psr18Client ;

$ client = new Psr18Client ();

使用秘密のキー

ウィジェットの秘密の鍵。シークレットキーは、TurnStileの下のCloudFlareダッシュボードのウィジェット設定の下にあります。

本物のキー

https://dash.cloudflare.com/?to=/：account/turnstileのAPIキー

テストキー

1x0000000000000000000000000000000AA常に渡されます

2x0000000000000000000000000000000AA常に失敗します

3x0000000000000000000000000000000AAは、「すでに使用されているトークン」エラーを生成します

例

 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 ,
);

使用法idempotencyキー

アプリケーションで失敗した要求を再試行する必要がある場合、Idempotency機能を利用する必要があります。

UUIDをidempotencyKeyパラメーターとして提供し、必要な回数を同じトークンで$turnstile->verify(...)を使用することでこれを行うことができます。

ラムジー・ウーイドの例

インストール
 composer require ramsey/uuid
使用法
 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 ) {
    // ...
}

使用法を確認します

サンプル

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

リモートIP

remoteIpパラメーターは、現在の訪問者がトークンを受け取った訪問者であることを保証することにより、虐待を防ぐのに役立ちます。

これは現在、厳密に検証されていません。

基本的な使用法
 $ 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.
);
使用状況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.
);

拡張

 $ 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.
);

使用率

成功ステータス

 $ response -> success

エラーコード

 $ response -> errorCodes

チャレンジタイムスタンプ

 $ response -> challengeTs

ホスト名

 $ response -> hostname

アクション

 $ response -> action

顧客データ

 $ response -> cdata

ひもに

生のJSONデータを備えた文字列

( string ) $ response

配列に

デコードされたJSONデータ

 $ response -> toArray ()

配列にオブジェクト

Responseクラスのプロパティに基づく処理されたJSONデータの配列： success 、 errorCodes 、 challengeTs 、 hostname 、 action 、 cdata 

 $ response -> toArray (strict: true )

説明への使用エラーコード

エラーコードを適切な言語で説明に変換する（デフォルトの英語） 

 use Turnstile  Error { Code , Description };

var_dump (
    Code:: toDescription (
        codes: $ response -> errorCodes ,
        descriptions: Description:: TEXTS , // Default
    ),
);
拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて