Skip to content

Ktor Client におけるダイジェスト認証 ​

必要な依存関係: io.ktor:ktor-client-auth

コード例: client-auth-digest

ダイジェスト認証(Digest authentication)スキームでは、ユーザー名とパスワードをネットワーク経由で送信する前にハッシュ関数を適用します。

サーバー側では、Ktor はダイジェスト認証を処理するための Authentication プラグインを提供しています。

依存関係の追加 ​

認証を有効にするには、ビルドスクリプトに ktor-client-auth アーティファクトを含めます。

kotlin
implementation(ktorLibs.client.auth)
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログ を使用しています。
groovy
implementation ktorLibs.client.auth
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログ を使用しています。
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-client-auth-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>
Ktor クライアントに必要なアーティファクトの詳細については、クライアントの依存関係の追加既存のプロジェクトにクライアントの依存関係を追加する方法を学びます。 を参照してください。

ダイジェスト認証のフロー ​

ダイジェスト認証のフローは以下のようになります。

  1. クライアントが、サーバーアプリケーション内の特定のリソースに対して Authorization ヘッダーなしでリクエストを送信します。

  2. サーバーは 401(Unauthorized)レスポンスステータスでクライアントに応答し、WWW-Authenticate レスポンスヘッダーを使用して、ルートの保護にダイジェスト認証スキームが使用されているという情報を提供します。典型的な WWW-Authenticate ヘッダーは次のようになります。

    WWW-Authenticate: Digest
            realm="Access to the '/' path",
            nonce="e4549c0548886bc2",
            algorithm="MD5"
  3. 通常、クライアントはユーザーが認証情報を入力できるログインダイアログを表示します。その後、クライアントは以下の Authorization ヘッダーを付加してリクエストを送信します。

    Authorization: Digest username="jetbrains",
            realm="Access to the '/' path",
            nonce="e4549c0548886bc2",
            uri="/",
            algorithm=MD5,
            response="6299988bb4f05c0d8ad44295873858cf"

    response の値は以下のように生成されます。

    a. HA1 = MD5(username:realm:password)

    b. HA2 = MD5(method:digestURI)

    c. response = MD5(HA1:nonce:HA2)

  4. サーバーはクライアントから送信された認証情報を検証し、リクエストされたコンテンツで応答します。

ダイジェスト認証の設定 ​

Digest スキームを使用して Authorization ヘッダーでユーザー認証情報を送信するには、次のように digest 認証プロバイダーを設定する必要があります。

  1. install ブロック内で digest 関数を呼び出します。
  2. DigestAuthCredentials を使用して必要な認証情報を指定し、このオブジェクトを credentials 関数に渡します。
  3. 必要に応じて、realm プロパティを使用してレルムを設定します。
kotlin
val client = HttpClient(CIO) {
    install(Auth) {
        digest {
            credentials {
                DigestAuthCredentials(username = "jetbrains", password = "foobar")
            }
            realm = "Access to the '/' path"
        }
    }
}

完全なコード例はこちらから確認できます: client-auth-digest。