การแก้ปัญหาข้อผิดพลาดของรันไทม์ JWT ในการถอดรหัส

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

FailedToDecode

รหัสข้อผิดพลาด

steps.jwt.FailedToDecode

เนื้อหาการตอบกลับข้อผิดพลาด

{
  "fault": {
    "faultstring": "Failed to Decode Token: policy({0})",
    "detail": {
       "errorcode": "steps.jwt.FailedToDecode"
     }
  }
}

สาเหตุ

ข้อผิดพลาดนี้เกิดขึ้นหาก JSON Web Token (JWT) ที่ระบุในองค์ประกอบ <Source> ของนโยบาย Decode JWT ผิดรูปแบบ ไม่ถูกต้อง หรือถอดรหัสไม่ได้

JWT ที่มีโครงสร้างที่ถูกต้องควรมีส่วนหัว เพย์โหลด และลายเซ็นในรูปแบบ header.payload.signature หาก JWT ที่ส่งไปยังนโยบาย DecodeJWT ไม่มีส่วนคอมโพเนนต์ คุณจะได้รับข้อผิดพลาด ตัวอย่างเช่น หาก JWT มีเพียง payload.signature แต่ไม่มี header ข้อผิดพลาดจะเกิดขึ้น

การวินิจฉัย

  1. ระบุตัวแปรที่ระบุในองค์ประกอบ <Source> ของนโยบาย Decode JWT ตัวแปรนี้ควรมี JWT

    ตัวอย่างนโยบาย JWT ถอดรหัส

    <DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>request.header.authorization</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</DecodeJWT>

    ในตัวอย่างข้างต้น JWT ควรอยู่ในส่วนหัวของคำขอการให้สิทธิ์

  2. ตรวจสอบตัวแปรที่ระบุในขั้นตอนที่ 1 และตรวจสอบว่า JWT ที่มีนั้นถูกต้องหรือไม่ หากอินพุต JWT ไม่ถูกต้อง นั่นก็เป็นสาเหตุของข้อผิดพลาด

    ในตัวอย่างคำขอ API ด้านล่าง ระบบจะส่ง JWT อินพุตในส่วนหัวคำขอการให้สิทธิ์

    curl -v "http://<org>-<env>.apigee.net/v1/decodeJWT" -H "Authorization: Bearer eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM"

    การตรวจสอบ JWT อย่างใกล้ชิดแสดงให้เห็นว่า JWT มีรูปแบบเป็น payload.signature ซึ่งไม่ถูกต้อง รูปแบบที่คาดไว้ของ JWT คือ header.payload.signature ดังนั้น นโยบาย Decode JWT จะดำเนินการไม่สำเร็จโดยมีข้อผิดพลาด

    "faultstring": "Failed to Decode Token: policy({0})"

ความละเอียด

ตรวจสอบว่า JWT ที่ส่งไปยังนโยบาย Decode JWT มีองค์ประกอบทั้ง 3 รายการ มีการจัดรูปแบบอย่างถูกต้องและถอดรหัสได้

หากต้องการแก้ไขตัวอย่างที่แสดงข้างต้น คุณสามารถส่ง JWT ที่ถูกต้องด้วยรูปแบบ header.payload.signature ซึ่งทำได้ด้วยการเรียก API โดยใช้คำสั่ง cURL ดังนี้

curl -v "http://<org>-<env>.apigee.net/v1/decodeJWT" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM"

InvalidToken

รหัสข้อผิดพลาด

steps.jwt.InvalidToken

เนื้อหาการตอบกลับข้อผิดพลาด

{
  "fault": {
    "faultstring": "Invalid token: policy({0})",
    "detail": {
      "errorcode": "steps.jwt.InvalidToken"
     }
  }
}

สาเหตุ

ข้อผิดพลาดนี้เกิดขึ้นหากตัวแปรโฟลว์ที่ระบุในองค์ประกอบ <Source> ของนโยบาย JWT ถอดรหัสคือ

  • อยู่นอกขอบเขต (ใช้ไม่ได้ในขั้นตอนที่เจาะจงซึ่งจะมีการบังคับใช้นโยบาย) หรือ
  • ไม่สามารถแก้ไขได้ (ไม่ได้กำหนด)

การวินิจฉัย

  1. ระบุตัวแปรที่ระบุในองค์ประกอบ <Source> ของนโยบาย Decode JWT ตัวแปรนี้ควรมี JWT

    ตัวอย่างนโยบาย JWT ถอดรหัส

    <DecodeJWT name="JWT-Decode-HS256">
    <DisplayName>JWT Verify HS256</DisplayName>
    <Source>request.header.authorization</Source>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</DecodeJWT>

    ในตัวอย่างข้างต้น ส่วนหัวคำขอการให้สิทธิ์ควรมี JWT

  2. ตรวจสอบว่าตัวแปรที่ระบุในขั้นตอนที่ 1 ได้รับการกำหนดและพร้อมใช้งานในโฟลว์ที่มีการบังคับใช้นโยบาย JWT สำหรับการถอดรหัสหรือไม่

  3. หากตัวแปรมีลักษณะอย่างใดอย่างหนึ่งต่อไปนี้

    • อยู่นอกขอบเขต (ใช้ไม่ได้ในขั้นตอนที่เจาะจงซึ่งจะมีการบังคับใช้นโยบาย) หรือ
    • ไม่สามารถแก้ไขได้ (ไม่ได้กำหนด)

    นั่นคือสาเหตุของข้อผิดพลาด

    ในตัวอย่างคำขอ API ด้านล่าง ผู้ใช้จะไม่ส่ง JWT ในส่วนหัวของคำขอการให้สิทธิ์

    curl -v "http://<org>-<env>.apigee.net/v1/decodeJWT"

    เนื่องจากไม่มีการส่งส่วนหัวของคำขอการให้สิทธิ์ นโยบาย Decode JWT จึงล้มเหลวเนื่องจากมีข้อผิดพลาด:

    "faultstring": "Invalid token: policy({0})"

ความละเอียด

ตรวจสอบว่าได้กำหนดตัวแปรที่อ้างอิงในองค์ประกอบ <Source> ของนโยบาย JWT ถอดรหัสแล้ว มี JWT ที่ถูกต้อง (ถอดรหัสได้) และใช้ได้ในขั้นตอนที่เจาะจงซึ่งกำลังบังคับใช้นโยบาย JWT ถอดรหัส

หากต้องการแก้ไขตัวอย่างที่แสดงข้างต้น ก็ส่ง JWT ที่ถูกต้องได้ในส่วนหัวการให้สิทธิ์คำขอ ซึ่งทำได้ด้วยการเรียก API โดยใช้คำสั่ง cURL ดังนี้

curl -v "http://<org>-<env>.apigee.net/v1/decodeJWT" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM"