Ktor Client での Basic 認証
必要な依存関係: io.ktor:ktor-client-auth
コード例: client-auth-basic
Basic 認証スキームは、ユーザーのログインに使用できます。このスキームでは、ユーザーの認証情報は Base64 でエンコードされたユーザー名とパスワードのペアとして送信されます。
サーバー側では、Ktor は Basic 認証を処理するための Authentication プラグインを提供しています。
依存関係の追加
認証を有効にするには、ビルドスクリプトに ktor-client-auth アーティファクトを含めます。
implementation(ktorLibs.client.auth)implementation ktorLibs.client.auth<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-client-auth-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>Basic 認証のフロー
Basic 認証のフローは次のようになります。
クライアントが、
Authorizationヘッダーを含めずにサーバーアプリケーションの保護されたリソースにリクエストを送信します。サーバーは
401 Unauthorizedレスポンスステータスを返し、WWW-Authenticateレスポンスヘッダーを使用して Basic 認証が必要であることを示します。一般的なWWW-Authenticateヘッダーは次のようになります。WWW-Authenticate: Basic realm="Access to the '/' path", charset="UTF-8"Ktor クライアントでは、
sendWithoutRequest()関数 を使用することで、WWW-Authenticateヘッダーを待たずに事前に(preemptively)認証情報を送信できます。クライアントは通常、ユーザーに認証情報の入力を求めます。その後、Base64 でエンコードされたユーザー名とパスワードのペアを含む
Authorizationヘッダーを付加してリクエストを送信します。例:Authorization: Basic amV0YnJhaW5zOmZvb2Jhcgサーバーはクライアントから送信された認証情報を検証し、リクエストされたコンテンツを返します。
Basic 認証の設定
Basic スキームを使用して Authorization ヘッダーでユーザー認証情報を送信するには、basic 認証プロバイダーを設定する必要があります。
install(Auth)ブロック内でbasic関数を呼び出します。BasicAuthCredentialsを使用して必要な認証情報を指定し、このオブジェクトをcredentials関数に渡します。realmプロパティを使用してレルムを設定します。kotlinval client = HttpClient(CIO) { install(Auth) { basic { credentials { BasicAuthCredentials(username = "jetbrains", password = "foobar") } realm = "Access to the '/' path" } } }(オプション)
sendWithoutRequest関数を使用してプリエンプティブ認証を有効にします。この関数はリクエストパラメータを確認し、最初のリクエストに認証情報を付加するかどうかを決定します。kotlininstall(Auth) { basic { // ... sendWithoutRequest { request -> request.url.host == "0.0.0.0" } } }(オプション)認証情報のキャッシュを無効にします。デフォルトでは、
credentials {}プロバイダーによって返された認証情報はリクエスト間で再利用できるようにキャッシュされます。cacheTokensオプションを使用してキャッシュを無効にできます。kotlinbasic { cacheTokens = false // リクエストごとに認証情報を再読み込みします // ... }キャッシュの無効化は、クライアントセッション中に認証情報が変更される可能性がある場合や、最新の保存状態を反映する必要がある場合に役立ちます。
キャッシュされた認証情報をプログラムでクリアする詳細については、全般的な トークンのキャッシュとキャッシュ制御 セクションを参照してください。
Ktor Client における Basic 認証の完全な例については、client-auth-basic を参照してください。
