שילוב עם Google Cloud Armor לאפליקציות לנייד

אתם יכולים לשלב את התכונות של Google Cloud Fraud Defense עם Cloud Armor באפליקציות לנייד.

כדי להשלים את השילוב, צריך להטמיע תכונה אחת או יותר של reCAPTCHA ולהגדיר את מדיניות האבטחה של Cloud Armor. עם זאת, באפליקציות לנייד אפשר להטמיע רק אסימוני פעולה של reCAPTCHA לשילוב עם Cloud Armor.

לפני שמתחילים

  1. מפעילים את reCAPTCHA Enterprise API.

    התפקידים שנדרשים כדי להפעיל ממשקי API

    כדי להפעיל ממשקי API, צריך את ההרשאה serviceusage.services.enable. אם אתם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד "בעלים" (roles/owner). אחרת, אתם יכולים לקבל את ההרשאה הזו דרך התפקיד "אדמין בממשק 'שימוש בשירות'" (roles/serviceusage.serviceUsageAdmin). איך מקצים תפקידים

    להפעלת ה-API

  2. מזהים את הפעולות שרוצים להגן עליהן.

הטמעת אסימוני פעולה של reCAPTCHA

כדי ליצור אסימוני פעולה, צריך להפעיל את reCAPTCHA באפליקציה לנייד. אחרי ש-reCAPTCHA יוצר טוקן פעולה, אתם מצרפים את טוקן הפעולה לכותרת בקשה מוגדרת מראש בכל מקום שבו אתם צריכים להגן על פעולת משתמש, כמו checkout. כברירת מחדל, אסימוני הפעולה תקפים למשך 30 דקות, אבל זה יכול להשתנות בהתאם לתנועה. כדי ש-Cloud Armor יוכל להעריך את מאפייני הטוקן, צריך לצרף את ה-action-token לכותרת בקשה מוגדרת מראש לפני שתוקף הטוקן יפוג.

