ยืนยันโทเค็นรหัส Google ในฝั่งเซิร์ฟเวอร์

เมื่อใช้บริการระบุตัวตนของ Google หรือโฟลว์รหัสการให้สิทธิ์ OAuth 2.0 Google จะ ส่งโทเค็นรหัสโดยใช้วิธี POST ไปยังปลายทางการเปลี่ยนเส้นทาง หรือ ขั้นตอนโดยนัยของ OIDC จะใช้คำขอ GET ดังนั้น แอปพลิเคชันของคุณจึงมีหน้าที่รับผิดชอบในการส่งข้อมูลเข้าสู่ระบบที่ได้รับเหล่านี้ไปยังเซิร์ฟเวอร์อย่างปลอดภัย

GET

นี่คือโฟลว์โดยนัย โทเค็นรหัสจะแสดงในส่วน URL ซึ่ง JavaScript ฝั่งไคลเอ็นต์ต้องแยกวิเคราะห์ แอปพลิเคชันของคุณ มีหน้าที่ใช้กลไกการตรวจสอบของตัวเองเพื่อให้มั่นใจ ในความถูกต้องของคำขอและป้องกันการโจมตี เช่น CSRF

    HTTP/1.1 302 Found
    Location: https://<REDIRECT_URI>#access_token=<ACCESS_TOKEN>&token_type=bearer&expires_in=<TIME_IN_SECONDS>&scope=<SCOPE>&state=<STATE_STRING>
    
POST

ระบบจะส่งโทเค็นรหัสกลับเป็นฟิลด์ credential เมื่อ เตรียมส่งโทเค็นรหัสไปยังเซิร์ฟเวอร์ ไลบรารี GIS จะเพิ่ม g_csrf_token ลงในคุกกี้ส่วนหัวและเนื้อหาคำขอโดยอัตโนมัติ ตัวอย่างคำขอ POST มีดังนี้

