排解基本驗證政策執行階段錯誤的問題

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info

UnresolvedVariable

錯誤代碼

steps.basicauthentication.UnresolvedVariable

錯誤回應主體

{
    "fault": {
        "faultstring": "Unresolved variable : [variable_name]",
        "detail": {
            "errorcode": "steps.basicauthentication.UnresolvedVariable"
        }
    }
}

錯誤訊息範例

{
    "fault": {
        "faultstring": "Unresolved variable : request.header.Authorization",
        "detail": {
            "errorcode": "steps.basicauthentication.UnresolvedVariable"
        }
    }
}

原因

如果變數包含 BasicAuthentication 政策 <Source> 元素中指定的 Base64 編碼字串，則會發生此錯誤：

• 超出範圍 (無法在執行政策的特定流程中使用)
• 無法解析 (未定義)

舉例來說，如果基本驗證政策在 <Source> 元素中指定了 request.header.Authorization 的變數，但 Authorization 標頭並未隨 API 要求一併傳遞，就會發生這個錯誤。

診斷

1. 找出 BasicAuthentication 政策中 <Source> 元素使用的變數。您可以在錯誤回應的 faultstring 元素中找到這項資訊。例如，在以下 faultstring, 中，用於 <Source> 元素的變數為 request.header.Authorization：

   "faultstring": "Unresolved variable : request.header.Authorization"
   

2. 請檢查發生失敗的特定 API Proxy 中，所有 BasicAuthentication 政策。可能會有一或多項「基本驗證」政策。找出特定 BasicAuthentication 政策或多個政策，其中 <Source> 元素中指定的變數與錯誤字串中指出的變數名稱相符 (步驟 1 上方)。

   舉例來說，下列政策會將 <Source> 元素設為名為 request.header.Authorization 的變數，此變數與 faultstring 中的內容相符：

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <BasicAuthentication name="DecodeBaseAuthHeaders">
     <DisplayName>Decode Basic Authentication Header</DisplayName>
     <Operation>Decode</Operation>
     <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
     <User ref="request.header.username"/>
     <Password ref="request.header.password"/>
     <Source>request.header.Authorization</Source>
   </BasicAuthentication>
   

3. 判定是否已定義變數，並在執行基本驗證政策的流程中加以定義。

4. 如果變數為：

   1. 超出範圍 (無法在執行政策的特定流程中使用)
   2. 無法解析 (未定義)

   那就是錯誤的原因。

   在上述 BasicAuthentication 政策範例中，變數 request.header.Authorization 並未在要求中傳遞。也就是說，在沒有 Authorization 標頭的情況下提出 API 要求，如下所示：

   curl -v "http://org-env.apigee.net/basicauth"

   由於 BasicAuthentication 政策中使用的變數無法使用，因此您會收到以下錯誤代碼：

   steps.basicauthentication.UnresolvedVariable
   

解析度

請確認在 BasicAuthentication 政策中使用的變數已定義或以輸入格式傳遞，並且在執行政策的流程中可供使用。

如要修正上述基本驗證政策範例的問題，請按照以下方式提出 API 要求：

curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: Basic YWthc2g6MTIz"

InvalidBasicAuthenticationSource

錯誤代碼

steps.basicauthentication.InvalidBasicAuthenticationSource

錯誤回應主體

{
    "fault": {
        "faultstring": "Source variable : [variable_name] for basic authentication decode policy is not valid",
        "detail": {
            "errorcode": "steps.basicauthentication.InvalidBasicAuthenticationSource"
        }
    }
}

錯誤示例：錯誤訊息

{
    "fault": {
        "faultstring": "Source variable : request.header.Authorization for basic authentication decode policy is not valid",
        "detail": {
            "errorcode": "steps.basicauthentication.InvalidBasicAuthenticationSource"
        }
    }
}

可能原因

導致這項錯誤的可能原因包括：

原因	說明
無效的來源變數	BasicAuthentication 政策的輸入來源變數並非有效的 Base64 編碼字串。
標頭格式錯誤	包含 Base64 編碼字串的標頭格式錯誤，導致 BasicAuthentication 政策無法傳遞。

原因：來源變數無效

如果變數包含 BasicAuthentication 政策 <Source> 元素中指定的 Base64 編碼字串，但不含有效值，就會發生此錯誤。

舉例來說，如果 BasicAuthentication 政策的 <Source> 元素中指定的變數沒有有效的 Base64 編碼字串，就會發生這項錯誤。

診斷

1. 找出 BasicAuthentication 政策中 <Source> 元素使用的變數。您可以在錯誤回應的 faultstring 元素中找到這項資訊。例如，在以下 faultstring, 中，用於 <Source> 元素的變數為 request.header.Authorization：

   "faultstring": "Source variable : request.header.Authorization for basic authentication decode policy is not valid"
   