כדי להטמיע טוקן פעולה של reCAPTCHA:

  1. יוצרים מפתח של אסימון פעולה לאפליקציה לנייד.

    המסוף

    1. נכנסים לדף Google Cloud Fraud Defense במסוף Google Cloud .

      כניסה ל-Google Cloud Fraud Defense

    2. מוודאים ששם הפרויקט מופיע בבורר המשאבים שבראש הדף.

      אם שם הפרויקט לא מופיע, לוחצים על בורר המשאבים ובוחרים את הפרויקט.

    3. לוחצים על הכרטיסייה Keys.
    4. לוחצים על Create key.
    5. בשדה Display name, מזינים שם לתצוגה של המפתח.
    6. בהתאם לסוג האפליקציה שרוצים ליצור בשבילה את מפתחות reCAPTCHA ל-WAF, מבצעים את הפעולה המתאימה:
    7. יצירת מפתחות reCAPTCHA ל-WAF לאפליקציות ל-iOS

      מומלץ ליצור מפתח reCAPTCHA אחד לכל אפליקציה ל-iOS.

      1. בקטע Application type, בוחרים באפשרות iOS.
        1. בקטע רשימת מזהי החבילות ל-iOS, לוחצים על הוספת מזהה חבילה ל-iOS.
        2. בשדה Bundle ID, מזינים את השם של מזהה החבילה ב-iOS.

        3. אופציונלי: כדי להוסיף עוד מזהה חבילה, לוחצים על הוספת מזהה חבילה ל-iOS ומזינים את השם של מזהה החבילה ל-iOS בשדה מזהה חבילה.
        4. כדי להגן על מפתח ה-reCAPTCHA של מזהי החבילות, צריך לוודא שהמתג Disable bundle ID verification מושבת. אם משביתים את אימות מזהה החבילה, צריך לאמת את השדה tokenProperties.iosBundleId בבדיקות שיוצרים.
        5. אופציונלי: מספקים את הגדרות המפתח של אפל.

          מומלץ לספק את הנתונים האלה כי הם מאפשרים ל-Fraud Defense לספק חישוב של ציון סיכונים מדויק יותר לתנועה שלכם.

          מזינים את פריטי המידע האלה:

          • מפתח פרטי (‎.p8): המפתח הזה נוצר ב-Apple Developer Center בקטע Certificates, Identifiers & Profiles (אישורים, מזהים ופרופילים).
          • מזהה מפתח: מזהה המפתח של מפתח Apple (מחרוזת של 10 תווים).
          • מזהה צוות: מזהה הצוות של אפל (מחרוזת של 10 תווים) שבבעלותו פרופיל ההקצאה שמשמש ליצירת האפליקציה.
        6. אופציונלי: לוחצים על השלב הבא (אופציונלי).
          1. כדי ליצור מפתח reCAPTCHA ל-WAF:
            1. בהגדרות נוספות, מפעילים את
            2. בקטע Additional settings, מפעילים את המתג Will you deploy this key in a Web Application Firewall (WAF)?‎.
            3. באפשרויות של Service, בוחרים באפשרות Cloud Armor.
            4. באפשרויות של תכונה, בוחרים באפשרות פעולה.
          2. בסביבה שאינה סביבת ייצור, אם רוצים לציין את הניקוד שהמפתח אמור להחזיר כשיוצרים לו הערכות, מבצעים את הפעולות הבאות:

            1. בקטע Additional settings, לוחצים על המתג Are you creating this key for testing purposes only?.
            2. משתמשים בפס ההזזה הגדרת ניקוד כדי לציין ניקוד בין 0 ל-1.0.
        7. לוחצים על Create key.
        8. המפתח החדש שנוצר מופיע בדף reCAPTCHA keys.

      יצירת מפתחות reCAPTCHA ל-WAF לאפליקציות ל-Android

      1. בקטע Application type, בוחרים באפשרות Android.
      2. בקטע Android package list, לוחצים על Add Android package.
      3. בשדה Android package, מזינים את שם החבילה של Android.
      4. אופציונלי: כדי להוסיף עוד חבילה, לוחצים על Add Android package ומזינים את השם של חבילת Android נוספת בשדה Android package.
      5. כדי לאכוף את השימוש במפתח reCAPTCHA רק באפליקציה, משביתים את המתג Disable package name verification. אם משביתים את אימות שם החבילה, צריך לאמת את השדה tokenProperties.androidPackageName בבדיקות שיוצרים.
      6. אם רוצים ליצור מפתח לאפליקציה שזמינה בחנויות אפליקציות אחרות בנוסף לחנות Google Play, מפעילים את האפשרות תמיכה באפליקציות שמופצות מחוץ לחנות Google Play.
      7. אופציונלי: לוחצים על השלב הבא (אופציונלי).
        1. כדי ליצור מפתח reCAPTCHA ל-WAF:
          1. בהגדרות נוספות, מפעילים את
          2. בקטע Additional settings, מפעילים את המתג Will you deploy this key in a Web Application Firewall (WAF)?‎.
          3. באפשרויות של Service, בוחרים באפשרות Cloud Armor.
          4. באפשרויות של תכונה, בוחרים באפשרות פעולה.
        2. בסביבה שאינה סביבת ייצור, אם רוצים לציין את הניקוד שהמפתח אמור להחזיר כשיוצרים לו הערכות, מבצעים את הפעולות הבאות:

          1. בקטע Additional settings, לוחצים על המתג Are you creating this key for testing purposes only?.
          2. משתמשים בפס ההזזה הגדרת ניקוד כדי לציין ניקוד בין 0 ל-1.0.
      8. לוחצים על Create key.
      9. המפתח החדש שנוצר מופיע בדף reCAPTCHA keys.

    gcloud (iOS)

    כדי ליצור מפתחות reCAPTCHA, משתמשים בפקודה gcloud recaptcha keys create.

    לפני השימוש בנתוני הפקודה הבאים, צריך להחליף את הנתונים הבאים:

    • ‫DISPLAY_NAME: שם המפתח. בדרך כלל שם האתר.
    • ‫BUNDLE_IDs: מזהי החבילות של אפליקציות ל-iOS שמורשות להשתמש במפתח. כדי לציין כמה מזהי חבילות, צריך להזין רשימה מופרדת בפסיקים.
    • ‫WAF_FEATURE: שם התכונה של WAF. מציינים את action-token.
    • ‫WAF_SERVICE: השם של ספק שירות ה-WAF. מציינים את CA ל-Cloud Armor.

    מריצים את הפקודה gcloud recaptcha keys create:

    ‫Linux,‏ macOS או Cloud Shell

    gcloud recaptcha keys create \
    --display-name=DISPLAY_NAME  \
    --ios --bundle-ids=BUNDLE_IDs \
    --waf-feature=WAF_FEATURE \
    --waf-service=WAF_SERVICE 

    ‏Windows (PowerShell)

    gcloud recaptcha keys create `
    --display-name=DISPLAY_NAME  `
    --ios --bundle-ids=BUNDLE_IDs `
    --waf-feature=WAF_FEATURE `
    --waf-service=WAF_SERVICE 

    Windows‏ (cmd.exe)

    gcloud recaptcha keys create ^
    --display-name=DISPLAY_NAME  ^
    --ios --bundle-ids=BUNDLE_IDs ^
    --waf-feature=WAF_FEATURE ^
    --waf-service=WAF_SERVICE 

    התשובה מכילה את מפתח reCAPTCHA החדש שנוצר.

    gcloud (Android)

    כדי ליצור מפתחות reCAPTCHA, משתמשים בפקודה gcloud recaptcha keys create.

    לפני השימוש בנתוני הפקודה הבאים, צריך להחליף את הנתונים הבאים:

    • ‫DISPLAY_NAME: שם המפתח. בדרך כלל שם האתר.
    • ‫PACKAGE_NAMES: שמות החבילות של אפליקציות ל-Android שמורשות להשתמש במפתח. כדי לציין כמה שמות של חבילות, צריך להזין רשימה מופרדת בפסיקים.
    • ‫WAF_FEATURE: שם התכונה של WAF. מציינים את action-token.
    • ‫WAF_SERVICE: השם של ספק שירות ה-WAF. מציינים את CA ל-Cloud Armor.

    מריצים את הפקודה gcloud recaptcha keys create:

    ‫Linux,‏ macOS או Cloud Shell

    gcloud recaptcha keys create \
    --display-name=DISPLAY_NAME  \
    --android --package-names=PACKAGE_NAMES \
    --waf-feature=WAF_FEATURE \
    --waf-service=WAF_SERVICE 

    ‏Windows (PowerShell)

    gcloud recaptcha keys create `
    --display-name=DISPLAY_NAME  `
    --android --package-names=PACKAGE_NAMES `
    --waf-feature=WAF_FEATURE `
    --waf-service=WAF_SERVICE 

    Windows‏ (cmd.exe)

    gcloud recaptcha keys create ^
    --display-name=DISPLAY_NAME  ^
    --android --package-names=PACKAGE_NAMES ^
    --waf-feature=WAF_FEATURE ^
    --waf-service=WAF_SERVICE 

    התשובה מכילה את מפתח reCAPTCHA החדש שנוצר.

    ‫REST (iOS)

    לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

    • ‫DISPLAY_NAME: שם המפתח. בדרך כלל שם האפליקציה.
    • ‫BUNDLE_IDs: מזהי החבילות של אפליקציות ל-iOS שמורשות להשתמש במפתח. כדי לציין כמה מזהי חבילות, צריך להזין רשימה מופרדת בפסיקים.
    • ‫WAF_FEATURE: שם התכונה של WAF. מציינים את action-token.
    • ‫WAF_SERVICE: השם של ספק שירות ה-WAF. מציינים את CA ל-Cloud Armor.

    ה-method של ה-HTTP וכתובת ה-URL:

    POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

    גוף בקשת JSON:

    {
      "displayName": "DISPLAY_NAME",
      "iosSettings": {
     "allowedBundleIds": "BUNDLE_IDS"
     },
       'wafSettings': "  {
           "wafService": "CA",
     "wafFeature": "ACTION_TOKEN"
      }
     }
    
    

    כדי לשלוח את הבקשה עליכם לבחור אחת מהאפשרויות הבאות:

    curl

    שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה:

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys"

    PowerShell

    שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה:

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

    אתם אמורים לקבל תגובת JSON שדומה לזו:

    
    {
      "name": "projects/project-id/keys/6LfhtywnAAAAABY3sCS2duZ6A55kmDXz-PNEgKgT",
      "displayName": "DISPLAY_NAME",
      "iosSettings": {
        "allowAllBundleIds": false,
        "allowedBundleIds": [
            BUNDLE_IDS
        ]
      },
      "labels": {},
      "wafSettings": {
          "wafService": "CA",
          "wafFeature": "ACTION_TOKEN"
      }
    }
    
    

    REST (Android)

    לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

    • ‫DISPLAY_NAME: שם המפתח. בדרך כלל שם האפליקציה.
    • ‫PACKAGE_NAMES: שמות החבילות של אפליקציות ל-Android שמורשות להשתמש במפתח. כדי לציין כמה שמות של חבילות, צריך להזין רשימה מופרדת בפסיקים.
    • ‫WAF_FEATURE: שם התכונה של WAF. מציינים את action-token.
    • ‫WAF_SERVICE: השם של ספק שירות ה-WAF. מציינים את CA ל-Cloud Armor.

    ה-method של ה-HTTP וכתובת ה-URL:

    POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

    גוף בקשת JSON:

    {
      "displayName": "DISPLAY_NAME",
      "androidSettings": {
      "allowedPackageNames":"PACKAGE_NAMES"
     },
       'wafSettings': "  {
           "wafService": "CA",
     "wafFeature": "ACTION_TOKEN"
      }
     }
    
    

    כדי לשלוח את הבקשה עליכם לבחור אחת מהאפשרויות הבאות:

    curl

    שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה:

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys"

    PowerShell

    שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה:

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

    אתם אמורים לקבל תגובת JSON שדומה לזו:

    
    {
      "name": "projects/project-id/keys/6LcioSknAAAAABrjlMuZv2fjIGYMqwaAFC9izhoy",
      "displayName": "DISPLAY_NAME",
      "androidSettings": {
          "allowAllPackageNames": false,
          "allowedPackageNames": [
              PACKAGE_NAMES
          ],
          "supportNonGoogleAppStoreDistribution": false
      },
      "labels": {},
      "wafSettings": {
          "wafService": "CA",
          "wafFeature": "ACTION_TOKEN"
      }
    }
    
    

  2. משלבים את reCAPTCHA mobile SDK באפליקציות לנייד באמצעות מפתח ה-action-token שיצרתם. הוראות מפורטות זמינות במאמר שמתאים לסוג האפליקציה לנייד.

  3. אחרי שמקבלים את הטוקן, מצרפים אותו ל-request header מוגדר מראש בפורמט הבא:

    X-Recaptcha-Token: value-of-your-action-token
    

    הקוד לדוגמה הבא מראה איך לצרף את האסימון:

    Android

    קוד לדוגמה ב-Java

    // This example shows how to send an HTTP request to the backend server
    // attached with the reCAPTCHA token in the header.
    //
    // @param serverUrl: the URL of the backend server.
    // @param rceToken: reCAPTCHA token that is attached to the header of the
    // HTTP request.
    
    public static void sendRequestToServerWithRceToken(
        String serverUrl, String rceToken) throws JSONException, IOException {
     URL url = new URL(String.format("http://%s/decryptcaptchacookie/accesswafserver", serverUrl));
     HttpURLConnection connection = (HttpURLConnection) url.openConnection();
     connection.setRequestProperty("X-Recaptcha-Token", rceToken);
    
     try {
        String requestBody = "['']";
        sendRequest(connection, requestBody, "AccessWithRceToken", "GET");
     } finally {
        connection.disconnect();
     }
    }
    
    private static void sendRequest(
        HttpURLConnection connection, String requestString, String requestName, String action)
        throws IOException {
     connection.setConnectTimeout(HTTP_CONNECT_TIMEOUT_MS);
     connection.setReadTimeout(HTTP_READ_TIMEOUT_MS);
     connection.setRequestProperty("Content-type", CONTENT_TYPE);
     connection.setRequestProperty(
        "Content-Length", Integer.toString(Utf8.encodedLength(requestString)));
     connection.setRequestMethod(action);
     connection.setDoOutput(true);
     connection.connect();
     try (OutputStream postStream = connection.getOutputStream()) {
        postStream.write(requestString.getBytes(UTF_8));
     }
    
     int responseCode = connection.getResponseCode();
     String response = connection.getResponseMessage();
     if (responseCode != HttpURLConnection.HTTP_OK) {
        throw new IOException(
           String.format(
              "Failed to complete request.\nResponse code:%s\nError Detail:\n%s",
              responseCode, response));
     }
    }

    iOS

    קוד לדוגמה ב-Swift

    // This example shows how to send an HTTP request to the backend server
    // attached with the reCAPTCHA token in the header.
    // @param serverUrl: the URL of the backend server.
    // @param rceToken: reCAPTCHA token that is attached to the header of
    // the HTTP request.
    
     public static func accessWafServer(rceToken: String, serverUrl: String)
        async throws -> String
     {
        let requestURL = try HttpHelper.createRequestURL(endpoint: serverUrl)
        var request = try HttpHelper.createRequest(requestURL: requestURL, action: "GET")
        request.setValue(rceToken, forHTTPHeaderField: "X-Recaptcha-Token")
    
        let data = try await HttpHelper.getDataFromServer(request)
    
        return String(decoding: data, as: UTF8.self)
     }

הגדרת מדיניות האבטחה של Cloud Armor

אחרי שמטמיעים את התכונות של Fraud Defense ל-WAF, צריך להגדיר כללי מדיניות אבטחה של Cloud Armor שמעריכים אסימוני reCAPTCHA לניהול בוטים.

במאמר הגדרת כללים לניהול בוטים מוסבר איך מגדירים את מדיניות האבטחה של Cloud Armor ואיך משתמשים ב מפתחות של אסימוני פעולה במדיניות האבטחה.

קבלת תוצאות של reCAPTCHA

בטוקנים לפעולות של reCAPTCHA, אפשר לקבל את הניקוד של reCAPTCHA מהכותרת X-Recaptcha-Wafdata. על סמך הניקוד הזה, אתם יכולים להגדיר כל פעולה מותאמת אישית שצריך לבצע לבקשות של משתמשים.

הדוגמה הבאה מציגה כותרת X-Recaptcha-Wafdata לדוגמה:

X-Recaptcha-Wafdata: waf_service="Google Cloud Armor", action_token;score=0.9\r\n

אפשר גם לראות את הניקוד של reCAPTCHA ביומנים של Google Cloud Armor.

המאמרים הבאים