QOAuthUriSchemeReplyHandler Class

詳細な説明

このクラスは、リダイレクトにプライベート／カスタムまたはHTTPS URIスキームを使用するOAuth 2.0認証プロセスの応答ハンドラとして機能します。認証リダイレクト（コールバックとも呼ばれる）の受信と、それに続くアクセストークンの取得を管理します。

リダイレクト URIとは、フローの認証部分が完了した後、認証サーバーがユーザーエージェント（通常は、かつ望ましくはシステムのブラウザ）をリダイレクトする先のことです。

特定の URI スキームを使用するには、URI を正しいアプリケーションに関連付けるために、オペレーティングシステムレベルでの設定が必要です。この関連付けの設定方法は、オペレーティングシステムによって異なります。Platform Support and Dependencies を参照してください。

このクラスは、ローカルホストサーバーを設定することでhttp スキーマを処理するQOAuthHttpServerReplyHandler を補完するものです。

以下のコードは、その使用例を示しています。まず、必要な変数を定義します。

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

続いて、OAuthの設定を行います（簡潔にするためエラー処理は省略しています）：

m_oauth.setAuthorizationUrl(QUrl(authorizationUrl));
m_oauth.setTokenUrl(QUrl(accessTokenUrl));
m_oauth.setClientIdentifier(clientIdentifier);
m_oauth.setRequestedScopeTokens({scope});

connect(&m_oauth, &QAbstractOAuth::authorizeWithBrowser, this, &QDesktopServices::openUrl);
connect(&m_oauth, &QAbstractOAuth::granted, this, [this]() {
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_oauth.token().toLatin1());
    m_handler.close();
});

最後に、URIスキームのreply-handlerを設定します：

m_handler.setRedirectUrl(QUrl{"com.example.myqtapp://oauth2redirect"_L1});
m_oauth.setReplyHandler(&m_handler);

// Initiate the authorization
if (m_handler.listen()) {
    m_oauth.grant();
}

プライベート／カスタムURIスキーマ

カスタムURIスキーマでは、通常、リバースドメイン表記の後にパスが続く形式が使用されます。また、場合によってはホストまたはホスト＋パスが指定されることもあります：

// Example with path:
com.example.myapp:/oauth2/callback
// Example with host:
com.example.myapp://oauth2.callback

HTTPS URIスキーム

HTTPS URIスキーマの場合、リダイレクトURLは通常のhttpsリンクになります：

https://myapp.example.com/oauth2/callback

これらのリンクは、iOS では「ユニバーサルリンク」、Android では「アプリリンク」と呼ばれます。

HTTPSスキームの使用が推奨されます。これは、アプリケーション開発者に使用されるURLの所有権を証明することを義務付けることで、セキュリティを強化するためです。この証明は、関連付けファイルをホストすることで行われ、オペレーティングシステムは内部のURLディスパッチ処理の一環としてこのファイルを参照します。

このファイルの内容は、アプリケーションと使用されるURLを関連付けます。アソシエーションファイルは、HTTPリダイレクトを経由せずに一般に公開されている必要があります。さらに、ホスティングサイトには有効な証明書が必要であり、少なくともAndroidの場合、ファイルはapplication/json のコンテンツタイプとして配信されなければなりません（サーバーの設定ガイドを参照してください）。

さらに、HTTPSリンクには、ユーザビリティ上の利点もあります：

• HTTPS URLは、通常のHTTPSリンクとしても機能します。ユーザーがアプリケーションをインストールしていない場合（そのURLがどのアプリケーションによっても処理されなかった場合）、HTTPSリンクは、例えばインストール手順を表示する役割を果たすことがあります。
• URLを開くためのアプリケーション選択ダイアログが表示されず、代わりにアプリケーションが自動的に開かれる場合があります。

その代償として、このパブリックホスト上の関連付けファイルを設定する必要があるため、追加の設定作業が必要となります。

対応プラットフォームと依存関係

現在サポートされているプラットフォームは、Android、iOS、および macOS です。

URI スキームのリスニングは、QDesktopServices::setUrlHandler() およびQDesktopServices::unsetUrlHandler() に基づいています。これらは現在 Qt::Gui モジュールによって提供されているため、QtNetworkAuth モジュールは Qt::Gui に依存しています。QtNetworkAuth が Qt::Gui なしでビルドされた場合、QOAuthUriSchemeReplyHandler は含まれません。

Android

Androidでは、URI スキームの設定に以下が必要です:

• アプリケーションマニフェストでのintent-filters の設定
• オプションとして、https スキームでの自動検証を行うために、サイトアソシエーションファイルをホストするassetlinks.json

「Qt Android マニフェストファイルの設定」も参照してください。

iOS および macOS

iOSおよびmacOSでは、URIスキームに関して以下の要件があります:

• サイトアソシエーションの設定entitlement
• HTTPSスキームを使用する場合は、site association file (apple-app-site-association) をホストする必要があります。

Windows、Linux

現在はサポートされていません。ただし、このリプライハンドラーをサポートしているプラットフォームやユースケースでは Qt WebEngine このリプライハンドラを使用できます。詳細については、「Qt OAuth2 ブラウザのサポート」を参照してください。