Client Plugin

Ktor 用戶端中的認證與授權

必要依賴項：io.ktor:ktor-client-auth

Ktor 提供 Auth 外掛程式，用於處理您用戶端應用程式中的認證與授權。典型使用情境包括使用者登入及取得特定資源的存取權。

在伺服器端，Ktor 提供 Authentication 外掛程式來處理認證與授權。

支援的認證類型

HTTP 提供一個 通用框架 用於存取控制和認證。Ktor 用戶端允許您使用以下 HTTP 認證方案：

• 基本 - 使用 Base64 編碼提供使用者名稱和密碼。如果未與 HTTPS 結合使用，通常不建議使用。
• 摘要 - 一種認證方法，透過將雜湊函數應用於使用者名稱和密碼，以加密形式傳輸使用者憑證。
• 承載者 - 一種認證方案，涉及稱為承載者令牌的安全令牌。例如，您可以將此方案作為 OAuth 流程的一部分，透過使用外部提供者（如 Google、Facebook、Twitter 等）來授權您的應用程式使用者。

添加依賴項

若要啟用認證，您需要在建構腳本中包含 ktor-client-auth 構件：

Gradle (Kotlin)Gradle (Groovy)Maven

您可以從

添加用戶端依賴項

瞭解如何將用戶端依賴項添加到現有專案。

瞭解更多關於 Ktor 用戶端所需的構件資訊。

安裝 Auth

若要安裝 Auth 外掛程式，請將其傳遞給 用戶端配置區塊 內的 install 函數：

import io.ktor.client.*
import io.ktor.client.engine.cio.*
import io.ktor.client.plugins.auth.*
//...
val client = HttpClient(CIO) {
    install(Auth) {
        // 配置認證
    }
}

現在您可以配置 所需的認證提供者。

配置認證

步驟 1：選擇認證提供者

若要使用特定的認證提供者（基本、摘要 或 承載者），您需要在 install 區塊內呼叫對應的函數。例如，若要使用 basic 認證，請呼叫 basic 函數：

install(Auth) {
    basic {
        // 配置基本認證
    }
}

在區塊內部，您可以配置此提供者特有的設定。

步驟 2：（可選）配置領域

您可以選擇使用 realm 屬性配置領域：

install(Auth) {
    basic {
        realm = "Access to the '/' path"
        // ...
    }
}

您可以建立幾個具有不同領域的提供者，以存取不同的資源：

install(Auth) {
    basic {
        realm = "Access to the '/' path"
        // ...
    }
    basic {
        realm = "Access to the '/admin' path"
        // ...
    }
}

在此情況下，用戶端會根據包含領域的 WWW-Authenticate 回應標頭來選擇必要的提供者。

步驟 3：配置提供者

若要瞭解如何為特定的提供者 配置設定，請參閱對應的主題：

• Ktor 用戶端中的基本認證
• Ktor 用戶端中的摘要認證
• Ktor 用戶端中的承載者認證