migrate code from googleapis/java-recaptchaenterprise

recaptcha_enterprise/pom.xml

@@ -0,0 +1,61 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.google.cloud</groupId>
+  <artifactId>recaptcha-enterprise-snippets</artifactId>
+  <packaging>jar</packaging>
+  <name>Google reCAPTCHA Enterprise Snippets</name>
+  <url>https://github.com/googleapis/java-recaptchaenterprise</url>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.2.0</version>
+  </parent>
+
+  <properties>
+    <maven.compiler.target>1.8</maven.compiler.target>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+
+  <!-- [START recaptcha_enterprise_install_with_bom] -->
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.google.cloud</groupId>
+        <artifactId>libraries-bom</artifactId>
+        <version>26.1.4</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-recaptchaenterprise</artifactId>
+    </dependency>
+    <!-- [START_EXCLUDE] -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.1.3</version>
+      <scope>test</scope>
+    </dependency>
+    <!-- [END_EXCLUDE] -->
+  </dependencies>
+  <!-- [END recaptcha_enterprise_install_with_bom] -->
+</project>

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

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package app;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Main {
+
+  public static void main(String[] args) {
+    SpringApplication.run(Main.class, args);
+  }
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+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.servlet.ModelAndView;
+
+@Controller
+@RequestMapping
+public class MainController {
+
+  @GetMapping(value = "/")
+  public static ModelAndView landingPage(
+      @RequestParam("recaptchaSiteKey") String recaptchaSiteKey) {
+    ModelMap map = new ModelAndView().getModelMap();
+    map.put("siteKey", recaptchaSiteKey);
+    return new ModelAndView("index", map);
+  }
+}

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

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package recaptcha;
+
+// [START recaptcha_enterprise_annotate_assessment]
+
+import com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceClient;
+import com.google.recaptchaenterprise.v1.AnnotateAssessmentRequest;
+import com.google.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation;
+import com.google.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason;
+import com.google.recaptchaenterprise.v1.AnnotateAssessmentResponse;
+import com.google.recaptchaenterprise.v1.AssessmentName;
+import java.io.IOException;
+
+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 assessmentId = "assessment-id";
+    annotateAssessment(projectID, assessmentId);
+  }
+
+  /**
+   * Pre-requisite: Create an assessment before annotating.
+   *
+   * <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.
+   */
+  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
+    // clean up any remaining background resources.
+    try (RecaptchaEnterpriseServiceClient client = RecaptchaEnterpriseServiceClient.create()) {
+      // Build the annotation request.
+      // For more info on when/how to annotate, see:
+      // https://cloud.google.com/recaptcha-enterprise/docs/annotate-assessment#when_to_annotate
+      AnnotateAssessmentRequest annotateAssessmentRequest =
+          AnnotateAssessmentRequest.newBuilder()
+              .setName(AssessmentName.of(projectID, assessmentId).toString())
+              .setAnnotation(Annotation.FRAUDULENT)
+              .addReasons(Reason.FAILED_TWO_FACTOR)
+              .build();
+
+      // Empty response is sent back.
+      AnnotateAssessmentResponse response = client.annotateAssessment(annotateAssessmentRequest);
+      System.out.println("Annotated response sent successfully ! " + response);
+    }
+  }
+}
+// [END recaptcha_enterprise_annotate_assessment]

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

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package recaptcha;
+
+// [START recaptcha_enterprise_create_assessment]
+
+import com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceClient;
+import com.google.recaptchaenterprise.v1.Assessment;
+import com.google.recaptchaenterprise.v1.CreateAssessmentRequest;
+import com.google.recaptchaenterprise.v1.Event;
+import com.google.recaptchaenterprise.v1.ProjectName;
+import com.google.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason;
+import java.io.IOException;
+
+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 recaptchaSiteKey = "recaptcha-site-key";
+    String token = "action-token";
+    String recaptchaAction = "action-name";
+
+    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 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)
+      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 properties of the event to be tracked.
+      Event event = Event.newBuilder().setSiteKey(recaptchaSiteKey).setToken(token).build();
+
+      // Build the assessment request.
+      CreateAssessmentRequest createAssessmentRequest =
+          CreateAssessmentRequest.newBuilder()
+              .setParent(ProjectName.of(projectID).toString())
+              .setAssessment(Assessment.newBuilder().setEvent(event).build())
+              .build();
+
+      Assessment response = client.createAssessment(createAssessmentRequest);
+
+      // Check if the token is valid.
+      if (!response.getTokenProperties().getValid()) {
+        System.out.println(
+            "The CreateAssessment call failed because the token was: "
+                + response.getTokenProperties().getInvalidReason().name());
+        return;
+      }
+
+      // Check if the expected action was executed.
+      // (If the key is checkbox type and 'action' attribute wasn't set, skip this check.)
+      if (!response.getTokenProperties().getAction().equals(recaptchaAction)) {
+        System.out.println(
+            "The action attribute in reCAPTCHA tag is: "
+                + response.getTokenProperties().getAction());
+        System.out.println(
+            "The action attribute in the reCAPTCHA tag "
+                + "does not match the action ("
+                + recaptchaAction
+                + ") you are expecting to score");
+        return;
+      }
+
+      // Get the reason(s) and the risk score.
+      // For more information on interpreting the assessment,
+      // see: https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment
+      for (ClassificationReason reason : response.getRiskAnalysis().getReasonsList()) {
+        System.out.println(reason);
+      }
+
+      float recaptchaScore = response.getRiskAnalysis().getScore();
+      System.out.println("The reCAPTCHA score is: " + recaptchaScore);
+
+      // Get the assessment name (id). Use this to annotate the assessment.
+      String assessmentName = response.getName();
+      System.out.println(
+          "Assessment name: " + assessmentName.substring(assessmentName.lastIndexOf("/") + 1));
+    }
+  }
+}
+// [END recaptcha_enterprise_create_assessment]

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

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package recaptcha;
+
+// [START recaptcha_enterprise_create_site_key]
+
+import com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceClient;
+import com.google.recaptchaenterprise.v1.CreateKeyRequest;
+import com.google.recaptchaenterprise.v1.Key;
+import com.google.recaptchaenterprise.v1.ProjectName;
+import com.google.recaptchaenterprise.v1.WebKeySettings;
+import com.google.recaptchaenterprise.v1.WebKeySettings.IntegrationType;
+import java.io.IOException;
+
+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 domainName = "domain-name";
+
+    createSiteKey(projectID, domainName);
+  }
+
+  /**
+   * Create reCAPTCHA Site key which binds a domain name to a unique key.
+   *
+   * @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 {
+    // 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 type of reCAPTCHA to be displayed.
+      // For different types, see: https://cloud.google.com/recaptcha-enterprise/docs/keys
+      Key scoreKey =
+          Key.newBuilder()
+              .setDisplayName("any_descriptive_name_for_the_key")
+              .setWebSettings(
+                  WebKeySettings.newBuilder()
+                      .addAllowedDomains(domainName)
+                      .setAllowAmpTraffic(false)
+                      .setIntegrationType(IntegrationType.SCORE)
+                      .build())
+              .build();
+
+      CreateKeyRequest createKeyRequest =
+          CreateKeyRequest.newBuilder()
+              .setParent(ProjectName.of(projectID).toString())
+              .setKey(scoreKey)
+              .build();
+
+      // Get the name of the created reCAPTCHA site key.
+      Key response = client.createKey(createKeyRequest);
+      String keyName = response.getName();
+      String recaptchaSiteKey = keyName.substring(keyName.lastIndexOf("/") + 1);
+      System.out.println("reCAPTCHA Site key created successfully. Site Key: " + recaptchaSiteKey);
+      return recaptchaSiteKey;
+    }
+  }
+}
+// [END recaptcha_enterprise_create_site_key]