Create assessments for websites

  
 using 
  
 System 
 ; 
  
 using 
  
 Google.Api.Gax.ResourceNames 
 ; 
  
 using 
  
 Google.Cloud.RecaptchaEnterprise.V1 
 ; 
  
 public 
  
 class 
  
 CreateAssessmentSample 
  
 { 
  
 // Create an assessment to analyze the risk of a UI action. 
  
 // projectID: Google Cloud project ID. 
  
 // recaptchaKey: reCAPTCHA key obtained by registering a domain or an app to use reCAPTCHA Enterprise. 
  
 // token: The token obtained from the client on passing the recaptchaKey. 
  
 // recaptchaAction: Action name corresponding to the token. 
  
 public 
  
 void 
  
 createAssessment 
 ( 
 string 
  
 projectID 
  
 = 
  
 "project-id" 
 , 
  
 string 
  
 recaptchaKey 
  
 = 
  
 "recaptcha-key" 
 , 
  
 string 
  
 token 
  
 = 
  
 "action-token" 
 , 
  
 string 
  
 recaptchaAction 
  
 = 
  
 "action-name" 
 ) 
  
 { 
  
 // Create the client. 
  
 // TODO: To avoid memory issues, move this client generation outside 
  
 // of this example, and cache it (recommended) or call client.close() 
  
 // before exiting this method. 
  
 RecaptchaEnterpriseServiceClient 
  
 client 
  
 = 
  
 RecaptchaEnterpriseServiceClient 
 . 
 Create 
 (); 
  
 ProjectName 
  
 projectName 
  
 = 
  
 new 
  
 ProjectName 
 ( 
 projectID 
 ); 
  
 // Build the assessment request. 
  
 CreateAssessmentRequest 
  
 createAssessmentRequest 
  
 = 
  
 new 
  
 CreateAssessmentRequest 
 () 
  
 { 
  
 Assessment 
  
 = 
  
 new 
  
 Assessment 
 () 
  
 { 
  
 // Set the properties of the event to be tracked. 
  
 Event 
  
 = 
  
 new 
  
 Event 
 () 
  
 { 
  
 SiteKey 
  
 = 
  
 recaptchaKey 
 , 
  
 Token 
  
 = 
  
 token 
 , 
  
 ExpectedAction 
  
 = 
  
 recaptchaAction 
  
 }, 
  
 }, 
  
 ParentAsProjectName 
  
 = 
  
 projectName 
  
 }; 
  
 Assessment 
  
 response 
  
 = 
  
 client 
 . 
 CreateAssessment 
 ( 
 createAssessmentRequest 
 ); 
  
 // Check if the token is valid. 
  
 if 
  
 ( 
 response 
 . 
 TokenProperties 
 . 
 Valid 
  
 == 
  
 false 
 ) 
  
 { 
  
 System 
 . 
 Console 
 . 
 WriteLine 
 ( 
 "The CreateAssessment call failed because the token was: " 
  
 + 
  
 response 
 . 
 TokenProperties 
 . 
 InvalidReason 
 . 
 ToString 
 ()); 
  
 return 
 ; 
  
 } 
  
 // Check if the expected action was executed. 
  
 if 
  
 ( 
 response 
 . 
 TokenProperties 
 . 
 Action 
  
 != 
  
 recaptchaAction 
 ) 
  
 { 
  
 System 
 . 
 Console 
 . 
 WriteLine 
 ( 
 "The action attribute in reCAPTCHA tag is: " 
  
 + 
  
 response 
 . 
 TokenProperties 
 . 
 Action 
 . 
 ToString 
 ()); 
  
 System 
 . 
 Console 
 . 
 WriteLine 
 ( 
 "The action attribute in the reCAPTCHA tag does not " 
  
 + 
  
 "match the action you are expecting to score" 
 ); 
  
 return 
 ; 
  
 } 
  
 // Get the risk score and the reasons. 
  
 // For more information on interpreting the assessment, 
  
 // see: https://cloud.google.com/recaptcha/docs/interpret-assessment 
  
 System 
 . 
 Console 
 . 
 WriteLine 
 ( 
 "The reCAPTCHA score is: " 
  
 + 
  
 (( 
 decimal 
 ) 
 response 
 . 
 RiskAnalysis 
 . 
 Score 
 )); 
  
 foreach 
  
 ( 
 RiskAnalysis 
 . 
 Types 
 . 
 ClassificationReason 
  
 reason 
  
 in 
  
 response 
 . 
 RiskAnalysis 
 . 
 Reasons 
 ) 
  
 { 
  
 System 
 . 
 Console 
 . 
 WriteLine 
 ( 
 reason 
 . 
 ToString 
 ()); 
  
 } 
  
 } 
  
 public 
  
 static 
  
 void 
  
 Main 
 ( 
 string 
 [] 
  
 args 
 ) 
  
 { 
  
 new 
  
 CreateAssessmentSample 
 (). 
 createAssessment 
 (); 
  
 } 
  
 } 

  
 import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 recaptcha 
  
 "cloud.google.com/go/recaptchaenterprise/v2/apiv1" 
  
 recaptchapb 
  
 "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb" 
  
 ) 
  
 func 
  
 main 
 () 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 projectID 
  
 := 
  
 "project-id" 
  
 recaptchaKey 
  
 := 
  
 "recaptcha-key" 
  
 token 
  
 := 
  
 "action-token" 
  
 recaptchaAction 
  
 := 
  
 "action-name" 
  
 createAssessment 
 ( 
 projectID 
 , 
  
 recaptchaKey 
 , 
  
 token 
 , 
  
 recaptchaAction 
 ) 
  
 } 
  
 /** 
 * Create an assessment to analyze the risk of a UI action. 
 * 
 * @param projectID: Google Cloud project ID 
 * @param recaptchaKey: reCAPTCHA key obtained by registering a domain or an app to use the services of reCAPTCHA Enterprise. 
 * @param token: The token obtained from the client on passing the recaptchaKey. 
 * @param recaptchaAction: Action name corresponding to the token. 
 */ 
  
 func 
  
 createAssessment 
 ( 
 projectID 
  
 string 
 , 
  
 recaptchaKey 
  
 string 
 , 
  
 token 
  
 string 
 , 
  
 recaptchaAction 
  
 string 
 ) 
  
 { 
  
 // Create the recaptcha client. 
  
 // TODO: To avoid memory issues, move this client generation outside 
  
 // of this example, and cache it (recommended) or call client.close() 
  
 // before exiting this method. 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 recaptcha 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 fmt 
 . 
 Printf 
 ( 
 "Error creating reCAPTCHA client\n" 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 // Set the properties of the event to be tracked. 
  
 event 
  
 := 
  
 & 
 recaptchapb 
 . 
 Event 
 { 
  
 Token 
 : 
  
 token 
 , 
  
 SiteKey 
 : 
  
 recaptchaKey 
 , 
  
 } 
  
 assessment 
  
 := 
  
 & 
 recaptchapb 
 . 
 Assessment 
 { 
  
 Event 
 : 
  
 event 
 , 
  
 } 
  
 // Build the assessment request. 
  
 request 
  
 := 
  
 & 
 recaptchapb 
 . 
 CreateAssessmentRequest 
 { 
  
 Assessment 
 : 
  
 assessment 
 , 
  
 Parent 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s" 
 , 
  
 projectID 
 ), 
  
 } 
  
 response 
 , 
  
 err 
  
 := 
  
 client 
 . 
 CreateAssessment 
 ( 
  
 ctx 
 , 
  
 request 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 fmt 
 . 
 Printf 
 ( 
 "%v" 
 , 
  
 err 
 . 
 Error 
 ()) 
  
 } 
  
 // Check if the token is valid. 
  
 if 
  
 response 
 . 
 TokenProperties 
 . 
 Valid 
  
 == 
  
 false 
  
 { 
  
 fmt 
 . 
 Printf 
 ( 
 "The CreateAssessment() call failed because the token" 
 + 
  
 " was invalid for the following reasons: %v" 
 , 
  
 response 
 . 
 TokenProperties 
 . 
 InvalidReason 
 ) 
  
 return 
  
 } 
  
 // Check if the expected action was executed. 
  
 if 
  
 response 
 . 
 TokenProperties 
 . 
 Action 
  
 == 
  
 recaptchaAction 
  
 { 
  
 // Get the risk score and the reason(s). 
  
 // For more information on interpreting the assessment, 
  
 // see: https://cloud.google.com/recaptcha/docs/interpret-assessment 
  
 fmt 
 . 
 Printf 
 ( 
 "The reCAPTCHA score for this token is:  %v" 
 , 
  
 response 
 . 
 RiskAnalysis 
 . 
 Score 
 ) 
  
 for 
  
 _ 
 , 
 reason 
  
 := 
  
 range 
  
 response 
 . 
 RiskAnalysis 
 . 
 Reasons 
  
 { 
  
 fmt 
 . 
 Printf 
 ( 
 reason 
 . 
 String 
 () 
 + 
 "\n" 
 ) 
  
 } 
  
 return 
  
 } 
  
 fmt 
 . 
 Printf 
 ( 
 "The action attribute in your reCAPTCHA tag does " 
  
 + 
  
 "not match the action you are expecting to score" 
 ) 
  
 } 

  
 const 
  
 { 
 RecaptchaEnterpriseServiceClient 
 } 
  
 = 
  
 require 
 ( 
 '@google-cloud/recaptcha-enterprise' 
 ); 
  
 /** 
 * Create an assessment to analyze the risk of a UI action. Note that 
 * this example does set error boundaries and returns `null` for 
 * exceptions. 
 * 
 * projectID: Google Cloud project ID 
 * recaptchaKey: reCAPTCHA key obtained by registering a domain or an app to use the services of reCAPTCHA Enterprise. 
 * token: The token obtained from the client on passing the recaptchaKey. 
 * recaptchaAction: Action name corresponding to the token. 
 * userIpAddress: The IP address of the user sending a request to your backend is available in the HTTP request. 
 * userAgent: The user agent is included in the HTTP request in the request header. 
 * ja4: JA4 fingerprint associated with the request. 
 * ja3: JA3 fingerprint associated with the request. 
 */ 
  
 async 
  
 function 
  
 createAssessment 
 ({ 
  
 projectID 
  
 = 
  
 "your-project-id" 
 , 
  
 recaptchaKey 
  
 = 
  
 "your-recaptcha-key" 
 , 
  
 token 
  
 = 
  
 "action-token" 
 , 
  
 recaptchaAction 
  
 = 
  
 "action-name" 
 , 
  
 userIpAddress 
  
 = 
  
 "user-ip-address" 
 , 
  
 userAgent 
  
 = 
  
 "user-agent" 
 , 
  
 ja4 
  
 = 
  
 "ja4" 
  
 ja3 
  
 = 
  
 "ja3" 
  
 }) 
  
 { 
  
 // Create the reCAPTCHA client & set the project path. There are multiple 
  
 // ways to authenticate your client. For more information see: 
  
 // https://cloud.google.com/docs/authentication 
  
 // TODO: To avoid memory issues, move this client generation outside 
  
 // of this example, and cache it (recommended) or call client.close() 
  
 // before exiting this method. 
  
 const 
  
 client 
  
 = 
  
 new 
  
 RecaptchaEnterpriseServiceClient 
 (); 
  
 const 
  
 projectPath 
  
 = 
  
 client 
 . 
 projectPath 
 ( 
 projectID 
 ); 
  
 // Build the assessment request. 
  
 const 
  
 request 
  
 = 
  
 ({ 
  
 assessment 
 : 
  
 { 
  
 event 
 : 
  
 { 
  
 token 
 : 
  
 token 
 , 
  
 siteKey 
 : 
  
 recaptchaKey 
 , 
  
 userIpAddress 
 : 
  
 userIpAddress 
 , 
  
 userAgent 
 : 
  
 userAgent 
 , 
  
 ja4 
 : 
  
 ja4 
 , 
  
 ja3 
 : 
  
 ja3 
 , 
  
 }, 
  
 }, 
  
 parent 
 : 
  
 projectPath 
 , 
  
 }); 
  
 // client.createAssessment() can return a Promise or take a Callback 
  
 const 
  
 [ 
  
 response 
  
 ] 
  
 = 
  
 await 
  
 client 
 . 
 createAssessment 
 ( 
 request 
 ); 
  
 // Check if the token is valid. 
  
 if 
  
 ( 
 ! 
 response 
 . 
 tokenProperties 
 . 
 valid 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 "The CreateAssessment call failed because the token was: " 
  
 + 
  
 response 
 . 
 tokenProperties 
 . 
 invalidReason 
 ); 
  
 return 
  
 null 
 ; 
  
 } 
  
 // Check if the expected action was executed. 
  
 // The `action` property is set by user client in the 
  
 // grecaptcha.enterprise.execute() method. 
  
 if 
  
 ( 
 response 
 . 
 tokenProperties 
 . 
 action 
  
 === 
  
 recaptchaAction 
 ) 
  
 { 
  
 // Get the risk score and the reason(s). 
  
 // For more information on interpreting the assessment, 
  
 // see: https://cloud.google.com/recaptcha/docs/interpret-assessment 
  
 console 
 . 
 log 
 ( 
 "The reCAPTCHA score is: " 
  
 + 
  
 response 
 . 
 riskAnalysis 
 . 
 score 
 ); 
  
 response 
 . 
 riskAnalysis 
 . 
 reasons 
 . 
 forEach 
 (( 
 reason 
 ) 
  
 => 
  
 { 
  
 console 
 . 
 log 
 ( 
 reason 
 ); 
  
 }); 
  
 return 
  
 response 
 . 
 riskAnalysis 
 . 
 score 
 ; 
  
 } 
  
 else 
  
 { 
  
 console 
 . 
 log 
 ( 
 "The action attribute in your reCAPTCHA tag " 
  
 + 
  
 "does not match the action you are expecting to score" 
 ); 
  
 return 
  
 null 
 ; 
  
 } 
  
 } 

 <?php 
 // Include Google Cloud dependencies using Composer 
 // composer require google/cloud-recaptcha-enterprise 
 require 'vendor/autoload.php'; 
 use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient; 
 use Google\Cloud\RecaptchaEnterprise\V1\Event; 
 use Google\Cloud\RecaptchaEnterprise\V1\Assessment; 
 use Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest; 
 use Google\Cloud\RecaptchaEnterprise\V1\TokenProperties\InvalidReason; 
 /** 
 * Create an assessment to analyze the risk of a UI action. 
 * @param string $siteKey The key ID for the reCAPTCHA key (See https://cloud.google.com/recaptcha/docs/create-key) 
 * @param string $token The user's response token for which you want to receive a reCAPTCHA score. (See https://cloud.google.com/recaptcha/docs/create-assessment#retrieve_token) 
 * @param string $project Your Google Cloud project ID 
 */ 
 function create_assessment( 
 string $siteKey, 
 string $token, 
 string $project 
 ): void { 
 // TODO: To avoid memory issues, move this client generation outside 
 // of this example, and cache it (recommended) or call client.close() 
 // before exiting this method. 
 $client = new RecaptchaEnterpriseServiceClient(); 
 $projectName = $client->projectName($project); 
 $event = (new Event()) 
 ->setSiteKey($siteKey) 
 ->setToken($token); 
 $assessment = (new Assessment()) 
 ->setEvent($event); 
 $request = (new CreateAssessmentRequest()) 
 ->setParent($projectName) 
 ->setAssessment($assessment); 
 try { 
 $response = $client->createAssessment($request); 
 // You can use the score only if the assessment is valid, 
 // In case of failures like re-submitting the same token, getValid() will return false 
 if ($response->getTokenProperties()->getValid() == false) { 
 printf('The CreateAssessment() call failed because the token was invalid for the following reason: '); 
 printf(InvalidReason::name($response->getTokenProperties()->getInvalidReason())); 
 } else { 
 printf('The score for the protection action is:'); 
 printf($response->getRiskAnalysis()->getScore()); 
 // Optional: You can use the following methods to get more data about the token 
 // Action name provided at token generation. 
 // printf($response->getTokenProperties()->getAction() . PHP_EOL); 
 // The timestamp corresponding to the generation of the token. 
 // printf($response->getTokenProperties()->getCreateTime()->getSeconds() . PHP_EOL); 
 // The hostname of the page on which the token was generated. 
 // printf($response->getTokenProperties()->getHostname() . PHP_EOL); 
 } 
 } catch (exception $e) { 
 printf('CreateAssessment() call failed with the following error: '); 
 printf($e); 
 } 
 } 
 // TODO(Developer): Replace the following before running the sample 
 create_assessment( 
 'YOUR_RECAPTCHA_KEY', 
 'YOUR_USER_RESPONSE_TOKEN', 
 'YOUR_GOOGLE_CLOUD_PROJECT_ID' 
 ); 
 ?>