Recaptcha.Verify.Net
v2.3.0
Biblioteca para verificação do lado do servidor do token de resposta do Google Recaptcha V2/V3 para asp.net.
Recaptcha.Verify.net A partir da versão 2.0.0 suporta as seguintes plataformas e qualquer destino que suporta o padrão .NET de 2.0:
O pacote pode ser instalado usando a interface do usuário do Visual Studio (Ferramentas> Nuget Package Manager> Gerencie pacotes NUGET para solução e pesquise "recaptcha.verifify.net").
Além disso, a versão mais recente do pacote pode ser instalada usando o Console do Gerenciador de Pacotes:
PM> Install-Package Recaptcha.Verify.Net
{
"Recaptcha" : {
"SecretKey" : " <recaptcha secret key> " ,
"ScoreThreshold" : 0.5
}
} public void ConfigureServices ( IServiceCollection services )
{
services . AddRecaptcha ( Configuration . GetSection ( "Recaptcha" ) ) ;
//...
} [ 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" : {
...
"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
}
}
}Ou definido no startup getResponseTokenFromActionArguments ou GetResponseTokenFromexecutingContext delegado que aponta como obter token a partir de dados analisados.
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 ;
} ) ;O modelo de credenciais usado no exemplo tem classe base com propriedades contendo token.
public class BaseRecaptchaCredentials
{
public string RecaptchaToken { get ; set ; }
}
public class Credentials : BaseRecaptchaCredentials
{
public string Login { get ; set ; }
public string Password { get ; set ; }
} [ Recaptcha ( "login" ) ]
[ HttpPost ( "Login" ) ]
public async Task < IActionResult > Login ( [ FromBody ] Credentials credentials , CancellationToken cancellationToken )
{
// Process login
return Ok ( ) ;
}O limite de pontuação em appSettings.json é opcional e o valor pode ser passado diretamente para a função VerifyAndCheckasync.
var scoreThreshold = 0.5f ;
var checkResult = await _recaptchaService . VerifyAndCheckAsync (
credentials . RecaptchaToken ,
_loginAction ,
scoreThreshold ) ;Com base na pontuação, você pode tomar ações variáveis no contexto do seu site, em vez de bloquear o tráfego para proteger melhor seu site. Os limites de pontuação especificados para ações permitem obter análise e proteção de riscos adaptáveis com base no contexto da ação.
{
"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" ) ;Se a verificação da resposta à verificação precisar ser concluída separadamente, você poderá usar o verificadoSync em vez de verifique e oCHECKASYNC.
var response = await _recaptchaService . VerifyAsync ( credentials . RecaptchaToken ) ;A biblioteca pode produzir as seguintes exceções
| Exceção | Descrição |
|---|---|
| VazioactionException | Essa exceção é lançada quando a ação passada em função está vazia. |
| EsvaziCAptchaanswerexception | Esta exceção é lançada quando a resposta do captcha passada em função está vazia. |
| HttPrequestException | Esta exceção é lançada quando a solicitação HTTP falhou. Lojas refit.apiexception como exceção interna. |
| MINSCORENOTSPECIFIFICECCECTIMENTO | Essa exceção é lançada quando a pontuação mínima não foi especificada e a solicitação teve um valor de pontuação (recortcha v3 usado). |
| SecretKeyNotsPecifiedException | Essa exceção é lançada quando a chave secreta não foi especificada em opções ou parâmetros de solicitação. |
| UnknownErrorKeyException | Esta exceção é lançada quando a chave de erro de resposta a verificação é desconhecida. |
Todas essas exceções são herdadas da RecaptChaserviceException.
Exemplos podem ser encontrados no repositório da biblioteca:
