feat(recaptcha): add mfa sample

recaptcha_enterprise/snippets/src/pom.xml → recaptcha_enterprise/snippets/pom.xml

@@ -18,8 +18,8 @@
   </parent>
 
   <properties>
-    <maven.compiler.target>11</maven.compiler.target>
-    <maven.compiler.source>11</maven.compiler.source>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <spring.boot.version>2.7.16</spring.boot.version>
   </properties>
@@ -50,6 +50,14 @@
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-maven-plugin</artifactId>
         <version>3.1.1</version>
+        <configuration>
+          <mainClass>app.Main</mainClass>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-failsafe-plugin</artifactId>
+        <version>3.1.2</version>
       </plugin>
     </plugins>
   </build>
@@ -61,6 +69,12 @@
       <artifactId>google-cloud-recaptchaenterprise</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>recaptcha-password-check-helpers</artifactId>
+      <version>1.0.1</version>
+    </dependency>
+
     <!-- [Start_Selenium_dependencies] -->
     <dependency>
       <groupId>org.seleniumhq.selenium</groupId>
@@ -80,6 +94,16 @@
       <artifactId>webdrivermanager</artifactId>
       <version>5.5.3</version>
     </dependency>
+    <dependency>
+      <groupId>org.apache.httpcomponents.client5</groupId>
+      <artifactId>httpclient5</artifactId>
+      <version>5.2.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.seleniumhq.selenium</groupId>
+      <artifactId>selenium-http-jdk-client</artifactId>
+      <version>4.8.1</version>
+    </dependency>
     <!-- [End_Selenium_dependencies] -->
 
 
@@ -119,6 +143,20 @@
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-thymeleaf</artifactId>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot</artifactId>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-actuator</artifactId>
+    </dependency>
     <!-- [End_Spring_dependencies] -->
 
   </dependencies>

recaptcha_enterprise/snippets/src/main/java/app/MainController.java

@@ -16,14 +16,14 @@
 
 package app;
 
-import org.springframework.stereotype.Controller;
 import org.springframework.ui.ModelMap;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.servlet.ModelAndView;
 
-@Controller
+@RestController
 @RequestMapping
 public class MainController {
 

recaptcha_enterprise/snippets/src/main/java/recaptcha/AnnotateAssessment.java

@@ -30,20 +30,19 @@ public class AnnotateAssessment {
 
   public static void main(String[] args) throws IOException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "project-id";
+    String projectId = "project-id";
     String assessmentId = "assessment-id";
-    annotateAssessment(projectID, assessmentId);
+    annotateAssessment(projectId, assessmentId);
   }
 
   /**
    * Pre-requisite: Create an assessment before annotating.
+   * Annotate an assessment to provide feedback on the correctness of recaptcha prediction.
    *
-   * <p>Annotate an assessment to provide feedback on the correctness of recaptcha prediction.
-   *
-   * @param projectID: GCloud Project id
-   * @param assessmentId: Value of the 'name' field returned from the CreateAssessment call.
+   * @param projectId : GCloud Project id
+   * @param assessmentId : Value of the 'name' field returned from the CreateAssessment call.
    */
-  public static void annotateAssessment(String projectID, String assessmentId) throws IOException {
+  public static void annotateAssessment(String projectId, String assessmentId) throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
     // the `client.close()` method on the client to safely
@@ -54,7 +53,7 @@ public static void annotateAssessment(String projectID, String assessmentId) thr
       // https://cloud.google.com/recaptcha-enterprise/docs/annotate-assessment#when_to_annotate
       AnnotateAssessmentRequest annotateAssessmentRequest =
           AnnotateAssessmentRequest.newBuilder()
-              .setName(AssessmentName.of(projectID, assessmentId).toString())
+              .setName(AssessmentName.of(projectId, assessmentId).toString())
               .setAnnotation(Annotation.FRAUDULENT)
               .addReasons(Reason.FAILED_TWO_FACTOR)
               .build();

recaptcha_enterprise/snippets/src/main/java/recaptcha/CreateAssessment.java

@@ -30,26 +30,26 @@ public class CreateAssessment {
 
   public static void main(String[] args) throws IOException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "project-id";
+    String projectId = "project-id";
     String recaptchaSiteKey = "recaptcha-site-key";
     String token = "action-token";
     String recaptchaAction = "action-name";
 
-    createAssessment(projectID, recaptchaSiteKey, token, recaptchaAction);
+    createAssessment(projectId, recaptchaSiteKey, token, recaptchaAction);
   }
 
   /**
    * Create an assessment to analyze the risk of an UI action. Assessment approach is the same for
    * both 'score' and 'checkbox' type recaptcha site keys.
    *
-   * @param projectID : GCloud Project ID
+   * @param projectId : GCloud Project ID
    * @param recaptchaSiteKey : Site key obtained by registering a domain/app to use recaptcha
    *     services. (score/ checkbox type)
    * @param token : The token obtained from the client on passing the recaptchaSiteKey.
    * @param recaptchaAction : Action name corresponding to the token.
    */
   public static void createAssessment(
-      String projectID, String recaptchaSiteKey, String token, String recaptchaAction)
+      String projectId, String recaptchaSiteKey, String token, String recaptchaAction)
       throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
@@ -63,7 +63,7 @@ public static void createAssessment(
       // Build the assessment request.
       CreateAssessmentRequest createAssessmentRequest =
           CreateAssessmentRequest.newBuilder()
-              .setParent(ProjectName.of(projectID).toString())
+              .setParent(ProjectName.of(projectId).toString())
               .setAssessment(Assessment.newBuilder().setEvent(event).build())
               .build();
 

recaptcha_enterprise/snippets/src/main/java/recaptcha/CreateSiteKey.java

@@ -30,19 +30,19 @@ public class CreateSiteKey {
 
   public static void main(String[] args) throws IOException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "your-project-id";
+    String projectId = "your-project-id";
     String domainName = "domain-name";
 
-    createSiteKey(projectID, domainName);
+    createSiteKey(projectId, domainName);
   }
 
   /**
    * Create reCAPTCHA Site key which binds a domain name to a unique key.
    *
-   * @param projectID : GCloud Project ID.
+   * @param projectId : GCloud Project ID.
    * @param domainName : Specify the domain name in which the reCAPTCHA should be activated.
    */
-  public static String createSiteKey(String projectID, String domainName) throws IOException {
+  public static String createSiteKey(String projectId, String domainName) throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
     // the `client.close()` method on the client to safely
@@ -64,7 +64,7 @@ public static String createSiteKey(String projectID, String domainName) throws I
 
       CreateKeyRequest createKeyRequest =
           CreateKeyRequest.newBuilder()
-              .setParent(ProjectName.of(projectID).toString())
+              .setParent(ProjectName.of(projectId).toString())
               .setKey(scoreKey)
               .build();
 

recaptcha_enterprise/snippets/src/main/java/recaptcha/DeleteSiteKey.java

@@ -31,19 +31,19 @@ public class DeleteSiteKey {
   public static void main(String[] args)
       throws IOException, ExecutionException, InterruptedException, TimeoutException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "your-project-id";
+    String projectId = "your-project-id";
     String recaptchaSiteKey = "recaptcha-site-key";
 
-    deleteSiteKey(projectID, recaptchaSiteKey);
+    deleteSiteKey(projectId, recaptchaSiteKey);
   }
 
   /**
    * Delete the given reCAPTCHA site key present under the project ID.
    *
-   * @param projectID: GCloud Project ID.
-   * @param recaptchaSiteKey: Specify the site key to be deleted.
+   * @param projectId : GCloud Project ID.
+   * @param recaptchaSiteKey : Specify the site key to be deleted.
    */
-  public static void deleteSiteKey(String projectID, String recaptchaSiteKey)
+  public static void deleteSiteKey(String projectId, String recaptchaSiteKey)
       throws IOException, ExecutionException, InterruptedException, TimeoutException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
@@ -54,7 +54,7 @@ public static void deleteSiteKey(String projectID, String recaptchaSiteKey)
       // Set the project ID and reCAPTCHA site key.
       DeleteKeyRequest deleteKeyRequest =
           DeleteKeyRequest.newBuilder()
-              .setName(KeyName.of(projectID, recaptchaSiteKey).toString())
+              .setName(KeyName.of(projectId, recaptchaSiteKey).toString())
               .build();
 
       client.deleteKeyCallable().futureCall(deleteKeyRequest).get(5, TimeUnit.SECONDS);

recaptcha_enterprise/snippets/src/main/java/recaptcha/GetMetrics.java

@@ -38,8 +38,8 @@ public static void main(String[] args) throws IOException {
    * Get metrics specific to a recaptcha site key. E.g: score bucket count for a key or number of
    * times the checkbox key failed/ passed etc.,
    *
-   * @param projectId: Google Cloud Project Id.
-   * @param recaptchaSiteKey: Specify the site key to get metrics.
+   * @param projectId : Google Cloud Project id.
+   * @param recaptchaSiteKey : Specify the site key to get metrics.
    */
   public static void getMetrics(String projectId, String recaptchaSiteKey) throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created

recaptcha_enterprise/snippets/src/main/java/recaptcha/GetSiteKey.java

@@ -33,19 +33,19 @@ public class GetSiteKey {
   public static void main(String[] args)
       throws IOException, InterruptedException, ExecutionException, TimeoutException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "your-project-id";
+    String projectId = "your-project-id";
     String recaptchaSiteKey = "recaptcha-site-key";
 
-    getSiteKey(projectID, recaptchaSiteKey);
+    getSiteKey(projectId, recaptchaSiteKey);
   }
 
   /**
    * Get the reCAPTCHA site key present under the project ID.
-   *
-   * @param projectID: GCloud Project ID.
-   * @param recaptchaSiteKey: Specify the site key to get the details.
+   * 
+   * @param projectId : GCloud Project ID.
+   * @param recaptchaSiteKey : Specify the site key to get the details.
    */
-  public static void getSiteKey(String projectID, String recaptchaSiteKey)
+  public static void getSiteKey(String projectId, String recaptchaSiteKey)
       throws IOException, InterruptedException, ExecutionException, TimeoutException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
@@ -56,7 +56,7 @@ public static void getSiteKey(String projectID, String recaptchaSiteKey)
       // Construct the "GetSiteKey" request.
       GetKeyRequest getKeyRequest =
           GetKeyRequest.newBuilder()
-              .setName(KeyName.of(projectID, recaptchaSiteKey).toString())
+              .setName(KeyName.of(projectId, recaptchaSiteKey).toString())
               .build();
 
       // Wait for the operation to complete.

recaptcha_enterprise/snippets/src/main/java/recaptcha/ListSiteKeys.java

@@ -29,25 +29,25 @@ public class ListSiteKeys {
 
   public static void main(String[] args) throws IOException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "your-project-id";
+    String projectId = "your-project-id";
 
-    listSiteKeys(projectID);
+    listSiteKeys(projectId);
   }
 
   /**
    * List all keys present under the given project ID.
    *
-   * @param projectID : GCloud Project ID.
+   * @param projectId : GCloud Project ID.
    */
-  public static ListKeysPagedResponse listSiteKeys(String projectID) throws IOException {
+  public static ListKeysPagedResponse listSiteKeys(String projectId) throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
     // the `client.close()` method on the client to safely
     // clean up any remaining background resources.
     try (RecaptchaEnterpriseServiceClient client = RecaptchaEnterpriseServiceClient.create()) {
       // Set the project ID to list the keys present in it.
       ListKeysRequest listKeysRequest =
-          ListKeysRequest.newBuilder().setParent(ProjectName.of(projectID).toString()).build();
+          ListKeysRequest.newBuilder().setParent(ProjectName.of(projectId).toString()).build();
 
       ListKeysPagedResponse response = client.listKeys(listKeysRequest);
       System.out.println("Listing reCAPTCHA site keys: ");

recaptcha_enterprise/snippets/src/main/java/recaptcha/MigrateKey.java

@@ -39,8 +39,8 @@ public static void main(String[] args) throws IOException {
    * to reCAPTCHA Enterprise. For more info, see:
    * https://cloud.google.com/recaptcha-enterprise/docs/migrate-recaptcha
    *
-   * @param projectId: Google Cloud Project Id.
-   * @param recaptchaSiteKey: Specify the site key to migrate.
+   * @param projectId : Google Cloud Project Id.
+   * @param recaptchaSiteKey : Specify the site key to migrate.
    */
   public static void migrateKey(String projectId, String recaptchaSiteKey) throws IOException {
     // Initialize client that will be used to send requests. This client only needs to be created

recaptcha_enterprise/snippets/src/main/java/recaptcha/UpdateSiteKey.java

@@ -33,21 +33,21 @@ public class UpdateSiteKey {
   public static void main(String[] args)
       throws IOException, InterruptedException, ExecutionException, TimeoutException {
     // TODO(developer): Replace these variables before running the sample.
-    String projectID = "your-project-id";
-    String recaptchaSiteKeyID = "recaptcha-site-key-id";
+    String projectId = "your-project-id";
+    String recaptchaSiteKeyId = "recaptcha-site-key-id";
     String domainName = "domain-name";
 
-    updateSiteKey(projectID, recaptchaSiteKeyID, domainName);
+    updateSiteKey(projectId, recaptchaSiteKeyId, domainName);
   }
 
   /**
    * Update the properties of the given site key present under the project id.
    *
-   * @param projectID: GCloud Project ID.
-   * @param recaptchaSiteKeyID: Specify the site key.
-   * @param domainName: Specify the domain name for which the settings should be updated.
+   * @param projectId : GCloud Project ID.
+   * @param recaptchaSiteKeyId : Specify the site key.
+   * @param domainName : Specify the domain name for which the settings should be updated.
    */
-  public static void updateSiteKey(String projectID, String recaptchaSiteKeyID, String domainName)
+  public static void updateSiteKey(String projectId, String recaptchaSiteKeyId, String domainName)
       throws IOException, InterruptedException, ExecutionException, TimeoutException {
     // Initialize client that will be used to send requests. This client only needs to be created
     // once, and can be reused for multiple requests. After completing all of your requests, call
@@ -61,7 +61,7 @@ public static void updateSiteKey(String projectID, String recaptchaSiteKeyID, St
               .setKey(
                   Key.newBuilder()
                       .setDisplayName("any descriptive name for the key")
-                      .setName(KeyName.of(projectID, recaptchaSiteKeyID).toString())
+                      .setName(KeyName.of(projectId, recaptchaSiteKeyId).toString())
                       .setWebSettings(
                           WebKeySettings.newBuilder()
                               .setAllowAmpTraffic(true)
@@ -75,7 +75,7 @@ public static void updateSiteKey(String projectID, String recaptchaSiteKeyID, St
       // Check if the key has been updated.
       GetKeyRequest getKeyRequest =
           GetKeyRequest.newBuilder()
-              .setName(KeyName.of(projectID, recaptchaSiteKeyID).toString())
+              .setName(KeyName.of(projectId, recaptchaSiteKeyId).toString())
               .build();
       Key response = client.getKey(getKeyRequest);
 

recaptcha_enterprise/snippets/src/main/java/recaptcha/account_defender/AccountDefenderAssessment.java → recaptcha_enterprise/snippets/src/main/java/recaptcha/accountdefender/AccountDefenderAssessment.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package account_defender;
+package recaptcha.accountdefender;
 
 // [START recaptcha_enterprise_account_defender_assessment]
 
@@ -60,12 +60,12 @@ public static void main(String[] args)
     String userIdentifier = "default" + UUID.randomUUID().toString().split("-")[0];
 
     // Change this to a secret not shared with Google.
-    final String HMAC_KEY = "SOME_INTERNAL_UNSHARED_KEY";
+    final String hmacKey = "SOME_INTERNAL_UNSHARED_KEY";
 
     // Get instance of Mac object implementing HmacSHA256, and initialize it with the above
     // secret key.
     Mac mac = Mac.getInstance("HmacSHA256");
-    mac.init(new SecretKeySpec(HMAC_KEY.getBytes(StandardCharsets.UTF_8),
+    mac.init(new SecretKeySpec(hmacKey.getBytes(StandardCharsets.UTF_8),
         "HmacSHA256"));
     byte[] hashBytes = mac.doFinal(userIdentifier.getBytes(StandardCharsets.UTF_8));
     ByteString hashedAccountId = ByteString.copyFrom(hashBytes);