2. 請檢查發生失敗的特定 API Proxy 中，所有 BasicAuthentication 政策。可能會有一或多項 BasicAuthentication 政策。找出特定的 BasicAuthentication 政策，其中 <Source> 元素中指定的變數與錯誤字串中指出的變數名稱相符 (請參閱上述步驟 1)。

   舉例來說，下列政策會將 <Source> 元素設為名為 request.header.Authorization 的變數，此變數與 faultstring 中的內容相符：

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <BasicAuthentication name="DecodeBaseAuthHeaders">
       <DisplayName>Decode Basic Authentication Header</DisplayName>
       <Operation>Decode</Operation>
       <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
       <User ref="request.header.username"/>
       <Password ref="request.header.password"/>
       <Source>request.header.Authorization</Source>
   </BasicAuthentication>
   

3. 如果 <Source> 元素中指定的變數儲存的值不是有效的 Base64 編碼字串，就會導致錯誤。

   在上述 BasicAuthentication 政策範例中，由用戶端以標頭傳送的變數 request.header.Authorization 無效，如下所示：

   curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: Basic 23435"

   由於變數 request.header.Authorization 含有無效的 Base64 編碼字串「23435"」，因此您會收到以下錯誤代碼：

   steps.basicauthentication.InvalidBasicAuthenticationSource

解析度

請確認 BasicAuthentication 政策中 <Source> 元素指定的變數具有有效的 Base64 編碼字串。

如要修正上述 BasicAuthentication 政策範例的問題，請在授權標頭中傳遞有效的 Base64 編碼字串，藉此提出 API 要求，如下所示：

curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: Basic YWthc2g6MTIz"

原因：標頭格式不正確/無效

如果傳遞至 BasicAuthentication 政策的標頭格式錯誤或無效，就會發生這項錯誤。

舉例來說，如果 BasicAuthentication 政策在 <Source> 元素中指定的變數為 request.header.Authorization，且 API 要求中傳遞的標頭格式錯誤/無效，就會發生這個錯誤。

診斷

1. 找出 BasicAuthentication 政策中 <Source> 元素使用的變數。您可以在錯誤回應的 faultstring 元素中找到這項資訊。舉例來說，在下列錯誤中，<Source> 元素使用的變數為 request.header.Authorization：

   "faultstring": "Source variable : request.header.Authorization for basic authentication decode policy is not valid"
   

2. 請檢查發生失敗的特定 API Proxy 中，所有 BasicAuthentication 政策。您可以設定一或多項 BasicAuthentication 政策。找出特定的 BasicAuthentication 政策，其中 <Source> 元素中指定的變數與錯誤字串中指出的變數名稱相符 (請參閱上述步驟 1)。

   舉例來說，下列政策會將 <Source> 元素設為名為 request.header.Authorization 的變數，與 faultstring 中的內容相符：

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <BasicAuthentication name="DecodeBaseAuthHeaders">
       <DisplayName>Decode Basic Authentication Header</DisplayName>
       <Operation>Decode</Operation>
       <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
       <User ref="request.header.username"/>
       <Password ref="request.header.password"/>
       <Source>request.header.Authorization</Source>
   </BasicAuthentication>
   

3. 如果變數是標頭，且格式有誤或無效 (例如，沒有驗證類型，或驗證類型不是「Basic」)，則會導致錯誤。

   Authorization 標頭的格式如下：

   Authorization: <Authentication type> <credentials>
   

   格式錯誤的標頭可以透過兩種方式傳遞至 BasicAuthentication 政策：

   示例 1：標頭中沒有驗證類型：

   curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: YWthc2g6MTIz"

   在上述範例中，Authorization 標頭沒有「驗證」類型。如果這個標頭傳遞至上述 BasicAuthentication 政策，您會收到以下錯誤代碼：

   steps.basicauthentication.InvalidBasicAuthenticationSource
   

   範例 2：驗證類型不是「Basic」類型：

   curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: OAuth YWthc2g6MTIz"

   在上述範例中，Authorization 標頭並不包含「Basic」類型的驗證。如果傳遞至上述基本驗證政策，您會收到錯誤代碼：

   steps.basicauthentication.InvalidBasicAuthenticationSource
   

   同樣地，如果在 Authorization 標頭中使用「驗證類型」(例如 Bearer、摘要驗證等)，也可能會發生這個錯誤。

解析度

請確認傳遞至 BasicAuthentication 政策的輸入內容標頭具有驗證類型，且類型為「Basic」。

如要修正上述「基本驗證」政策範例的問題，請在 Authorization 標頭中傳送包含「Basic」驗證類型的有效 Base64 編碼字串，並提出 API 要求，如下所示：

curl -v "http://org-env.apigee.net/basicauth" -H "Authorization: Basic YWthc2g6MTIz"