Recaptcha.Verify.Net

Recaptcha.verify.net

Perpustakaan untuk Verifikasi Sisi Server Google RECAPTCHCA V2/V3 Token Respons untuk ASP.NET.

Recaptcha.verify.net mulai dari versi 2.0.0 mendukung platform berikut dan target apa pun yang mendukung .NET Standar dari 2.0:

• .NET Standard 2.0
• .NET Standard 2.1
• .NET Framework 4.6.2
• .Net 6
• .Net 7

Daftar isi

• Instalasi
• Memverifikasi respons recaptcha
• Menggunakan atribut untuk memverifikasi respons recaptcha
• Langsung melewati ambang batas skor
• Menggunakan peta ambang batas skor
• Memverifikasi respons recaptcha tanpa memeriksa tindakan dan skor
• Menangani pengecualian
• Contoh

Instalasi

Paket dapat diinstal menggunakan Visual Studio UI (Tools> Nuget Package Manager> Kelola Paket Nuget untuk solusi dan cari "recaptcha.verify.net").

Paket versi terbaru dapat diinstal menggunakan konsol Paket Manajer:

 PM> Install-Package Recaptcha.Verify.Net

Memverifikasi respons recaptcha

1. Tambahkan Kunci Rahasia di file appsettings.json.

{
  "Recaptcha" : {
    "SecretKey" : " <recaptcha secret key> " ,
    "ScoreThreshold" : 0.5
  }
}

2. Konfigurasikan layanan di startup.cs.

 public void ConfigureServices ( IServiceCollection services )
{
    services . AddRecaptcha ( Configuration . GetSection ( "Recaptcha" ) ) ;
    //...
}

3. Gunakan layanan di Controller untuk memverifikasi Jawaban CAPTCHA dan periksa tindakan respons dan skor untuk V3.

 [ ApiController ]
[ Route ( "api/[controller]" ) ]
public class LoginController : Controller
{
    private const string _loginAction = "login" ;
    
    private readonly ILogger _logger ;
    private readonly IRecaptchaService _recaptchaService ;

    public LoginController ( ILoggerFactory loggerFactory , IRecaptchaService recaptchaService )
    {
        _logger = loggerFactory . CreateLogger < LoginController > ( ) ;
        _recaptchaService = recaptchaService ;
    }

    [ HttpPost ]
    public async Task < IActionResult > Login ( [ FromBody ] Credentials credentials , CancellationToken cancellationToken )
    {
        var checkResult = await _recaptchaService . VerifyAndCheckAsync (
            credentials . RecaptchaToken ,
            _loginAction ,
            cancellationToken ) ;
        
        if ( ! checkResult . Success )
        {
            if ( ! checkResult . Response . Success )
            {
                // Handle unsuccessful verification response
                _logger . LogError ( "Recaptcha error: {errorCodes}" , JsonConvert . SerializeObject ( checkResult . Response . ErrorCodes ) ) ;
            }
            
            if ( ! checkResult . ScoreSatisfies )
            {
                // Handle score less than specified threshold for v3
            }
            
            // Unsuccessful verification and check
            return BadRequest ( ) ;
        }
        
        // Process login
        
        return Ok ( ) ;
    }
}

Menggunakan atribut untuk memverifikasi respons recaptcha

1. Tentukan di appsettings.json Nama parameter untuk cara di mana token respons recaptcha dilewati.

{
  "Recaptcha" : {
    ...
    "AttributeOptions" : {
      "ResponseTokenNameInHeader" : " RecaptchaTokenInHeader " , // If token is passed in header
      "ResponseTokenNameInQuery" : " RecaptchaTokenInQuery " , // If token is passed in query
      "ResponseTokenNameInForm" : " RecaptchaTokenInForm " // If token is passed in form
    }
  }
}

Atau diatur dalam startup getResponsTokenFromactionArguments atau getResponsetokenFromExecutingContext delegasi yang menunjukkan cara mendapatkan token dari data parsed.

 services . AddRecaptcha ( Configuration . GetSection ( "Recaptcha" ) ,
    // Specify how to get token from parsed arguments for using in RecaptchaAttribute
    o => o . AttributeOptions . GetResponseTokenFromActionArguments =
        d =>
        { 
            if ( d . TryGetValue ( "credentials" , out var credentials ) )
            {
                return ( ( BaseRecaptchaCredentials ) credentials ) . RecaptchaToken ;
            }
            return null ;
        } ) ;

