Recaptcha.Verify.Net скачать - Recaptcha.Verify.Net исходный код скачать

Recaptcha.verify.net

Строить

Библиотека для проверки на стороне сервера Google Recaptcha V2/V3 токен ответа для ASP.NET.

Recaptcha.verify.net, начиная с версии 2.0.0, поддерживает следующие платформы и любую цель, которая поддерживает стандарт .net с 2.0:

.NET Стандарт 2.0
.NET Стандарт 2.1
.Net Framework 4.6.2
.NET 6
.NET 7

Установка
Проверка ответа Recaptcha
Использование атрибута для проверки ответа recaptcha
Порог сцены с непосредственным прохождением
Использование карты порогового счета
Проверка ответа RecAptcha без проверки действия и результатов
Обработка исключений
Примеры

Установка

Пакет может быть установлен с использованием пользовательского интерфейса Visual Studio (Инструменты> Диспетчер пакетов Nuget> Управление пакетами Nuget для решения и поиск "recaptcha.verify.net").

Также последняя версия пакета может быть установлена с помощью консоли Manager Package Manager:

 PM> Install-Package Recaptcha.Verify.Net

Проверка ответа Recaptcha

Добавьте секретный ключ в файл appsettings.json.

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

Настройка службы в startup.cs.

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

Используйте службу в контроллере, чтобы проверить ответ CAPTCHA и проверьте действие ответа и оценку на 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 ( ) ;
    }
}

Использование атрибута для проверки ответа recaptcha

Укажите в Appsettings.json имя параметра для способа передачи токена ответа recaptcha.

{
  "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
    }
  }
}

Или установить в стартап GetResponsetOkenFromActionArguments или GetResponsetOkenFromexeCutingContext Делегируйте, который указывает, как получить токен из проанализированных данных.

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

Модель учетных данных, используемая в примере, имеет базовый класс со свойством, содержащим токен.

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

Добавьте атрибут recaptcha в контроллер, чтобы проверить ответ CAPTCHA и проверьте действие ответа и оценку на V3.

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

Порог сцены с непосредственным прохождением

Порог оценки в appsettings.json является необязательным, и значение может быть передано непосредственно в функцию VerifyAndCheckAsync.

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

Использование карты порогового счета

Основываясь на оценке, вы можете предпринять переменные действия в контексте своего сайта вместо блокировки трафика, чтобы лучше защитить ваш сайт. Пороги баллов, указанные для действий, позволяют вам добиться адаптивного анализа рисков и защиты на основе контекста действия.

Укажите ActionScoretholds в appsettings.json. Если указанное значение Scorethreshold будет использоваться в качестве порога баллов по умолчанию для действий, которых нет в карте.

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

Вызовать функцию проверки и функции

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

Проверка ответа RecAptcha без проверки действия и результатов

Если проверка ответа на проверку должна быть завершена отдельно, вы можете использовать VerifyAsync вместо VerifyandCheckasync.

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

Обработка исключений

Библиотека может создать следующие исключения

Исключение	Описание
EmptyCationException	Это исключение брошено, когда действие, передаваемое функцией, пусто.
EmptyCaptChaansWerexception	Это исключение брошено, когда ответ Captcha, переданный в функции, пуст.
Httprequestexception	Это исключение брошено, когда HTTP -запрос не удался. Магазины Refit.apiexception как внутреннее исключение.
MinScorenotSpecifiedException	Это исключение брошено, когда минимальный балл не был указан, а запрос имел оценку (использованный v3 recaptcha).
SecretKeyNotSpecifiedException	Это исключение брошено, когда секретный ключ не был указан в параметрах или параметрах запроса.
Неизвестно -экологически чистое	Это исключение брошено, когда ключ ошибки ответа проверки неизвестен.