POST /auth/token-verification HTTP/1.1
Host: example.com
Content-Type: application/json;charset=UTF-8
Cookie: g_csrf_token=<CSRF_TOKEN>
Origin: https://example.com
Content-Length: <LENGTH_OF_JSON_BODY>
    {
      "credential": "<ID_TOKEN>",
      "g_csrf_token": "<CSRF_TOKEN>",
      "client_id": "<CLIENT_ID>"
    }

  1. การตรวจสอบ g_csrf_token เพื่อป้องกันการโจมตีแบบ Cross-Site Request Forgery (CSRF)

    • ดึงค่าโทเค็น CSRF จากคุกกี้ g_csrf_token
    • แยกค่าโทเค็น CSRF จากเนื้อหาคำขอ ไลบรารี GIS จะรวมโทเค็นนี้ไว้ในเนื้อหาของคำขอ POST เป็นพารามิเตอร์ ซึ่งมีชื่อว่า g_csrf_token
    • เปรียบเทียบค่าโทเค็น 2 ค่า
      • หากมีทั้ง 2 ค่าและตรงกันทุกประการ ระบบจะถือว่าคำขอ ถูกต้องและมาจากโดเมนของคุณ
      • หากไม่มีค่าหรือค่าไม่ตรงกัน เซิร์ฟเวอร์จะต้องปฏิเสธคำขอ การตรวจสอบนี้ช่วยให้มั่นใจได้ว่าคำขอเริ่มต้นจาก JavaScript ที่ทำงานใน โดเมนของคุณเอง เนื่องจากมีเพียงโดเมนของคุณเท่านั้นที่เข้าถึงคุกกี้ g_csrf_token ได้
  2. ยืนยันโทเค็นรหัส

    To verify that the token is valid, ensure that the following criteria are satisfied:

    • The ID token is properly signed by Google. Use Google's public keys (available in JWK or PEM format) to verify the token's signature. These keys are regularly rotated; examine the Cache-Control header in the response to determine when you should retrieve them again.
    • The value of aud in the ID token is equal to one of your app's client IDs. This check is necessary to prevent ID tokens issued to a malicious app being used to access data about the same user on your app's backend server.
    • The value of iss in the ID token is equal to accounts.google.com or https://accounts.google.com.
    • The expiry time (exp) of the ID token has not passed.
    • If you need to validate that the ID token represents a Google Workspace or Cloud organization account, you can check the hd claim, which indicates the hosted domain of the user. This must be used when restricting access to a resource to only members of certain domains. The absence of this claim indicates that the account does not belong to a Google hosted domain.

    Using the email, email_verified and hd fields, you can determine if Google hosts and is authoritative for an email address. In the cases where Google is authoritative, the user is known to be the legitimate account owner, and you may skip password or other challenge methods.

    Cases where Google is authoritative:

    • email has a @gmail.com suffix, this is a Gmail account.
    • email_verified is true and hd is set, this is a Google Workspace account.

    Users may register for Google Accounts without using Gmail or Google Workspace. When email does not contain a @gmail.com suffix and hd is absent, Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verified can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

    Rather than writing your own code to perform these verification steps, we strongly recommend using a Google API client library for your platform, or a general-purpose JWT library. For development and debugging, you can call our tokeninfo validation endpoint.

    การใช้ไลบรารีของไคลเอ็นต์ Google API

    การใช้ไลบรารีของไคลเอ็นต์ Google API รายการใดรายการหนึ่ง (เช่น Java Node.js PHP Python) เป็นวิธีที่แนะนำในการตรวจสอบโทเค็น Google ID ในสภาพแวดล้อมการใช้งานจริง

    Java

    ในการตรวจสอบโทเค็นรหัสใน Java ให้ใช้ ออบเจ็กต์ GoogleIdTokenVerifier เช่น

    import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken;
    import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
    import com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier;
    
    ...
    
    GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
        // Specify the WEB_CLIENT_ID of the app that accesses the backend:
        .setAudience(Collections.singletonList(WEB_CLIENT_ID))
        // Or, if multiple clients access the backend:
        //.setAudience(Arrays.asList(WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3))
        .build();
    
    // (Receive idTokenString by HTTPS POST)
    
    GoogleIdToken idToken = verifier.verify(idTokenString);
    if (idToken != null) {
      Payload payload = idToken.getPayload();
    
      // Print user identifier. This ID is unique to each Google Account, making it suitable for
      // use as a primary key during account lookup. Email is not a good choice because it can be
      // changed by the user.
      String userId = payload.getSubject();
      System.out.println("User ID: " + userId);
    
      // Get profile information from payload
      String email = payload.getEmail();
      boolean emailVerified = Boolean.valueOf(payload.getEmailVerified());
      String name = (String) payload.get("name");
      String pictureUrl = (String) payload.get("picture");
      String locale = (String) payload.get("locale");
      String familyName = (String) payload.get("family_name");
      String givenName = (String) payload.get("given_name");
    
      // Use or store profile information
      // ...
    
    } else {
      System.out.println("Invalid ID token.");
    }

    เมธอด GoogleIdTokenVerifier.verify() จะยืนยัน JWT ลายเซ็น การอ้างสิทธิ์ aud การอ้างสิทธิ์ iss และ การอ้างสิทธิ์ exp

    หากต้องการตรวจสอบว่าโทเค็นรหัสแสดงถึง Google Workspace หรือ Cloud บัญชีขององค์กร คุณสามารถยืนยันการอ้างสิทธิ์ hd โดยการตรวจสอบชื่อโดเมน แสดงผลโดยเมธอด Payload.getHostedDomain() โดเมนของ การอ้างสิทธิ์ email รายการไม่เพียงพอที่จะตรวจสอบว่าบัญชีได้รับการจัดการโดยโดเมน หรือองค์กรต่างๆ

    Node.js

    ในการตรวจสอบโทเค็นรหัสใน Node.js ให้ใช้ไลบรารีการตรวจสอบสิทธิ์ของ Google สำหรับ Node.js วิธีติดตั้งไลบรารี

    npm install google-auth-library --save
    จากนั้นเรียกฟังก์ชัน verifyIdToken() เช่น

    const {OAuth2Client} = require('google-auth-library');
    const client = new OAuth2Client();
    async function verify() {
      const ticket = await client.verifyIdToken({
          idToken: token,
          audience: WEB_CLIENT_ID,  // Specify the WEB_CLIENT_ID of the app that accesses the backend
          // Or, if multiple clients access the backend:
          //[WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]
      });
      const payload = ticket.getPayload();
      // This ID is unique to each Google Account, making it suitable for use as a primary key
      // during account lookup. Email is not a good choice because it can be changed by the user.
      const userid = payload['sub'];
      // If the request specified a Google Workspace domain:
      // const domain = payload['hd'];
    }
    verify().catch(console.error);

    ฟังก์ชัน verifyIdToken จะยืนยัน ลายเซ็น JWT, การอ้างสิทธิ์ aud, การอ้างสิทธิ์ exp และการอ้างสิทธิ์ iss

    หากต้องการตรวจสอบว่าโทเค็นรหัสแสดงถึง Google Workspace หรือ Cloud บัญชีขององค์กร คุณสามารถตรวจสอบการอ้างสิทธิ์ hd ซึ่งระบุการอ้างสิทธิ์ที่โฮสต์ไว้ โดเมนของผู้ใช้ ต้องใช้เมื่อจำกัดการเข้าถึงทรัพยากรให้กับสมาชิกเท่านั้น ของโดเมนหนึ่งๆ การที่ไม่มีการอ้างสิทธิ์นี้แสดงว่าบัญชีนี้ไม่ได้เป็นของ โดเมนที่ Google โฮสต์

    PHP

    หากต้องการตรวจสอบโทเค็นรหัสใน PHP ให้ใช้ไลบรารีของไคลเอ็นต์ Google API สำหรับ PHP ติดตั้งไลบรารี (เช่น โดยใช้ Composer) ดังนี้

    composer require google/apiclient
    จากนั้นเรียกฟังก์ชัน verifyIdToken() เช่น

    require_once 'vendor/autoload.php';
    
    // Get $id_token via HTTPS POST.
    
    $client = new Google_Client(['client_id' => $WEB_CLIENT_ID]);  // Specify the WEB_CLIENT_ID of the app that accesses the backend
    $payload = $client->verifyIdToken($id_token);
    if ($payload) {
      // This ID is unique to each Google Account, making it suitable for use as a primary key
      // during account lookup. Email is not a good choice because it can be changed by the user.
      $userid = $payload['sub'];
      // If the request specified a Google Workspace domain
      //$domain = $payload['hd'];
    } else {
      // Invalid ID token
    }

    ฟังก์ชัน verifyIdToken จะยืนยัน ลายเซ็น JWT, การอ้างสิทธิ์ aud, การอ้างสิทธิ์ exp และการอ้างสิทธิ์ iss

    หากต้องการตรวจสอบว่าโทเค็นรหัสแสดงถึง Google Workspace หรือ Cloud บัญชีขององค์กร คุณสามารถตรวจสอบการอ้างสิทธิ์ hd ซึ่งระบุการอ้างสิทธิ์ที่โฮสต์ไว้ โดเมนของผู้ใช้ ต้องใช้เมื่อจำกัดการเข้าถึงทรัพยากรให้กับสมาชิกเท่านั้น ของโดเมนหนึ่งๆ การที่ไม่มีการอ้างสิทธิ์นี้แสดงว่าบัญชีนี้ไม่ได้เป็นของ โดเมนที่ Google โฮสต์

    Python

    หากต้องการตรวจสอบโทเค็นรหัสใน Python ให้ใช้เมธอด verify_oauth2_token เช่น

    from google.oauth2 import id_token
    from google.auth.transport import requests
    
    # (Receive token by HTTPS POST)
    # ...
    
    try:
        # Specify the WEB_CLIENT_ID of the app that accesses the backend:
        idinfo = id_token.verify_oauth2_token(token, requests.Request(), WEB_CLIENT_ID)
    
        # Or, if multiple clients access the backend server:
        # idinfo = id_token.verify_oauth2_token(token, requests.Request())
        # if idinfo['aud'] not in [WEB_CLIENT_ID_1, WEB_CLIENT_ID_2, WEB_CLIENT_ID_3]:
        #     raise ValueError('Could not verify audience.')
    
        # If the request specified a Google Workspace domain
        # if idinfo['hd'] != DOMAIN_NAME:
        #     raise ValueError('Wrong domain name.')
    
        # ID token is valid. Get the user's Google Account ID from the decoded token.
        # This ID is unique to each Google Account, making it suitable for use as a primary key
        # during account lookup. Email is not a good choice because it can be changed by the user.
        userid = idinfo['sub']
    except ValueError:
        # Invalid token
        pass

    ฟังก์ชัน verify_oauth2_token จะยืนยัน JWT ลายเซ็น, การอ้างสิทธิ์ aud และการอ้างสิทธิ์ exp คุณต้องยืนยัน hd ด้วย การอ้างสิทธิ์ (หากมี) โดยการตรวจสอบออบเจ็กต์ที่ verify_oauth2_token กลับมา หากมีลูกค้าหลายรายเข้าถึง เซิร์ฟเวอร์ส่วนหลัง ให้ยืนยันการอ้างสิทธิ์ aud ด้วยตนเองด้วย

  3. เมื่อยืนยันความถูกต้องของโทเค็นแล้ว คุณจะใช้ข้อมูลในโทเค็นรหัส Google เพื่อเชื่อมโยงสถานะบัญชีของเว็บไซต์ได้

    • ผู้ใช้ที่ไม่ได้ลงทะเบียน: คุณสามารถแสดงอินเทอร์เฟซผู้ใช้ (UI) สำหรับการลงชื่อสมัครใช้ที่อนุญาตให้ผู้ใช้ระบุข้อมูลโปรไฟล์เพิ่มเติมได้ หากจำเป็น นอกจากนี้ยังช่วยให้ผู้ใช้สร้างบัญชีใหม่และเซสชันของผู้ใช้ที่เข้าสู่ระบบได้โดยอัตโนมัติ

    • บัญชีที่มีอยู่แล้วในเว็บไซต์: คุณสามารถแสดงหน้าเว็บที่อนุญาตให้ผู้ใช้ปลายทางป้อนรหัสผ่านและลิงก์บัญชีเดิมกับข้อมูลเข้าสู่ระบบของ Google ซึ่งเป็นการยืนยันว่า ผู้ใช้มีสิทธิ์เข้าถึงบัญชีที่มีอยู่

    • ผู้ใช้แบบรวมระบบที่กลับมา: คุณลงชื่อเข้าใช้ให้ผู้ใช้ได้โดยไม่ต้องแจ้งให้ทราบ