Model kredensial yang digunakan dalam contoh memiliki kelas dasar dengan properti yang mengandung token.

 public class BaseRecaptchaCredentials
{
    public string RecaptchaToken { get ; set ; }
}
public class Credentials : BaseRecaptchaCredentials
{
    public string Login { get ; set ; }
    public string Password { get ; set ; }
}

2. Tambahkan Atribut Recaptcha di Controller untuk memverifikasi Jawaban CAPTCHA dan periksa tindakan respons dan skor untuk V3.

 [ Recaptcha ( "login" ) ]
[ HttpPost ( "Login" ) ]
public async Task < IActionResult > Login ( [ FromBody ] Credentials credentials , CancellationToken cancellationToken )
{
    // Process login
    return Ok ( ) ;
}

Langsung melewati ambang batas skor

Ambang skor di appsettings.json adalah opsional dan nilai dapat diteruskan langsung ke fungsi verifyAndCheckAsync.

 var scoreThreshold = 0.5f ;
var checkResult = await _recaptchaService . VerifyAndCheckAsync (
    credentials . RecaptchaToken ,
    _loginAction ,
    scoreThreshold ) ;

Menggunakan peta ambang batas skor

Berdasarkan skor, Anda dapat mengambil tindakan variabel dalam konteks situs Anda alih -alih memblokir lalu lintas untuk melindungi situs Anda dengan lebih baik. Ambang batas skor yang ditentukan untuk tindakan memungkinkan Anda untuk mencapai analisis risiko adaptif dan perlindungan berdasarkan konteks tindakan.

1. Tentukan ActionScorethresholds di appsettings.json. Jika nilai SCORETHreshold yang ditentukan akan digunakan sebagai ambang batas skor default untuk tindakan yang tidak ada di peta.

{
  "Recaptcha" : {
    "SecretKey" : " <recaptcha secret key> " ,
    "ScoreThreshold" : 0.5 ,
    "ActionsScoreThresholds" : {
      "login" : 0.75 ,
      "test" : 0.9
    }
  }
}

2. Call VerifyAndCheckAsync Function

 // Response will be checked with score threshold equal to 0.75
var checkResultLogin  = await _recaptchaService . VerifyAndCheckAsync ( credentials . RecaptchaToken , "login" ) ;

// Response will be checked with score threshold equal to 0.9
var checkResultTest   = await _recaptchaService . VerifyAndCheckAsync ( credentials . RecaptchaToken , "test" ) ;

// Response will be checked with score threshold equal to 0.5
var checkResultSignUp = await _recaptchaService . VerifyAndCheckAsync ( credentials . RecaptchaToken , "signup" ) ;

Memverifikasi respons recaptcha tanpa memeriksa tindakan dan skor

Jika pemeriksaan respons verifikasi perlu diselesaikan secara terpisah maka Anda dapat menggunakan verifyAsync alih -alih verifyAndCheckAsync.

 var response = await _recaptchaService . VerifyAsync ( credentials . RecaptchaToken ) ;

Menangani pengecualian

Perpustakaan dapat menghasilkan pengecualian berikut

Pengecualian	Keterangan
COMMELDACTIONEXCEPTION	Pengecualian ini dilemparkan ketika tindakan berlalu dalam fungsi kosong.
COMPANDCAPTCHAANSWEREXCEPTION	Pengecualian ini dilemparkan ketika jawaban captcha berlalu dalam fungsi kosong.
HttpRequestException	Pengecualian ini dilemparkan ketika permintaan HTTP gagal. Toko REPIT.ApIException sebagai pengecualian batin.
MinScorenotspecifiedException	Pengecualian ini dilemparkan ketika skor minimal tidak ditentukan dan permintaan memiliki nilai skor (digunakan V3 Recaptcha).
SecretKeyNotSpecifiedException	Pengecualian ini dilemparkan ketika kunci rahasia tidak ditentukan dalam opsi atau permintaan params.
UnknownErrorKeyException	Pengecualian ini dilemparkan ketika kunci kesalahan respons verifikasi tidak diketahui.

Semua pengecualian ini diwarisi dari RecaptChaserviceException.

Contoh

Contoh dapat ditemukan di repositori perpustakaan:

• Recaptcha.verify.net.consoleApp (.net 6)
• Recaptcha.verify.net.aspnetCoreAngular (asp.net 6 + angular)